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 | |
| parent | 625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff) | |
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star')
1330 files changed, 34164 insertions, 26309 deletions
diff --git a/offapi/com/sun/star/awt/ActionEvent.idl b/offapi/com/sun/star/awt/ActionEvent.idl index c26b012d7fa0..bebdffba783e 100644 --- a/offapi/com/sun/star/awt/ActionEvent.idl +++ b/offapi/com/sun/star/awt/ActionEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ActionEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,6 +106,9 @@ struct ActionEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/AdjustmentEvent.idl b/offapi/com/sun/star/awt/AdjustmentEvent.idl index 059e3991209c..b17c39d2f33c 100644 --- a/offapi/com/sun/star/awt/AdjustmentEvent.idl +++ b/offapi/com/sun/star/awt/AdjustmentEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: AdjustmentEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,18 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::awt::AdjustmentEvent /** adjustment event emitted by adjustable objects. */ struct AdjustmentEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::awt::AdjustmentEvent::Value /** contains the current value in the adjustment event. */ long Value; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::awt::AdjustmentEvent::Type /** contains the type of the adjustment event. */ com::sun::star::awt::AdjustmentType Type; @@ -101,24 +98,4 @@ struct AdjustmentEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:04 mi - documentation merged from XML - - Revision 1.3 2000/05/15 12:50:14 mi - documentation - - Revision 1.2 2000/02/07 11:24:10 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/AdjustmentType.idl b/offapi/com/sun/star/awt/AdjustmentType.idl index 08422086a7ce..42d58b405fa4 100644 --- a/offapi/com/sun/star/awt/AdjustmentType.idl +++ b/offapi/com/sun/star/awt/AdjustmentType.idl @@ -2,9 +2,9 @@ * * $RCSfile: AdjustmentType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,38 +67,32 @@ module com { module sun { module star { module awt { //============================================================================= -// DOCUMENTATION MISSING FOR AdjustmentType -// DocMerge from xml: enum com::sun::star::awt::AdjustmentType -/** specifies whether the event is originated in a line or page jump or a - direct positioning of the thumb. +/** specifies the adjustment type. */ enum AdjustmentType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::awt::AdjustmentType::ADJUST_LINE /** adjustment is originated by a line jump. - A line jump can, for example, be caused by a click on - one of the pointer buttons. + + <p>A line jump can, for example, be caused by a click on + one of the pointer buttons.</p> */ ADJUST_LINE, //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR AdjustmentType:: ADJUST_PAGE, - // DocMerge from xml: value com::sun::star::awt::AdjustmentType::ADJUST_PAGE /** adjustment is originated by a page jump. - A page jump can, for example, be caused by a click in the + + <p>A page jump can, for example, be caused by a click in the background area of the scrollbar (neither one of the pointer - buttons, nor the thumb). + buttons, nor the thumb).</p> */ ADJUST_PAGE, //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR AdjustmentType:: ADJUST_ABS - // DocMerge from xml: value com::sun::star::awt::AdjustmentType::ADJUST_ABS /** adjustment is originated by dragging the thumb. */ ADJUST_ABS @@ -109,24 +103,4 @@ enum AdjustmentType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:04 mi - documentation merged from XML - - Revision 1.3 2000/05/15 12:50:14 mi - documentation - - Revision 1.2 2000/02/07 11:24:11 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/CharSet.idl b/offapi/com/sun/star/awt/CharSet.idl index 0779560890c0..a9b98c8ee053 100644 --- a/offapi/com/sun/star/awt/CharSet.idl +++ b/offapi/com/sun/star/awt/CharSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CharSet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -164,6 +164,9 @@ constants CharSet /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/DeviceCapability.idl b/offapi/com/sun/star/awt/DeviceCapability.idl index dadd900c2825..62f83f2118d5 100644 --- a/offapi/com/sun/star/awt/DeviceCapability.idl +++ b/offapi/com/sun/star/awt/DeviceCapability.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeviceCapability.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,6 +101,9 @@ constants DeviceCapability /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/DeviceInfo.idl b/offapi/com/sun/star/awt/DeviceInfo.idl index adbea0f927bb..a50790be4735 100644 --- a/offapi/com/sun/star/awt/DeviceInfo.idl +++ b/offapi/com/sun/star/awt/DeviceInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeviceInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -150,6 +150,9 @@ struct DeviceInfo /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FocusChangeReason.idl b/offapi/com/sun/star/awt/FocusChangeReason.idl index 7b6b66d70e0b..16c6013fcde0 100644 --- a/offapi/com/sun/star/awt/FocusChangeReason.idl +++ b/offapi/com/sun/star/awt/FocusChangeReason.idl @@ -2,9 +2,9 @@ * * $RCSfile: FocusChangeReason.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -132,6 +132,9 @@ constants FocusChangeReason /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FocusEvent.idl b/offapi/com/sun/star/awt/FocusEvent.idl index 0a54e941d531..fdf7fb13fae6 100644 --- a/offapi/com/sun/star/awt/FocusEvent.idl +++ b/offapi/com/sun/star/awt/FocusEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FocusEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -130,6 +130,9 @@ struct FocusEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontDescriptor.idl b/offapi/com/sun/star/awt/FontDescriptor.idl index cac96641dabc..e80fd0d63918 100644 --- a/offapi/com/sun/star/awt/FontDescriptor.idl +++ b/offapi/com/sun/star/awt/FontDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -252,6 +252,9 @@ struct FontDescriptor /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/12/14 12:53:34 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:42:10 mi moved from api diff --git a/offapi/com/sun/star/awt/FontFamily.idl b/offapi/com/sun/star/awt/FontFamily.idl index f42468d91ecd..b6d66aaba23a 100644 --- a/offapi/com/sun/star/awt/FontFamily.idl +++ b/offapi/com/sun/star/awt/FontFamily.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontFamily.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -133,6 +133,9 @@ constants FontFamily /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontPitch.idl b/offapi/com/sun/star/awt/FontPitch.idl index 0ad82301e1eb..b1b385821d62 100644 --- a/offapi/com/sun/star/awt/FontPitch.idl +++ b/offapi/com/sun/star/awt/FontPitch.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontPitch.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,6 +106,9 @@ constants FontPitch /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontSlant.idl b/offapi/com/sun/star/awt/FontSlant.idl index 2d3cc9f83256..ecf13dfaf726 100644 --- a/offapi/com/sun/star/awt/FontSlant.idl +++ b/offapi/com/sun/star/awt/FontSlant.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontSlant.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -125,6 +125,9 @@ enum FontSlant /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontStrikeout.idl b/offapi/com/sun/star/awt/FontStrikeout.idl index d46ff7af9ff1..6276057f42a2 100644 --- a/offapi/com/sun/star/awt/FontStrikeout.idl +++ b/offapi/com/sun/star/awt/FontStrikeout.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontStrikeout.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -133,6 +133,9 @@ constants FontStrikeout /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontType.idl b/offapi/com/sun/star/awt/FontType.idl index 5e71b7d42895..f1065e5e29c5 100644 --- a/offapi/com/sun/star/awt/FontType.idl +++ b/offapi/com/sun/star/awt/FontType.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,6 +112,9 @@ constants FontType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontUnderline.idl b/offapi/com/sun/star/awt/FontUnderline.idl index d2b6466967c2..e7d349765340 100644 --- a/offapi/com/sun/star/awt/FontUnderline.idl +++ b/offapi/com/sun/star/awt/FontUnderline.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontUnderline.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -200,6 +200,9 @@ constants FontUnderline /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontWeight.idl b/offapi/com/sun/star/awt/FontWeight.idl index 5df10b0f2020..2c9e17ba52a2 100644 --- a/offapi/com/sun/star/awt/FontWeight.idl +++ b/offapi/com/sun/star/awt/FontWeight.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontWeight.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -144,6 +144,9 @@ constants FontWeight /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/FontWidth.idl b/offapi/com/sun/star/awt/FontWidth.idl index 3a8c8c5d5a96..2921e6bf5b02 100644 --- a/offapi/com/sun/star/awt/FontWidth.idl +++ b/offapi/com/sun/star/awt/FontWidth.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontWidth.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -154,6 +154,9 @@ constants FontWidth /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/Gradient.idl b/offapi/com/sun/star/awt/Gradient.idl index 5b0c156b3a53..b005d1aa2979 100644 --- a/offapi/com/sun/star/awt/Gradient.idl +++ b/offapi/com/sun/star/awt/Gradient.idl @@ -2,9 +2,9 @@ * * $RCSfile: Gradient.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -158,6 +158,9 @@ struct Gradient /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/GradientStyle.idl b/offapi/com/sun/star/awt/GradientStyle.idl index 4cbd006b90fe..d42a27c362a4 100644 --- a/offapi/com/sun/star/awt/GradientStyle.idl +++ b/offapi/com/sun/star/awt/GradientStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: GradientStyle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -124,6 +124,9 @@ enum GradientStyle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/ImageStatus.idl b/offapi/com/sun/star/awt/ImageStatus.idl index c6dbfd871195..e13fd89996d5 100644 --- a/offapi/com/sun/star/awt/ImageStatus.idl +++ b/offapi/com/sun/star/awt/ImageStatus.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImageStatus.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,6 +112,9 @@ constants ImageStatus /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/InputEvent.idl b/offapi/com/sun/star/awt/InputEvent.idl index a5e0e9aba9ff..70b222befb64 100644 --- a/offapi/com/sun/star/awt/InputEvent.idl +++ b/offapi/com/sun/star/awt/InputEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: InputEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,6 +104,9 @@ struct InputEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/InvalidateStyle.idl b/offapi/com/sun/star/awt/InvalidateStyle.idl index 93f535abed53..ac590c1123cb 100644 --- a/offapi/com/sun/star/awt/InvalidateStyle.idl +++ b/offapi/com/sun/star/awt/InvalidateStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvalidateStyle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -127,6 +127,9 @@ constants InvalidateStyle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/ItemEvent.idl b/offapi/com/sun/star/awt/ItemEvent.idl index 0b3e48e645fa..ee262a1a5505 100644 --- a/offapi/com/sun/star/awt/ItemEvent.idl +++ b/offapi/com/sun/star/awt/ItemEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ItemEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -107,6 +107,9 @@ struct ItemEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/Key.idl b/offapi/com/sun/star/awt/Key.idl index 1e4a3b89a16f..194ebb1096f7 100644 --- a/offapi/com/sun/star/awt/Key.idl +++ b/offapi/com/sun/star/awt/Key.idl @@ -2,9 +2,9 @@ * * $RCSfile: Key.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -664,6 +664,9 @@ constants Key /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/KeyEvent.idl b/offapi/com/sun/star/awt/KeyEvent.idl index 7b58449e4f9c..500c445e695f 100644 --- a/offapi/com/sun/star/awt/KeyEvent.idl +++ b/offapi/com/sun/star/awt/KeyEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -116,6 +116,9 @@ struct KeyEvent: com::sun::star::awt::InputEvent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/KeyFunction.idl b/offapi/com/sun/star/awt/KeyFunction.idl index 690f81427c9d..4e5d756049b0 100644 --- a/offapi/com/sun/star/awt/KeyFunction.idl +++ b/offapi/com/sun/star/awt/KeyFunction.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyFunction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -196,6 +196,9 @@ constants KeyFunction /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/KeyGroup.idl b/offapi/com/sun/star/awt/KeyGroup.idl index 16a952b5b0c2..cb38bb4c139e 100644 --- a/offapi/com/sun/star/awt/KeyGroup.idl +++ b/offapi/com/sun/star/awt/KeyGroup.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyGroup.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -125,6 +125,9 @@ constants KeyGroup /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/KeyModifier.idl b/offapi/com/sun/star/awt/KeyModifier.idl index f13ef08d953b..08ead8097073 100644 --- a/offapi/com/sun/star/awt/KeyModifier.idl +++ b/offapi/com/sun/star/awt/KeyModifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyModifier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -103,6 +103,9 @@ constants KeyModifier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/MenuEvent.idl b/offapi/com/sun/star/awt/MenuEvent.idl index 0293db7f4b11..9f251f543d77 100644 --- a/offapi/com/sun/star/awt/MenuEvent.idl +++ b/offapi/com/sun/star/awt/MenuEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,6 +93,9 @@ struct MenuEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/MenuItemStyle.idl b/offapi/com/sun/star/awt/MenuItemStyle.idl index 19c1ce2f6348..a1aaacc92451 100644 --- a/offapi/com/sun/star/awt/MenuItemStyle.idl +++ b/offapi/com/sun/star/awt/MenuItemStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuItemStyle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,6 +105,9 @@ constants MenuItemStyle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/MessageBoxCommand.idl b/offapi/com/sun/star/awt/MessageBoxCommand.idl index 8be93ccecc02..8b8f40ddcc40 100644 --- a/offapi/com/sun/star/awt/MessageBoxCommand.idl +++ b/offapi/com/sun/star/awt/MessageBoxCommand.idl @@ -2,9 +2,9 @@ * * $RCSfile: MessageBoxCommand.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,6 +112,9 @@ constants MessageBoxCommand /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/MouseButton.idl b/offapi/com/sun/star/awt/MouseButton.idl index 6f23e2a1e021..fa773e8e8499 100644 --- a/offapi/com/sun/star/awt/MouseButton.idl +++ b/offapi/com/sun/star/awt/MouseButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: MouseButton.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -103,6 +103,9 @@ constants MouseButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:49 hjs initial import diff --git a/offapi/com/sun/star/awt/MouseEvent.idl b/offapi/com/sun/star/awt/MouseEvent.idl index b3775bf61587..5e0700fc349a 100644 --- a/offapi/com/sun/star/awt/MouseEvent.idl +++ b/offapi/com/sun/star/awt/MouseEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: MouseEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -125,6 +125,9 @@ struct MouseEvent: com::sun::star::awt::InputEvent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/PaintEvent.idl b/offapi/com/sun/star/awt/PaintEvent.idl index 7992bc9db30f..5034612a5c81 100644 --- a/offapi/com/sun/star/awt/PaintEvent.idl +++ b/offapi/com/sun/star/awt/PaintEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PaintEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -114,6 +114,9 @@ struct PaintEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/Point.idl b/offapi/com/sun/star/awt/Point.idl index c2c464960e72..7d1948b1c1f9 100644 --- a/offapi/com/sun/star/awt/Point.idl +++ b/offapi/com/sun/star/awt/Point.idl @@ -2,9 +2,9 @@ * * $RCSfile: Point.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -94,6 +94,9 @@ struct Point /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/PopupMenuDirection.idl b/offapi/com/sun/star/awt/PopupMenuDirection.idl index 820fe154eae7..b2a45ee1facd 100644 --- a/offapi/com/sun/star/awt/PopupMenuDirection.idl +++ b/offapi/com/sun/star/awt/PopupMenuDirection.idl @@ -2,9 +2,9 @@ * * $RCSfile: PopupMenuDirection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -134,6 +134,9 @@ constants PopupMenuDirection /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/PosSize.idl b/offapi/com/sun/star/awt/PosSize.idl index 5eb73850aa97..afb977f30475 100644 --- a/offapi/com/sun/star/awt/PosSize.idl +++ b/offapi/com/sun/star/awt/PosSize.idl @@ -2,9 +2,9 @@ * * $RCSfile: PosSize.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,51 +68,50 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::awt::PosSize -/** @deprecated +/** These constants are used to flag the parameters of a rectangle. */ constants PosSize { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::X - // DocMerge: empty anyway + /** flags the x-coordinate. + */ const short X = 1; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::Y - // DocMerge: empty anyway + /** flags the y-coordinate. + */ const short Y = 2; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::WIDTH - // DocMerge: empty anyway + /** flags the width. + */ const short WIDTH = 4; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::HEIGHT - // DocMerge: empty anyway + /** flags the height. + */ const short HEIGHT = 8; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::POS - // DocMerge: empty anyway + /** flags the x- and y-coordinate. + */ const short POS = 3; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::12 - // DocMerge: empty anyway + /** flags the width and height. + */ const short SIZE = 12; //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PosSize::15 - // DocMerge: empty anyway + /** flags the x- and y-coordinate, width and height. + */ const short POSSIZE = 15; }; @@ -121,24 +120,4 @@ constants PosSize }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:05 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:51 mi - documentation - - Revision 1.2 2000/02/07 11:24:13 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/PrinterException.idl b/offapi/com/sun/star/awt/PrinterException.idl index 42d5582c542c..3136c1d0bf2c 100644 --- a/offapi/com/sun/star/awt/PrinterException.idl +++ b/offapi/com/sun/star/awt/PrinterException.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrinterException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,6 +91,9 @@ exception PrinterException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/PushButtonType.idl b/offapi/com/sun/star/awt/PushButtonType.idl index d32822fc27a1..7496498de628 100644 --- a/offapi/com/sun/star/awt/PushButtonType.idl +++ b/offapi/com/sun/star/awt/PushButtonType.idl @@ -2,9 +2,9 @@ * * $RCSfile: PushButtonType.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mt $ $Date: 2001-10-17 08:02:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,6 +106,9 @@ enum PushButtonType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1 2001/10/17 08:02:38 mt + #91616# PushButtonType + =============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/RasterOperation.idl b/offapi/com/sun/star/awt/RasterOperation.idl index a62407890c43..b7af7e66633e 100644 --- a/offapi/com/sun/star/awt/RasterOperation.idl +++ b/offapi/com/sun/star/awt/RasterOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: RasterOperation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-13 15:52:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/Rectangle.idl b/offapi/com/sun/star/awt/Rectangle.idl index 91ca84f121f8..5f511019268a 100644 --- a/offapi/com/sun/star/awt/Rectangle.idl +++ b/offapi/com/sun/star/awt/Rectangle.idl @@ -2,9 +2,9 @@ * * $RCSfile: Rectangle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -108,6 +108,9 @@ struct Rectangle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/ScrollBarOrientation.idl b/offapi/com/sun/star/awt/ScrollBarOrientation.idl index be64c9793ea0..db3a73cb5b89 100644 --- a/offapi/com/sun/star/awt/ScrollBarOrientation.idl +++ b/offapi/com/sun/star/awt/ScrollBarOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: ScrollBarOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,22 +68,19 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::awt::ScrollBarOrientation -/** These constants are used to specify the orientation if scrollbars. +/** These constants are used to specify the orientation of a scroll bar. */ constants ScrollBarOrientation { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::awt::ScrollBarOrientation::HORIZONTAL - /** specifies a horizontal scrollbar. + /** specifies a horizontal scroll bar. */ const long HORIZONTAL = 0; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::awt::ScrollBarOrientation::VERTICAL - /** specifies a vertical scrollbar. + /** specifies a vertical scroll bar. */ const long VERTICAL = 1; @@ -93,24 +90,4 @@ constants ScrollBarOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:05 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:51 mi - documentation - - Revision 1.2 2000/02/07 11:24:13 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/Selection.idl b/offapi/com/sun/star/awt/Selection.idl index 835e76be7ddc..3eb145984d58 100644 --- a/offapi/com/sun/star/awt/Selection.idl +++ b/offapi/com/sun/star/awt/Selection.idl @@ -2,9 +2,9 @@ * * $RCSfile: Selection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -94,6 +94,9 @@ struct Selection /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/SimpleFontMetric.idl b/offapi/com/sun/star/awt/SimpleFontMetric.idl index 08b998649fa9..aabc87162c05 100644 --- a/offapi/com/sun/star/awt/SimpleFontMetric.idl +++ b/offapi/com/sun/star/awt/SimpleFontMetric.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleFontMetric.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -151,6 +151,9 @@ struct SimpleFontMetric /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/Size.idl b/offapi/com/sun/star/awt/Size.idl index 2a6934db704d..19cbb3987364 100644 --- a/offapi/com/sun/star/awt/Size.idl +++ b/offapi/com/sun/star/awt/Size.idl @@ -2,9 +2,9 @@ * * $RCSfile: Size.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -94,6 +94,9 @@ struct Size /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/SpinEvent.idl b/offapi/com/sun/star/awt/SpinEvent.idl index 4df1fcd15111..88f717899ad5 100644 --- a/offapi/com/sun/star/awt/SpinEvent.idl +++ b/offapi/com/sun/star/awt/SpinEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpinEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: tbe $ $Date: 2002-09-24 15:31:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/Style.idl b/offapi/com/sun/star/awt/Style.idl index c9dfdc82df31..eac826275857 100644 --- a/offapi/com/sun/star/awt/Style.idl +++ b/offapi/com/sun/star/awt/Style.idl @@ -2,9 +2,9 @@ * * $RCSfile: Style.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,6 +93,9 @@ constants Style /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/SystemDependentXWindow.idl b/offapi/com/sun/star/awt/SystemDependentXWindow.idl index 5a7ccaaede04..0d2bc71d080c 100644 --- a/offapi/com/sun/star/awt/SystemDependentXWindow.idl +++ b/offapi/com/sun/star/awt/SystemDependentXWindow.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemDependentXWindow.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -108,6 +108,9 @@ struct SystemDependentXWindow /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/SystemPointer.idl b/offapi/com/sun/star/awt/SystemPointer.idl index 2ec1f79064e0..69d4d43cffa6 100644 --- a/offapi/com/sun/star/awt/SystemPointer.idl +++ b/offapi/com/sun/star/awt/SystemPointer.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemPointer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -586,6 +586,9 @@ constants SystemPointer /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/TextAlign.idl b/offapi/com/sun/star/awt/TextAlign.idl index e8b1bd2991cb..b2c27b676e21 100644 --- a/offapi/com/sun/star/awt/TextAlign.idl +++ b/offapi/com/sun/star/awt/TextAlign.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextAlign.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -103,6 +103,9 @@ constants TextAlign /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/TextEvent.idl b/offapi/com/sun/star/awt/TextEvent.idl index e66d57f56892..a819086948e6 100644 --- a/offapi/com/sun/star/awt/TextEvent.idl +++ b/offapi/com/sun/star/awt/TextEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,6 +93,9 @@ struct TextEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:50 hjs initial import diff --git a/offapi/com/sun/star/awt/Toolkit.idl b/offapi/com/sun/star/awt/Toolkit.idl index 5a070be8c9ae..0376789e660b 100644 --- a/offapi/com/sun/star/awt/Toolkit.idl +++ b/offapi/com/sun/star/awt/Toolkit.idl @@ -2,9 +2,9 @@ * * $RCSfile: Toolkit.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obr $ $Date: 2001-03-23 12:29:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,6 +71,7 @@ module com { module sun { module star { module awt { interface XDataTransferProviderAccess; +interface XSystemChildFactory; //============================================================================= @@ -87,10 +88,12 @@ interface XDataTransferProviderAccess; service Toolkit { // DocMerge: empty anyway - interface com::sun::star::awt::XToolkit; + interface XToolkit; // interface for clipbaord access and drag-and-drop protocol - [optional] interface com::sun::star::awt::XDataTransferProviderAccess; + [optional] interface XDataTransferProviderAccess; + + [optional] interface XSystemChildFactory; }; //============================================================================= @@ -100,6 +103,12 @@ service Toolkit /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/06/19 13:25:55 mi + XSystemChildFactory added, was always implemented + + Revision 1.5 2001/03/23 12:29:21 obr + XDataTransfer renamed to XDataTransferProviderAccess + Revision 1.4 2001/02/19 11:04:22 obr XDataTransfer added diff --git a/offapi/com/sun/star/awt/UnoControl.idl b/offapi/com/sun/star/awt/UnoControl.idl index 8c2e89da307e..8e87ab40df46 100644 --- a/offapi/com/sun/star/awt/UnoControl.idl +++ b/offapi/com/sun/star/awt/UnoControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,10 +65,11 @@ #include <com/sun/star/lang/XComponent.idl> #endif -#ifndef __com_sun_star_awt_Toolkit_idl__ -#include <com/sun/star/awt/Toolkit.idl> +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> #endif + //============================================================================= module com { module sun { module star { module awt { @@ -79,71 +80,37 @@ interface XControl; //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControl /** specifies an abstract control. - - <p>All components which implement this service can be integrated in a windowing environment. This service describes - the controller of the Smalltalk model view controller design. + the controller of the Smalltalk model view controller design.</p> - </p> <p>You must set a model and a stub to the UnoControl before using other methods. The implementation only allows the change of the graphics (<type>XView</type>) if the window is not visible. The change of the graphics in visible state should redirect the output - to these graphics, but this behavior is implementation-specific. + to these graphics, but this behavior is implementation-specific.</p> - </p> <p>The change of data directly at the control may not affect the model data. To ensure this behavior, modify the data of the model.</p> */ service UnoControl { + [optional] interface com::sun::star::beans::XPropertySet; - - // DocMerge from xml: service com::sun::star::awt::UnoControl: interface com::sun::star::lang::XComponent - /** The control must implement these interfaces. - */ interface com::sun::star::lang::XComponent; - // DocMerge: empty anyway interface XControl; - // DocMerge: empty anyway interface XWindow; - // DocMerge: empty anyway interface XView; - - // DocMerge from idl: property com::sun::star::awt::UnoControl::Toolkit - /** These services must be installed to instanciate a control. - */ - needs Toolkit; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.4 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:54 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlButtonModel.idl b/offapi/com/sun/star/awt/UnoControlButtonModel.idl index 047c4dcdc784..cce4e7a66898 100644 --- a/offapi/com/sun/star/awt/UnoControlButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlButtonModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlButtonModel.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mt $ $Date: 2001-10-17 08:56:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,131 +76,121 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlButtonModel -/** specifies the standard model of an <type>UnoButtonControl</type>. +/** specifies the standard model of an <type>UnoControlButton</type>. */ service UnoControlButtonModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::DefaultButton /** specifies that the button is the default button on the document. */ [property] boolean DefaultButton; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the font attributes of the text in the control. */ - [property] boolean Enabled; + [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontEmphasisMark; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::Label - /** specifies the label of the control. + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. */ - [property] string Label; + [property] short FontRelief; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::Printable - /** specifies that the control will be printed with the document. + /** specifies the help text of the control. */ - [property] boolean Printable; + [property] string HelpText; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::Tabstop - /** specifies that the control can be reached with the Tab key. + /** specifies the help URL of the control. */ - [property] boolean Tabstop; + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlButtonModel::TextColor - /** specifies the text color (RGB) of the control. + /** specifies the alignment of the image inside the button as + <type>ImageAlign</type> value. */ - [property] long TextColor; + [property] short ImageAlign; //------------------------------------------------------------------------- - /** specifies the help text of the control. + /** specifies an URL to an image to use for the button. */ - [property] string HelpText; + [property] string ImageURL; //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the label of the control. */ - [property] string HelpURL; + [property] string Label; //------------------------------------------------------------------------- - /** specifies the default action of the button. - <pre> - 0: standard - 1: ok - 2: cancel - 3: help - </pre> + /** specifies that the control will be printed with the document. */ + [property] boolean Printable; + + //------------------------------------------------------------------------- + /** specifies the default action of the button as <type>PushButtonType</type> value. + */ [property] short PushButtonType; -}; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** specifies the state of the control. + */ + [property] short State; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/23 14:40:26 mt - Added HelpURL and HelpText + /** specifies that the control can be reached with the TAB key. + */ + [property] boolean Tabstop; - Revision 1.3 2000/11/08 12:42:10 mi - moved from api + //------------------------------------------------------------------------- - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import + /** specifies the text color (RGB) of the control. + */ + [property] long TextColor; - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML + //------------------------------------------------------------------------- - Revision 1.3 2000/02/21 16:17:46 mi - string documentation from stardiv...*.idl-files + /** specifies the text line color (RGB) of the control. + */ + [property] long TextLineColor; - Revision 1.2 2000/02/07 11:24:13 mi - zu #70728# missing documentation marked +}; - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl index a479954152b0..15c88b8433c5 100644 --- a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlCheckBoxModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,55 +76,66 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlCheckBoxModel -/** specifies the standard model of an <type scope="com::sun::star::awt">UnoCheckBoxControl</type>. +/** specifies the standard model of an <type>UnoControlCheckBox</type>. */ service UnoControlCheckBoxModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the font attributes of the text in the control. */ - [property] boolean Enabled; + [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::Label /** specifies the label of the control. */ [property] string Label; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::State /** specifies the state of the control. - <pre> 0: not checked 1: checked @@ -135,36 +146,27 @@ service UnoControlCheckBoxModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::Tabstop - /** specifies that the control can be reached with the Tab key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCheckBoxModel::TriState - /** specifies that the control may have the state "don't know". - */ - [property] boolean TriState; - - //------------------------------------------------------------------------- - - /** specifies the help text of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpText; + [property] long TextLineColor; //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies that the control may have the state "don't know". */ - [property] string HelpURL; + [property] boolean TriState; }; @@ -172,27 +174,4 @@ service UnoControlCheckBoxModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:46 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:13 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl index 03456b1ca413..9d6ef3894fab 100644 --- a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlComboBoxModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,34 +76,28 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlComboBoxModel -/** specifies the standard model of an <type scope="com::sun::star::awt">UnoComboBoxControl</type>. +/** specifies the standard model of an <type>UnoControlComboBox</type>. */ service UnoControlComboBoxModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Autocomplete - /** determines if auto complete is enabled. + /** specifies whether automatic completion of text is enabled. */ [property] boolean Autocomplete; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -114,99 +108,103 @@ service UnoControlComboBoxModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Dropdown - /** specifies that the control has a drop down button. + /** specifies if the control has a drop down button. */ [property] boolean Dropdown; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::FontDescriptor /** specifies the font attributes of the text in the control. */ [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::LineCount + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. + */ + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; + + //------------------------------------------------------------------------- + /** specifies the maximum line count displayed in the drop down box. */ [property] short LineCount; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::MaxTextLen - /** specifies the maximum character count; 0 means no limit. + /** specifies the maximum character count. + + <p>There's no limitation, if set to 0.</p> */ [property] short MaxTextLen; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::ReadOnly /** specifies that the content of the control cannot be modified by the user. */ [property] boolean ReadOnly; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::awt::UnoControlComboBoxModel::StringItemList - /** specifies the list of strings used as items. + /** specifies the list of items. */ [property] sequence<string> StringItemList; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Tabstop - /** specifies that the control can be reached with the tabulator key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::Text /** specifies the text displayed in the control. */ [property] string Text; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlComboBoxModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - /** specifies the help text of the control. - */ - [property] string HelpText; - - //------------------------------------------------------------------------- - - /** specifies the help id of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpURL; + [property] long TextLineColor; }; @@ -214,30 +212,4 @@ service UnoControlComboBoxModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.6 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.4 2000/05/16 12:19:51 mi - documentation - - Revision 1.3 2000/02/21 16:17:47 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlContainer.idl b/offapi/com/sun/star/awt/UnoControlContainer.idl index 8d8fbeedb5a6..d8bea8de2c68 100644 --- a/offapi/com/sun/star/awt/UnoControlContainer.idl +++ b/offapi/com/sun/star/awt/UnoControlContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlContainer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,86 +61,38 @@ #ifndef __com_sun_star_awt_UnoControlContainer_idl__ #define __com_sun_star_awt_UnoControlContainer_idl__ -#ifndef __com_sun_star_lang_XComponent_idl__ -#include <com/sun/star/lang/XComponent.idl> +#ifndef __com_sun_star_awt_UnoControl_idl__ +#include <com/sun/star/awt/UnoControl.idl> #endif -#ifndef __com_sun_star_awt_Toolkit_idl__ -#include <com/sun/star/awt/Toolkit.idl> +#ifndef __com_sun_star_container_XContainer_idl__ +#include <com/sun/star/container/XContainer.idl> #endif - //============================================================================= module com { module sun { module star { module awt { +interface XUnoControlContainer; interface XControlContainer; -interface XControl; -interface XWindow; //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlContainer -/** specifies an abstract control which can contain other controls. - - One additional interface (<type scope="com::sun::star::awt">XControlContainer</type>) is specified. - An <type>UnoControlContainer</type> contains other - <type>UnoControl</type>s. - - - - <p>An <type>UnoControl</type> that satisfies this service does not need a - stub. - </p> +/** specifies an abstract control which contains other controls. */ service UnoControlContainer { + service com::sun::star::awt::UnoControl; + interface XUnoControlContainer; - // DocMerge from xml: service com::sun::star::awt::UnoControlContainer: interface com::sun::star::lang::XComponent - /** The control must implement these interfaces. - */ - interface com::sun::star::lang::XComponent; - - // DocMerge: empty anyway interface XControlContainer; - // DocMerge: empty anyway - interface XControl; - - // DocMerge: empty anyway - interface XWindow; - - - // DocMerge from idl: property com::sun::star::awt::UnoControlContainer::Toolkit - /** These services must be installed to instanciate a control. - */ - needs com::sun::star::awt::Toolkit; - + interface com::sun::star::container::XContainer; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.2 1999/11/18 11:49:54 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlContainerModel.idl b/offapi/com/sun/star/awt/UnoControlContainerModel.idl index 07141b9cd8a6..4c8a93336c5e 100644 --- a/offapi/com/sun/star/awt/UnoControlContainerModel.idl +++ b/offapi/com/sun/star/awt/UnoControlContainerModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlContainerModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,35 +72,28 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlContainerModel -/** specifies the standard model of an - <type>UnoControlContainer</type> +/** specifies the standard model of an <type>UnoControlContainer</type>. */ service UnoControlContainerModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::Enabled /** determines whether a control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -111,23 +104,12 @@ service UnoControlContainerModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::DefaultControl - /** specifies the service name of the default control for - this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::Printable - /** specifies whether the control will be printed with the - document. + /** specifies whether the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlContainerModel::Text /** specifies the text displayed in the control. */ [property] string Text; @@ -140,7 +122,7 @@ service UnoControlContainerModel //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the help URL of the control. */ [property] string HelpURL; @@ -150,27 +132,4 @@ service UnoControlContainerModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:47 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl index d39a1c94916c..030cda0466c7 100644 --- a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlCurrencyFieldModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -121,13 +121,6 @@ service UnoControlCurrencyFieldModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCurrencyFieldModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlCurrencyFieldModel::Enabled /** determines whether a control is enabled or disabled. */ @@ -237,6 +230,12 @@ service UnoControlCurrencyFieldModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/03/04 11:19:00 fs + #97386# moved the DefaultControl property to the basic service (UnoControlModel) + + Revision 1.4 2001/03/23 14:40:26 mt + Added HelpURL and HelpText + Revision 1.3 2000/11/08 12:42:10 mi moved from api diff --git a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl index f0166130ec84..c25ace919fa4 100644 --- a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlDateFieldModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,27 +76,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlDateFieldModel -/** specifies the standard model of a date field control. +/** specifies the standard model of an <type>UnoControlDateField</type>. */ service UnoControlDateFieldModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::BackgroundColor /** specifies the background color(RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -107,122 +102,136 @@ service UnoControlDateFieldModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Date /** specifies the date displayed in the control. + + <p>The date must be specified in the format YYYYMMDD.</p> */ [property] long Date; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::DateMax + /** specifies the format of the displayed date. + + <pre> + 0: system short + 1: system short YY + 2: system short YYYY + 3: system long + 4: short DDMMYY + 5: short MMDDYY + 6: short YYMMDD + 7: short DDMMYYYY + 8: short MMDDYYYY + 9: short YYYYMMDD + 10: short YYMMDD DIN5008 + 11: short YYYYMMDD DIN5008 + </pre> + */ + [property] short DateFormat; + + //------------------------------------------------------------------------- + /** specifies the maximum date that can be entered. */ [property] long DateMax; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::DateMin /** specifies the minimum date that can be entered. */ [property] long DateMin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::DefaultControl - /** specifies the service name of the default control for this model. + /** specifies, if the date century is displayed. */ - [property] string DefaultControl; + [property] boolean DateShowCentury; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies, if the control has a dropdown button. + */ + [property] boolean Dropdown; + + //------------------------------------------------------------------------- + + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::DateFormat - /** specifies the format of the date. + /** specifies the font attributes of the text in the control. + */ + [property] com::sun::star::awt::FontDescriptor FontDescriptor; + //------------------------------------------------------------------------- - <pre> - 0: system short - 1: system short YY - 2: system short YYYY - 3: system long - 4: short DDMMYY - 5: short MMDDYY - 6: short YYMMDD - 7: short DDMMYYYY - 8: short MMDDYYYY - 9: short YYYYMMDD - 10: short YYMMDD DIN5008 - 11: short YYYYMMDD DIN5008 - </pre> + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] short DateFormat; + [property] short FontEmphasisMark; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::ReadOnly /** specifies that the content of the control cannot be modified by the user. */ [property] boolean ReadOnly; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Spin /** specifies that the control has a spin button. */ [property] boolean Spin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::StrictFormat - /** specifies that the date is checked during the input. + /** specifies that the date is checked during the user input. */ [property] boolean StrictFormat; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::Tabstop - /** specifies that the control can be reached with the tabulator key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlDateFieldModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - /** specifies the help text of the control. - */ - [property] string HelpText; - - //------------------------------------------------------------------------- - - /** specifies the help id of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpURL; + [property] long TextLineColor; }; @@ -230,27 +239,4 @@ service UnoControlDateFieldModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:47 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlEditModel.idl b/offapi/com/sun/star/awt/UnoControlEditModel.idl index 2eb6e8a2cc52..bd37a14db8f5 100644 --- a/offapi/com/sun/star/awt/UnoControlEditModel.idl +++ b/offapi/com/sun/star/awt/UnoControlEditModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlEditModel.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mt $ $Date: 2001-04-09 15:20:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,20 +76,16 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlEditModel /** specifies the standard model of an <type>UnoControlEdit</type>. */ service UnoControlEditModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Align /** specifies the alignment of the text in the control. - <pre> 0: left 1: center @@ -100,17 +96,14 @@ service UnoControlEditModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -121,119 +114,118 @@ service UnoControlEditModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::EchoChar /** specifies the echo character for a password edit field. - - @optional */ [optional, property] short EchoChar; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::FontDescriptor /** specifies the font attributes of the text in the control. */ [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::HardLineBreaks - /** specifies that the soft line breaks will be - returned in the getText method of the editfield. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] boolean HardLineBreaks; + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::HScroll - /** specifies that the content of the control can be scrolled in - the - horizontal direction. + /** specifies if the content of the control can be scrolled in + the horizontal direction. */ [property] boolean HScroll; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::MaxTextLen - /** specifies the maximum character count; 0 means no limit. + /** specifies if hard line breaks will be returned in the + <member>XTextComponent::getText</member> method. + */ + [property] boolean HardLineBreaks; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; + + //------------------------------------------------------------------------- + + /** specifies the maximum character count. + + <p>There's no limitation, if set to 0.</p> */ [property] short MaxTextLen; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::MultiLine - /** specifies that the edit may have more than one line. + /** specifies that the control may have more than one line. */ [property] boolean MultiLine; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::ReadOnly /** specifies that the content of the control cannot be modified by the user. */ [property] boolean ReadOnly; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Tabstop - /** specifies that the control can be reached with the tabulator key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::Text - /** specifies the text that is displayed in the control. + /** specifies the text displayed in the control. */ [property] string Text; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlEditModel::VScroll - /** specifies that the content of the control can be scrolled in the - vertical direction. - */ - [property] boolean VScroll; - - //------------------------------------------------------------------------- - - /** specifies the help text of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpText; + [property] long TextLineColor; //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies if the content of the control can be scrolled in + the vertical direction. */ - [property] string HelpURL; + [property] boolean VScroll; }; @@ -241,33 +233,4 @@ service UnoControlEditModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/23 14:40:26 mt - Added HelpURL and HelpText - - Revision 1.4 2001/01/23 10:07:57 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:47 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/01/26 09:12:12 mi - #72129# EchoChar is optional especially for MultiLineEdit - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlFixedLine.idl b/offapi/com/sun/star/awt/UnoControlFixedLine.idl index abd6c297b586..8a3a80b87c0b 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedLine.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedLine.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlFixedLine.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tbe $ $Date: 2001-05-04 09:51:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,11 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoFixedLineControl -/** specifies a FixedLine control. +/** specifies a fixed line control. */ service UnoControlFixedLine { - // DocMerge: empty anyway service com::sun::star::awt::UnoControl; - }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl b/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl index ee21f7be7c1c..fc3fc04d99a0 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlFixedLineModel.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tbe $ $Date: 2001-05-04 10:56:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,34 +76,37 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlFixedLineModel -/** specifies the standard model of an <type>UnoFixedLineControl</type>. +/** specifies the standard model of an <type>UnoControlFixedLine</type>. */ service UnoControlFixedLineModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the font attributes of the text in the control. */ - [property] boolean Enabled; + [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; //------------------------------------------------------------------------- @@ -113,23 +116,20 @@ service UnoControlFixedLineModel //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the help URL of the control. */ [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::Label /** specifies the label of the control. */ [property] string Label; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::Orientation /** specifies the orientation of the control. - <pre> 0: horizontal 1: vertical @@ -139,17 +139,22 @@ service UnoControlFixedLineModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedLineModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; + + //------------------------------------------------------------------------- + + /** specifies the text line color (RGB) of the control. + */ + [property] long TextLineColor; + }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl b/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl index ae45143644cb..3959188f7528 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlFixedTextModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,20 +76,16 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlFixedTextModel -/** specifies the standard model of an <type>UnoFixedTextControl</type>. +/** specifies the standard model of an <type>UnoControlFixedText</type>. */ service UnoControlFixedTextModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::Align /** specifies the alignment of the text in the control. - <pre> 0: left 1: center @@ -100,17 +96,14 @@ service UnoControlFixedTextModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -121,64 +114,77 @@ service UnoControlFixedTextModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the font attributes of the text in the control. */ - [property] boolean Enabled; + [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::Label /** specifies the label of the control. */ [property] string Label; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::MultiLine /** specifies that the text may be displayed on more than one line. */ [property] boolean MultiLine; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlFixedTextModel::TextColor - /** specifies the text color (RGB) of the control. + /** specifies that the control can be reached with the TAB key. */ - [property] long TextColor; + [property] boolean Tabstop; //------------------------------------------------------------------------- - /** specifies the help text of the control. + /** specifies the text color (RGB) of the control. */ - [property] string HelpText; + [property] long TextColor; //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpURL; + [property] long TextLineColor; }; @@ -186,30 +192,4 @@ service UnoControlFixedTextModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.2 2000/10/16 11:52:16 mt - Removed property TabStop - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:47 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl b/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl index 0c7af0b90d0a..2340c28c18d4 100644 --- a/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlGroupBoxModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,55 +76,37 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlGroupBoxModel -/** specifies the standard model of an <type scope="com::sun::star::awt">UnoGroupBoxControl</type>. +/** specifies the standard model of an <type>UnoControlGroupBox</type>. */ service UnoControlGroupBoxModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::FontDescriptor /** specifies the font attributes of the text in the control. */ [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::Label - /** specifies the label of the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] string Label; + [property] short FontEmphasisMark; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::Printable - /** specifies that the control will be printed with the document. + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. */ - [property] boolean Printable; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlGroupBoxModel::TextColor - /** specifies the text color (RGB) of the control. - */ - [property] long TextColor; + [property] short FontRelief; //------------------------------------------------------------------------- @@ -134,37 +116,38 @@ service UnoControlGroupBoxModel //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the help URL of the control. */ [property] string HelpURL; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** specifies the label of the control. + */ + [property] string Label; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** specifies that the control will be printed with the document. + */ + [property] boolean Printable; - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api + //------------------------------------------------------------------------- - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import + /** specifies the text color (RGB) of the control. + */ + [property] long TextColor; - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML + //------------------------------------------------------------------------- - Revision 1.3 2000/02/21 16:17:48 mi - string documentation from stardiv...*.idl-files + /** specifies the text line color (RGB) of the control. + */ + [property] long TextLineColor; - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked +}; - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl index 60168c67865e..a373ceb0f648 100644 --- a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlImageControlModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,27 +72,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlImageControlModel -/** specifies the standard model of an UnoImageControl. +/** specifies the standard model of an <type>UnoControlImageControl</type>. */ service UnoControlImageControlModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -103,43 +98,40 @@ service UnoControlImageControlModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the help text of the control. */ - [property] boolean Enabled; + [property] string HelpText; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::ImageURL - /** specifies the location of the graphic. + /** specifies the help URL of the control. */ - [property] string ImageURL; + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlImageControlModel::Printable - /** specifies that the control will be printed with the document. + /** specifies an URL to an image to use for the control. */ - [property] boolean Printable; + [property] string ImageURL; //------------------------------------------------------------------------- - /** specifies the help text of the control. + /** specifies that the control will be printed with the document. */ - [property] string HelpText; + [property] boolean Printable; //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies if the image is automatically scaled to the size of the + control. */ - [property] string HelpURL; + [property] boolean ScaleImage; }; @@ -147,27 +139,4 @@ service UnoControlImageControlModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:10 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:48 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl index 367c3a54114b..a76270f4d57d 100644 --- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlListBoxModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,27 +76,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlListBoxModel -/** specifies the standard model of an <type>UnoListBoxControl</type>. +/** specifies the standard model of an <type>UnoControlListBox</type>. */ service UnoControlListBoxModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -107,92 +102,101 @@ service UnoControlListBoxModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::Dropdown - /** specifies that the control has a drop down button. + /** specifies if the control has a drop down button. */ [property] boolean Dropdown; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::FontDescriptor /** specifies the font attributes of the text in the control. */ [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::LineCount + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. + */ + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; + + //------------------------------------------------------------------------- + /** specifies the maximum line count displayed in the drop down box. */ [property] short LineCount; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::MultiSelection /** specifies if more than one entry can be selected. */ [property] boolean MultiSelection; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::awt::UnoControlListBoxModel::SelectedItems + /** specifies that the content of the control cannot be modified by the user. + */ + [property] boolean ReadOnly; + + //------------------------------------------------------------------------- + /** specifies the sequence of selected items, identfied by the position. */ [property] sequence<short> SelectedItems; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::awt::UnoControlListBoxModel::StringItemList /** specifies the list of items. */ [property] sequence<string> StringItemList; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::Tabstop - /** specifies that the control can be reached with the tabulator key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlListBoxModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - /** specifies the help text of the control. - */ - [property] string HelpText; - - //------------------------------------------------------------------------- - - /** specifies the help id of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpURL; + [property] long TextLineColor; }; @@ -200,30 +204,4 @@ service UnoControlListBoxModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.6 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.4 2000/05/16 12:19:51 mi - documentation - - Revision 1.3 2000/02/21 16:17:48 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlModel.idl b/offapi/com/sun/star/awt/UnoControlModel.idl index ee6f3611ceb8..c0028e68a732 100644 --- a/offapi/com/sun/star/awt/UnoControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlModel.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,6 +61,10 @@ #ifndef __com_sun_star_awt_UnoControlModel_idl__ #define __com_sun_star_awt_UnoControlModel_idl__ +#ifndef __com_sun_star_awt_UnoControlDialogElement_idl__ +#include <com/sun/star/awt/UnoControlDialogElement.idl> +#endif + #ifndef __com_sun_star_awt_XControlModel_idl__ #include <com/sun/star/awt/XControlModel.idl> #endif @@ -81,6 +85,10 @@ #include <com/sun/star/io/XPersistObject.idl> #endif +#ifndef __com_sun_star_util_XCloneable_idl__ +#include <com/sun/star/util/XCloneable.idl> +#endif + //============================================================================= @@ -88,7 +96,6 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlModel /** specifies the standard model of an <type>UnoControl</type> in the <em>Smalltalk model view controller design</em>. @@ -102,49 +109,35 @@ */ service UnoControlModel { - - - // DocMerge from xml: service com::sun::star::awt::UnoControlModel: interface com::sun::star::awt::XControlModel - /** The control must implement these interfaces. + /** This service is present when the control model is embedded in an + <type>UnoControlDialogModel</type>. */ + [optional] service com::sun::star::awt::UnoControlDialogElement; + interface com::sun::star::awt::XControlModel; - // DocMerge: empty anyway interface com::sun::star::lang::XComponent; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway interface com::sun::star::beans::XMultiPropertySet; - // DocMerge: empty anyway interface com::sun::star::io::XPersistObject; -}; + interface com::sun::star::util::XCloneable; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML + /** specifies the service name of the default control for this model. + */ + [property] string DefaultControl; - Revision 1.3 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked + //------------------------------------------------------------------------- - Revision 1.2 1999/11/18 11:49:54 mi - XComponent now in module lang +}; - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl index b6cab28e39ef..bffbba83055a 100644 --- a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlNumericFieldModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -114,13 +114,6 @@ service UnoControlNumericFieldModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlNumericFieldModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlNumericFieldModel::Enabled /** determines whether a control is enabled or disabled. */ @@ -231,6 +224,12 @@ service UnoControlNumericFieldModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/03/04 11:19:00 fs + #97386# moved the DefaultControl property to the basic service (UnoControlModel) + + Revision 1.4 2001/03/23 14:40:26 mt + Added HelpURL and HelpText + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl index d76c24d4b724..70d7b9c7edad 100644 --- a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlPatternFieldModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mt $ $Date: 2001-03-23 14:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -107,13 +107,6 @@ service UnoControlPatternFieldModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlPatternFieldModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlPatternFieldModel::EditMask /** specifies the edit mask. */ @@ -203,6 +196,12 @@ service UnoControlPatternFieldModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/03/04 11:19:00 fs + #97386# moved the DefaultControl property to the basic service (UnoControlModel) + + Revision 1.4 2001/03/23 14:40:26 mt + Added HelpURL and HelpText + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/UnoControlProgressBar.idl b/offapi/com/sun/star/awt/UnoControlProgressBar.idl index a4903cac1df5..ad1b32949c54 100644 --- a/offapi/com/sun/star/awt/UnoControlProgressBar.idl +++ b/offapi/com/sun/star/awt/UnoControlProgressBar.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlProgressBar.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tbe $ $Date: 2001-05-02 16:18:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,13 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoProgressBarControl -/** specifies a progressbar control. +/** specifies a progress bar control. */ service UnoControlProgressBar { - // DocMerge: empty anyway service com::sun::star::awt::UnoControl; - // DocMerge: empty anyway interface com::sun::star::awt::XProgressBar; - }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl b/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl index 5c5b94d79992..4c3d1af5ab79 100644 --- a/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl +++ b/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlProgressBarModel.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tbe $ $Date: 2001-05-04 13:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,27 +72,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlProgressBarModel -/** specifies the standard model of an <type>UnoProgressBarControl</type>. +/** specifies the standard model of an <type>UnoControlProgressBar</type>. */ service UnoControlProgressBarModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::BackgroundColor /** specifies the background color (RGB) of the control. */ [property] long BackgroundColor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -103,21 +98,12 @@ service UnoControlProgressBarModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::FillColor /** specifies the fill color (RGB) of the control. */ [property] long FillColor; @@ -130,37 +116,34 @@ service UnoControlProgressBarModel //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the help URL of the control. */ [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::ProgressValue /** specifies the progress value of the control. */ [property] long ProgressValue; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::ProgressValueMax /** specifies the maximum progress value of the control. */ [property] long ProgressValueMax; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlProgressBarModel::ProgressValueMin /** specifies the minimum progress value of the control. */ [property] long ProgressValueMin; + }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl index a7e6bddf6202..754a4fa058ee 100644 --- a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlRadioButtonModel.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mt $ $Date: 2001-04-20 09:05:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,55 +76,66 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlRadioButtonModel -/** specifies the standard model of an <type>UnoRadioButtonControl</type>. +/** specifies the standard model of an <type>UnoControlRadioButton</type>. */ service UnoControlRadioButtonModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::DefaultControl - /** specifies the service name of the default control for this model. + /** determines whether the control is enabled or disabled. */ - [property] string DefaultControl; + [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::Enabled - /** determines whether a control is enabled or disabled. + /** specifies the font attributes of the text in the control. */ - [property] boolean Enabled; + [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::FontDescriptor - /** specifies the font attributes of the text in the control. + /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> + value of the text in the control. */ - [property] com::sun::star::awt::FontDescriptor FontDescriptor; + [property] short FontEmphasisMark; + + //------------------------------------------------------------------------- + + /** specifies the <type scope="com::sun::star::text">FontRelief</type> + value of the text in the control. + */ + [property] short FontRelief; + + //------------------------------------------------------------------------- + + /** specifies the help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::Label /** specifies the label of the control. */ [property] string Label; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::State /** specifies the state of the control. - <pre> 0: not checked 1: checked @@ -134,29 +145,21 @@ service UnoControlRadioButtonModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::Tabstop - /** specifies that the control can be reached with the tabulator key. + /** specifies that the control can be reached with the TAB key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlRadioButtonModel::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; //------------------------------------------------------------------------- - /** specifies the help text of the control. - */ - [property] string HelpText; - - //------------------------------------------------------------------------- - - /** specifies the help id of the control. + /** specifies the text line color (RGB) of the control. */ - [property] string HelpURL; + [property] long TextLineColor; }; @@ -164,30 +167,4 @@ service UnoControlRadioButtonModel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/23 14:40:26 mt - Added HelpURL and HelpText - - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:06 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:17:48 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:14 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/UnoControlScrollBar.idl b/offapi/com/sun/star/awt/UnoControlScrollBar.idl index 78ec6b231498..37b5f1811f78 100644 --- a/offapi/com/sun/star/awt/UnoControlScrollBar.idl +++ b/offapi/com/sun/star/awt/UnoControlScrollBar.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlScrollBar.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tbe $ $Date: 2001-05-02 16:24:05 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,10 +65,6 @@ #include <com/sun/star/awt/UnoControl.idl> #endif -#ifndef __com_sun_star_awt_XAdjustmentListener_idl__ -#include <com/sun/star/awt/XAdjustmentListener.idl> -#endif - #ifndef __com_sun_star_awt_XScrollBar_idl__ #include <com/sun/star/awt/XScrollBar.idl> #endif @@ -80,20 +76,13 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoScrollBarControl -/** specifies a scrollbar control. +/** specifies a scroll bar control. */ service UnoControlScrollBar { - // DocMerge: empty anyway service com::sun::star::awt::UnoControl; - // DocMerge: empty anyway - interface com::sun::star::awt::XAdjustmentListener; - - // DocMerge: empty anyway interface com::sun::star::awt::XScrollBar; - }; //============================================================================= diff --git a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl index 988ee4836b49..ff22647ecd2c 100644 --- a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl +++ b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnoControlScrollBarModel.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tbe $ $Date: 2001-05-04 13:42:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,27 +72,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::awt::UnoControlScrollBarModel -/** specifies the standard model of an <type>UnoScrollBarControl</type>. +/** specifies the standard model of an <type>UnoControlScrollBar</type>. */ service UnoControlScrollBarModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::BlockIncrement /** specifies the increment for a block move. */ [property] long BlockIncrement; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::Border /** specifies the border style of the control. - <pre> 0: No border 1: 3D border @@ -103,15 +98,7 @@ service UnoControlScrollBarModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::DefaultControl - /** specifies the service name of the default control for this model. - */ - [property] string DefaultControl; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::Enabled - /** determines whether a control is enabled or disabled. + /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; @@ -123,51 +110,46 @@ service UnoControlScrollBarModel //------------------------------------------------------------------------- - /** specifies the help id of the control. + /** specifies the help URL of the control. */ [property] string HelpURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::LineIncrement /** specifies the increment for a single line move. */ [property] long LineIncrement; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::Orientation /** specifies the <type>ScrollBarOrientation</type> of the control. */ [property] long Orientation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::Printable /** specifies that the control will be printed with the document. */ [property] boolean Printable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::ScrollValue /** specifies the scroll value of the control. */ [property] long ScrollValue; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::ScrollValueMax /** specifies the maximum scroll value of the control. */ [property] long ScrollValueMax; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::awt::UnoControlScrollBarModel::VisibleSize - /** specifies the visible size of the scrollbar. + /** specifies the visible size of the scroll bar. */ [property] long VisibleSize; + }; //============================================================================= diff --git a/offapi/com/sun/star/awt/VclContainerEvent.idl b/offapi/com/sun/star/awt/VclContainerEvent.idl index dd8919cf0ead..1562fd7e131b 100644 --- a/offapi/com/sun/star/awt/VclContainerEvent.idl +++ b/offapi/com/sun/star/awt/VclContainerEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: VclContainerEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,6 +106,9 @@ struct VclContainerEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:51 hjs initial import diff --git a/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl b/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl index bd29398b4e4a..70ea6f2a981d 100644 --- a/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl +++ b/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl @@ -2,9 +2,9 @@ * * $RCSfile: VclWindowPeerAttribute.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -220,6 +220,9 @@ constants VclWindowPeerAttribute /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:51 hjs initial import diff --git a/offapi/com/sun/star/awt/WindowAttribute.idl b/offapi/com/sun/star/awt/WindowAttribute.idl index f98a6c7ef5c4..f84e24a70055 100644 --- a/offapi/com/sun/star/awt/WindowAttribute.idl +++ b/offapi/com/sun/star/awt/WindowAttribute.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowAttribute.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -166,6 +166,9 @@ constants WindowAttribute /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.2 2000/10/09 14:24:53 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/offapi/com/sun/star/awt/WindowClass.idl b/offapi/com/sun/star/awt/WindowClass.idl index f0b215700deb..a313818d52a8 100644 --- a/offapi/com/sun/star/awt/WindowClass.idl +++ b/offapi/com/sun/star/awt/WindowClass.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowClass.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -111,6 +111,9 @@ enum WindowClass /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:51 hjs initial import diff --git a/offapi/com/sun/star/awt/WindowDescriptor.idl b/offapi/com/sun/star/awt/WindowDescriptor.idl index f3cc5ece86a0..3a9e9b3655a2 100644 --- a/offapi/com/sun/star/awt/WindowDescriptor.idl +++ b/offapi/com/sun/star/awt/WindowDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -158,6 +158,9 @@ struct WindowDescriptor /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:51 hjs initial import diff --git a/offapi/com/sun/star/awt/WindowEvent.idl b/offapi/com/sun/star/awt/WindowEvent.idl index fe1b4deea82e..70112a930dea 100644 --- a/offapi/com/sun/star/awt/WindowEvent.idl +++ b/offapi/com/sun/star/awt/WindowEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -162,6 +162,9 @@ struct WindowEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2000/11/08 12:42:11 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:51 hjs initial import diff --git a/offapi/com/sun/star/awt/XActionListener.idl b/offapi/com/sun/star/awt/XActionListener.idl index d47a7de9a4c6..0201e7893b04 100644 --- a/offapi/com/sun/star/awt/XActionListener.idl +++ b/offapi/com/sun/star/awt/XActionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActionListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,13 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XActionListener -/** makes it possible to receive action events from a component. +/** makes it possible to receive action events. */ interface XActionListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XActionListener::actionPerformed - /** is called when an action is performed. + /** is invoked when an action is performed. */ [oneway] void actionPerformed( [in] com::sun::star::awt::ActionEvent rEvent ); @@ -94,24 +92,4 @@ interface XActionListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:51 hjs - initial import - - Revision 1.4 2000/09/11 11:52:07 mi - documentation merged from XML - - Revision 1.2 2000/05/16 12:19:52 mi - documentation - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XActivateListener.idl b/offapi/com/sun/star/awt/XActivateListener.idl index a6803cbd1a61..82b844e7437c 100644 --- a/offapi/com/sun/star/awt/XActivateListener.idl +++ b/offapi/com/sun/star/awt/XActivateListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActivateListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -117,6 +117,9 @@ interface XActivateListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XAdjustmentListener.idl b/offapi/com/sun/star/awt/XAdjustmentListener.idl index f584b27c693a..b8713b800c20 100644 --- a/offapi/com/sun/star/awt/XAdjustmentListener.idl +++ b/offapi/com/sun/star/awt/XAdjustmentListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAdjustmentListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,13 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XAdjustmentListener -/** makes it possible to receive adjustment events from a component. +/** makes it possible to receive adjustment events. */ interface XAdjustmentListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XAdjustmentListener::adjustmentValueChanged - /** is called when the adjustment changed. + /** is invoked when the adjustment has changed. */ [oneway] void adjustmentValueChanged( [in] com::sun::star::awt::AdjustmentEvent rEvent ); @@ -94,24 +92,4 @@ interface XAdjustmentListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:51 hjs - initial import - - Revision 1.4 2000/09/11 11:52:07 mi - documentation merged from XML - - Revision 1.2 2000/05/16 12:19:52 mi - documentation - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XBitmap.idl b/offapi/com/sun/star/awt/XBitmap.idl index c6cd8b6fe5b5..4d9cca67c487 100644 --- a/offapi/com/sun/star/awt/XBitmap.idl +++ b/offapi/com/sun/star/awt/XBitmap.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBitmap.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -114,6 +114,9 @@ interface XBitmap: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XButton.idl b/offapi/com/sun/star/awt/XButton.idl index 105da0eba4a8..15eaff75c8a3 100644 --- a/offapi/com/sun/star/awt/XButton.idl +++ b/offapi/com/sun/star/awt/XButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: XButton.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,35 +76,30 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XButton /** makes it possible to set the label of a button and to register for action events. */ interface XButton: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XButton::addActionListener /** registers an event handler for button action events. */ [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XButton::removeActionListener /** unregisters an event handler for button action events. */ [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XButton::setLabel /** sets the label of the button. */ [oneway] void setLabel( [in] string Label ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XButton::setActionCommand /** sets a command string for pushing the button. */ [oneway] void setActionCommand( [in] string Command ); @@ -115,27 +110,4 @@ interface XButton: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:07 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:52 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XCheckBox.idl b/offapi/com/sun/star/awt/XCheckBox.idl index 387f8b43d9f7..3b37f5f311a8 100644 --- a/offapi/com/sun/star/awt/XCheckBox.idl +++ b/offapi/com/sun/star/awt/XCheckBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCheckBox.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,50 +76,43 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XCheckBox -/** gives access to the state of a check box and makes it possible to register for events. +/** gives access to the state of a check box and makes it possible + to register for events. */ interface XCheckBox: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XCheckBox::addItemListener /** registers a listener for item events. */ [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XCheckBox::removeItemListener /** unregisters a listener for item events. */ [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XCheckBox::getState - /** @returns - the state of the checkbox. + /** returns the state of the check box. */ short getState(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XCheckBox::setState - /** sets the state of the checkbox. + /** sets the state of the check box. */ [oneway] void setState( [in] short n ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XCheckBox::setLabel - /** sets the label of the checkbox. + /** sets the label of the check box. */ [oneway] void setLabel( [in] string Label ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XCheckBox::enableTriState /** enables or disables the tri state mode. */ [oneway] void enableTriState( [in] boolean b ); @@ -130,27 +123,4 @@ interface XCheckBox: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:52 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XComboBox.idl b/offapi/com/sun/star/awt/XComboBox.idl index 8439acb00a99..5d539c7b983a 100644 --- a/offapi/com/sun/star/awt/XComboBox.idl +++ b/offapi/com/sun/star/awt/XComboBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComboBox.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,6 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XComboBox /** gives access to the items of a combo box and makes it possible to register item and action event listeners. */ @@ -88,89 +87,73 @@ interface XComboBox: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::addItemListener /** registers a listener for item events. */ [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::removeItemListener /** unregisters a listener for item events. */ [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::addActionListener /** registers a listener for action events. */ [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::removeActionListener /** unregisters a listener for action events. */ [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::addItem - /** adds a new item to the combo box. + /** adds an item at the specified position. */ [oneway] void addItem( [in] string aItem, [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::addItems - /** adds multiple items to the combo box. + /** adds multiple items at the specified position. */ [oneway] void addItems( [in] sequence<string> aItems, [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::removeItems - /** removes multiple items to the combo box. + /** removes a number of items at the specified position. */ [oneway] void removeItems( [in] short nPos, [in] short nCount ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XComboBox::getItemCount - /** @returns - the number of items in this combo box. + /** returns the number of items in the combo box. */ short getItemCount(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XComboBox::getItem - /** @returns - the item at the position <var>nPos</var>. + /** returns the item at the specified position. */ string getItem( [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XComboBox::getItems - /** @returns - all items of this combo box. + /** returns all items of the combo box. */ sequence<string> getItems(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XComboBox::getDropDownLineCount - /** @returns - the number of lines which are visible in the drop down area. + /** returns the number of visible lines in the drop down mode. */ short getDropDownLineCount(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XComboBox::setDropDownLineCount - /** sets the number of lines which are visible in the drop down area. + /** sets the number of visible lines for drop down mode. */ [oneway] void setDropDownLineCount( [in] short nLines ); @@ -180,27 +163,4 @@ interface XComboBox: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:52 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XControl.idl b/offapi/com/sun/star/awt/XControl.idl index be44fbf55518..6ba71ac9e8fd 100644 --- a/offapi/com/sun/star/awt/XControl.idl +++ b/offapi/com/sun/star/awt/XControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: XControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,104 +92,82 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XControl -/** Implementations of this interface are abstract windows. +/** identifies a control. - The main reason to instanciate this implementation is to show it - on a screen. A control has a context. Set the context with the - "set context" method.<br> + <p>Implementations of this interface are abstract windows. + The main reason to instantiate this implementation is to show the window + on the screen. Before the window appears on the screen, the + <member>XControl::createPeer</member> method must be called.</p> - Before the window appears on a screen, the createPeer(...) must - be called.<br> - - If the implementation of the control does not distinguish - between model, view or controller, then it must allow you to set - a new XGraphics in the view so you can print the control. + <p>If the implementation of the control does not distinguish + between model, view and controller, it must allow to set + a new XGraphics in the view, so that the control can be printed.</p> */ interface XControl: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::setContext - /** sets the context for the control. + /** sets the context of the control. */ [oneway] void setContext( [in] com::sun::star::uno::XInterface Context ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::getContext - /** gets the context which was previously set with - setContext. + /** gets the context of the control. */ com::sun::star::uno::XInterface getContext(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::createPeer - /** creates a "child" window on the screen. If the - parent is NULL, then the desktop window of the toolkit - is the parent. + /** creates a "child" window on the screen. + + <p>If the parent is NULL, then the desktop window of the toolkit + is the parent.</p> */ [oneway] void createPeer( [in] com::sun::star::awt::XToolkit Toolkit, [in] com::sun::star::awt::XWindowPeer Parent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::getPeer /** returns the peer which was previously created or set. */ com::sun::star::awt::XWindowPeer getPeer(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::setModel - /** sets a model for the control. The control gets - the persistent data from this interface and sets update - links to the model data. The main interface to the - model is the XPropertySet. + /** sets a model for the control. */ boolean setModel( [in] com::sun::star::awt::XControlModel Model ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::getModel - /** returns the model for this control. The model - allows access to data like "test," "font," etc. for the - control. If there is no extra model, this method must - return the "com::sun::star::uno::XInterface" from the control. + /** returns the model for this control. */ com::sun::star::awt::XControlModel getModel(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::getView /** returns the view of this control. */ com::sun::star::awt::XView getView(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControl::setDesignMode /** sets the design mode for use in a design editor. - Normally the control will be painted directly without a peer. + + <p>Normally the control will be painted directly without a peer.</p> */ [oneway] void setDesignMode( [in] boolean bOn ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XControl::isDesignMode - /** @returns - <true/> if the control is in design mode, - <false/> otherwise. + /** returns <true/> if the control is in design mode, <false/> otherwise. */ boolean isDesignMode(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XControl::isTransparent - /** @returns - <true/> if the control is transparent, - <false/> otherwise. + /** returns <true/> if the control is transparent, <false/> otherwise. */ boolean isTransparent(); @@ -199,33 +177,4 @@ interface XControl: com::sun::star::lang::XComponent }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.2 2000/10/09 14:24:53 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.6 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.4 2000/05/16 12:19:52 mi - documentation - - Revision 1.3 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.2 1999/11/18 11:49:54 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XControlContainer.idl b/offapi/com/sun/star/awt/XControlContainer.idl index 0ad8b93ce7aa..fa64dbdf5246 100644 --- a/offapi/com/sun/star/awt/XControlContainer.idl +++ b/offapi/com/sun/star/awt/XControlContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XControlContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,62 +76,39 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XControlContainer -/** this interface is the container for controls. - - Other names for the container are container or environment.<br> - - If this container is not embedded, then it uses the default - "VclToolkit" service to create the peer components. The name is - "com.sun.star.awt.Toolkit".<br> +/** Provides access to the controls within an + <type>UnoControlContainer</type>. */ interface XControlContainer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControlContainer::setStatusText - /** sets a status text in the status bar of the - container. + /** sets the status text in the status bar of the container. */ [oneway] void setStatusText( [in] string StatusText ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XControlContainer::getControls - /** @returns - all controls of this container. + /** returns all controls. */ sequence<com::sun::star::awt::XControl> getControls(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControlContainer::getControl - /** returns the control with the name "Name". + /** returns the control with the specified name. */ com::sun::star::awt::XControl getControl( [in] string aName ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControlContainer::addControl - /** adds the control to the container. The control - must not be added to another container. The container - must call <code>setControlContainer( this )</code> at - the control. + /** adds the given control with the specified name to the container. */ [oneway] void addControl( [in] string Name, [in] com::sun::star::awt::XControl Control ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XControlContainer::removeControl - /** removes the control from the container. You must - call - - - - - - at this control. + /** removes the given control from the container. */ [oneway] void removeControl( [in] com::sun::star::awt::XControl Control ); @@ -141,30 +118,4 @@ interface XControlContainer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.2 2000/10/09 14:24:53 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:52 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XControlModel.idl b/offapi/com/sun/star/awt/XControlModel.idl index a5f1fe944241..f4a41e9b3354 100644 --- a/offapi/com/sun/star/awt/XControlModel.idl +++ b/offapi/com/sun/star/awt/XControlModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XControlModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,6 +86,9 @@ interface XControlModel: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XCurrencyField.idl b/offapi/com/sun/star/awt/XCurrencyField.idl index e7dd179a697c..f0b3089258b3 100644 --- a/offapi/com/sun/star/awt/XCurrencyField.idl +++ b/offapi/com/sun/star/awt/XCurrencyField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCurrencyField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -206,6 +206,9 @@ interface XCurrencyField: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XDataTransferProviderAccess.idl b/offapi/com/sun/star/awt/XDataTransferProviderAccess.idl index 04d05522b09b..9f61bc34eac1 100644 --- a/offapi/com/sun/star/awt/XDataTransferProviderAccess.idl +++ b/offapi/com/sun/star/awt/XDataTransferProviderAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataTransferProviderAccess.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:00:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XDateField.idl b/offapi/com/sun/star/awt/XDateField.idl index 4eb6a5c25766..6a27f39fde14 100644 --- a/offapi/com/sun/star/awt/XDateField.idl +++ b/offapi/com/sun/star/awt/XDateField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDateField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,127 +72,108 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XDateField -/** makes it possible to set the limits and the value of a date field. +/** gives access to the value and settings of a date field. */ interface XDateField: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setDate - /** sets the date value to display in the date field. + /** sets the date value which is displayed in the date field. + + <p>The date value must be specified in the format + YYYYMMDD.</p> */ [oneway] void setDate( [in] long Date ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::getDate - /** @returns - the date value which is currently displayed in the date field. + /** returns the date value which is currently displayed in the date field. */ long getDate(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setMin - /** sets the minimum value to accept by the user. + /** sets the minimum date value that can be entered by the user. */ [oneway] void setMin( [in] long Date ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::getMin - /** @returns - the currently set minimum value accepted by the user. + /** returns the currently set minimum date value that can be entered by + the user. */ long getMin(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setMax - /** sets the maximum value to accept by the user. + /** sets the maximum date value that can be entered by the user. */ [oneway] void setMax( [in] long Date ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::getMax - /** @returns - the currently set maximum value accepted by the user. + /** returns the currently set maximum date value that can be entered by + the user. */ long getMax(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setFirst - /** sets the first value to set on 'Pos1' key. + /** sets the first value to be set on POS1 key. */ [oneway] void setFirst( [in] long Date ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::getFirst - /** @returns - the currently set first value which is set on 'Pos1' key. + /** returns the currently set first value which is set on POS1 key. */ long getFirst(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setLast - /** sets the last value to set on 'End' key. + /** sets the last value to be set on END key. */ [oneway] void setLast( [in] long Date ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::getLast - /** @returns - the currently set last value which is set on 'End' key. + /** returns the currently set last value which is set on END key. */ long getLast(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setLongFormat /** determines if the long date format is to be used. */ [oneway] void setLongFormat( [in] boolean bLong ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::isLongFormat /** determines if the long date format is currently used. */ boolean isLongFormat(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setEmpty - /** sets the empty value for the date. + /** sets an empty value for the date. */ void setEmpty(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::isEmpty - /** @returns - whether currently the empty value is set for the date. + /** returns whether currently an empty value is set for the date. */ boolean isEmpty(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XDateField::setStrictFormat - /** determines if the format is checked, even during editing. + /** determines if the format is checked during user input. */ [oneway] void setStrictFormat( [in] boolean bStrict ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XDateField::isStrictFormat - /** @returns - whether the format is currently checked even during editing. + /** returns whether the format is currently checked during user input. */ boolean isStrictFormat(); @@ -202,27 +183,4 @@ interface XDateField: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:52 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XDevice.idl b/offapi/com/sun/star/awt/XDevice.idl index 12ad3a8ef528..c528ed7244d8 100644 --- a/offapi/com/sun/star/awt/XDevice.idl +++ b/offapi/com/sun/star/awt/XDevice.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDevice.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -179,6 +179,9 @@ interface XDevice: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:01 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/awt/XDialog.idl b/offapi/com/sun/star/awt/XDialog.idl index e6c4b6a97289..43ee12ea20a9 100644 --- a/offapi/com/sun/star/awt/XDialog.idl +++ b/offapi/com/sun/star/awt/XDialog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDialog.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,33 +72,34 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XDialog -/** @deprecated +/** makes it possible to show and hide a dialog and gives access to + the title of the dialog. */ interface XDialog: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XDialog::setTitle - // DocMerge: empty anyway + /** sets the title of the dialog. + */ [oneway] void setTitle( [in] string Title ); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XDialog::getTitle - // DocMerge: empty anyway + /** gets the title of the dialog. + */ string getTitle(); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XDialog::execute - // DocMerge: empty anyway + /** shows the dialog. + */ short execute(); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XDialog::endExecute - // DocMerge: empty anyway + /** hides the dialog and then causes <member>XDialog::execute</member> + to return. + */ void endExecute(); }; @@ -107,27 +108,4 @@ interface XDialog: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:15 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XDisplayBitmap.idl b/offapi/com/sun/star/awt/XDisplayBitmap.idl index fa1592490bd3..4f5610840b8e 100644 --- a/offapi/com/sun/star/awt/XDisplayBitmap.idl +++ b/offapi/com/sun/star/awt/XDisplayBitmap.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDisplayBitmap.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,6 +91,9 @@ interface XDisplayBitmap: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XDisplayConnection.idl b/offapi/com/sun/star/awt/XDisplayConnection.idl index 8ae960c47d1b..da187ac658a7 100644 --- a/offapi/com/sun/star/awt/XDisplayConnection.idl +++ b/offapi/com/sun/star/awt/XDisplayConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDisplayConnection.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XEventHandler.idl b/offapi/com/sun/star/awt/XEventHandler.idl index b6caaae88555..6b9c5df058ac 100644 --- a/offapi/com/sun/star/awt/XEventHandler.idl +++ b/offapi/com/sun/star/awt/XEventHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventHandler.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XFileDialog.idl b/offapi/com/sun/star/awt/XFileDialog.idl index 1abe9e8516ca..8ece64e59ee4 100644 --- a/offapi/com/sun/star/awt/XFileDialog.idl +++ b/offapi/com/sun/star/awt/XFileDialog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFileDialog.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -117,6 +117,9 @@ interface XFileDialog: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XFixedText.idl b/offapi/com/sun/star/awt/XFixedText.idl index 8b1eb6175a40..162942a4fbc7 100644 --- a/offapi/com/sun/star/awt/XFixedText.idl +++ b/offapi/com/sun/star/awt/XFixedText.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFixedText.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,38 +72,37 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XFixedText -/** makes it possible to access the text and formatting of a test field. +/** gives access to the text and formatting of a fixed text field. */ interface XFixedText: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XFixedText::setText - /** sets the text to display in the text field. + /** sets the text of the control. */ [oneway] void setText( [in] string Text ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XFixedText::getText - /** @returns - the text which is currently displayed in the text field. + /** returns the text of the control. */ string getText(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XFixedText::setAlignment - /** sets the <type>TextAlign</type> for this field. + /** sets the alignment of the text in the control. + + <pre> + 0: left + 1: center + 2: right + </pre> */ [oneway] void setAlignment( [in] short nAlign ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XFixedText::getAlignment - /** @returns - the currently set <type>TextAlign</type> for this field. + /** returns the alignment of the text in the control. */ short getAlignment(); @@ -113,27 +112,4 @@ interface XFixedText: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:16 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XFocusListener.idl b/offapi/com/sun/star/awt/XFocusListener.idl index 4d98512a7d05..0aabb6654756 100644 --- a/offapi/com/sun/star/awt/XFocusListener.idl +++ b/offapi/com/sun/star/awt/XFocusListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFocusListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -111,6 +111,9 @@ interface XFocusListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XFont.idl b/offapi/com/sun/star/awt/XFont.idl index 18e25e9ce9aa..2fc0343cf0cc 100644 --- a/offapi/com/sun/star/awt/XFont.idl +++ b/offapi/com/sun/star/awt/XFont.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFont.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -165,6 +165,9 @@ interface XFont: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XGraphics.idl b/offapi/com/sun/star/awt/XGraphics.idl index 00d6b7d127db..605f31aee020 100644 --- a/offapi/com/sun/star/awt/XGraphics.idl +++ b/offapi/com/sun/star/awt/XGraphics.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGraphics.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -386,6 +386,9 @@ interface XGraphics: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XImageButton.idl b/offapi/com/sun/star/awt/XImageButton.idl index cc5343265c9a..22574f09e256 100644 --- a/offapi/com/sun/star/awt/XImageButton.idl +++ b/offapi/com/sun/star/awt/XImageButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImageButton.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,6 +112,9 @@ interface XImageButton: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XImageConsumer.idl b/offapi/com/sun/star/awt/XImageConsumer.idl index 0cd11c7e3367..5a6f5ca63ea4 100644 --- a/offapi/com/sun/star/awt/XImageConsumer.idl +++ b/offapi/com/sun/star/awt/XImageConsumer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImageConsumer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -175,6 +175,9 @@ interface XImageConsumer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XImageProducer.idl b/offapi/com/sun/star/awt/XImageProducer.idl index a3ce80109d8c..6f7efc5f0f8c 100644 --- a/offapi/com/sun/star/awt/XImageProducer.idl +++ b/offapi/com/sun/star/awt/XImageProducer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImageProducer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -135,6 +135,9 @@ interface XImageProducer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XInfoPrinter.idl b/offapi/com/sun/star/awt/XInfoPrinter.idl index 360b91b076e2..b8df4277d44c 100644 --- a/offapi/com/sun/star/awt/XInfoPrinter.idl +++ b/offapi/com/sun/star/awt/XInfoPrinter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInfoPrinter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,6 +98,9 @@ interface XInfoPrinter: com::sun::star::awt::XPrinterPropertySet /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XItemListener.idl b/offapi/com/sun/star/awt/XItemListener.idl index 13106f59e3f8..a8ace434098b 100644 --- a/offapi/com/sun/star/awt/XItemListener.idl +++ b/offapi/com/sun/star/awt/XItemListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XItemListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,6 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XItemListener /** makes it possible to receive events from a component when the state of an item changes. */ @@ -84,8 +83,7 @@ interface XItemListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XItemListener::itemStateChanged - /** is called when an item changes state. + /** is invoked when an item changes its state. */ [oneway] void itemStateChanged( [in] com::sun::star::awt::ItemEvent rEvent ); @@ -95,24 +93,4 @@ interface XItemListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:53 hjs - initial import - - Revision 1.4 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.2 2000/05/16 12:19:53 mi - documentation - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XKeyListener.idl b/offapi/com/sun/star/awt/XKeyListener.idl index 59c2a95da6d5..f9c047e22437 100644 --- a/offapi/com/sun/star/awt/XKeyListener.idl +++ b/offapi/com/sun/star/awt/XKeyListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XKeyListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,6 +104,9 @@ interface XKeyListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XLayoutConstrains.idl b/offapi/com/sun/star/awt/XLayoutConstrains.idl index ed870e09a655..6904cded374b 100644 --- a/offapi/com/sun/star/awt/XLayoutConstrains.idl +++ b/offapi/com/sun/star/awt/XLayoutConstrains.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLayoutConstrains.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,33 +76,25 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XLayoutConstrains -/** enables a component to specify layout constrains for a surrounding - container. +/** specifies the layout constraints for a surrounding container. */ interface XLayoutConstrains: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XLayoutConstrains::getMinimumSize - /** @returns - the minimum size for this component. + /** returns the minimum size for this component. */ com::sun::star::awt::Size getMinimumSize(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XLayoutConstrains::getPreferredSize - /** @returns - the preferred size for this component. + /** returns the preferred size for this component. */ com::sun::star::awt::Size getPreferredSize(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XLayoutConstrains::calcAdjustedSize - /** @returns - the an actual size for a given maximal size. + /** calculates the adjusted size for a given maximum size. */ com::sun::star::awt::Size calcAdjustedSize( [in] com::sun::star::awt::Size aNewSize ); @@ -112,27 +104,4 @@ interface XLayoutConstrains: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:53 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:16 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XListBox.idl b/offapi/com/sun/star/awt/XListBox.idl index 0aa3cadb9e59..86b26b4e1472 100644 --- a/offapi/com/sun/star/awt/XListBox.idl +++ b/offapi/com/sun/star/awt/XListBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: XListBox.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,179 +80,147 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XListBox -/** gives access to the items and their state and to register for - item and action events of a listbox. +/** gives access to the items of a list box and makes it possible to + register item and action event listeners. */ interface XListBox: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::addItemListener - /** registers an item event listener. + /** registers a listener for item events. */ [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::removeItemListener - /** unregisters an item event listener. + /** unregisters a listener for item events. */ [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::addActionListener - /** registers an action event listener. + /** registers a listener for action events. */ [oneway] void addActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::removeActionListener - /** unregisters an action event listener. + /** unregisters a listener for action events. */ [oneway] void removeActionListener( [in] com::sun::star::awt::XActionListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::addItem - /** adds an item at a specified position. + /** adds an item at the specified position. */ [oneway] void addItem( [in] string aItem, [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::addItems - /** adds multiple items at a specified position. + /** adds multiple items at the specified position. */ [oneway] void addItems( [in] sequence<string> aItems, [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::removeItems - /** removes a number of items at a specified position. + /** removes a number of items at the specified position. */ [oneway] void removeItems( [in] short nPos, [in] short nCount ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getItemCount - /** @returns - the number of items currently in the listbox. + /** returns the number of items in the listbox. */ short getItemCount(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getItem - /** @returns - the item at the specified position. + /** returns the item at the specified position. */ string getItem( [in] short nPos ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getItems - /** @returns - all items of the list box. + /** returns all items of the list box. */ sequence<string> getItems(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItemPos - /** @returns - the position of the currently selected item. + /** returns the position of the currently selected item. */ short getSelectedItemPos(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItemsPos - /** @returns - the positions of all currently selected items. + /** returns the positions of all currently selected items. */ sequence<short> getSelectedItemsPos(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItem - /** @returns - the currently selected item. + /** returns the currently selected item. */ string getSelectedItem(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getSelectedItems - /** @returns - all currently selected items. + /** returns all currently selected items. */ sequence<string> getSelectedItems(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::selectItemPos - /** selects/unselects the item at the specified position. + /** selects/deselects the item at the specified position. */ [oneway] void selectItemPos( [in] short nPos, [in] boolean bSelect ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::selectItemsPos - /** selects/unselects multiple items at the specified positions. + /** selects/deselects multiple items at the specified positions. */ [oneway] void selectItemsPos( [in] sequence<short> aPositions, [in] boolean bSelect ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::selectItem - /** selects/unselects the specified item. + /** selects/deselects the specified item. */ [oneway] void selectItem( [in] string aItem, [in] boolean bSelect ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::isMutipleMode - /** @returns - <true/> if multiple items can be selected, - <false/> if only one item can be selected. + /** returns <true/> if multiple items can be selected, + <false/> if only one item can be selected. */ boolean isMutipleMode(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::setMultipleMode /** determines if only a single item or multiple items can be selected. */ [oneway] void setMultipleMode( [in] boolean bMulti ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XListBox::getDropDownLineCount - /** @returns - the number of visible lines in drop down mode. + /** returns the number of visible lines in drop down mode. */ short getDropDownLineCount(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::setDropDownLineCount /** sets the number of visible lines for drop down mode. */ [oneway] void setDropDownLineCount( [in] short nLines ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XListBox::makeVisible - /** makes the item at the specified position visible by scolling. + /** makes the item at the specified position visible by scrolling. */ [oneway] void makeVisible( [in] short nEntry ); @@ -262,27 +230,4 @@ interface XListBox: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:53 hjs - initial import - - Revision 1.5 2000/09/11 11:52:08 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:16 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XMenu.idl b/offapi/com/sun/star/awt/XMenu.idl index 5ef0370a69a4..80ac00dc3267 100644 --- a/offapi/com/sun/star/awt/XMenu.idl +++ b/offapi/com/sun/star/awt/XMenu.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMenu.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -191,6 +191,9 @@ interface XMenu: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XMenuBar.idl b/offapi/com/sun/star/awt/XMenuBar.idl index 8a324dc5f093..fb387c1173be 100644 --- a/offapi/com/sun/star/awt/XMenuBar.idl +++ b/offapi/com/sun/star/awt/XMenuBar.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMenuBar.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,6 +86,9 @@ interface XMenuBar: com::sun::star::awt::XMenu /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XMenuListener.idl b/offapi/com/sun/star/awt/XMenuListener.idl index 38104e7f9e06..c3abe3f6e8bc 100644 --- a/offapi/com/sun/star/awt/XMenuListener.idl +++ b/offapi/com/sun/star/awt/XMenuListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMenuListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -118,6 +118,9 @@ interface XMenuListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XMessageBox.idl b/offapi/com/sun/star/awt/XMessageBox.idl index 3ffc55beeb98..5f5e29e475f0 100644 --- a/offapi/com/sun/star/awt/XMessageBox.idl +++ b/offapi/com/sun/star/awt/XMessageBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMessageBox.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -116,6 +116,9 @@ interface XMessageBox: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XMouseListener.idl b/offapi/com/sun/star/awt/XMouseListener.idl index 37c0bd8c62dd..4ba7cb73f670 100644 --- a/offapi/com/sun/star/awt/XMouseListener.idl +++ b/offapi/com/sun/star/awt/XMouseListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMouseListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -118,6 +118,9 @@ interface XMouseListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XMouseMotionListener.idl b/offapi/com/sun/star/awt/XMouseMotionListener.idl index 12e4f309604e..e5a26ef4dd98 100644 --- a/offapi/com/sun/star/awt/XMouseMotionListener.idl +++ b/offapi/com/sun/star/awt/XMouseMotionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMouseMotionListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -113,6 +113,9 @@ interface XMouseMotionListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XNumericField.idl b/offapi/com/sun/star/awt/XNumericField.idl index aef83274e7b1..6fdfa54ae180 100644 --- a/offapi/com/sun/star/awt/XNumericField.idl +++ b/offapi/com/sun/star/awt/XNumericField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumericField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -205,6 +205,9 @@ interface XNumericField: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPaintListener.idl b/offapi/com/sun/star/awt/XPaintListener.idl index c83bf84db6d4..d5f5b45b3e0a 100644 --- a/offapi/com/sun/star/awt/XPaintListener.idl +++ b/offapi/com/sun/star/awt/XPaintListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPaintListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,6 +98,9 @@ interface XPaintListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPatternField.idl b/offapi/com/sun/star/awt/XPatternField.idl index 6766f34cd826..ebaffe81dbe7 100644 --- a/offapi/com/sun/star/awt/XPatternField.idl +++ b/offapi/com/sun/star/awt/XPatternField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPatternField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -132,6 +132,9 @@ interface XPatternField: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPointer.idl b/offapi/com/sun/star/awt/XPointer.idl index 060b472136ea..7711c9a4be6f 100644 --- a/offapi/com/sun/star/awt/XPointer.idl +++ b/offapi/com/sun/star/awt/XPointer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPointer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,6 +101,9 @@ interface XPointer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPopupMenu.idl b/offapi/com/sun/star/awt/XPopupMenu.idl index aa76ccac3303..1ac599ddddd2 100644 --- a/offapi/com/sun/star/awt/XPopupMenu.idl +++ b/offapi/com/sun/star/awt/XPopupMenu.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPopupMenu.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -137,6 +137,9 @@ interface XPopupMenu: XMenu /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPrinter.idl b/offapi/com/sun/star/awt/XPrinter.idl index a232378ec4d8..1914720168df 100644 --- a/offapi/com/sun/star/awt/XPrinter.idl +++ b/offapi/com/sun/star/awt/XPrinter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrinter.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -166,6 +166,9 @@ interface XPrinter: com::sun::star::awt::XPrinterPropertySet /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/14 12:53:34 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/awt/XPrinterPropertySet.idl b/offapi/com/sun/star/awt/XPrinterPropertySet.idl index a2fcb939338f..ae88bb5d44c0 100644 --- a/offapi/com/sun/star/awt/XPrinterPropertySet.idl +++ b/offapi/com/sun/star/awt/XPrinterPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrinterPropertySet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -161,6 +161,9 @@ interface XPrinterPropertySet: com::sun::star::beans::XPropertySet /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XPrinterServer.idl b/offapi/com/sun/star/awt/XPrinterServer.idl index ca6651ef4bf6..a9b2d35e0f6c 100644 --- a/offapi/com/sun/star/awt/XPrinterServer.idl +++ b/offapi/com/sun/star/awt/XPrinterServer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrinterServer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -126,6 +126,9 @@ interface XPrinterServer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XProgressBar.idl b/offapi/com/sun/star/awt/XProgressBar.idl index 3de169eb4c7c..7cb852e59c09 100644 --- a/offapi/com/sun/star/awt/XProgressBar.idl +++ b/offapi/com/sun/star/awt/XProgressBar.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProgressBar.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,45 +72,42 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XProgressBar -/** @deprecated +/** gives access to the value and settings of a progress bar. */ interface XProgressBar: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XProgressBar::setForegroundColor - // DocMerge: empty anyway + /** sets the foreground color (RGB) of the control. + */ [oneway] void setForegroundColor( [in] long Color ); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XProgressBar::setBackgroundColor - // DocMerge: empty anyway + /** sets the background color (RGB) of the control. + */ [oneway] void setBackgroundColor( [in] long Color ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XProgressBar::setRange - /** set free range of progress + /** sets the minimum and the maximum progress value of the progress bar. - - <p> - If "Min" higher then "Max" the method exchange values automaticly!</p> + <p>If the minimum value is greater than the maximum value, the method + exchanges the values automatically.</p> */ [oneway] void setRange( [in] long Min, [in] long Max ); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XProgressBar::setValue - // DocMerge: empty anyway + /** sets the progress value of the progress bar. + */ [oneway] void setValue( [in] long Value ); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XProgressBar::getValue - // DocMerge: empty anyway + /** returns the current progress value of the progress bar. + */ long getValue(); }; @@ -119,27 +116,4 @@ interface XProgressBar: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.5 2000/09/11 11:52:09 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:16 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XProgressMonitor.idl b/offapi/com/sun/star/awt/XProgressMonitor.idl index 24b12b138e55..eb4f53b65382 100644 --- a/offapi/com/sun/star/awt/XProgressMonitor.idl +++ b/offapi/com/sun/star/awt/XProgressMonitor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProgressMonitor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -107,6 +107,9 @@ interface XProgressMonitor: com::sun::star::awt::XProgressBar /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XRadioButton.idl b/offapi/com/sun/star/awt/XRadioButton.idl index 6ab803824ff2..8e3b258b60e9 100644 --- a/offapi/com/sun/star/awt/XRadioButton.idl +++ b/offapi/com/sun/star/awt/XRadioButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRadioButton.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,44 +76,37 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XRadioButton /** gives access to the state of a radio button and makes it possible - to register item event listener. + to register item event listeners. */ interface XRadioButton: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XRadioButton::addItemListener - /** registers an item event listener. + /** registers a listener for item events. */ [oneway] void addItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XRadioButton::removeItemListener - /** unregisters an item event listener. + /** unregisters a listener for item events. */ [oneway] void removeItemListener( [in] com::sun::star::awt::XItemListener l ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XRadioButton::getState - /** @returns - <true/> if the button is checked, <false/> otherwise. + /** returns <true/> if the button is checked, <false/> otherwise. */ boolean getState(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XRadioButton::setState - /** sets the checked state of the radio button. + /** sets the state of the radio button. */ [oneway] void setState( [in] boolean b ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XRadioButton::setLabel /** sets the label of the radio button. */ [oneway] void setLabel( [in] string Label ); @@ -124,27 +117,4 @@ interface XRadioButton: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.5 2000/09/11 11:52:09 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:53 mi - documentation - - Revision 1.2 2000/02/07 11:24:16 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XRegion.idl b/offapi/com/sun/star/awt/XRegion.idl index 6d5821801027..cf334402ab19 100644 --- a/offapi/com/sun/star/awt/XRegion.idl +++ b/offapi/com/sun/star/awt/XRegion.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRegion.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -176,6 +176,9 @@ interface XRegion: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XScrollBar.idl b/offapi/com/sun/star/awt/XScrollBar.idl index a682d8d9e6b6..c430aaf01335 100644 --- a/offapi/com/sun/star/awt/XScrollBar.idl +++ b/offapi/com/sun/star/awt/XScrollBar.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScrollBar.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,37 +76,33 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XScrollBar /** gives access to the value and settings of a scroll bar and makes it possible - to register event listeners. + to register adjustment event listeners. */ interface XScrollBar: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::addAdjustmentListener /** registers an adjustment event listener. */ [oneway] void addAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::removeAdjustmentListener /** unregisters an adjustment event listener. */ [oneway] void removeAdjustmentListener( [in] com::sun::star::awt::XAdjustmentListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setValue - /** sets the value (position) of the scrollbar. + /** sets the scroll value of the scroll bar. */ [oneway] void setValue( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setValues - /** sets the value (position), visible area and scale of the scollbar. + /** sets the scroll value, visible area and maximum scroll value + of the scoll bar. */ [oneway] void setValues( [in] long nValue, [in] long nVisible, @@ -114,84 +110,68 @@ interface XScrollBar: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getValue - /** @returns - the current value (position) of the scrollbar. + /** returns the current scroll value of the scroll bar. */ long getValue(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setMaximum - /** sets the maximum value (scale) for the scrollbar. + /** sets the maximum scroll value of the scroll bar. */ [oneway] void setMaximum( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getMaximum - /** @returns - the currently set value (scale) for the scrollbar. + /** returns the currently set maximum scroll value of the scroll bar. */ long getMaximum(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setLineIncrement /** sets the increment for a single line move. */ [oneway] void setLineIncrement( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getLineIncrement - /** @returns - the currently set increment of a single line move. + /** returns the currently set increment for a single line move. */ long getLineIncrement(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setBlockIncrement /** sets the increment for a block move. */ [oneway] void setBlockIncrement( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getBlockIncrement - /** @returns - the currently set increment of a block move. + /** returns the currently set increment for a block move. */ long getBlockIncrement(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setVisibleSize - /** sets the visible size for this scrollbar. + /** sets the visible size of the scroll bar. */ [oneway] void setVisibleSize( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getVisibleSize - /** @returns - the currently visible size for this scrollbar. + /** returns the currently visible size of the scroll bar. */ long getVisibleSize(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XScrollBar::setOrientation - /** sets the <type>ScrollBarOrientation</type> of this scrollbar. + /** sets the <type>ScrollBarOrientation</type> of the scroll bar. */ [oneway] void setOrientation( [in] long n ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XScrollBar::getOrientation - /** @returns - the currently set <type>ScrollBarOrientation</type> of this scrollbar. + /** returns the currently set <type>ScrollBarOrientation</type> of the + scroll bar. */ long getOrientation(); @@ -201,27 +181,4 @@ interface XScrollBar: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.5 2000/09/11 11:52:09 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:54 mi - documentation - - Revision 1.2 2000/02/07 11:24:17 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XSpinField.idl b/offapi/com/sun/star/awt/XSpinField.idl index 66ac84007e0d..2189311668f8 100644 --- a/offapi/com/sun/star/awt/XSpinField.idl +++ b/offapi/com/sun/star/awt/XSpinField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpinField.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tbe $ $Date: 2002-09-24 15:31:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XSpinListener.idl b/offapi/com/sun/star/awt/XSpinListener.idl index 6afc413c6ad9..9e9d531e036b 100644 --- a/offapi/com/sun/star/awt/XSpinListener.idl +++ b/offapi/com/sun/star/awt/XSpinListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpinListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tbe $ $Date: 2002-09-24 15:31:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XSystemChildFactory.idl b/offapi/com/sun/star/awt/XSystemChildFactory.idl index 98789d15ee0a..72766de580bc 100644 --- a/offapi/com/sun/star/awt/XSystemChildFactory.idl +++ b/offapi/com/sun/star/awt/XSystemChildFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSystemChildFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: as $ $Date: 2002-05-27 10:24:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,16 +82,18 @@ interface XSystemChildFactory : com::sun::star::uno::XInterface a sytem-specific handle to a window <p>You must check the machine ID and the process ID.<BR> - WIN32: HWND<BR> - WIN16: HWND<BR> - JAVA : HWND (provided from the JNI-API)<BR> - OS2 : HWND<BR> - MAC : Not supported<BR> + WIN32: HWND.<BR> + WIN16: HWND.<BR> + + JAVA: global reference to a java.awt.Component + object provided from the JNI-API.<BR> + + OS2: HWND.<BR> + MAC: Not supported<BR> @param ProcessId - obsolete - User of this api call must know if the system window handle can be shared between - both processes - means of the use the same display for output. + the process identifier. Use the sal_getGlobalProcessId + function of the RTL library. @param SystemType one constant out of the constant group diff --git a/offapi/com/sun/star/awt/XSystemDependentWindowPeer.idl b/offapi/com/sun/star/awt/XSystemDependentWindowPeer.idl index 37200a1cd852..aeb609fb159d 100644 --- a/offapi/com/sun/star/awt/XSystemDependentWindowPeer.idl +++ b/offapi/com/sun/star/awt/XSystemDependentWindowPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSystemDependentWindowPeer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -121,6 +121,9 @@ interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XTabController.idl b/offapi/com/sun/star/awt/XTabController.idl index 84bd2ed91495..c28d20eb89e1 100644 --- a/offapi/com/sun/star/awt/XTabController.idl +++ b/offapi/com/sun/star/awt/XTabController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTabController.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tbe $ $Date: 2002-09-25 12:12:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XTabControllerModel.idl b/offapi/com/sun/star/awt/XTabControllerModel.idl index 29e59eedc8d0..02b6a37887b9 100644 --- a/offapi/com/sun/star/awt/XTabControllerModel.idl +++ b/offapi/com/sun/star/awt/XTabControllerModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTabControllerModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -148,6 +148,9 @@ interface XTabControllerModel: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XTextArea.idl b/offapi/com/sun/star/awt/XTextArea.idl index 9da56ccb1abc..2dd43adebaeb 100644 --- a/offapi/com/sun/star/awt/XTextArea.idl +++ b/offapi/com/sun/star/awt/XTextArea.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextArea.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -94,6 +94,9 @@ interface XTextArea: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XTextComponent.idl b/offapi/com/sun/star/awt/XTextComponent.idl index 65f421b4be20..08be3deb6f44 100644 --- a/offapi/com/sun/star/awt/XTextComponent.idl +++ b/offapi/com/sun/star/awt/XTextComponent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextComponent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mt $ $Date: 2002-09-05 14:20:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,100 +80,81 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XTextComponent -/** gives access to the text of a text component and makes it possible +/** gives access to the text of a component and makes it possible to register event listeners. */ interface XTextComponent: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::addTextListener /** registers a text event listener. */ [oneway] void addTextListener( [in] com::sun::star::awt::XTextListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::removeTextListener /** unregisters a text event listener. */ [oneway] void removeTextListener( [in] com::sun::star::awt::XTextListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::setText - /** sets the text of the text field. + /** sets the text of the component. */ [oneway] void setText( [in] string aText ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::insertText - /** inserts text at the given position. + /** inserts text at the specified position. */ [oneway] void insertText( [in] com::sun::star::awt::Selection Sel, [in] string Text ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextComponent::getText - /** @returns - the currently set text of this text component. + /** returns the text of the component. */ string getText(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextComponent::getSelectedText - /** @returns - the currently selected text. + /** returns the currently selected text. */ string getSelectedText(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::setSelection /** sets the user selection. */ [oneway] void setSelection( [in] com::sun::star::awt::Selection aSelection ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextComponent::getSelection - /** @returns - the current user selection. + /** returns the current user selection. */ com::sun::star::awt::Selection getSelection(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextComponent::isEditable - /** @returns - whether the text is editable by the user. + /** returns if the text is editable by the user. */ boolean isEditable(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::setEditable /** makes the text editable for the user or read-only. */ [oneway] void setEditable( [in] boolean bEditable ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTextComponent::setMaxTextLen - /** specifies the maximum character count; 0 means no limit. - Value will only be considered on user interactions, not when changing the text via API. + /** sets the maximum text length. */ [oneway] void setMaxTextLen( [in] short nLen ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextComponent::getMaxTextLen - /** @returns - the currently set maximum text length. + /** returns the currently set maximum text length. */ short getMaxTextLen(); @@ -183,30 +164,4 @@ interface XTextComponent: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:13 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.5 2000/09/11 11:52:09 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:54 mi - documentation - - Revision 1.2 2000/02/07 11:24:17 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XTextEditField.idl b/offapi/com/sun/star/awt/XTextEditField.idl index 25b459af3856..f4e280dcf9ac 100644 --- a/offapi/com/sun/star/awt/XTextEditField.idl +++ b/offapi/com/sun/star/awt/XTextEditField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextEditField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,6 +93,9 @@ interface XTextEditField: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XTextLayoutConstrains.idl b/offapi/com/sun/star/awt/XTextLayoutConstrains.idl index e23c01f100fb..d337972c2780 100644 --- a/offapi/com/sun/star/awt/XTextLayoutConstrains.idl +++ b/offapi/com/sun/star/awt/XTextLayoutConstrains.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextLayoutConstrains.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,25 +76,20 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XTextLayoutConstrains -/** specifies layout contstrains for text fields. +/** specifies the layout contstraints for a text field. */ interface XTextLayoutConstrains: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextLayoutConstrains::getMinimumSize - /** @returns - the minimum size for a given number of columns and lines. + /** returns the minimum size for a given number of columns and lines. */ com::sun::star::awt::Size getMinimumSize( [in] short nCols, [in] short nLines ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XTextLayoutConstrains::getColumnsAndLines - /** @returns - returns the ideal number of columns and lines to display this text. + /** returns the ideal number of columns and lines for displaying this text. */ void getColumnsAndLines( [out] short nCols, [out] short nLines ); @@ -104,27 +99,4 @@ interface XTextLayoutConstrains: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.5 2000/09/11 11:52:09 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:54 mi - documentation - - Revision 1.2 2000/02/07 11:24:17 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XTextListener.idl b/offapi/com/sun/star/awt/XTextListener.idl index b6779c4d3997..48f064db69b3 100644 --- a/offapi/com/sun/star/awt/XTextListener.idl +++ b/offapi/com/sun/star/awt/XTextListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -97,6 +97,9 @@ interface XTextListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XTimeField.idl b/offapi/com/sun/star/awt/XTimeField.idl index bd3ea3dc1b03..ac52c7f67671 100644 --- a/offapi/com/sun/star/awt/XTimeField.idl +++ b/offapi/com/sun/star/awt/XTimeField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTimeField.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tbe $ $Date: 2002-09-24 15:04:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/awt/XToolkit.idl b/offapi/com/sun/star/awt/XToolkit.idl index ca64b9023eaf..50425b0a3446 100644 --- a/offapi/com/sun/star/awt/XToolkit.idl +++ b/offapi/com/sun/star/awt/XToolkit.idl @@ -2,9 +2,9 @@ * * $RCSfile: XToolkit.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -164,6 +164,9 @@ interface XToolkit: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 16:03:23 mi documentations syntax errors fixed diff --git a/offapi/com/sun/star/awt/XTopWindow.idl b/offapi/com/sun/star/awt/XTopWindow.idl index 32f9f808fe46..b2a26f0047a0 100644 --- a/offapi/com/sun/star/awt/XTopWindow.idl +++ b/offapi/com/sun/star/awt/XTopWindow.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTopWindow.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,34 +80,26 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XTopWindow /** manages the functionality specific for a top window. - - - - <p>A top window must implement the <type scope="com::sun::star::awt">XVclContainer</type> interface.</p> */ interface XTopWindow: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindow::addTopWindowListener - /** adds the specified window listener to receive window events from + /** adds the specified top window listener to receive window events from this window. */ [oneway] void addTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindow::removeTopWindowListener - /** removes the specified window listener so that it no longer + /** removes the specified top window listener so that it no longer receives window events from this window. */ [oneway] void removeTopWindowListener( [in] com::sun::star::awt::XTopWindowListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindow::toFront /** places this window at the top of the stacking order and shows it in front of any other windows. */ @@ -115,7 +107,6 @@ interface XTopWindow: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindow::toBack /** places this window at the bottom of the stacking order and makes the corresponding adjustment to other visible windows. */ @@ -123,7 +114,6 @@ interface XTopWindow: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindow::setMenuBar /** sets a menu bar. */ [oneway] void setMenuBar( [in] com::sun::star::awt::XMenuBar xMenu ); @@ -134,24 +124,4 @@ interface XTopWindow: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:55 hjs - initial import - - Revision 1.4 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:17 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XTopWindowListener.idl b/offapi/com/sun/star/awt/XTopWindowListener.idl index 349af0bc2c0a..55db3e4b1f9e 100644 --- a/offapi/com/sun/star/awt/XTopWindowListener.idl +++ b/offapi/com/sun/star/awt/XTopWindowListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTopWindowListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,24 +76,21 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XTopWindowListener -/** makes it possible to receive window events.@see XActivateListener +/** makes it possible to receive window events. + + @see XActivateListener */ interface XTopWindowListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowOpened - /** gets invoked when a window has been opened. + /** is invoked when a window has been opened. */ [oneway] void windowOpened( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowClosing - /** gets invoked when a window is in the process of being closed. - - + /** is invoked when a window is in the process of being closed. <p>The close operation can be overridden at this point.</p> */ @@ -101,36 +98,31 @@ interface XTopWindowListener: com::sun::star::lang::XEventListener //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowClosed - /** gets invoked when a window has been closed. + /** is invoked when a window has been closed. */ [oneway] void windowClosed( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowMinimized - /** gets invoked when a window is iconified. + /** is invoked when a window is iconified. */ [oneway] void windowMinimized( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowNormalized - /** gets invoked when a window is de-iconified. + /** is invoked when a window is de-iconified. */ [oneway] void windowNormalized( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowActivated - /** gets invoked when a window is activated. + /** is invoked when a window is activated. */ [oneway] void windowActivated( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XTopWindowListener::windowDeactivated - /** gets invoked when a window is de-activated. + /** is invoked when a window is de-activated. */ [oneway] void windowDeactivated( [in] com::sun::star::lang::EventObject e ); @@ -140,21 +132,4 @@ interface XTopWindowListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:54 hjs - initial import - - Revision 1.3 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XUnoControlContainer.idl b/offapi/com/sun/star/awt/XUnoControlContainer.idl index 0b922f400b55..8632485b9dfe 100644 --- a/offapi/com/sun/star/awt/XUnoControlContainer.idl +++ b/offapi/com/sun/star/awt/XUnoControlContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnoControlContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,36 +76,30 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XUnoControlContainer -/** gives access to the tab controllers of a control container. +/** gives access to the tab controllers of a <type>UnoControlContainer</type>. */ interface XUnoControlContainer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XUnoControlContainer::setTabControllers /** sets a set of tab controllers. */ [oneway] void setTabControllers( [in] sequence<com::sun::star::awt::XTabController> TabControllers ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XUnoControlContainer::getTabControllers - /** @returns - all currently specified tab controllers. + /** returns all currently specified tab controllers. */ sequence<com::sun::star::awt::XTabController> getTabControllers(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XUnoControlContainer::addTabController /** adds a single tab controller. */ [oneway] void addTabController( [in] com::sun::star::awt::XTabController TabController ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XUnoControlContainer::removeTabController /** removes a single tab controller. */ [oneway] void removeTabController( [in] com::sun::star::awt::XTabController TabController ); @@ -116,27 +110,4 @@ interface XUnoControlContainer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:55 hjs - initial import - - Revision 1.5 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.3 2000/05/16 12:19:54 mi - documentation - - Revision 1.2 2000/02/07 11:24:17 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XVclContainer.idl b/offapi/com/sun/star/awt/XVclContainer.idl index ba02f8ccf63f..16c8383f01c9 100644 --- a/offapi/com/sun/star/awt/XVclContainer.idl +++ b/offapi/com/sun/star/awt/XVclContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVclContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -130,6 +130,9 @@ interface XVclContainer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XVclContainerListener.idl b/offapi/com/sun/star/awt/XVclContainerListener.idl index bcd2907bf5c5..711877749cb8 100644 --- a/offapi/com/sun/star/awt/XVclContainerListener.idl +++ b/offapi/com/sun/star/awt/XVclContainerListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVclContainerListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -124,6 +124,9 @@ interface XVclContainerListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XVclContainerPeer.idl b/offapi/com/sun/star/awt/XVclContainerPeer.idl index 321bc1a03da6..891bc86989a0 100644 --- a/offapi/com/sun/star/awt/XVclContainerPeer.idl +++ b/offapi/com/sun/star/awt/XVclContainerPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVclContainerPeer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -110,6 +110,9 @@ interface XVclContainerPeer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XVclWindowPeer.idl b/offapi/com/sun/star/awt/XVclWindowPeer.idl index e08bbbb2cca6..987513c0f878 100644 --- a/offapi/com/sun/star/awt/XVclWindowPeer.idl +++ b/offapi/com/sun/star/awt/XVclWindowPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVclWindowPeer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -150,6 +150,9 @@ interface XVclWindowPeer: com::sun::star::awt::XWindowPeer /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/awt/XView.idl b/offapi/com/sun/star/awt/XView.idl index cc0a44aa641b..848830b656de 100644 --- a/offapi/com/sun/star/awt/XView.idl +++ b/offapi/com/sun/star/awt/XView.idl @@ -2,9 +2,9 @@ * * $RCSfile: XView.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,67 +80,47 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XView /** makes it possible to attach an oputput device to the object. - - - <p>This kind of object is called view-object.</p>@see XViewable + <p>This kind of object is called view-object.</p> */ interface XView: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XView::setGraphics /** sets the output device. - - @see XView::getDevice */ boolean setGraphics( [in] com::sun::star::awt::XGraphics aDevice ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XView::getGraphics - /** @returns - the output device which was set using the method - <member>XView::setGraphics()</member> - - @see XView::setDevice + /** returns the output device which was set using the method + <member>XView::setGraphics</member>. */ com::sun::star::awt::XGraphics getGraphics(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XView::getSize - /** @returns - the size of the object in device units. A device must be set before. + /** returns the size of the object in device units. - @see XView::draw + <p>A device must be set before.</p> */ com::sun::star::awt::Size getSize(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XView::draw /** draws the object at the specified position. - - <p>If the output should be clipped, the caller has to set the - clipping region. </p> - - @see XView::getSize + clipping region.</p> */ [oneway] void draw( [in] long nX, [in] long nY ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XView::setZoom /** sets the zoom factor. - - <p>The zoom factor only affects the content of the view, not the size.</p> */ [oneway] void setZoom( [in] float fZoomX, @@ -152,24 +132,4 @@ interface XView: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/19 16:03:23 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XWindow.idl b/offapi/com/sun/star/awt/XWindow.idl index 74ce32b57545..8749b1b6ba01 100644 --- a/offapi/com/sun/star/awt/XWindow.idl +++ b/offapi/com/sun/star/awt/XWindow.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWindow.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,23 +100,35 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XWindow /** specifies the basic operations for a window component. - - - <p>A windows is a rectangular region on an output device with - its own position, size, and internal coordinate system. Despite of - displaying the main sense of a window is to receive events from - the user.</p> + <p>A window is a rectangular region on an output device with + its own position, size, and internal coordinate system. + A window is used for displaying data. In addition, the window + receives events from the user.</p> */ interface XWindow: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::setPosSize /** sets the outer bounds of the window. - */ + + @param X + the x-coordinate of the window. + + @param Y + the y-coordinate of the window. + + @param Width + the width of the window. + + @param Height + the height of the window. + + @param Flags + Flags are of type <type>PosSize</type> and specify, which parameters + are taken into account when setting the outer bounds of the window. + */ [oneway] void setPosSize( [in] long X, [in] long Y, [in] long Width, @@ -125,126 +137,97 @@ interface XWindow: com::sun::star::lang::XComponent //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::awt::XWindow::getPosSize - /** @returns - the outer bounds of the window. + /** returns the outer bounds of the window. */ com::sun::star::awt::Rectangle getPosSize(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::setVisible /** shows or hides the window depending on the parameter. */ [oneway] void setVisible( [in] boolean Visible ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::setEnable /** enables or disables the window depending on the parameter. */ [oneway] void setEnable( [in] boolean Enable ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::setFocus /** sets the focus to the window. */ [oneway] void setFocus(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addWindowListener - /** adds the specified component listener to receive component events - from this window component. + /** adds a window listener to the object. */ [oneway] void addWindowListener( [in] com::sun::star::awt::XWindowListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removeWindowListener - /** removes the specified listener so it no longer receives component - events from this window component. + /** removes the specified window listener from the listener list. */ [oneway] void removeWindowListener( [in] com::sun::star::awt::XWindowListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addFocusListener - /** adds the specified focus listener to receive focus events - from this window component. + /** adds a focus listener to the object. */ [oneway] void addFocusListener( [in] com::sun::star::awt::XFocusListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removeFocusListener - /** removes the specified focus listener so it no longer receives focus - events from this component. + /** removes the specified focus listener from the listener list. */ [oneway] void removeFocusListener( [in] com::sun::star::awt::XFocusListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addKeyListener - /** adds the specified key listener to receive key events - from this component. + /** adds a key listener to the object. */ [oneway] void addKeyListener( [in] com::sun::star::awt::XKeyListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removeKeyListener - /** removes the specified key listener so it no longer receives key - events from this component. + /** removes the specified key listener from the listener list. */ [oneway] void removeKeyListener( [in] com::sun::star::awt::XKeyListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addMouseListener - /** adds the specified mouse listener to receive mouse events - from this component. + /** adds a mouse listener to the object. */ [oneway] void addMouseListener( [in] com::sun::star::awt::XMouseListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removeMouseListener - /** removes the specified mouse listener so it no longer receives mouse - events from this component. + /** removes the specified mouse listener from the listener list. */ [oneway] void removeMouseListener( [in] com::sun::star::awt::XMouseListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addMouseMotionListener - /** adds the specified mouse motion listener to receive mouse motion events - from this component. + /** adds a mouse motion listener to the object. */ [oneway] void addMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removeMouseMotionListener - /** removes the specified mouse motion listener so it no longer - receives mouse motion events from this component. + /** removes the specified mouse motion listener from the listener list. */ [oneway] void removeMouseMotionListener( [in] com::sun::star::awt::XMouseMotionListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::addPaintListener - /** adds the specified paint listener to receive panit events - from this component. + /** adds a paint listener to the object. */ [oneway] void addPaintListener( [in] com::sun::star::awt::XPaintListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindow::removePaintListener - /** removes the specified paint listener so it no longer - receives paint events from this component. + /** removes the specified paint listener from the listener list. */ [oneway] void removePaintListener( [in] com::sun::star::awt::XPaintListener xListener ); @@ -254,24 +237,4 @@ interface XWindow: com::sun::star::lang::XComponent }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:50 hjs - initial import - - Revision 1.4 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:54 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XWindowListener.idl b/offapi/com/sun/star/awt/XWindowListener.idl index 603a1154f483..815624f4eb9d 100644 --- a/offapi/com/sun/star/awt/XWindowListener.idl +++ b/offapi/com/sun/star/awt/XWindowListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWindowListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,45 +80,36 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::awt::XWindowListener /** makes it possible to receive window events. - - <p>Component events are provided <strong>only</strong> for notification purposes. Moves and resizes will be handled interally by the window component, so that GUI layout works properly - regardless of whether a program registers such a listener or not. - - </p> + regardless of whether a program registers such a listener or not.</p> */ interface XWindowListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindowListener::windowResized - /** gets invoked when the window has been resized. + /** is invoked when the window has been resized. */ [oneway] void windowResized( [in] com::sun::star::awt::WindowEvent e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindowListener::windowMoved - /** gets invoked when the window has been moved. + /** is invoked when the window has been moved. */ [oneway] void windowMoved( [in] com::sun::star::awt::WindowEvent e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindowListener::windowShown - /** gets invoked when the window has been shown. + /** is invoked when the window has been shown. */ [oneway] void windowShown( [in] com::sun::star::lang::EventObject e ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::awt::XWindowListener::windowHidden - /** gets invoked when the window has been hidden. + /** is invoked when the window has been hidden. */ [oneway] void windowHidden( [in] com::sun::star::lang::EventObject e ); @@ -128,21 +119,4 @@ interface XWindowListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:11 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:55 hjs - initial import - - Revision 1.3 2000/09/11 11:52:10 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/awt/XWindowPeer.idl b/offapi/com/sun/star/awt/XWindowPeer.idl index 8cb30f8b5997..9c0cc1055a9f 100644 --- a/offapi/com/sun/star/awt/XWindowPeer.idl +++ b/offapi/com/sun/star/awt/XWindowPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWindowPeer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:01:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -128,6 +128,9 @@ interface XWindowPeer: com::sun::star::lang::XComponent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2001/03/16 16:41:13 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:11 mi moved from api diff --git a/offapi/com/sun/star/chart/AreaDiagram.idl b/offapi/com/sun/star/chart/AreaDiagram.idl index 0bfd9525a437..db09ce0f3242 100644 --- a/offapi/com/sun/star/chart/AreaDiagram.idl +++ b/offapi/com/sun/star/chart/AreaDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: AreaDiagram.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,32 +96,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::AreaDiagram /** This is a service for area diagrams. */ service AreaDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartTwoAxisYSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisZSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::Dim3DDiagram; - - // DocMerge: empty anyway service com::sun::star::chart::StackableDiagram; - }; //============================================================================= @@ -131,6 +116,12 @@ service AreaDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/BarDiagram.idl b/offapi/com/sun/star/chart/BarDiagram.idl index 6aa50b439e4c..e8bbfbe65a4b 100644 --- a/offapi/com/sun/star/chart/BarDiagram.idl +++ b/offapi/com/sun/star/chart/BarDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: BarDiagram.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,65 +96,47 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::BarDiagram -/**This is a service for bar diagrams. +/**This is a service for bar and column diagrams. */ service BarDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartTwoAxisYSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisZSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::Dim3DDiagram; - - // DocMerge: empty anyway service com::sun::star::chart::StackableDiagram; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::BarDiagram::Vertical - /** Determines if a chart is drawn vertically or - horizontally. + /** Determines if the bars of a chart are drawn vertically or + horizontally. Default is vertical. + + <p>If Vertical is <FALSE/> you get a column chart rather than + a bar chart.</p> */ [property] boolean Vertical; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::BarDiagram::Deep - /** Determines if a 3-dimensional bar chart is displayed - as a deep chart with a z-axis (real 3D chart) or as a - 2-dimensional xy chart with 3-dimensional graphics. - - @optional + /** If <TRUE/>, determines that in a three-dimensional bar chart + the bars of each series are arranged behind each other in the + z-direction. If <FALSE/> the arrangement of bars is like in + two-dimensional bar charts. */ [optional, property] boolean Deep; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::BarDiagram::StackedBarsConnected - /** Determines if there are connecting lines between - stacked bar charts. Currently, vertical bar charts do not support - this property. - - @optional + /** determines if, in a stacked chart, there are connecting lines + between corresponding bars. Currently, bar charts with + horizontal bars do not support this property. */ [optional, property] boolean StackedBarsConnected; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::BarDiagram::NumberOfLines /** Determines how many data rows are displayed as lines rather than bars. @@ -174,6 +156,15 @@ service BarDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/01/29 15:58:52 bm + #96984# IDL Review -- second check + + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2001/01/23 10:08:02 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/chart/Chart3DBarProperties.idl b/offapi/com/sun/star/chart/Chart3DBarProperties.idl index bc46e6aca112..cf78673cc41b 100644 --- a/offapi/com/sun/star/chart/Chart3DBarProperties.idl +++ b/offapi/com/sun/star/chart/Chart3DBarProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: Chart3DBarProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,18 +71,15 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::Chart3DBarProperties /** Specifies all the properties for the graphic object of a data point in a three-dimensional bar diagram.@see BarDiagram */ service Chart3DBarProperties { - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::Chart3DBarProperties::SolidType /** Specifies the solid shape of a data point.@see ChartSolidType */ [property] long SolidType; @@ -96,6 +93,12 @@ service Chart3DBarProperties /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartArea.idl b/offapi/com/sun/star/chart/ChartArea.idl index d4e5d27f97c9..323e13801f7c 100644 --- a/offapi/com/sun/star/chart/ChartArea.idl +++ b/offapi/com/sun/star/chart/ChartArea.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartArea.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,22 +80,15 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartArea /** Specifies the area elements of a chart, e.g. the background area, the diagram wall, and the diagram floor of three-dimensional charts. */ service ChartArea { - // DocMerge: empty anyway service com::sun::star::drawing::FillProperties; - - // DocMerge: empty anyway service com::sun::star::drawing::LineProperties; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - }; //============================================================================= @@ -105,6 +98,12 @@ service ChartArea /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2001/03/07 13:57:13 cl cleanup of shape services diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index ce3c37747a26..7cd4037bc9f8 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxis.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,6 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartAxis /** Specifies the axes in a diagram. <p>Note: The text properties correlate to all axis description @@ -94,54 +93,49 @@ service ChartAxis { - /** Contains all the drawing and text properties. + /** set the properties for the entire axis line as well as for the + tick marks. */ service com::sun::star::drawing::LineProperties; - // DocMerge: empty anyway + /** set the properties for all text labels of the axis + */ service com::sun::star::style::CharacterProperties; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Max /** Contains the maximum value for the axis scale. */ [optional, property] double Max; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Min /** Contains the minimum value for the axis scale. */ [optional, property] double Min; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Origin /** Contains the origin of the axis scale. */ [optional, property] double Origin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::StepMain /** Contains the distance between the main tick marks. */ [optional, property] double StepMain; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::StepHelp /** Contains the distance between the help tick marks. */ [optional, property] double StepHelp; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::AutoMax /** The maximium value of the axis scale is calculated by the chart if this property is <TRUE/>. */ @@ -149,7 +143,6 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::AutoMin /** The minimum value of the axis scale is calculated by the chart if this property is <TRUE/>. */ @@ -157,22 +150,12 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::AutoOrigin - /** The origin is calculated by the chart if this property is . -<!--- JRH: Please insert <TRUE/> or <FALSE/> --->*/ + /** The origin is calculated by the chart if this property is <TRUE/>. + */ [optional, property] boolean AutoOrigin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::AutoStepHelp - /** The distance between the help tick marks is calculated by the - chart if this property is . -<!--- JRH: Please insert <TRUE/> or <FALSE/> --->*/ - [optional, property] boolean AutoStepHelp; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::chart::ChartAxis::AutoStepMain /** The distance between the main tick marks is calculated by the chart if this property is <TRUE/>. */ @@ -180,7 +163,14 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Logarithmic + /** The distance between the help tick marks is calculated by the + chart if this property is <TRUE/>. + */ + [optional, property] boolean AutoStepHelp; + + + //------------------------------------------------------------------------- + /** Determines if the axis is scaled logarithmically or not (linear). */ @@ -188,14 +178,12 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::chart::ChartAxis::DisplayLabels /** Determines whether to display text at the axis or not. */ [property] boolean DisplayLabels; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::TextRotation /** Determines the rotation of the text elements (axis description) in 100th degrees. */ @@ -203,21 +191,18 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Marks /** Determines the position of the marks.@see ChartAxisMarks */ [property] long Marks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::HelpMarks /** Determines the position of the help marks.@see ChartAxisMarks */ [property] long HelpMarks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::Overlap /** Determines the overlap of the bars in a bar-type chart. <p>The value is given in percent of the width of the bars. The @@ -228,7 +213,6 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::GapWidth /** Specifies the width of the gaps between each set of data points in a bar chart. @@ -239,7 +223,6 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::ArrangeOrder /** The axis description may be arranged in a special order for a better placement. */ @@ -247,7 +230,6 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::TextBreak /** Determines if long text is broken into multiple lines. */ [property] boolean TextBreak; @@ -261,8 +243,9 @@ service ChartAxis //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxis::NumberFormat - /** Contains the type id for the number formatter of the axis.@see com::sun::star::util::XNumberFormatter + /** Contains the type id for the number formatter of the axis. + + @see com::sun::star::util::XNumberFormatter */ [property] long NumberFormat; @@ -275,6 +258,12 @@ service ChartAxis /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.7 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.6 2001/03/07 14:19:25 cl cleanup of shape services diff --git a/offapi/com/sun/star/chart/ChartAxisArrangeOrderType.idl b/offapi/com/sun/star/chart/ChartAxisArrangeOrderType.idl index 66b70d6e36d5..f6794a6020cf 100644 --- a/offapi/com/sun/star/chart/ChartAxisArrangeOrderType.idl +++ b/offapi/com/sun/star/chart/ChartAxisArrangeOrderType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisArrangeOrderType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,14 +68,12 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartAxisArrangeOrderType /** Values specify the arrangement of the axes descriptions. */ enum ChartAxisArrangeOrderType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartAxisArrangeOrderType::AUTO /** The descriptions are arranged automatically. <p>If there is enough space to put them side by side, this @@ -86,14 +84,12 @@ enum ChartAxisArrangeOrderType //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartAxisArrangeOrderType::SIDE_BY_SIDE /** The descriptions are arranged side by side. */ SIDE_BY_SIDE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartAxisArrangeOrderType::STAGGER_EVEN /** The descriptions are alternately put on two lines with the even values out of the normal line. */ @@ -101,12 +97,10 @@ enum ChartAxisArrangeOrderType //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartAxisArrangeOrderType::STAGGER_ODD /** The descriptions are alternately put on two lines with the odd values out of the normal line. */ STAGGER_ODD - }; //============================================================================= @@ -116,6 +110,12 @@ enum ChartAxisArrangeOrderType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartAxisAssign.idl b/offapi/com/sun/star/chart/ChartAxisAssign.idl index 668be11d237c..f059ddd67657 100644 --- a/offapi/com/sun/star/chart/ChartAxisAssign.idl +++ b/offapi/com/sun/star/chart/ChartAxisAssign.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisAssign.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,22 +68,19 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::chart::ChartAxisAssign /** These values specify to which y-axis a data row is assigned. */ constants ChartAxisAssign { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartAxisAssign::PRIMARY_Y - /** Assign row to primary y axis + /** Assign row to primary <i>y</i>-axis */ const long PRIMARY_Y = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartAxisAssign::SECONDARY_Y - /** Assign row to secondary y axis + /** Assign row to secondary <i>y</i>-axis */ const long SECONDARY_Y = 4; @@ -96,6 +93,12 @@ constants ChartAxisAssign /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartAxisMarks.idl b/offapi/com/sun/star/chart/ChartAxisMarks.idl index 8b44459f5d62..93dc4e9b2bce 100644 --- a/offapi/com/sun/star/chart/ChartAxisMarks.idl +++ b/offapi/com/sun/star/chart/ChartAxisMarks.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisMarks.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,31 +68,30 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::chart::ChartAxisMarks -/** These are the positions for the marks of an axis. +/** With these constants you can specify how the tick-marks of an axis + are displayed. - <p>The values are combinable, an arithmetical <em>or</em> operation. + <p>You can combine <code>INNER</code> and <code>OUTER</code> with + an arithmetical <em>or</em>-operation to get tick-marks that + extend in both directions.</p> */ constants ChartAxisMarks { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartAxisMarks::NONE - /** No marks. + /** Do not display any marks. */ const long NONE = 0; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartAxisMarks::INNER - /** Marks inside the diagram area. + /** Display marks that point into the diagram area. */ const long INNER = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartAxisMarks::OUTER - /** Marks outside the diagram area. + /** Display marks that point out of the diagram area. */ const long OUTER = 2; @@ -105,6 +104,12 @@ constants ChartAxisMarks /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartAxisXSupplier.idl b/offapi/com/sun/star/chart/ChartAxisXSupplier.idl index 40b795c33e48..acd6cfa3c302 100644 --- a/offapi/com/sun/star/chart/ChartAxisXSupplier.idl +++ b/offapi/com/sun/star/chart/ChartAxisXSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisXSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,24 +72,23 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartAxisXSupplier -/** A helper service for the x-axis. +/** has to be supported by charts providing the cpabilities of a + horizontal axis, i.e., an <em>x</em>-axis. */ service ChartAxisXSupplier { - // DocMerge: empty anyway + /** offers access to the axis object, the title, and the grids + */ interface com::sun::star::chart::XAxisXSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisXSupplier::HasXAxis /** This property determines if the x-axis is shown or hidden.@see ChartAxis */ [property] boolean HasXAxis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisXSupplier::HasXAxisDescription /** Determines if the description of the x-axis is shown or hidden. */ @@ -97,7 +96,6 @@ service ChartAxisXSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisXSupplier::HasXAxisGrid /** Determines if the major grid of the x-axis is shown or hidden.@see ChartGrid */ @@ -105,7 +103,6 @@ service ChartAxisXSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisXSupplier::HasXAxisHelpGrid /** Determines if the minor grid of the x-axis is shown or hidden.@see ChartGrid */ @@ -113,7 +110,6 @@ service ChartAxisXSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisXSupplier::HasXAxisTitle /** Determines if the title of the x-axis is shown or hidden.@see ChartTitle */ @@ -128,6 +124,12 @@ service ChartAxisXSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/ChartAxisYSupplier.idl b/offapi/com/sun/star/chart/ChartAxisYSupplier.idl index b1b8d04a3a66..1dc74e3a5bb4 100644 --- a/offapi/com/sun/star/chart/ChartAxisYSupplier.idl +++ b/offapi/com/sun/star/chart/ChartAxisYSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisYSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,24 +72,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartAxisYSupplier /** A helper service for the y-axis. */ service ChartAxisYSupplier { - // DocMerge: empty anyway + /** offers access to the axis object, the title, and the grids + */ interface com::sun::star::chart::XAxisYSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisYSupplier::HasYAxis /** Determines if the y-axis is shown or hidden.@see ChartAxis */ [property] boolean HasYAxis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisYSupplier::HasYAxisDescription /** Determines if the description of the y-axis is shown or hidden. */ @@ -97,7 +95,6 @@ service ChartAxisYSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisYSupplier::HasYAxisGrid /** Determines if the major grid of the y-axis is shown or hidden.@see ChartGrid */ @@ -105,7 +102,6 @@ service ChartAxisYSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisYSupplier::HasYAxisHelpGrid /** Determines if the minor grid of the y-axis is shown or hidden.@see ChartGrid */ @@ -113,7 +109,6 @@ service ChartAxisYSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisYSupplier::HasYAxisTitle /** Determines if the title of the y-axis is shown or hidden.@see ChartTitle */ @@ -128,6 +123,12 @@ service ChartAxisYSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/ChartAxisZSupplier.idl b/offapi/com/sun/star/chart/ChartAxisZSupplier.idl index 6ecf0b93d20d..a8c315286027 100644 --- a/offapi/com/sun/star/chart/ChartAxisZSupplier.idl +++ b/offapi/com/sun/star/chart/ChartAxisZSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartAxisZSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,24 +72,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartAxisZSupplier /** A helper service for chart documents which supply a z-axis. */ service ChartAxisZSupplier { - // DocMerge: empty anyway + /** offers access to the axis object, the title, and the grids + */ interface com::sun::star::chart::XAxisZSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisZSupplier::HasZAxis /** Determines if the z-axis is shown or hidden.@see ChartAxis */ [property] boolean HasZAxis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisZSupplier::HasZAxisDescription /** Determines if the description of the z-axis is shown or hidden. */ @@ -97,7 +95,6 @@ service ChartAxisZSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisZSupplier::HasZAxisGrid /** Determines if the major grid of the z-axis is shown or hidden.@see ChartGrid */ @@ -105,7 +102,6 @@ service ChartAxisZSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisZSupplier::HasZAxisHelpGrid /** Determines if the minor grid of the z-axis is shown or hidden.@see ChartGrid */ @@ -113,12 +109,10 @@ service ChartAxisZSupplier //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartAxisZSupplier::HasZAxisTitle /** Determines if the title of the z-axis is shown or hidden.@see ChartTitle */ [property] boolean HasZAxisTitle; - }; //============================================================================= @@ -128,6 +122,12 @@ service ChartAxisZSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/ChartData.idl b/offapi/com/sun/star/chart/ChartData.idl index 187b14ee0068..f8ebced8e278 100644 --- a/offapi/com/sun/star/chart/ChartData.idl +++ b/offapi/com/sun/star/chart/ChartData.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartData.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartData -/** "ChartData" is a basic service for the chart data. +/** must be supported by every component that wants to provide data + for a chart */ service ChartData { - // DocMerge: empty anyway interface com::sun::star::chart::XChartData; - }; //============================================================================= @@ -89,6 +87,12 @@ service ChartData /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartDataArray.idl b/offapi/com/sun/star/chart/ChartDataArray.idl index 86abedd0065a..2d593a7c28d3 100644 --- a/offapi/com/sun/star/chart/ChartDataArray.idl +++ b/offapi/com/sun/star/chart/ChartDataArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataArray.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,25 +80,16 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartDataArray -/** the internal or external data source for charts. +/** must be supported by each data source for charts, where you want + to access the values directly. - - - <p>It contains the data values and the descriptions for each row - and each column.</p> + <p>It contains the data values as well as the descriptions for + each row and column.</p> */ service ChartDataArray { - // DocMerge: empty anyway service com::sun::star::chart::ChartData; - - // DocMerge: empty anyway interface com::sun::star::chart::XChartDataArray; - - // DocMerge: empty anyway - interface com::sun::star::chart::XChartData; - }; //============================================================================= @@ -108,6 +99,12 @@ service ChartDataArray /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:01 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartDataCaption.idl b/offapi/com/sun/star/chart/ChartDataCaption.idl index 1e67cdcf3d7d..87f420090dd0 100644 --- a/offapi/com/sun/star/chart/ChartDataCaption.idl +++ b/offapi/com/sun/star/chart/ChartDataCaption.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataCaption.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: bm $ $Date: 2001-05-17 15:12:55 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,43 +68,46 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::chart::ChartDataCaption -/** These values specify how the caption of data points is displayed. +/** These values specify how the captions of data points are displayed. */ constants ChartDataCaption { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::NONE - /** No caption for data points is displayed. + /** No captions are displayed. */ const long NONE = 0; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::VALUE - /** The value of the data points is displayed as caption. + /** The caption contains the value of the data point in the number + format of the axis that is attached to the respective data + series. */ const long VALUE = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::PERCENT - /** The percent value of the data points is displayed as caption. + /** The caption contains the value of the data point in percent of + all data points of one category. + + <p>That means, if a data point is the first one of a series, + the percentage is calculated by using the first data points of + all available series.</p> */ const long PERCENT = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::TEXT - /** The title of the column/row of the data point is displayed as caption. + /** The caption contains the category name of the category to + which a data point belongs. */ const long TEXT = 4; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::FORMAT - /** The number formatter is used for displaying the value. + /** The number formatter is always used for displaying the value + as value. So this setting is deprecated. @deprecated */ @@ -112,11 +115,9 @@ constants ChartDataCaption //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartDataCaption::SYMBOL /** The symbol of data column/row is additionally displayed in the caption. */ const long SYMBOL = 16; - }; //============================================================================= @@ -126,6 +127,12 @@ constants ChartDataCaption /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.12.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/05/17 15:12:55 bm + #87095# FORMAT is deprecated + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartDataChangeEvent.idl b/offapi/com/sun/star/chart/ChartDataChangeEvent.idl index 81d742e08783..4f6a475703d1 100644 --- a/offapi/com/sun/star/chart/ChartDataChangeEvent.idl +++ b/offapi/com/sun/star/chart/ChartDataChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataChangeEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,42 +76,36 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::chart::ChartDataChangeEvent /** describes a change that was applied to the data. */ struct ChartDataChangeEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataChangeEvent::Type /** specifies the type of change to the data. */ com::sun::star::chart::ChartDataChangeType Type; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataChangeEvent::StartColumn /** specifies the column number in which the changes begin. */ short StartColumn; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataChangeEvent::EndColumn /** specifies the column number in which the changes end. */ short EndColumn; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataChangeEvent::StartRow /** specifies the row number in which the changes begin. */ short StartRow; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataChangeEvent::EndRow /** specifies the row number in which the changes end. */ short EndRow; @@ -125,6 +119,12 @@ struct ChartDataChangeEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:01 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartDataChangeType.idl b/offapi/com/sun/star/chart/ChartDataChangeType.idl index 7a604f51b4f8..f35ae6788e15 100644 --- a/offapi/com/sun/star/chart/ChartDataChangeType.idl +++ b/offapi/com/sun/star/chart/ChartDataChangeType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataChangeType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,50 +68,48 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartDataChangeType /** specifies the type of change that was applied to the data. */ enum ChartDataChangeType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::ALL - /** major changes were applied to the data. + /** Major changes were applied to the data. */ ALL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::DATA_RANGE - /** specified range of columns and rows changed. + /** The range of columns and rows, given in the + <type>ChartDataChangeEvent</type>, has changed. */ DATA_RANGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::COLUMN_INSERTED - /** specified data column was inserted. + /** The column given in the <type>ChartDataChangeEvent</type>, was + inserted. */ COLUMN_INSERTED, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::ROW_INSERTED - /** specified data row was inserted. + /** The row given in the <type>ChartDataChangeEvent</type>, was + inserted. */ ROW_INSERTED, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::COLUMN_DELETED - /** specified data column was deleted. - */ + /** The column given in the <type>ChartDataChangeEvent</type>, was + deleted. + */ COLUMN_DELETED, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataChangeType::ROW_DELETED - /** specified data row was deleted. + /** The row given in the <type>ChartDataChangeEvent</type>, was + deleted. */ ROW_DELETED @@ -124,6 +122,12 @@ enum ChartDataChangeType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:01 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartDataPoint.idl b/offapi/com/sun/star/chart/ChartDataPoint.idl index 747b4d706eae..46d2af457a8a 100644 --- a/offapi/com/sun/star/chart/ChartDataPoint.idl +++ b/offapi/com/sun/star/chart/ChartDataPoint.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataPoint.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,7 @@ module com { module sun { module star { module chart { //============================================================================= -/** +/** @deprecated */ typedef sequence<ChartDataValue> ChartDataPoint; diff --git a/offapi/com/sun/star/chart/ChartDataPointProperties.idl b/offapi/com/sun/star/chart/ChartDataPointProperties.idl index de3248df406f..3e22bb93ad6a 100644 --- a/offapi/com/sun/star/chart/ChartDataPointProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataPointProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataPointProperties.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,66 +87,68 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartDataPointProperties /** specifies all the properties for the graphic object of a data point (e.g., a single bar in a bar chart). + <p>Text properties correlate to the data description of the data + point. There is a similar service for a group of graphic elements + called <type>ChartDataRowProperties</type> for the properties of + whole data rows.</p> - - <p>Text properties correlate to the data description of the data point. - There is a similar service for a group of graphic elements called - <type>ChartDataRowProperties</type> for the properties of whole data rows. - - </p>@see ChartDataRowProperties + @see ChartDataRowProperties */ service ChartDataPointProperties { - // DocMerge: empty anyway - service com::sun::star::drawing::FillProperties; + /** This service has to be supported for data points that can be + filled. + */ + [optional] service com::sun::star::drawing::FillProperties; - // DocMerge: empty anyway service com::sun::star::drawing::LineProperties; - // DocMerge: empty anyway + /** These properties affect the characters of data captions if + those are displayed. + */ service com::sun::star::style::CharacterProperties; //------------------------------------------------------------------------- - // DocMerge from xml: service com::sun::star::chart::ChartDataPointProperties: service com::sun::star::chart::Chart3DBarProperties /** is only available if the chart is of type - <type>BarDiagram</type> and <type>Dim3DDiagram</type> - and the property <member>Dim3D</member> is set to <TRUE/>. + <type>BarDiagram</type> and <type>Dim3DDiagram</type> and the + property <member>ChartDataPointProperties::Dim3D</member> is + set to <TRUE/>. - @see BarDiagram - @see Dim3DDiagram@see BarDiagram - @see Dim3DDiagram + @see BarDiagram + @see Dim3DDiagram@see BarDiagram + @see Dim3DDiagram */ - service com::sun::star::chart::Chart3DBarProperties; + [optional] service com::sun::star::chart::Chart3DBarProperties; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataPointProperties::DataCaption /** specifies how the captions of data points are displayed.@see ChartDataCaption */ [property] long DataCaption; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataPointProperties::SymbolType - /** specifies the type of symbol. + /** specifies the type of symbols if the current chart type + supports the usage of symbols. - @optional @see ChartSymbolType */ [optional, property] long SymbolType; //------------------------------------------------------------------------- - /** specifies the type of symbol. + /** In charts that support symbols, you can set this property to + any valid URL that points to a graphic file. This graphic is + then used as symbol for each data point. + + <p>When you query this value you get an internal URL of the + embedded graphic.</p> - @optional @see ChartSymbolType */ [optional, property] string SymbolBitmapURL; @@ -159,6 +161,15 @@ service ChartDataPointProperties /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8.2.2 2002/01/29 15:58:52 bm + #96984# IDL Review -- second check + + Revision 1.8.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.8 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.7 2001/03/07 13:57:13 cl cleanup of shape services diff --git a/offapi/com/sun/star/chart/ChartDataRow.idl b/offapi/com/sun/star/chart/ChartDataRow.idl index 1658c25cfec5..7647ff873cb7 100644 --- a/offapi/com/sun/star/chart/ChartDataRow.idl +++ b/offapi/com/sun/star/chart/ChartDataRow.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataRow.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,28 +71,23 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::chart::ChartDataRow /** describes a single data row, specified by its name and a sequence of data points. - - - + <p>This struct is currently used nowhere.</p> @deprecated */ struct ChartDataRow { - // DocMerge from xml: field com::sun::star::chart::ChartDataRow::Name /** The name of the data row. */ string Name; //------------------------------------------------------------------------- - - // DocMerge: empty anyway + /** The points contained in this data row. + */ sequence< sequence<ChartDataValue> > Points; - }; //============================================================================= @@ -102,6 +97,12 @@ struct ChartDataRow /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartDataRowProperties.idl b/offapi/com/sun/star/chart/ChartDataRowProperties.idl index 6a8efa846958..d33d26b08378 100644 --- a/offapi/com/sun/star/chart/ChartDataRowProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataRowProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataRowProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,64 +80,64 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartDataRowProperties -/** specifies the properties for a group of graphic elements - which belong to a data row. - - +/** specifies the properties for a group of graphic elements which + belong to a data row (also known as data series). <p>For this service, the properties supported by - <type>ChartDataPointProperties</type> are applied to all data point - elements contained in this group. + <type>ChartDataPointProperties</type> are applied to all data + point elements contained in this group. They serve as a template; + thus, when changing a data point property afterwards</p> - </p> - <p>Note: Statistical properties are not available for all types of - diagrams. - - </p>@see ChartDataPointProperties + @see ChartDataPointProperties */ service ChartDataRowProperties { - // DocMerge: empty anyway service com::sun::star::chart::ChartDataPointProperties; - - // DocMerge: empty anyway - service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway + /** Statistical properties are not available for all types of + diagrams. + */ + [optional] service com::sun::star::chart::ChartStatistics; interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataRowProperties::Axis - /** determines to which axis the row is assigned. - - + /** determines to which axis the data row is assigned. - <p>It must be a y-axis (primary or secondary y-axis) + <p>The axis must be a primary or secondary y-axis</p> - </p>@see ChartAxisAssign + @see ChartAxisAssign + @see ChartAxisYSupplier + @see ChartTwoAxisYSupplier */ [property] long Axis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataRowProperties::DataRegressionProperties - /** holds the properties of the regression line.@see ChartLine + /** holds the properties of the regression line, if such one is + enabled. + + @see ChartLine + @see ChartStatistics */ [optional, readonly, property] com::sun::star::beans::XPropertySet DataRegressionProperties; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataRowProperties::DataErrorProperties - /** holds the properties of the error markers.@see ChartLine + /** holds the properties of the error markers, if those are + enabled. + + @see ChartLine + @see ChartStatistics */ [optional, readonly, property] com::sun::star::beans::XPropertySet DataErrorProperties; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDataRowProperties::DataMeanValueProperties - /** holds the properties of the average line.@see ChartLine + /** holds the properties of the average line, if such one is + enabled. + + @see ChartLine + @see ChartStatistics */ [optional, readonly, property] com::sun::star::beans::XPropertySet DataMeanValueProperties; }; @@ -149,6 +149,15 @@ service ChartDataRowProperties /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/01/29 15:58:52 bm + #96984# IDL Review -- second check + + Revision 1.4.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartDataRowSource.idl b/offapi/com/sun/star/chart/ChartDataRowSource.idl index 9b645332272a..daeba858e749 100644 --- a/offapi/com/sun/star/chart/ChartDataRowSource.idl +++ b/offapi/com/sun/star/chart/ChartDataRowSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataRowSource.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,6 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartDataRowSource /** specifies if the data rows (aka data series) displayed in the chart, take their values from the row or the column in the underlying data source (<type>ChartDataArray</type>). @@ -77,14 +76,12 @@ enum ChartDataRowSource { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataRowSource::ROWS /** values displayed as data rows are taken from the rows of the data source. */ ROWS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartDataRowSource::COLUMNS /** values displayed as data rows are taken from the columns of the data source. */ COLUMNS @@ -98,6 +95,12 @@ enum ChartDataRowSource /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartDataValue.idl b/offapi/com/sun/star/chart/ChartDataValue.idl index 15c98d98e2c3..72f9b40c734b 100644 --- a/offapi/com/sun/star/chart/ChartDataValue.idl +++ b/offapi/com/sun/star/chart/ChartDataValue.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDataValue.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,26 +68,26 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::chart::ChartDataValue -/** describes a single data value, including the error range. +/** describes a single data value, including the error + + <p>This struct is currently used nowhere.</p> + + @deprecated */ struct ChartDataValue { - // DocMerge from xml: field com::sun::star::chart::ChartDataValue::Value /** value by itself. */ double Value; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataValue::HighError /** highest possible error value. */ double HighError; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartDataValue::LowError /** lowest possible error value. */ double LowError; @@ -101,6 +101,12 @@ struct ChartDataValue /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:01 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartDocument.idl b/offapi/com/sun/star/chart/ChartDocument.idl index d1cb4adbd21c..e4dc33734586 100644 --- a/offapi/com/sun/star/chart/ChartDocument.idl +++ b/offapi/com/sun/star/chart/ChartDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartDocument.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,10 +76,7 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartDocument -/** the service for a chart document. - - +/** is the service for a chart document. <p>A chart document consists of a reference to the data source, the diagram and some additional elements like a main title, a @@ -92,29 +89,23 @@ */ service ChartDocument { - // DocMerge: empty anyway interface com::sun::star::chart::XChartDocument; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDocument::HasMainTitle /** determines if the main title is shown or hidden. */ [property] boolean HasMainTitle; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDocument::HasSubTitle /** determines if the subtitle is shown or hidden. */ [property] boolean HasSubTitle; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartDocument::HasLegend /** determines if the legend is shown or hidden. */ [property] boolean HasLegend; @@ -128,6 +119,12 @@ service ChartDocument /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartErrorCategory.idl b/offapi/com/sun/star/chart/ChartErrorCategory.idl index c203b865ad6a..5bf0497eae94 100644 --- a/offapi/com/sun/star/chart/ChartErrorCategory.idl +++ b/offapi/com/sun/star/chart/ChartErrorCategory.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartErrorCategory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,50 +68,61 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartErrorCategory /** specifies the category of error indicators. */ enum ChartErrorCategory { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::NONE /** error indicators are not displayed. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::VARIANCE /** displays error indicators for the variance of the data row. */ VARIANCE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::STANDARD_DEVIATION - /** displays error indicators for the standard deviation of the data row. + /** displays error indicators for the standard deviation (square + root of variance) of the data row. */ STANDARD_DEVIATION, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::PERCENT - /** displays error indicators for the percent error. + /** The length of the error indicators is calculated for each data + point by taking the percentage given as + <member>ChartStatistics::PercentageError</member> of its + value. + + @see ChartStatistics */ PERCENT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::ERROR_MARGIN - /** displays error indicators for an error margin. + /** The length of the error indicators for all data points is + calculated by taking the percentage given as + <member>ChartStatistics::ErrorMargin</member> of the largest + data point value. + + @see ChartStatistics */ ERROR_MARGIN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorCategory::CONSTANT_VALUE - /** displays different indicators for lower and upper errors. + /** displays the same lower and upper error indicators for all + data points. + + <p>The values for these are given as absolute numbers in + <member>ChartStatistics::ConstantErrorLow</member> and + <member>ChartStatistics::ConstantErrorHigh</member></p> + + @see ChartStatistics */ CONSTANT_VALUE @@ -124,6 +135,12 @@ enum ChartErrorCategory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartErrorIndicatorType.idl b/offapi/com/sun/star/chart/ChartErrorIndicatorType.idl index 3b70c4a94f36..f02c7b6bfdf1 100644 --- a/offapi/com/sun/star/chart/ChartErrorIndicatorType.idl +++ b/offapi/com/sun/star/chart/ChartErrorIndicatorType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartErrorIndicatorType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,39 +68,33 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartErrorIndicatorType /** specifies how the error is indicated. */ enum ChartErrorIndicatorType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorIndicatorType::NONE /** displays no error indicators. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorIndicatorType::TOP_AND_BOTTOM /** displays both the upper and lower values. */ TOP_AND_BOTTOM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorIndicatorType::UPPER /** displays only the upper value. */ UPPER, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartErrorIndicatorType::LOWER /** displays only the lower value. */ LOWER - }; //============================================================================= @@ -110,6 +104,12 @@ enum ChartErrorIndicatorType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartGrid.idl b/offapi/com/sun/star/chart/ChartGrid.idl index b977a14be200..6592b552e383 100644 --- a/offapi/com/sun/star/chart/ChartGrid.idl +++ b/offapi/com/sun/star/chart/ChartGrid.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartGrid.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: cl $ $Date: 2001-03-07 13:57:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,6 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartGrid /** specifies the grid of the diagram in a chart. @@ -86,12 +85,8 @@ */ service ChartGrid { - // DocMerge: empty anyway service com::sun::star::drawing::LineProperties; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - }; //============================================================================= @@ -101,6 +96,12 @@ service ChartGrid /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.18.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/07 13:57:13 cl + cleanup of shape services + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/ChartLegend.idl b/offapi/com/sun/star/chart/ChartLegend.idl index 4a0943972ad1..f9fc97ab5920 100644 --- a/offapi/com/sun/star/chart/ChartLegend.idl +++ b/offapi/com/sun/star/chart/ChartLegend.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartLegend.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,6 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartLegend /** specifies the legend of a chart. @@ -91,15 +90,11 @@ */ service ChartLegend { - // DocMerge: empty anyway service com::sun::star::drawing::Shape; - - // DocMerge: empty anyway service com::sun::star::style::CharacterProperties; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartLegend::Alignment /** determines the alignment of the legend relative to the diagram. */ @@ -114,6 +109,12 @@ service ChartLegend /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartLegendPosition.idl b/offapi/com/sun/star/chart/ChartLegendPosition.idl index 53519ab92ac0..6325696dd27f 100644 --- a/offapi/com/sun/star/chart/ChartLegendPosition.idl +++ b/offapi/com/sun/star/chart/ChartLegendPosition.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartLegendPosition.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,46 +68,56 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartLegendPosition -/** specifies where the legend is positioned. +/** specifies one of the default positions of the legend in relation + to the diagram. */ enum ChartLegendPosition { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartLegendPosition::NONE /** no chart legend is displayed. + + <p>To disable the legend you should set the property + <member>ChartDocument::HasLegend</member> to <FALSE/> instead + of setting this value.</p> */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartLegendPosition::LEFT /** displays the chart legend on the left side of the diagram. + + <p>The second entry in the legend is placed below the first + one.</p> */ LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartLegendPosition::TOP /** displays the chart legend above the diagram. + + <p>The second entry in the legend is placed an the right hand + side of the first one.</p> */ TOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartLegendPosition::RIGHT /** displays the chart legend on the right side of the diagram. + + <p>The second entry in the legend is placed below the first + one.</p> */ RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartLegendPosition::BOTTOM /** displays the chart legend beneath the diagram. + + <p>The second entry in the legend is placed an the right hand + side of the first one.</p> */ BOTTOM - }; //============================================================================= @@ -117,6 +127,12 @@ enum ChartLegendPosition /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartLine.idl b/offapi/com/sun/star/chart/ChartLine.idl index 8ad4467ce6ee..1a9fb4b974f2 100644 --- a/offapi/com/sun/star/chart/ChartLine.idl +++ b/offapi/com/sun/star/chart/ChartLine.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartLine.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: cl $ $Date: 2001-03-07 13:57:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartLine /** specifies line elements in a chart (regression lines, etc.). */ service ChartLine { - // DocMerge: empty anyway service com::sun::star::drawing::LineProperties; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - }; //============================================================================= @@ -96,6 +91,12 @@ service ChartLine /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.18.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/03/07 13:57:13 cl + cleanup of shape services + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl b/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl index dcc9fc8ce2ff..93e4bac37f6a 100644 --- a/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl +++ b/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartPieSegmentProperties.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,16 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartPieSegmentProperties /** specifies all the properties for the graphic object of a pie segment.@see PieDiagram */ service ChartPieSegmentProperties { - // DocMerge: empty anyway service com::sun::star::chart::ChartDataPointProperties; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartPieSegmentProperties::SegmentOffset /** reflects the offset of a pie segment in percent of the radius. @@ -114,6 +109,12 @@ service ChartPieSegmentProperties /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartRegressionCurveType.idl b/offapi/com/sun/star/chart/ChartRegressionCurveType.idl index 75cfce3d3bc6..fd0cf69b1d8d 100644 --- a/offapi/com/sun/star/chart/ChartRegressionCurveType.idl +++ b/offapi/com/sun/star/chart/ChartRegressionCurveType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartRegressionCurveType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,56 +68,58 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::chart::ChartRegressionCurveType /** specifiest the type of the regression curve to be displayed. */ enum ChartRegressionCurveType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::NONE /** displays no regression curve. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::LINEAR /** displays a linear regression curve. + + <p>The values of the series are approximated using the model + <i>y</i> = <i>A</i>·<i>x</i> + <i>B</i>.</p> */ LINEAR, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::LOGARITHM /** displays a linear logarithmic regression curve. + + <p>The values of the series are approximated using the model + <i>y</i> = <i>A</i>·log(<i>x</i>) + <i>B</i>.</p> */ LOGARITHM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::EXPONENTIAL /** displays an exponential regression curve. - */ + + <p>The values of the series are approximated using the model + <i>y</i> = <i>A</i>·e<sup><i>B</i>·<i>x</i></sup>.</p> + + */ EXPONENTIAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::POLYNOMIAL /** displays a polynomial regression curve. - */ + + @deprecated + */ POLYNOMIAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::chart::ChartRegressionCurveType::POWER - /** ssi! + /** displays a regression curve using a power function. - - - - - @deprecated + <p>The values of the series are approximated using the model + <i>y</i> = <i>A·<i>x</i><sup>B</sup></i>.</p> */ POWER @@ -130,6 +132,15 @@ enum ChartRegressionCurveType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/06/05 12:49:39 bm + #96984# semicolon missing for named HTML character middot + + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartSeriesAddress.idl b/offapi/com/sun/star/chart/ChartSeriesAddress.idl index 95d82efa0f81..53f645818cf9 100644 --- a/offapi/com/sun/star/chart/ChartSeriesAddress.idl +++ b/offapi/com/sun/star/chart/ChartSeriesAddress.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartSeriesAddress.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,34 +67,31 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::chart::ChartSeriesAddress -/** This structure describes a single data row, specified by its name and - a sequence of data points. +/** This structure describes a single data row, specified by its name + and a sequence of data points. - The cell addresses are in the format of the application that - contains this chart. + <p>The cell addresses are in the format of the application that + contains this chart.</p> */ struct ChartSeriesAddress { - // DocMerge from xml: field com::sun::star::chart::ChartSeriesAddress::DataRangeAddress /** contains the cell range address of the data for this series. */ string DataRangeAddress; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::chart::ChartSeriesAddress::LabelAddress /** contains the cell address of label (i.e. name) of this series. */ string LabelAddress; //------------------------------------------------------------------------- - // DocMerge from idl: field com::sun::star::chart::ChartSeriesAddress::DomainRangeAddresses /** contains cell addresses for each domain of this series. - For XY (scatter) diagrams at least one series has a domain. Most - of the other chart types use an empty sequence here. + <p>For XY (scatter) diagrams at least one series has a + domain. Most of the other chart types use an empty sequence + here.</p> */ sequence< string > DomainRangeAddresses; }; @@ -106,6 +103,12 @@ struct ChartSeriesAddress /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartSolidType.idl b/offapi/com/sun/star/chart/ChartSolidType.idl index 030e3c505ed6..db965fa3ee0e 100644 --- a/offapi/com/sun/star/chart/ChartSolidType.idl +++ b/offapi/com/sun/star/chart/ChartSolidType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartSolidType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,37 +68,32 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::chart::ChartSolidType /** These values specify the type of solid shapes for data points of - 3D bar charts. + 3D bar charts. */ constants ChartSolidType { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSolidType::RECTANGULAR_SOLID - /** extruded rectangle + /** extruded rectangle, i.e., a cuboid */ const long RECTANGULAR_SOLID = 0; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSolidType::CYLINDER - /** cylindric + /** cylinder with a circle as base */ const long CYLINDER = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSolidType::CONE - /** conic + /** cone with a circle as base */ const long CONE = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSolidType::PYRAMID - /** pyramidial + /** pyramidial with a square as base */ const long PYRAMID = 3; @@ -111,6 +106,12 @@ constants ChartSolidType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartStatistics.idl b/offapi/com/sun/star/chart/ChartStatistics.idl index 8f3a2f517d35..2e4c999e82e1 100644 --- a/offapi/com/sun/star/chart/ChartStatistics.idl +++ b/offapi/com/sun/star/chart/ChartStatistics.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartStatistics.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,79 +84,106 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartStatistics -/** offers statistical properties for the data in - the chart. It is available for a single data row and for the whole diagram. +/** offers statistical properties for the data in the chart. It is + available for a single data row and for the whole diagram. */ service ChartStatistics { - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::ConstantErrorLow /** specifies the lower limit of the error range of a - data row.@see ConstantErrorHigh - @see ErrorCategory + data row. + + <p>this setting is effective if the + <member>ChartStatistics::ErrorCategory</member> is set to + <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> + + @see ConstantErrorHigh + @see ErrorCategory */ [property] double ConstantErrorLow; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::ConstantErrorHigh /** specifies the upper limit of the error range of a - data row.@see ConstantErrorLow - @see ErrorCategory + data row. + + <p>this setting is effective if the + <member>ChartStatistics::ErrorCategory</member> is set to + <member>ChartErrorCategory::CONSTANT_VALUE</member>.</p> + + @see ConstantErrorLow + @see ErrorCategory */ [property] double ConstantErrorHigh; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::MeanValue /** determines if the mean value for a data row is - displayed. + displayed as a line. */ [property] boolean MeanValue; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::ErrorCategory - /** determines the type of error to indicate.@see ChartErrorCategory - @see PercentageError - @see ErrorMargin - @see ConstantErrorLow - @see ConstantErrorHigh - @see ErrorIndicator + /** determines the type of error to indicate. + + @see ChartErrorCategory + @see PercentageError + @see ErrorMargin + @see ConstantErrorLow + @see ConstantErrorHigh + @see ErrorIndicator */ [property] com::sun::star::chart::ChartErrorCategory ErrorCategory; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::PercentageError - /** specifies the percent error for the data row.@see ErrorCategory + /** specifies the percentage that is used to display error bars. + + <p>The length of the error indicators is calculated for each + data point by taking the given percentatge of its value.</p> + + <p>this setting is effective if the + <member>ChartStatistics::ErrorCategory</member> is set to + <member>ChartErrorCategory::PERCENT</member>.</p> + + @see ErrorCategory */ [property] double PercentageError; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::ErrorMargin - /** specifies the margin of errors for the data row.@see ErrorCategory + /** specifies the percentage for the margin of errors. + + <p>The length of the error indicators is calculated by taking + the percentage given of the largest data point value.</p> + + <p>this setting is effective if the + <member>ChartStatistics::ErrorCategory</member> is set to + <member>ChartErrorCategory::ERROR_MARGIN</member>.</p> + + @see ErrorCategory */ [property] double ErrorMargin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::ErrorIndicator - /** determines how the error is indicated.@see ErrorCategory + /** determines how the error is indicated. + + <p>You can enable indicators pointing up, down or both.</p> + + @see ErrorCategory */ [property] com::sun::star::chart::ChartErrorIndicatorType ErrorIndicator; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartStatistics::RegressionCurves - /** determines a type of regression for the - data row values. + /** determines a type of regression for the data row values. + + @see ChartRegressionCurveType */ [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves; @@ -169,6 +196,12 @@ service ChartStatistics /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/ChartSymbolType.idl b/offapi/com/sun/star/chart/ChartSymbolType.idl index 6515693c6dbe..68fe2772e391 100644 --- a/offapi/com/sun/star/chart/ChartSymbolType.idl +++ b/offapi/com/sun/star/chart/ChartSymbolType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartSymbolType.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,23 +68,39 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::chart::ChartSymbolType /** These values specify the type of the symbol used for data points. - */ + + <p>This only applies to diagrams that use symbols like line + diagrams.</p> + + <p>The default symbols are currently: + <table border > + <tr><td>Symbol 0</td><td>a square</td></tr> + <tr><td>Symbol 1</td><td>a diamond</td></tr> + <tr><td>Symbol 2</td><td>a triangle pointing down</td></tr> + <tr><td>Symbol 3</td><td>a triangle pointing up</td></tr> + <tr><td>Symbol 4</td><td>a triangle pointing right</td></tr> + <tr><td>Symbol 5</td><td>a triangle pointing left</td></tr> + <tr><td>Symbol 6</td><td>a bow tie</td></tr> + <tr><td>Symbol 7</td><td>a rotated bow tie</td></tr> + </table> + </p> + + @see LineDiagram + @see ChartDataPointProperties +*/ constants ChartSymbolType { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::NONE /** No symbol is used. */ const long NONE = -3; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::AUTO - /** The symbol is selected automatically. The size of symbol will be dynamic and the - type depends on the data row number. + /** The symbol is selected automatically. The size of symbol will + be dynamic and the type depends on the data row number. */ const long AUTO = -2; @@ -92,8 +108,9 @@ constants ChartSymbolType /** Take a Bitmap from a URL and use this as symbol. - The bitmap given by the URL set in the property <type>SymbolBitmapURL</type> - is copied so that the graphic is embedded. + <p>The bitmap given by the URL set in the property + <member>ChartDataPointProperties::SymbolBitmapURL</member> is + copied so that the graphic is embedded.</p> @see ChartDataPointProperties */ @@ -101,56 +118,48 @@ constants ChartSymbolType //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL0 /** The default symbol for row 0 is used. */ const long SYMBOL0 = 0; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL1 /** The default symbol for row 1 is used. */ const long SYMBOL1 = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL2 /** The default symbol for row 2 is used. */ const long SYMBOL2 = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL3 /** The default symbol for row 3 is used. */ const long SYMBOL3 = 3; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL4 /** The default symbol for row 4 is used. */ const long SYMBOL4 = 4; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL5 /** The default symbol for row 5 is used. */ const long SYMBOL5 = 5; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL6 /** The default symbol for row 6 is used. */ const long SYMBOL6 = 6; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::chart::ChartSymbolType::SYMBOL7 /** The default symbol for row 7 is used. */ const long SYMBOL7 = 7; @@ -164,6 +173,15 @@ constants ChartSymbolType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.20.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.5.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.4 2000/11/20 14:41:52 bm const value -1 was missing. It is now set to bitmap corresponding to the core value diff --git a/offapi/com/sun/star/chart/ChartTitle.idl b/offapi/com/sun/star/chart/ChartTitle.idl index 306bd24e9926..1fd3bf89ce16 100644 --- a/offapi/com/sun/star/chart/ChartTitle.idl +++ b/offapi/com/sun/star/chart/ChartTitle.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartTitle.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,33 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartTitle -/** specifies titles in a chart (e.g., the main title, sub title - and axis titles).@see com::sun::star::drawing::Shape +/** specifies titles in a chart. + + <p>In a chart there may be the following titles: the main title, + the sub title, and axis titles of the x- and y-axis.</p> */ service ChartTitle { - // DocMerge: empty anyway service com::sun::star::drawing::Shape; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTitle::TextRotation /** specifies the rotation of the shape in 100th of degrees. - - - <p>Though all titles can be rotated, we recommend using - the rotation of the axis titles in a 3 dimensional diagram to - achieve a better looking layout.</p> + <p>Especially in three-dimensional charts, this property comes + in handy if you want to align the axis titles with the axis, + which are usually not vertical or horizontal in the + two-dimensional projection.</p> */ [property] long TextRotation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTitle::String /** contains the text of the title. + + <p>Note that you can not change attributes of parts of a + title, e.g., put one word in bold characters. All formatting + affects the entire string.</p> */ [property] string String; @@ -110,6 +111,12 @@ service ChartTitle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl b/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl index 4396a78e2201..39f9d63d9cad 100644 --- a/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl +++ b/offapi/com/sun/star/chart/ChartTwoAxisXSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartTwoAxisXSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,27 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartTwoAxisXSupplier /** a helper service for chart documents which supply primary and secondary x-axes. */ service ChartTwoAxisXSupplier { - // DocMerge: empty anyway + /** offers access to the axis object + */ interface com::sun::star::chart::XTwoAxisXSupplier; - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTwoAxisXSupplier::HasSecondaryXAxis - /** determines if the secondary x-axis is shown or hidden.@see ChartAxis + /** determines if the secondary x-axis is shown or hidden. + + @see ChartAxis */ [property] boolean HasSecondaryXAxis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTwoAxisXSupplier::HasSecondaryXAxisDescription /** determines if the description of the secondary x-axis is shown or hidden. */ @@ -112,6 +111,12 @@ service ChartTwoAxisXSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl b/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl index ceb43106742a..3c4781f8dea4 100644 --- a/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl +++ b/offapi/com/sun/star/chart/ChartTwoAxisYSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChartTwoAxisYSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,29 +76,28 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::ChartTwoAxisYSupplier /** a helper service for chart documents which supply primary and secondary y-axes. */ service ChartTwoAxisYSupplier { - // DocMerge: empty anyway + /** offers access to the axis object + */ interface com::sun::star::chart::XTwoAxisYSupplier; - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisYSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTwoAxisYSupplier::HasSecondaryYAxis /** determines if the secondary y-axis is shown or - hidden.@see ChartAxis + hidden. + + @see ChartAxis */ [property] boolean HasSecondaryYAxis; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::ChartTwoAxisYSupplier::HasSecondaryYAxisDescription /** determines if the description of the secondary y-axis is shown or hidden. */ @@ -113,6 +112,12 @@ service ChartTwoAxisYSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/Diagram.idl b/offapi/com/sun/star/chart/Diagram.idl index 0cc0f5579c3d..2d7b7c85bfd9 100644 --- a/offapi/com/sun/star/chart/Diagram.idl +++ b/offapi/com/sun/star/chart/Diagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: Diagram.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,31 +80,37 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::Diagram -/** the basic service for the diagram of the chart document. +/** the base service for the diagram of the chart document. + + <p>The diagram is the object that contains the actual plot.</p> + + <p>Different Diagram Types, e.g., <type>PieDiagram</type> or + <type>LineDiagram</type>, can be instantiated by the + <type scope="com::sun::star::lang">XMultiServiceFactory</type> of + the <type>XChartDocument</type>.</p> + */ service Diagram { - // DocMerge: empty anyway interface com::sun::star::chart::XDiagram; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::Diagram::DataRowSource - /** determines if the data for a data row is contained - in the columns or in the rows of the data array.@see ChartDataRowSource - @see ChartDataArray + /** determines if the data for a data row is contained in the + columns or in the rows of the data array. + + @see ChartDataRowSource + @see ChartDataArray */ [property] com::sun::star::chart::ChartDataRowSource DataRowSource; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::Diagram::DataCaption - /** specifies how the caption of data points is - displayed.@see ChartDataCaption + /** specifies how the caption of data points is displayed. + + @see ChartDataCaption */ [property] long DataCaption; @@ -117,6 +123,15 @@ service Diagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.4.20.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2000/12/21 08:35:01 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/Dim3DDiagram.idl b/offapi/com/sun/star/chart/Dim3DDiagram.idl index bb8636fc09f9..3da2f6f131f2 100644 --- a/offapi/com/sun/star/chart/Dim3DDiagram.idl +++ b/offapi/com/sun/star/chart/Dim3DDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: Dim3DDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,21 +72,23 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::Dim3DDiagram -/** a helper service which supports properties of 3 dimensional chart - types. +/** is a service for diagrams that support the capability to render + themselves as three-dimensional diagrams as well as + two-dimensional ones. */ service Dim3DDiagram { - // DocMerge: empty anyway + /** gives access to the properties of the wall and floor objects + of the three-dimensional cuboid that contains the actual + diagram. + */ interface com::sun::star::chart::X3DDisplay; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::Dim3DDiagram::Dim3D - /** determines if the chart is 3 dimensional or 2 - dimensional. - */ + /** If set to <TRUE/>, the chart becomes a three-dimensional + chart. Otherwise it is two-dimensional. + */ [property] boolean Dim3D; }; @@ -98,6 +100,12 @@ service Dim3DDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/DonutDiagram.idl b/offapi/com/sun/star/chart/DonutDiagram.idl index 4b788f74a893..98b84dd3610b 100644 --- a/offapi/com/sun/star/chart/DonutDiagram.idl +++ b/offapi/com/sun/star/chart/DonutDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: DonutDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,13 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::DonutDiagram /** a service for donut diagrams. - */ + + <p>Donut diagrams are also known as ring diagrams.</p> +*/ service DonutDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - }; //============================================================================= @@ -89,6 +88,12 @@ service DonutDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:02 hjs initial import diff --git a/offapi/com/sun/star/chart/LineDiagram.idl b/offapi/com/sun/star/chart/LineDiagram.idl index f6b8cf7b3d77..77fde393fab3 100644 --- a/offapi/com/sun/star/chart/LineDiagram.idl +++ b/offapi/com/sun/star/chart/LineDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: LineDiagram.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,100 +99,85 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::LineDiagram /** specifies line, spline and symbol diagrams. */ service LineDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartTwoAxisYSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisZSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::Dim3DDiagram; - - // DocMerge: empty anyway service com::sun::star::chart::StackableDiagram; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::LineDiagram::SymbolType /** determines which type of symbols are displayed. + <p>In this interface, only the two values + <member>ChartSymbolType::NONE</member> and + <member>ChartSymbolType::AUTO</member> are supported. Later + versions may support the selection of the symbols shape.</p> - <p>In this interface, only the two values <type>ChartSymbolType</type>::NONE - and <type>ChartSymbolType</type>::AUTO are supported. Later versions may support - the selection of the symbols shape. You can change the symbol shape only - in the services <type>ChartDataPointProperties</type> and <type>ChartDataRowProperties</type>. - </p> - - <p>In this Interface, only the absence of symbols - (SymbolTypeType=ChartSymbol_NONE) or default symbols - (SymbolTypeType=ChartSymbol_AUTO) are supported. - - </p> - <p>Currently, before you can change the shape in these - interfaces, you have to set "SymbolType" to - "ChartSymbolType_AUTO" in this interface in order to get a - chart which supports symbols. + <p>If you set this property to + <member>ChartSymbolType::AUTO</member>, you can change the + symbol shape for objects supporting the service + <type>ChartDataPointProperties</type> or + <type>ChartDataRowProperties</type>.</p> - </p>@see ChartDataPoint - @see ChartDataRow + @see ChartDataPointProperties + @see ChartDataRowProperties */ [property] long SymbolType; //------------------------------------------------------------------------- - /** specifies the size of symbols. - - @optional + /** specifies the size of symbols in 1/100th of a millimeter. */ [optional, property] com::sun::star::awt::Size SymbolSize; //------------------------------------------------------------------------- - /** specifies the type of symbol. + /** Set this property to any valid URL that points to a graphic + file. This graphic is then used as symbol for all series. + + <p>When you query this value you get an internal URL of the + embedded graphic.</p> - @optional + @deprecated @see ChartSymbolType */ [optional, property] string SymbolBitmapURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::LineDiagram::Lines - /** determines if the chart type has lines connecting - the data points or contains just symbols. - - <p>It may only be used for line- and xy-charts.</p> + /** determines if the chart type has lines connecting the data + points or contains just symbols. */ [property] boolean Lines; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::LineDiagram::SplineType - /** determines if the chart is a spline-chart type - and specifies the type of splines, which can be cubic or - bicubic. + /** determines if the chart is a spline-chart type and specifies + the type of splines. + + <p>You can set the following values: + <table border> + <tr><td>0</td><td>lines are used instead of splines</td></tr> + <tr><td>1</td><td>use cubic splines</td></tr> + <tr><td>2</td><td>use B-splines</td></tr> + </table> + </p> */ [property] long SplineType; //------------------------------------------------------------------------- - /** specifies the power of the polynomials used for spline calculation + /** specifies the power of the polynomials used for spline + calculation - This property is only valid for b-splines + This property is only valid for B-splines */ [optional, property] long SplineOrder; @@ -210,6 +195,15 @@ service LineDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8.2.2 2002/01/29 15:58:52 bm + #96984# IDL Review -- second check + + Revision 1.8.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.8 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.7 2001/08/27 14:35:34 bm #91579# +properties SplineOrder, SplineResolution diff --git a/offapi/com/sun/star/chart/NetDiagram.idl b/offapi/com/sun/star/chart/NetDiagram.idl index f8dbe14b95b6..b732b1475941 100644 --- a/offapi/com/sun/star/chart/NetDiagram.idl +++ b/offapi/com/sun/star/chart/NetDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: NetDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,18 +80,14 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::NetDiagram /** specifies net diagrams. + + <p>Net diagrams are also known as radar diagrams.</p> */ service NetDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::StackableDiagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisYSupplier; }; @@ -103,6 +99,12 @@ service NetDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:03 hjs initial import diff --git a/offapi/com/sun/star/chart/PieDiagram.idl b/offapi/com/sun/star/chart/PieDiagram.idl index 0261d0ef6b0b..c912d6fd66c2 100644 --- a/offapi/com/sun/star/chart/PieDiagram.idl +++ b/offapi/com/sun/star/chart/PieDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: PieDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::PieDiagram /** a service for pie diagrams. */ service PieDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::Dim3DDiagram; - }; //============================================================================= @@ -96,6 +91,12 @@ service PieDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:03 hjs initial import diff --git a/offapi/com/sun/star/chart/StackableDiagram.idl b/offapi/com/sun/star/chart/StackableDiagram.idl index 64174f623b00..fc0dd40f8975 100644 --- a/offapi/com/sun/star/chart/StackableDiagram.idl +++ b/offapi/com/sun/star/chart/StackableDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: StackableDiagram.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,8 +68,9 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::StackableDiagram -/** a helper service for stackable chart types (e.g., charts in +/** + +a helper service for stackable chart types (e.g., charts in which the data rows may be displayed stacked on each other or in percent relation). */ @@ -77,17 +78,18 @@ service StackableDiagram { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::StackableDiagram::Percent - /** determines if the chart type is a percent - or non-percent type. + /** If <TRUE/>, the series of the diagram are stacked and each + category sums up to 100%. */ [property] boolean Percent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::StackableDiagram::Stacked - /** determines if the chart type is a stacked or - non-stacked type. + /** If <TRUE/>, the series of the diagram are stacked. + + <p>If you have a stacked bar chart, you can easily determine + the sum of data in each category, by taking the top of the + topmost bar.</p> */ [property] boolean Stacked; @@ -100,6 +102,12 @@ service StackableDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/StockDiagram.idl b/offapi/com/sun/star/chart/StockDiagram.idl index 880d60594748..f4adb56d696d 100644 --- a/offapi/com/sun/star/chart/StockDiagram.idl +++ b/offapi/com/sun/star/chart/StockDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: StockDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,49 +88,91 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::StockDiagram /** specifies a diagram which can be used for presenting stock quotes. - */ + + <p>Note that the data must have a specific structure for stock + diagrams. Let us assume that data is interpreted, such that + series are taken from columns (see property + <member>Diagram::DataRowSource</member>). Then you need tables of + the following structures for different types:</p> + + <p><strong> + <member>StockDiagram::Volume</member> is <FALSE/><br> + <member>StockDiagram::UpDown</member> is <FALSE/> + </strong> + <table border> + <tr><td>Low</td><td>High</td><td>Close</td></tr> + <tr><td>…</td><td>…</td><td>…</td></tr> + </table></p> + + <p><strong> + <member>StockDiagram::Volume</member> is <TRUE/><br> + <member>StockDiagram::UpDown</member> is <FALSE/> + </strong> + <table border> + <tr><td><strong>Volume</strong></td><td>Low</td><td>High</td><td>Close</td></tr> + <tr><td>…</td><td>…</td><td>…</td><td>…</td></tr> + </table></p> + + <p><strong> + <member>StockDiagram::Volume</member> is <FALSE/><br> + <member>StockDiagram::UpDown</member> is <TRUE/> + </strong> + <table border> + <tr><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> + <tr><td>…</td><td>…</td><td>…</td><td>…</td></tr> + </table></p> + + <p><strong> + <member>StockDiagram::Volume</member> is <TRUE/><br> + <member>StockDiagram::UpDown</member> is <TRUE/> + </strong> + <table border> + <tr><td><strong>Volume</strong></td><td><strong>Open</strong></td><td>Low</td><td>High</td><td>Close</td></tr> + <tr><td>…</td><td>…</td><td>…</td><td>…</td><td>…</td></tr> + </table></p> +*/ service StockDiagram { - // DocMerge: empty anyway interface com::sun::star::chart::XStatisticDisplay; - - // DocMerge: empty anyway service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartTwoAxisYSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::StockDiagram::Volume - /** indicates if a stock chart contains volume data. - + /** indicates if a stock chart contains data representing the + volume of stocks. + <p>The values of the volume are represented as columns like + those of a <type>BarDiagram</type>.</p> - <p>It will be displayed as a bar chart in the stock chart - background.</p> + <p>If this property is set to <TRUE/>, the values of the first + series of the chart data are interpreted as volume.</p> */ [property] boolean Volume; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::chart::StockDiagram::UpDown - /** indicates if a stock chart contains closed and - open data. - - + /** indicates if a stock chart contains data representing the + value of stocks on the opening and closing date. <p>The difference will be indicated by bars. The color of the bar will be significant for positive or negative differences between open and closed data.</p> + + <p>If this property is <FALSE/>, the values of the first + series (or second if <member>StockDiagram::Volume</member> is + <TRUE/>) of the chart data are interpreted as the day's lowest + value. The next series is interpreted as the day's highest + value, and the last series is interpreted as the closing + value.</p> + + <p>If this property is set to <TRUE/>, one additional series + is needed with the opening value of the stocks. It is assumed + as the series before the series with the day's lowest + value.</p> */ [property] boolean UpDown; @@ -143,6 +185,18 @@ service StockDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/01/29 15:58:23 bm + #96984# Some more information about data interpretation in service description + + Revision 1.3.24.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:03 hjs initial import diff --git a/offapi/com/sun/star/chart/X3DDisplay.idl b/offapi/com/sun/star/chart/X3DDisplay.idl index a45853541f4e..70589b937e64 100644 --- a/offapi/com/sun/star/chart/X3DDisplay.idl +++ b/offapi/com/sun/star/chart/X3DDisplay.idl @@ -2,9 +2,9 @@ * * $RCSfile: X3DDisplay.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,36 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::X3DDisplay -/** gives access to 3D elements of a chart.@see XChartDocument +/** gives access to 3D elements of a three-dimensional chart. + + @see Dim3DDiagram */ interface X3DDisplay: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::X3DDisplay::getWall /** @returns - the properties of the diagram wall(s). + the properties of the diagram wall(s). + + <p>This specifies the properties of the two side walls of the + chart scene.</p> - <p>In 3 dimension diagrams this specifies the side wall and the background wall; - in 2 dimension diagrams this specifies only the background of the diagram. + <p>Note that this property is also valid for two-dimensional + diagrams. There the properties returned here affect the + background rectangle of the diagram.</p> - @see ChartArea + @see ChartArea */ com::sun::star::beans::XPropertySet getWall(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::X3DDisplay::getFloor /** @returns - the properties of the floor in a 3 dimensional diagram. + the properties of the floor. + + <p>This is only valid for three-dimensional diagrams.</p> - @see ChartArea + @see ChartArea */ com::sun::star::beans::XPropertySet getFloor(); @@ -113,6 +118,12 @@ interface X3DDisplay: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XAxisXSupplier.idl b/offapi/com/sun/star/chart/XAxisXSupplier.idl index c35ea6e35fe6..e7f96e706beb 100644 --- a/offapi/com/sun/star/chart/XAxisXSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisXSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAxisXSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,48 +80,53 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XAxisXSupplier -/** gives access to the x-axis of a chart.@see XChartDocument +/** gives access to the <i>x</i>-axis of a chart. + + <p>Note that not all diagrams are capable of displaying an + <i>x</i>-axis, e.g., the <type>PieDiagram</type>.</p> + + @see XDiagram */ interface XAxisXSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisXSupplier::getXAxisTitle /** @returns - the properties of the shape of the x-axis title. + the <i>x</i>-axis title shape. - @see ChartTitle + @see ChartTitle */ com::sun::star::drawing::XShape getXAxisTitle(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisXSupplier::getXAxis /** @returns - the properties of the y-axis of the diagram. + the properties of the <i>x</i>-axis of the diagram. + + <p>The returned property set contains scaling properties as + well as formatting properties.</p> - @see ChartAxis + @see ChartAxis */ com::sun::star::beans::XPropertySet getXAxis(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisXSupplier::getXMainGrid /** @returns - the properties of the main grid of the x-axis of the diagram. + the properties of the main grid (major grid) of the + <i>x</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getXMainGrid(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisXSupplier::getXHelpGrid /** @returns - the properties of the help grid of the x-axis of the diagram. + the properties of the help grid (minor grid) of the + <i>x</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getXHelpGrid(); @@ -131,24 +136,4 @@ interface XAxisXSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:01 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:42:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:03 hjs - initial import - - Revision 1.3 2000/09/11 11:52:16 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/chart/XAxisYSupplier.idl b/offapi/com/sun/star/chart/XAxisYSupplier.idl index 51e0e1f4f8c7..f3d473a06d73 100644 --- a/offapi/com/sun/star/chart/XAxisYSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisYSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAxisYSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,48 +80,53 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XAxisYSupplier -/** gives access to the y-axis of a chart.@see XChartDocument +/** gives access to the <i>y</i>-axis of a chart. + + <p>Note that not all diagrams are capable of displaying a + <i>y</i>-axis, e.g., the <type>PieDiagram</type>.</p> + + @see XDiagram */ interface XAxisYSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisYSupplier::getYAxisTitle /** @returns - the properties of the shape of the y-axis title + the <i>y</i>-axis title shape. - @see ChartTitle + @see ChartTitle */ com::sun::star::drawing::XShape getYAxisTitle(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisYSupplier::getYAxis /** @returns - the properties of the y-axis of the diagram. + the properties of the <i>y</i>-axis of the diagram. + + <p>The returned property set contains scaling properties as + well as formatting properties.</p> - @see ChartAxis + @see ChartAxis */ com::sun::star::beans::XPropertySet getYAxis(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisYSupplier::getYHelpGrid /** @returns - the properties of the help grid of the y-axis of the diagram + the properties of the help grid (minor grid) of the + <i>y</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getYHelpGrid(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisYSupplier::getYMainGrid /** @returns - the properties of the main grid of the y-axis of the diagram. + the properties of the main grid (major grid) of the + <i>y</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getYMainGrid(); @@ -134,6 +139,12 @@ interface XAxisYSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XAxisZSupplier.idl b/offapi/com/sun/star/chart/XAxisZSupplier.idl index 523b9f85541a..399fd329c999 100644 --- a/offapi/com/sun/star/chart/XAxisZSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisZSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAxisZSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,48 +80,50 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XAxisZSupplier -/** gives access to the z-axis of a chart.@see XChartDocument +/** gives access to the <i>z</i>-axis of a chart. + + @see XDiagram */ interface XAxisZSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisZSupplier::getZAxisTitle /** @returns - the properties of the shape of the z-axis title. + the <i>z</i>-axis title shape. - @see ChartTitle + @see ChartTitle */ com::sun::star::drawing::XShape getZAxisTitle(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisZSupplier::getZMainGrid /** @returns - the properties of the main grid of the z-axis of the diagram. + the properties of the main grid (major grid) of the + <i>z</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getZMainGrid(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisZSupplier::getZHelpGrid /** @returns - the properties of the help grid of the z-axis of the diagram. + the properties of the help grid (minor grid) of the + <i>z</i>-axis of the diagram. - @see ChartGrid + @see ChartGrid */ com::sun::star::beans::XPropertySet getZHelpGrid(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XAxisZSupplier::getZAxis /** @returns - the properties of the z-axis of the diagram. + the properties of the <i>z</i>-axis of the diagram. + + <p>The returned property set contains scaling properties as + well as formatting properties.</p> - @see ChartAxis + @see ChartAxis */ com::sun::star::beans::XPropertySet getZAxis(); @@ -134,6 +136,12 @@ interface XAxisZSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XChartData.idl b/offapi/com/sun/star/chart/XChartData.idl index 46c6faccdf36..a4fe2d0827b1 100644 --- a/offapi/com/sun/star/chart/XChartData.idl +++ b/offapi/com/sun/star/chart/XChartData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChartData.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,47 +76,68 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XChartData -/** manages the data of the chart.@see XChartDocument +/** manages the data of the chart. + + @see XChartDocument */ interface XChartData: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartData::addChartDataChangeEventListener - /** allows the registration of an event which is - broadcast when the data changes. + /** allows a component supporting the + <type>XChartDataChangeEventListener</type> interface to + register as listener. The component will be notified with a + <type>ChartDataChangeEvent</type> every time the chart's data + changes.</p> + + @param aListener + the component that is to be added as listener + + @see XChartDataChangeEventListener + @see ChartDataChangeEvent */ void addChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartData::removeChartDataChangeEventListener - /** allows you to deregister from the data changed event. + /** removes a previously registered listener. + + @param aListener + the component that is to be removed */ void removeChartDataChangeEventListener( [in] com::sun::star::chart::XChartDataChangeEventListener aListener ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartData::getNotANumber /** @returns - the value which is to be used as an indicator for a non-available data point. + the value which is to be used as an indicator for a + missing value in the data. - <p>In IEEE arithmetic format it is one of the NAN values, so - there are no conflicts with existing numeric values. + <p>In IEEE arithmetic format it is one of the NaN values, so + there are no conflicts with existing numeric values.</p> */ double getNotANumber(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartData::isNotANumber - /** checks whether the value is to be used as an - indicator for an unavailable data point. + /** checks whether the value given is equal to the indicator value + for a missing value. + <p>In IEEE arithmetic format it is one of the NaN values, so + there are no conflicts with existing numeric values.</p> + <p>Always use this method to check, if a value is <em>not a + number</em>. If you compare the value returned by + <member>XChartData::getNotANumber</member> to another double + value using the = operator, you may not get the desired + result!</p> - <p>In IEEE arithmetic format it is one of the NAN values, so - there are no conflicts with existing numeric values.</p> + @returns + <TRUE/> if the number given is interpreted by the chart as + a missing value. + + @param nNumber + the number that you want to check for validity. */ boolean isNotANumber( [in] double nNumber ); @@ -129,6 +150,15 @@ interface XChartData: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2001/03/16 16:41:16 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/chart/XChartDataArray.idl b/offapi/com/sun/star/chart/XChartDataArray.idl index ccea70ae05b7..eee5c83af78b 100644 --- a/offapi/com/sun/star/chart/XChartDataArray.idl +++ b/offapi/com/sun/star/chart/XChartDataArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChartDataArray.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,60 +71,72 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XChartDataArray /** gives access to data represented as an array of rows. - - - <p>If used for xy-diagrams the row number 0 represents the x-values.</p> + <p>If used for an <type>XYDiagram</type>, the row number 0 + represents the <i>x</i>-values.</p> */ interface XChartDataArray: XChartData { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getData - /** retrieves the numerical data as a sequence of rows. Each row is - represented as a sequence of double values. - */ + /** retrieves the numerical data as a nested sequence of values. + + @returns + the values as a sequence of sequences. The inner sequence + represents rows. + */ sequence< sequence< double > > getData(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setData - /** sets the chart data as a sequence of sequences of double values. + /** sets the chart data as an array of numbers. + + @param aData + the values as a sequence of sequences. The inner sequence + represents rows. */ void setData( [in] sequence< sequence< double > > aData ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getRowDescriptions - /** retrieves the description texts of all rows as a sequence of strings. + /** retrieves the description texts for all rows. + + @returns + a sequence of strings, each representing the description + of a row. */ - sequence<string> getRowDescriptions(); + sequence< string > getRowDescriptions(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setRowDescriptions - /** sets the description texts of all rows according to the sequence of - strings given. - */ - void setRowDescriptions( [in] sequence<string> aRowDescriptions ); + /** sets the description texts for all rows. + + @param aRowDescriptions + a sequence of strings which represent a description for + each row. + */ + void setRowDescriptions( [in] sequence< string > aRowDescriptions ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDataArray::getColumnDescriptions - /** retrieves the description texts of all columns as a sequence of strings. + /** retrieves the description texts for all columns. + + @returns + a sequence of strings, each representing the description + of a column. */ - sequence<string> getColumnDescriptions(); + sequence< string > getColumnDescriptions(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDataArray::setColumnDescriptions - /** sets the description texts of all columns according to the sequence of - strings given. - */ - void setColumnDescriptions( [in] sequence<string> aColumnDescriptions ); + /** sets the description texts for all columns. + @param aColumnDescriptions + a sequence of strings which represent a description for + each column. + */ + void setColumnDescriptions( [in] sequence< string > aColumnDescriptions ); }; //============================================================================= @@ -134,6 +146,12 @@ interface XChartDataArray: XChartData /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.4 2001/03/16 16:41:16 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl b/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl index b48bbfeddfb1..1648e8de7c60 100644 --- a/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl +++ b/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChartDataChangeEventListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,23 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XChartDataChangeEventListener /** makes it possible to receive events when chart data changes. */ interface XChartDataChangeEventListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDataChangeEventListener::chartDataChanged - /** is called whenever changes are applied to the data. + /** is called whenever chart data changes in value or structure. + + <p>This interface must be implemented by components that wish + to get notified of changes in chart data. They can be + registered at an <type>XChartData</type> component.</p> + + @param aEvent + the event that gives further information on what changed. + + @see ChartDataChangeEvent + @see XChartData */ void chartDataChanged( [in] com::sun::star::chart::ChartDataChangeEvent aEvent ); @@ -97,6 +105,12 @@ interface XChartDataChangeEventListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.4 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:35 mi moved from api diff --git a/offapi/com/sun/star/chart/XChartDocument.idl b/offapi/com/sun/star/chart/XChartDocument.idl index f29d1a061bb5..a80f9a7ae9ad 100644 --- a/offapi/com/sun/star/chart/XChartDocument.idl +++ b/offapi/com/sun/star/chart/XChartDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChartDocument.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-24 14:54:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,91 +88,102 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XChartDocument -/** manages the chart document.@see XDiagram - @see XChartData +/** manages the chart document. + + @see XDiagram + @see XChartData */ interface XChartDocument: com::sun::star::frame::XModel { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getTitle /** @returns - the shape of the main title of the chart document. + the shape of the main title of the chart document. - @see ChartTitle + @see ChartTitle */ com::sun::star::drawing::XShape getTitle(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getSubTitle /** @returns - the shape of the subtitle of the chart document. + the shape of the subtitle of the chart document. + + <p>Usually the subtitle is smaller than the main title by + default. And it is most commonly placed below the main title + by default.</p> - @see ChartTitle + @see ChartTitle */ com::sun::star::drawing::XShape getSubTitle(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getLegend /** @returns - the shape of the legend of the chart document. + the shape of the legend of the chart document. - @see ChartLegend + @see ChartLegend */ com::sun::star::drawing::XShape getLegend(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getArea /** @returns - the properties of the background area of the chart document. + the properties of the background area of the chart document. + + <p>The area's extent is equal to the document size. If you + want to access properties of the background area of the + diagram, in which the actual data is represented, you have to + change the chart wall which you get from the + <type>X3DDisplay</type>.</p> - @see ChartArea + @see ChartArea + @see X3DDisplay */ com::sun::star::beans::XPropertySet getArea(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getDiagram /** @returns - the diagram of the chart document. + the diagram of the chart document. - @see Diagram + @see Diagram */ com::sun::star::chart::XDiagram getDiagram(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDocument::setDiagram /** sets the diagram for the chart document. + <p>Setting a new diagram implicitly disposes the previous + diagram.</p> - <p>The diagram component itself is created by - <type scope="com::sun::star::lang">XMultiServiceFactory</type>, - which is supplied by the <type>ChartDocument</type>. - - </p> - <p>Setting a new diagram implicitly disposes the previous diagram.</p> + @param xDiagram + the new diagram that should be set for the chart. To + create such a diagram component, you can use the + <type scope="com::sun::star::lang">XMultiServiceFactory</type>, + which should be implemented by an + <type>XChartDocument</type>. */ void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XChartDocument::getData /** @returns - the data source of the chart. + the data source of the chart. - @see ChartData + @see ChartData */ com::sun::star::chart::XChartData getData(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::chart::XChartDocument::attachData - /** attaches an external data source to the chart.@see ChartData + /** attaches an external data source to the chart. + + @see ChartData + + @param xData + the component that provides the new data. */ void attachData( [in] com::sun::star::chart::XChartData xData ); @@ -185,6 +196,15 @@ interface XChartDocument: com::sun::star::frame::XModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.2.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.6.2.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.6 2001/10/24 14:54:57 mi + proofreading and corrections by Richard Holt + Revision 1.5 2001/03/16 16:41:16 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/chart/XDiagram.idl b/offapi/com/sun/star/chart/XDiagram.idl index bbbd489f0338..b19a125f6cdf 100644 --- a/offapi/com/sun/star/chart/XDiagram.idl +++ b/offapi/com/sun/star/chart/XDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDiagram.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,38 +79,45 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XDiagram -/** manages the diagram of the chart document.@see XChartDocument +/** manages the diagram of the chart document. + + @see XChartDocument */ interface XDiagram: com::sun::star::drawing::XShape { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XDiagram::getDiagramType /** @returns - a string representing the diagram type. This string contains the fully - qualified name of the corresponding service. + a string representing the diagram type. This string + contains the fully qualified name of the corresponding + service. */ string getDiagramType(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XDiagram::getDataRowProperties /** @returns - the properties of the specified data row. + the properties of the specified data row (series). + + @param nRow + the index of the series (0-based) - @see ChartDataRowProperties + @see ChartDataRowProperties */ com::sun::star::beans::XPropertySet getDataRowProperties( [in] long nRow ) raises( com::sun::star::lang::IndexOutOfBoundsException ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XDiagram::getDataPointProperties /** @returns - the properties of the specified data point. + the properties of the specified data point. + + @param nCol + the index of the data point of a series (0-based). + @param nRow + the index of a series (0-based). - @see ChartDataPointProperties + @see ChartDataPointProperties */ com::sun::star::beans::XPropertySet getDataPointProperties( [in] long nCol, [in] long nRow ) @@ -125,6 +132,12 @@ interface XDiagram: com::sun::star::drawing::XShape /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XStatisticDisplay.idl b/offapi/com/sun/star/chart/XStatisticDisplay.idl index 3e80486430e7..e14ceebd31df 100644 --- a/offapi/com/sun/star/chart/XStatisticDisplay.idl +++ b/offapi/com/sun/star/chart/XStatisticDisplay.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatisticDisplay.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,46 +76,51 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XStatisticDisplay /** gives access to statistical elements for the chart. + <p>Statistical elements are used by a + <type>StockDiagram</type>.</p> - - <p>Statistical elements are used by <type>StockDiagram</type>. - - </p>@see XChartDocument + @see XChartDocument + @see StockDiagram */ interface XStatisticDisplay: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XStatisticDisplay::getUpBar /** @returns - the properties of the up bars of a stock chart - which has <member>UpDown</member> set to <TRUE/>. + the properties of the up bars of a stock chart which has + <member>StockDiagram::UpDown</member> set to <TRUE/>. - @see ChartArea + <p>The <em>UpBar</em> is the box that is drawn between the + open and close value of a stock, when the closing value is + above the opening value, i.e., the stock price rose.</p> + + @see ChartArea */ com::sun::star::beans::XPropertySet getUpBar(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XStatisticDisplay::getDownBar /** @returns - the properties of the down bars of a stock chart - which has <member>UpDown</member> set to <TRUE/>. + the properties of the down bars of a stock chart which has + <member>StockDiagram::UpDown</member> set to <TRUE/>. + + <p>The <em>DownBar</em> is the box that is drawn between the + open and close value of a stock, when the closing value is + below the opening value, i.e., the stock price fell.</p> - @see ChartArea + @see ChartArea */ com::sun::star::beans::XPropertySet getDownBar(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XStatisticDisplay::getMinMaxLine /** @returns - the properties of MinMax lines of a stock chart. + the properties of the lines that are drawn between the + lowest and highest stock value during a day. - @see ChartLine + @see ChartLine */ com::sun::star::beans::XPropertySet getMinMaxLine(); @@ -128,6 +133,15 @@ interface XStatisticDisplay: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.2 2002/01/29 14:23:17 bm + #96984# IDL Review -- second check + + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XTwoAxisXSupplier.idl b/offapi/com/sun/star/chart/XTwoAxisXSupplier.idl index 38b9dcb9f8d3..cb89aa3db134 100644 --- a/offapi/com/sun/star/chart/XTwoAxisXSupplier.idl +++ b/offapi/com/sun/star/chart/XTwoAxisXSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTwoAxisXSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,18 +76,23 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XTwoAxisXSupplier -/** gives access to both the primary and the secondary y-axis of a diagram.@see XChartDocument +/** gives access to both the primary and the secondary <i>x</i>-axis + of a chart. + + @see XDiagram */ interface XTwoAxisXSupplier: com::sun::star::chart::XAxisXSupplier { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XTwoAxisXSupplier::getSecondaryXAxis /** @returns - the properties of the secondary x-axis of the diagram + the properties of the secondary <i>x</i>-axis of the + diagram. + + <p>The returned property set contains scaling properties as + well as formatting properties.</p> - @see ChartAxis + @see ChartAxis */ com::sun::star::beans::XPropertySet getSecondaryXAxis(); @@ -100,6 +105,12 @@ interface XTwoAxisXSupplier: com::sun::star::chart::XAxisXSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XTwoAxisYSupplier.idl b/offapi/com/sun/star/chart/XTwoAxisYSupplier.idl index 80574d01efbc..1f53c198dba3 100644 --- a/offapi/com/sun/star/chart/XTwoAxisYSupplier.idl +++ b/offapi/com/sun/star/chart/XTwoAxisYSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTwoAxisYSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,18 +76,20 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::chart::XTwoAxisYSupplier /** gives access to both the primary and the secondary y-axis of a diagram.@see XChartDocument */ interface XTwoAxisYSupplier: com::sun::star::chart::XAxisYSupplier { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::chart::XTwoAxisYSupplier::getSecondaryYAxis /** @returns - the properties of the secondary y-axis of the diagram. + the properties of the secondary <i>y</i>-axis of the + diagram. - @see ChartAxis + <p>The returned property set contains scaling properties as + well as formatting properties.</p> + + @see ChartAxis */ com::sun::star::beans::XPropertySet getSecondaryYAxis(); @@ -100,6 +102,12 @@ interface XTwoAxisYSupplier: com::sun::star::chart::XAxisYSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.5 2001/03/16 16:41:16 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:01 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/chart/XYDiagram.idl b/offapi/com/sun/star/chart/XYDiagram.idl index a444e159846f..2f93acefe13a 100644 --- a/offapi/com/sun/star/chart/XYDiagram.idl +++ b/offapi/com/sun/star/chart/XYDiagram.idl @@ -2,9 +2,9 @@ * * $RCSfile: XYDiagram.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,26 +88,20 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::chart::XYDiagram -/** a service for xy diagrams. +/** a service for X/Y diagrams (Also known as scatter charts). + + <p>The special thing about X/Y diagrams is that the first series + of data contains <i>x</i>-values. The other series contain + <i>y</i>-values. Together both form two-dimensional coordinates, + at which data points are placed.</p> */ service XYDiagram { - // DocMerge: empty anyway service com::sun::star::chart::Diagram; - - // DocMerge: empty anyway service com::sun::star::chart::ChartStatistics; - - // DocMerge: empty anyway service com::sun::star::chart::ChartAxisXSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::ChartTwoAxisYSupplier; - - // DocMerge: empty anyway service com::sun::star::chart::LineDiagram; - }; //============================================================================= @@ -117,6 +111,12 @@ service XYDiagram /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/01/28 17:02:24 bm + #96984# IDL Review + + Revision 1.3 2000/11/08 12:42:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:03 hjs initial import diff --git a/offapi/com/sun/star/configuration/AccessRootElement.idl b/offapi/com/sun/star/configuration/AccessRootElement.idl index dfad2bf242ab..5e118b84e31e 100644 --- a/offapi/com/sun/star/configuration/AccessRootElement.idl +++ b/offapi/com/sun/star/configuration/AccessRootElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: AccessRootElement.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,8 +82,8 @@ module com { module sun { module star { module configuration { //============================================================================= -/** provides information about the root element of a hierarchy, by name, - and about the hierarchy as a whole. +/** provides information about the root element of a hierarchy and + about the hierarchy as a whole. <p>Provides information about the element and the whole hierarchy. Allows controlling the lifetime of the hierarchy. @@ -101,25 +101,14 @@ module com { module sun { module star { module configuration { and that is accessible starting from this element.</em> </p> -<!-- Dennis: Why is hierarchy in quotes? --> -<!-- Developer: The quoted one refers to the word 'hierarchy', not to the thing that word designates. --> - - <p>Generally it is not possible to navigate the 'surroundings', if any, of this - element, so <type scope="com::sun::star::container">XChild</type> is not - supported. + <p>Generally it is not possible to navigate the parent or siblings, if any, + of this element, so <type scope="com::sun::star::container">XChild</type> is + not supported. </p> -<!-- Dennis: Why is surroundings in quotes? --> -<!-- Developer: For no really good reason. I'm not sure if 'surroundings' is the best word here. - We just never use this term in our documentation. 'context' is an alternative, but it also - is not exactly what I mean. The intent is: - "You cannot navigate to ancestors or siblings of this node in the real (full) hierarchy - (if they exist at all - which you can't determine given just this object)." ---> - @see com::sun::star::configuration::UpdateRootElement Implementations that support modifying data in the hierarchy - generally implement service UpdateRootElement. + implement service UpdateRootElement. @see com::sun::star::configuration::SetElement A complementary service, for children of a dynamic homogeneous container. @@ -140,7 +129,7 @@ service AccessRootElement /** allows controlling or observing the lifetime of the whole hierarchy. <p>The owner of the hierarchy may dispose of this object - using <member scope="com::sun::star::lang">XComponent::dispose</member>. + using <member scope="com::sun::star::lang">XComponent::dispose()</member>. As this object owns its child elements and, recursively, the whole hierarchy, any descendant elements obtained, directly or indirectly, from this object will also be disposed. Disposing of the object does not affect a persistent @@ -177,14 +166,14 @@ service AccessRootElement </p> <p> - If <member scope="com::sun::star::beans">XMultiPropertySet::setPropertyValues</member> - or <member scope="com::sun::star::beans">XMultiHierarchicalPropertySet::setHierarchicalPropertyValues</member> + If <member scope="com::sun::star::beans">XMultiPropertySet::setPropertyValues()</member> + or <member scope="com::sun::star::beans">XMultiHierarchicalPropertySet::setHierarchicalPropertyValues()</member> is used on an element of the hierarchy to change multiple values within the hierarchy, all changes will be notified with a single event. </p> <p>If an outside source uses - <member scope="com::sun::star::util">XChangesBatch::commitChanges</member> + <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> on an overlapping hierarchy access, all relevant changes will be notified with a single event. </p> @@ -205,7 +194,7 @@ service AccessRootElement <p><em>Changing the locale is generally not supported.</em> If it is supported, there is no guarantee that values already loaded into the hierarchy, or an application cache, are refreshed to reflect the new locale. Use of - <member scope="com::sun::star::lang">XLocalizable::setLocale</member> + <member scope="com::sun::star::lang">XLocalizable::setLocale()</member> is therefore not recommended. </p> */ diff --git a/offapi/com/sun/star/configuration/AdministrationProvider.idl b/offapi/com/sun/star/configuration/AdministrationProvider.idl new file mode 100644 index 000000000000..4eedfaa9848f --- /dev/null +++ b/offapi/com/sun/star/configuration/AdministrationProvider.idl @@ -0,0 +1,225 @@ +/************************************************************************* + * + * $RCSfile: AdministrationProvider.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:02:38 $ + * + * 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_configuration_ConfigurationProvider_idl__ +#define __com_sun_star_configuration_ConfigurationProvider_idl__ + +#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ +#include <com/sun/star/lang/XMultiServiceFactory.idl> +#endif + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module configuration { + +//============================================================================= +/** manages one, or more, complete sets of configuration data for + administrative puposes and serves as a factory for objects that + provide access to subsets of these shared configurations. + + <p>Shared sets of configuration data usually serve to provide defaults, + which are used if no individual settings are present. Depending on the data + store multiple layers of defaults may be combined with a user-specific layer + to make up the final configuration. + </p> + <p>Many aspects of the supported behavior depend strongly on the underlying + data store and on the administrative structures it defines. With some data + stores this service also enables access to individual users' configuration + data by an administrator. + </p> + <p>On the other hand, in the simplest model there is only a single layer of + default data which is accessible through this service. + </p> + <p>An implementation is usually obtained from a + <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to + <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> + select the configuration data source. They may also define the scope of + administrable data or contain credentials to be used to authorize the + administrative access. Missing parameters may be filled in + from the context or the environment. + </p> + + @see com::sun::star::configuration::ConfigurationProvider + Offers the same services and creates the same accessor objects as this + service, but accesses the personal configuration. + + <p>A <type> ConfigurationProvider</type> provides access to the personal + layer of configuration data of the current user context. It should in + most cases be used when <em>using</em> the configuration data, although + for most contexts a <type>AdministrationProvider</type> can be used as + a drop-in replacement. + </p> + */ +service AdministrationProvider +{ +/** allows creating access objects for specific views such as subsets and fragments + of the configuration. + + <p>The parameter <var>aServiceSpecifier</var> passed to + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + supports at least the service specifiers + <code>"com.sun.star.configuration.ConfigurationAccess"</code> and + <code>"com.sun.star.configuration.ConfigurationUpdateAccess"</code>. + </p> + + <p>Using the first of these service specifiers requests a read-only view of + the configuration. + The object that is created implements service <type>ConfigurationAccess</type>. + To reflect its <em>element role</em> as root of the view, it implements + service <type>AccessRootElement</type>. + </p> + + <p>Using the second form requests an updatable view of the configuration. + The object that is created should implement service + <type>ConfigurationUpdateAccess</type>. To reflect its <em>element role</em> + which includes controlling updates for the whole view, it implements + service <type>UpdateRootElement</type>. + <BR />If the root element of the view is marked read-only (as indicated + by <const scope="com::sun::star::beans">PropertyAttributes::READONLY</const>), + the implementation may either raise an exception or return a (read-only) + <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. + </p> + + <p>The arguments passed to + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + in parameter <var>aArguments</var> specify the administrative entity for which + data should be administered. In other words they determine the layer to which + changes will apply. They also specify the view of that configuration that + should be created. That is, they determine the subset of elements that can be + accessed starting from the returned object. Each element of the argument + sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> + or a <type scope="com::sun::star::beans">NamedValue</type>, + so that the parameters can be identified by name rather than by position. + </p> + + <p>What combinations of arguments are supported depends on the service name + and on the data store being administered. + </p> + + <p>With both of the standard service-specifiers above, an implementation must + accept a single argument named <code>nodepath</code> of type <atom>string</atom>. + This argument must contain the absolute path to an element of the + configuration. The view that is selected consists of the named element and + all its decendants. The administrative entity is the default for the + <type>AdministrationProvider</type>. Usually this is the largest entity + encompassing all entities accessible from this instance. In other words this + can be used to influence as global a scope as possible. + </p> + + <p>Other arguments can be used to select a more specific entity and to control + the behavior of the view. These are different for different implementations + and data stores. Whether and how they are used may also depend on properties + that were selected when the provider was created. + </p> + + <p>An implementation may ignore unknown arguments.</p> + + <p>Some parameters that are commonly supported are described for service + <type>ConfigurationProvider</type>. + </p> + <p>One notable difference exists for parameter <code>"locale"</code>. For a + <type>ConfigurationProvider</type> the default behavior usually is to select + the locale set up for the user. But this service by default gets data for all + locales for which data is present. Locale-dependent values in this case are + replaced by a <type>SetAccess</type> using the language names as accessors. + This also allows targetted setting of values for selected locales. + This behavior can be requested explicitly by specifing a special argument + value <code>locale = "*"</code>. + </p> + + <p><member scope="com::sun::star::lang">XMultiServiceFactory::createInstance()</member> + may be unusable. Only an implementation that supports service names that can be + used with no further arguments support this method. It should return the + same result as if + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + had been called using an empty sequence of arguments. + </p> +*/ + interface com::sun::star::lang::XMultiServiceFactory; + + +/** allows controlling or observing the lifetime of the configuration. + + <p>The owner of the provider may dispose of this object + using <member scope="com::sun::star::lang">XComponent::dispose()</member>. + </p> + + <p>Views created by the provider generally refer to data that is managed by + the provider. Therefore, disposing of the provider will cause all objects + belonging to these views to be disposed of as well. This does not apply to + <em>snapshot</em> views that have their own copy of the data, if available. + </p> + +*/ + interface com::sun::star::lang::XComponent; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + + diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl index d0cbe9cd2823..f0244935f626 100644 --- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConfigurationAccess.idl,v $ * - * $Revision: 1.12 $ + * $Revision: 1.13 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -94,14 +94,8 @@ module com { module sun { module star { module configuration { //============================================================================= -/** provides (read) access to a fragment of the configuration hierarchy. - - <!-- Dennis: Why is "read" in () --> - <!-- Developer: I'm not completely sure whether to drop the parentheses or the word "read". - This service provides access to ... PERIOD. - But this access may be read only. This service only guarantees the ability to read data. - It does not preclude write access, though. - --> +/** provides read access to a fragment of the configuration hierarchy. + <p>Values that are direct or indirect descendants of a root element can be retrieved and, if themselves objects, navigated. Other interfaces provide access to information about this element and its context. @@ -111,11 +105,6 @@ module com { module sun { module star { module configuration { <p>Descendants of this service also implement this service. </p> - <!-- Dennis: Can the above sentence be changed to read: Descendants of this service also - implement this service recursively. --> - <!-- Developer: Dropped 'recursively' altogether. 'Descendants' (as opposed to 'children') - really says it all. --> - <p>Ultimately the configuration holds values. These values are organized into a hierarchy using structural elements. The structure is defined in advance in a schema. Necessary information from the schema is stored in the configuration @@ -136,9 +125,6 @@ module com { module sun { module star { module configuration { are defined in the configuration schema as <em>templates</em>. </dd> - <!-- Dennis: Is <p> the correct tag around "templates"? --> - <!-- Developer: No. --> - <dt>Groups</dt> <dd>are static collections of heterogeneous elements. The names and types of the elements of a <em>group</em> are completely defined in the @@ -166,9 +152,6 @@ module com { module sun { module star { module configuration { supported. The basic types are: </p> - <!-- Dennis: Should "Values" be in caps? --> - <!-- Developer: Not sure. Probably the emphasis is enough. --> - <ul> <li><strong>string</strong> can hold a human-readable text. <p>Values are represented as <atom>string</atom>.</p> @@ -203,11 +186,6 @@ module com { module sun { module star { module configuration { </li> </ul> - <!-- Dennis: Is the <atom> suppose to have visual effect? --> - <!-- Developer: It is one of our custom tags (for UNO builtin types). - It should have an effect in the generated output. Maybe a problem in your preview ? - I filed a bug report for the generator. --> - <p>Within templates an additional type <strong>any</strong> can occur. When such a template is used to create a new <type>SetElement</type>, the type of the element is initially reported as <atom>any</atom> (having no value). @@ -219,12 +197,6 @@ module com { module sun { module star { module configuration { its contents may be <NULL/>. </p> - <!-- Dennis: Should the data between the <const> appear in the HTML. It is not. --> - <!-- Dennis: Some of the text is not appearing --> - <!-- Developer: There was a closing quote missing on the scope attribute. - I wonder why this wasn't discovered by the generator. - All text is there now. --> - <p>The configuration should support explicit access to default values (implementing <type scope="com::sun::star::beans">XPropertyState</type> and <type scope="com::sun::star::beans">XPropertyWithState</type>). @@ -261,14 +233,6 @@ service ConfigurationAccess which depends on its <em>Element</em> role. </p> - <!-- Dennis: Is there a better way to say "An implementation actually implements"? --> - <!-- Developer: Not sure. The intent is: - An implementation of the service being described here (...ConfigurationAccess) - implements the service named here (....HierarchyAccess) - by implementing a specialization of ...HierarchyAccess. - Which one is chosen out of several existing ones depends on the Element role. - I haven't found a less awkward way to say that concisely. --> - <p>Implementations shall implement exactly one of:</p> <ul> <li><type>AccessRootElement</type> if this element is the @@ -280,29 +244,28 @@ service ConfigurationAccess <li><type>GroupElement</type> if this element is a child of a <em>Group</em>.</li> </ul> - <!-- Dennis: If this is a true representation of the HTML, there are some strange line breaks --> + */ service HierarchyElement; /** specializes <type>HierarchyAccess</type>, if this element is a <em>Set</em>. <p>This is an alternative to <type>GroupAccess</type>. - <!-- Developer: The changed text here should be in sync with the similar one in ConfigurationUpdateAccess --> + </p> /*[optional]*/ service SetAccess; /** specializes <type>HierarchyAccess</type>, if this element is a <em>Group</em>. - <BR>This is an alternative to <type>SetAccess</type>. - <!-- Developer: The changed text here should be in sync with the similar one in ConfigurationUpdateAccess --> -*/ + <p>This is an alternative to <type>SetAccess</type>. + </p> + */ /*[optional]*/ service GroupAccess; /** specializes <type>HierarchyElement</type>, if this element is the <em>Root</em> of the whole hierarchy. - <BR>This is an alternative to <type>SetElement</type> + <p>This is an alternative to <type>SetElement</type> or <type>GroupElement</type>. - <!-- Developer: The changed text here should be in sync with the similar one in ConfigurationUpdateAccess --> - + </p> @see ConfigurationProvider Instances obtained from a <type>ConfigurationProvider</type> will @@ -312,17 +275,17 @@ service ConfigurationAccess /** specializes <type>HierarchyElement</type>, if this element may be contained in a <em>Set</em>. - <BR>This is an alternative to <type>AccessRootElement</type> + <p>This is an alternative to <type>AccessRootElement</type> or <type>GroupElement</type>. - <!-- Developer: The changed text here should be in sync with the similar one in ConfigurationUpdateAccess --> + </p> */ /*[optional]*/ service SetElement; /** specializes <type>HierarchyElement</type>, if this element is a child of a <em>Group</em>. - <BR>This is an alternative to <type>AccessRootElement</type> + <p>This is an alternative to <type>AccessRootElement</type> or <type>SetElement</type>. - <!-- Developer: The changed text here should be in sync with the similar one in ConfigurationUpdateAccess --> + </p> */ /*[optional]*/ service GroupElement; }; diff --git a/offapi/com/sun/star/configuration/ConfigurationProvider.idl b/offapi/com/sun/star/configuration/ConfigurationProvider.idl index f369b9ccfc14..a33e71504b80 100644 --- a/offapi/com/sun/star/configuration/ConfigurationProvider.idl +++ b/offapi/com/sun/star/configuration/ConfigurationProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConfigurationProvider.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,16 +78,15 @@ module com { module sun { module star { module configuration { factory for objects that provide access to a subset of the configuration. <p>An implementation is usually obtained from a - <type scope="com::sun::star::lang">ServiceManager</type>. The default - <code>com.sun.star.configuration.ConfigurationProvider</code> object, that is - instantiated without using extra arguments, is a one instance service. + <type scope="com::sun::star::lang">ServiceManager</type>. The arguments passed to + <member scope="com::sun::star::lang">XMultiComponentFactory::createInstanceWithContextAndArguments()</member> + select the configuration data source. Missing parameters may also be taken + from the context or the environment. If an instance already exists for the + given set of arguments, the existing instance may be reused. + In particular, instantiating a provider without explicit arguments to access + the default configuration data will always yield the same + <code>com.sun.star.configuration.ConfigurationProvider</code> object. </p> - - <!-- Dennis: Why is "global" in ()? --> - <!-- Dennis: The <code> tag is doing nothing. --> - <!-- Developer: IMHO it should select a fixed width font (like with <pre>). - It does in the generated output. Maybe a preview problem ? - The quotes were wrong, though. --> */ service ConfigurationProvider { @@ -101,44 +100,34 @@ service ConfigurationProvider <code>"com.sun.star.configuration.ConfigurationUpdateAccess"</code>. </p> - <!-- Dennis: the <code> is doing nothing --> - <!-- Developer: It does in the generated output. --> - - <p>Using the first of these requests a read-only view of the configuration. + <p>Using the first of these service specifiers requests a read-only view of + the configuration. The object that is created implements service <type>ConfigurationAccess</type>. To reflect its <em>element role</em> as root of the view, it implements service <type>AccessRootElement</type>. </p> - <!-- Dennis: The first sentence of the previous para appears to have a missing verb --> - <!-- Developer: The verb is 'requests'. --> - <p>Using the second form requests an updatable view of the configuration. The object that is created should implement service <type>ConfigurationUpdateAccess</type>. To reflect its <em>element role</em> which includes controlling updates for the whole view, it implements service <type>UpdateRootElement</type>. - <BR>If the root element of the view is marked read-only (as indicated + <BR />If the root element of the view is marked read-only (as indicated by <const scope="com::sun::star::beans">PropertyAttributes::READONLY</const>), the implementation may either raise an exception or return a (read-only) <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. </p> - <!-- Dennis: <BR/> is doing nothing in the HTML --> - <!-- Developer: Missing space before the closing slash --> - <p>The arguments passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> in parameter <var>aArguments</var> specify the view of the configuration that should be created. That is, they determine the subset of elements that can be accessed starting from the returned object. Each element of the argument - sequence should be a <type scope="com::sun::star::beans">PropertyValue</type>, + sequence should be a <type scope="com::sun::star::beans">PropertyValue</type> + or a <type scope="com::sun::star::beans">NamedValue</type>, so that the parameters can be identified by name rather than by position. </p> - <!-- Dennis: Is the member suppose to have a formatting effect on the HTML? --> - <!-- Developer: Should create a hyperlink ! Preview problem or syntax ? --> - <p>What combinations of arguments are supported depends on the service name. </p> @@ -176,11 +165,8 @@ service ConfigurationProvider </dd> </dl> - <!-- Dennis: <dt> and <dd> tags are being generated out of order --> - <!-- Developer: I had them wrong --> - <p><strong>Example:</strong> In the hierarchy -<BR><pre> +<BR /><pre> A - B1 - C1 | - B2 - C2 (localized: de, en, fr, ..) @@ -200,10 +186,10 @@ service ConfigurationProvider - B4 - C6 - D4 - E3 </pre> - <BR>selecting a view with <code>nodepath = "/A/B2"</code>, + <BR />selecting a view with <code>nodepath = "/A/B2"</code>, <code>depth = 2</code> and <code>locale = <Locale for en_US></code> would result in the tree fragment -<BR><pre> +<BR /><pre> (A-) B2 - C2 (en) | - C3 - D1 @@ -233,16 +219,12 @@ service ConfigurationProvider returns. </dd> - <!-- Dennis: the data in the member is not being displayed. --> - <!-- Developer: added missing parentheses - does this fix it ? Now seen in the generated HTML. - BTW: It seems that <dt> and <dd> tags were in the wrong order here again --> - <dt><code>"nocache"</code> : <atom>boolean</atom></dt> <dd>specifies that data for the view is not taken from the cache, but - read directly from storage. This may entail future changes that + read directly from storage. This may entail that future changes that become visible in the cache are not reflected in this view and that changes done through this view are not reflected in the cache. - <BR><strong>Use with caution !</strong> + <BR /><strong>Use with caution !</strong> </dd> </dl> </li> @@ -262,7 +244,7 @@ service ConfigurationProvider /** allows controlling or observing the lifetime of the configuration. <p>The owner of the provider may dispose of this object - using <member scope="com::sun::star::lang">XComponent::dispose</member>. + using <member scope="com::sun::star::lang">XComponent::dispose()</member>. Note that the default provider is owned by the <type scope="com::sun::star::lang">ServiceManager</type> and should not be disposed of by user code. @@ -285,3 +267,4 @@ service ConfigurationProvider #endif + diff --git a/offapi/com/sun/star/configuration/ConfigurationRegistry.idl b/offapi/com/sun/star/configuration/ConfigurationRegistry.idl index 5c3158be1d9b..7b42dd4ab6f6 100644 --- a/offapi/com/sun/star/configuration/ConfigurationRegistry.idl +++ b/offapi/com/sun/star/configuration/ConfigurationRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConfigurationRegistry.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,24 +75,27 @@ module com { module sun { module star { module configuration { //============================================================================= -/* provides access to a configuration tree as a registry. Using the - <type scope="com::sun::star::registry">XSimpleRegistry</type> interface, the - service can be bound to a subtree within the configuration tree, as provided - by an <service scope="com.sun.star.configuration">ConfigurationProvider</service> +/* provides access to a configuration tree as a registry. + + <p> Using the <type scope="com::sun::star::registry">XSimpleRegistry</type> + interface, the service can be bound to a subtree within the + configuration tree, as provided by an + <type scope="com.sun.star.configuration">ConfigurationProvider</type> service, which must be accessible from the service factory you use for the creation of this service. - <BR> - There are some restrictions when accessing a configuration tree using a registry. + </p> + <p> There are some restrictions when accessing a configuration tree using a registry. Most of them are implications of the fact that a configuration tree is very static in it's structure. Removal and addition of sub nodes is allowed only for special nodes, and even then the new elements have to comply to a given scheme (which is some kind of attribute of the container node). So for instance the - <member scope="com.sun.star.registry">XRegistryKey::createKey</member> method is not allowed + <member scope="com.sun.star.registry">XRegistryKey::createKey()</member> method is not allowed for some nodes. - <BR> + </p><p> Thus anybody using this service is strongly advised to read and understand the specification - of an configuration provider (<service scope="com.sun.star.configuration">ConfigurationProvider</service>) + of an configuration provider (<type scope="com.sun.star.configuration">ConfigurationProvider</type>) and all of it's aspects. + </p> @author Frank Schoenheit @version 1.0 2000/07/06 @@ -101,17 +104,26 @@ module com { module sun { module star { module configuration { service ConfigurationRegistry { /** controls the binding of the object to a configuration sub tree. - <member scope="com::sun::star::registry">XSimpleRegistry::open</member> is used to - open a special subtree within the configuration tree.<BR> - The parameters of this method control the location of the root of the to-be-opened + <p><member scope="com::sun::star::registry">XSimpleRegistry::open()</member> + is used to open a special subtree within the configuration tree. + </p> + <p>The parameters of this method control the location of the root of the to-be-opened configuration node and the access mode (read only or updatable). + </p> */ interface com::sun::star::registry::XSimpleRegistry; - /** as specified for the <service scope="com.sun.star.configuration">ConfigurationProvider</service> - service, all changes made to an configuration subtree have to be commited before they become - persistent. The <interface scope="com.sun.star.util">XFlushable</interface> is used to control - this behavior for a configuration accessed as a registry. + /** is used to commit changes to the configuration. + <p>As specified for the + <type scope="com.sun.star.configuration">ConfigurationUpdateAccess</type> + service, all changes made to an configuration subtree have to be commited + before they become persistent. + To do this for a configuration accessed as a registry, call + <member scope="com.sun.star.util">XFlushable::flush()</member>. + </p> + <p><strong>Warning:</strong><em>Changes that are not flushed will be + lost.</em> + </p> */ interface com::sun::star::util::XFlushable; }; diff --git a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl index d558367ffc05..cda017a9626d 100644 --- a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConfigurationUpdateAccess.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,18 +89,11 @@ module com { module sun { module star { module configuration { </p> <p>Descendants of this service also implement this service - unless they are marked <em>read-only</em> in the - schema (which is indicated by attribute + unless they are marked <em>read-only</em> (which is indicated by attribute <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>), in which case they only need implement <type>ConfigurationAccess</type>. </p> - <!-- Dennis: data in <const> not displaying. --> - <!-- Developer: The current version is OK in the generated output. Preview problem ? --> - <!-- Dennis: "(and so on recursively)" needs to be rewritten. --> - <!-- Dennis: only the @see is being displayed beyond this point. --> - <!-- Developer: The current version is OK in the generated output. Preview problem ? --> - <p>The classification of implementations that is described for <type>ConfigurationAccess</type> applies to implementations of this service as well. Therefore an implementation will support one of several alternate @@ -143,7 +136,7 @@ service ConfigurationUpdateAccess are no new requirements mandated by the <em>Element</em> role. </p> -*/ + */ service ConfigurationAccess; /** specializes <type>SetAccess</type> to support modifying the element. @@ -151,14 +144,6 @@ service ConfigurationUpdateAccess <p>Implemented, if this element is a <em>Set</em>. Otherwise service <type>GroupUpdate</type> is provided. </p> - - <!-- Dennis: Should the last sentence read: "This is an alternative to <type>GroupUpdate</type>" --> - <!-- Developer: There are several similar services (here: SetUpdate and GroupUpdate). Exactly one - of these alternatives is available. - How can I express that more concisely ? I tried to rephrase it. - I think your version is slightly misleading. - We should use the same phrase here as in ConfigurationAccess. You already introduced - "This is an alternative .." there --> */ /*[optional]*/ service SetUpdate; @@ -168,25 +153,16 @@ service ConfigurationUpdateAccess <p>Implemented, if this element is a <em>Group</em>. Otherwise service <type>SetUpdate</type> is provided. </p> - - <!-- Dennis: Same comment as above --> - <!-- Developer: Same answer as above -->*/ + */ /*[optional]*/ service GroupUpdate; /** specializes <type>AccessRootElement</type> to support transaction-like - control over a batch of changes accumulated within the tree (fragment). - - <!-- Dennis: Why is "fragment" in ()? --> - <!-- Developer: I sometimes use 'tree' (or 'hierarchy') where 'tree fragment' ('hierarchy fragment') - would be more concise. The parenthesized 'fragment' is to remind of this. --> + control over a batch of changes accumulated within the tree fragment. <p>Implemented, if this element is the <em>Root</em> of the whole hierarchy. Otherwise either <type>SetElement</type> or <type>GroupElement</type> is provided. </p> - <!-- Dennis: BR is displaying --> - <!-- Developer: In the preview or in the generated HTML ? --> - @see ConfigurationProvider Instances obtained from a <type>ConfigurationProvider</type> will implement this version of <type>HierarchyElement</type>. diff --git a/offapi/com/sun/star/configuration/GroupAccess.idl b/offapi/com/sun/star/configuration/GroupAccess.idl index ffa08a8bf6b7..abb10b64442b 100644 --- a/offapi/com/sun/star/configuration/GroupAccess.idl +++ b/offapi/com/sun/star/configuration/GroupAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: GroupAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,13 +83,7 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides access to a predefined heterogeneous group of values and nested - trees as part of a (by name) hierarchy. - - <!-- Dennis: Could this also read as "...as part of an alphabetical hierarchy." ? --> - <!-- Developer: No. The 'by name' refers to the fact that children are accessed by name - (e.g. using XNameContainer) rather than by index, by enumeration or by other criteria. - It corresponds to method names like getByName, replaceByName, insertByName. - BTW: Same as in GroupElement. --> + trees as part of a hierarchy. <p>Provides access to, and information about, its children and descendants viewed either as properties or as contained elements. @@ -146,9 +140,6 @@ service GroupAccess <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set, and attempts to change property values will fail. </p> - - <!-- Dennis: <const> issue again --> - <!-- Developer: Surely a preview problem (not seen here) --> */ service PropertyHierarchy; @@ -177,8 +168,7 @@ service GroupAccess an implementation. [optional] <p>This interface may be missing if the hierarchy (or a hierarchy fragment - that contains this implementation as element) does not support default values, - or if the implementation does not support recursive defaults (see below). + that contains this implementation as element) does not support default values. </p> <p>If elements that are not simple values, but objects themselves, support diff --git a/offapi/com/sun/star/configuration/GroupElement.idl b/offapi/com/sun/star/configuration/GroupElement.idl index 99722f6a37dc..694dca1b1ad4 100644 --- a/offapi/com/sun/star/configuration/GroupElement.idl +++ b/offapi/com/sun/star/configuration/GroupElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: GroupElement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,13 +75,7 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides information about a predefined element contained in a - heterogeneous group of elements within a (by name) hierarchy. - - <!-- Dennis: Can it be rewritten as "...within an alphabetical hierarchy."? --> - <!-- Developer: No. The 'by name' refers to the fact that children are accessed by name - (e.g. using XNameContainer) rather than by index, by enumeration or by other criteria. - It corresponds to method names like getByName, replaceByName, insertByName. - BTW: Same as in GroupElement. --> + heterogeneous group of elements within a hierarchy. <p>Provides information about the element. Provides access to its containing group object. @@ -112,7 +106,7 @@ service GroupElement <p>In this service this interface is mandatory</p> - <p><member scope="com::sun::star::container">XChild::getParent</member> + <p><member scope="com::sun::star::container">XChild::getParent()</member> shall not return NULL. </p> diff --git a/offapi/com/sun/star/configuration/GroupUpdate.idl b/offapi/com/sun/star/configuration/GroupUpdate.idl index 033ee7aaf52b..05a30fb465b7 100644 --- a/offapi/com/sun/star/configuration/GroupUpdate.idl +++ b/offapi/com/sun/star/configuration/GroupUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: GroupUpdate.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,13 +75,7 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides write access to a predefined heterogeneous group of values - and nested trees as part of a (by name) hierarchy. - - <!-- Dennis: alphabetical hierarchy? --> - <!-- Developer: No. See the description in GroupAccess,GroupElement. --> - - <p>Allows replacing values with new values. - </p> + and nested trees as part of a hierarchy. <p>This service extends <type>GroupAccess</type> to support modifying values. @@ -96,9 +90,6 @@ service GroupUpdate unless they represent a read-only tree element as indicated by <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>. </p> - - <!-- Dennis: What is meant by "shall again"? --> - <!-- Developer: "must/will ... as well" --> */ service GroupAccess; @@ -120,8 +111,8 @@ service GroupUpdate <p>Elements of this group may be replaced only if they are of simple type. The type returned by - <member scope="com::sun::star::container">XElementAccess::getElementType</member> - is not an interface type. Replacing whole subtrees is not supported. + <member scope="com::sun::star::container">XElementAccess::getElementType()</member> + must not be an interface type. Replacing whole subtrees is not supported. </p> */ interface com::sun::star::container::XNameReplace; diff --git a/offapi/com/sun/star/configuration/HierarchyAccess.idl b/offapi/com/sun/star/configuration/HierarchyAccess.idl index 372bfc982588..88974ebfa3c5 100644 --- a/offapi/com/sun/star/configuration/HierarchyAccess.idl +++ b/offapi/com/sun/star/configuration/HierarchyAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,27 +82,20 @@ module com { module sun { module star { module configuration { //============================================================================= -/** provides access to a (by name) hierarchy of descendant elements. +/** provides access to a hierarchy of descendant elements. - <!-- Dennis: alphabetical? --> - <!-- Developer: No. See the description in GroupAccess,GroupElement. --> - - <p>Values that are direct or indirect descendants of this tree node can be - retrieved. Non-value subnodes can be navigated using container interfaces. + <p>Subnodes are accessed by their name. Values that are direct or indirect + descendants of this tree node can be retrieved. Non-value subnodes can be + navigated using container interfaces. Other interfaces provide access to information about this node. Changes to values in the subtree can be monitored by event listeners. </p> - <p>Elements of this (by name) container that are not simple values + <p>Elements of this container that are not simple values are similar containers themselves, thus (recursively) forming a hierarchical tree. </p> - <!-- Dennis: "(by name)" ?? --> - <!-- Developer: Rather than by index, by language or by phase of the moon. - As in XNameAccess vs. XIndexAccess vs XWhateverAccess (container interfaces) - having methods getByName(), getByIndex(), getByWhatever() --> - <p>Implementations of this service usually also implement service <type>HierarchyElement</type>, which concerns the complementary role of being accessible as an element of the hierarchy. @@ -112,26 +105,19 @@ service HierarchyAccess { /** allows access to immediate children of this node. - <p><member scope="com::sun::star::container">XNameAccess::getByName</member> + <p><member scope="com::sun::star::container">XNameAccess::getByName()</member> returns an <atom>any</atom> holding either a simple value or an interface on another HierarchyAccess if the child is not a simple value. </p> - - <!-- Dennis: I don't understand the phrase "returns an Any holding" --> - <!-- Developer: Added missing <atom>. 'any' is a builtin variant type, - which can contain ('hold') values of any other type - (e.g., a ('simple') integer or interface -->*/ +*/ interface com::sun::star::container::XNameAccess; /** allows access to all descendants of this node - <p><member scope="com::sun::star::container">XHierarchicalNameAccess::getByHierarchicalName</member> + <p><member scope="com::sun::star::container">XHierarchicalNameAccess::getByHierarchicalName()</member> returns an <atom>any</atom> holding either a simple value or an interface on another HierarchyAccess if the descendant is not a simple value. </p> - - <!-- Dennis: I don't understand the phrase "returns an Any holding" --> - <!-- Developer: Same as above. --> */ interface com::sun::star::container::XHierarchicalNameAccess; @@ -143,22 +129,13 @@ service HierarchyAccess <p>Exact names can be obtained for simple or hierarchical names for use in <type scope="com::sun::star::container">XNameAccess</type>, <type scope="com::sun::star::container">XHierarchicalNameAccess</type>, - <type scope="com::sun::star::beans">XPropertySet</type>, etc. + <type scope="com::sun::star::beans">XPropertySet</type> or + any other interfaces that allow access to or manipulation of subnodes + selected by name or hierarchical name. + </p> + <p>If an inexact name could be matched to either a simple or a hierachical + name, the simple (immediate child) name is preferred. </p> - - <!-- Dennis: What constitutes "etc"? --> - <!-- Developer: Any other interfaces from any other services this object implements, - where there are methods that take a string parameter that is a child or descendant name. - Examples include (but are not necessarily limited to): - com::sun::star::beans::XMultiPropertySet - com::sun::star::beans::XHierarchicalPropertySet - com::sun::star::beans::XMultiHierarchicalPropertySet - com::sun::star::beans::XPropertySetInfo - com::sun::star::beans::XHierarchicalPropertySetInfo - com::sun::star::container::XNameReplace - com::sun::star::container::XNameContainer - com::sun::star::container::XHierarchicalName - --> */ interface com::sun::star::beans::XExactName; }; diff --git a/offapi/com/sun/star/configuration/HierarchyElement.idl b/offapi/com/sun/star/configuration/HierarchyElement.idl index 2aa3952a11c7..944d0d725e37 100644 --- a/offapi/com/sun/star/configuration/HierarchyElement.idl +++ b/offapi/com/sun/star/configuration/HierarchyElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyElement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,7 @@ module com { module sun { module star { module configuration { //============================================================================= -/** provides information about an element within a (by name) hierarchy. +/** provides information about an element within a hierarchy. <p>The local name and the full hierarchical name can be retrieved. Attributes detailing the role of the element can be queried. @@ -105,13 +105,9 @@ service HierarchyElement */ interface com::sun::star::container::XHierarchicalName; -/** provides the (local) name of this element within its parent. - - <!-- Why is local in ()? --> +/** provides the local name of this element within its parent. <p><em>Renaming an element is generally not supported.</em></p> - - <!-- Should be more specific. When is it allowed? When is it not allowed? --> */ interface com::sun::star::container::XNamed; @@ -144,11 +140,6 @@ service HierarchyElement <p>If an implementation is part of a <em>read-only</em> view of the hierarchy, attempts to change property states will fail. </p> - - <!-- Dennis: What "attempts"? --> - <!-- Developer: Here: calling to method setToDefaultAsProperty() - This may fail if the object already assumes its default state, - it will fail otherwise. --> */ [optional] interface com::sun::star::beans::XPropertyWithState; @@ -158,22 +149,11 @@ service HierarchyElement as a child or descendant of another tree node, for example, directly from a factory or provider. </p> - <p><member scope="com::sun::star::container">XChild::getParent</member> + <p><member scope="com::sun::star::container">XChild::getParent()</member> returns NULL, if this object is currently not contained in another node. </p> <p><em>Setting a different parent is, generally, not supported.</em></p> - - <!-- Dennis: "generally" is vague --> - <!-- Developer: To a degree on purpose ;) Basically what I mean is: - 1. It is not guaranteed to be supported, unless the object also implements - another service (maybe a more specialized version of this one) which - is documented to provide this support (see service SetElement). - 2. Neither is it guaranteed that such support is missing (unless - documented otherwise elsewhere.) - 3. The basic assuption of the user should be 'not supported' - 4. Existing implementations don't support it. - --> */ [optional] interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/configuration/PropertyHierarchy.idl b/offapi/com/sun/star/configuration/PropertyHierarchy.idl index 323609064432..4bbc25417457 100644 --- a/offapi/com/sun/star/configuration/PropertyHierarchy.idl +++ b/offapi/com/sun/star/configuration/PropertyHierarchy.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyHierarchy.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,18 +91,12 @@ module com { module sun { module star { module configuration { direct access even to subproperties. </p> - <!-- Dennis: is the phrase "(and so on recursively)" necessary? --> - <!-- Developer: Yes. Unless the recursive nature of this is mentioned - we don't have a description of a hierarchical set of potentially - unlimited depth. Not having the phrase (or a replacement for it) - here, would IMHO suggest a 'hierarchy' of only two levels. --> - - <p>Properties of an implementation that are objects themselves will often + @see com::sun::star::beans::XProperty + Properties of an implementation that are objects themselves will often implement <type scope="com::sun::star::beans">XProperty</type> to allow direct access to information about the object. - If such properties have properties of their own, they should fully implement + If such objects have properties of their own, they should fully implement <type>PropertyHierarchy</type> again. - </p> */ service PropertyHierarchy { diff --git a/offapi/com/sun/star/configuration/SetAccess.idl b/offapi/com/sun/star/configuration/SetAccess.idl index 347dd5304226..bc63ab7256cb 100644 --- a/offapi/com/sun/star/configuration/SetAccess.idl +++ b/offapi/com/sun/star/configuration/SetAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: SetAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,21 +79,13 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides access to a dynamic, homogeneous set of values or nested - trees within a (by name) hierarchy. - - <!-- Dennis: (by name) ??? --> - <!-- Developer: See the description in GroupAccess,GroupElement, HierarchyAccess. --> + trees within a hierarchy. <p>Also provides information about the template for elements. Allows normalizing externally generated names. </p> - <p><em>Sets</em> here are dynamic containers within the hierarchy.</p> - - <!-- Dennis: is the word "here" necessary because "Sets" elsewhere are not dynamic containers --> - <!-- Developer: sets are always containers, probably dynamic ones. They are not necessarily - parts of a hierarchy. In the configuration package 'set' has a very specific somewhat - peculiar meaning. The 'here' is supposed to emphasize that there is such a special meaning. --> + <p><em>Sets</em> are dynamic containers within the hierarchy.</p> <p>The number and names of contained elements are not fixed in advance, but all elements have to be of one predetermined type. @@ -102,9 +94,9 @@ module com { module sun { module star { module configuration { @see com::sun::star::configuration::SetElement Child objects of this service generally implement <type>SetElement</type>. The template name returned by the child from - <member>XTemplateInstance::getTemplateName</member> + <member>XTemplateInstance::getTemplateName()</member> corresponds to the name returned by the set from - <member>XTemplateContainer::getElementTemplateName</member>. + <member>XTemplateContainer::getElementTemplateName()</member>. @see com::sun::star::configuration::GroupAccess A complementary service that provides for static heterogeneous groups of @@ -116,7 +108,7 @@ service SetAccess /** is the basic service for accessing child and descendent nodes in a hierarchy. <p>External names (from foreign namespaces) should be normalized using - <member scope="com::sun::star::util">XStringEscape::escapeString</member> + <member scope="com::sun::star::util">XStringEscape::escapeString()</member> (if available) before using them as element names. </p> */ @@ -128,12 +120,6 @@ service SetAccess <p>Interface <type scope="com::sun::star::configuration">XTemplateContainer</type>, which is optional in <type>SimpleSetAccess</type> must always be implemented in this service, if the elements are of object type. </p> - - <p> If an implementation handles naming restrictions transparently, it must - also handle the case of element names embedded in hierarchical names - passed - to any object in the hierarchy. Otherwise, the implementation should implement - <type scope="com::sun::star::util">XStringEscape</type>, in which case, - the client is responsible for constructing correct hierarchical names. </p> */ service SimpleSetAccess; diff --git a/offapi/com/sun/star/configuration/SetElement.idl b/offapi/com/sun/star/configuration/SetElement.idl index 2b72d4c4bfc5..1bb2ad0d2316 100644 --- a/offapi/com/sun/star/configuration/SetElement.idl +++ b/offapi/com/sun/star/configuration/SetElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: SetElement.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,10 +83,7 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides information about a dynamic element that can be inserted into a - homogeneous set of elements within a (by name) hierarchy. - - <!-- Dennis: "(by name)" ??? --> - <!-- Developer: See the description in GroupAccess,GroupElement, HierarchyAccess. --> + homogeneous set of elements within a hierarchy. <p>Provides information about the element. Provides access to its containing set object. @@ -107,26 +104,26 @@ module com { module sun { module star { module configuration { <p>While an instance is not contained in a set object, it is owned by the client and can be disposed by calling - <member scope="com::sun::star::lang">XComponent::dispose</member>. The name + <member scope="com::sun::star::lang">XComponent::dispose()</member>. The name of the object can freely be changed in that situation though without persistent effect. </p> - <p>When the instance is inserted into a set which includes replacing an - existing element, ownership is transferred to the container. - While it is contained in the container, clients must not dispose of the + <p>When the instance is inserted into a set (this includes replacing an + existing element), ownership is transferred to the container. + While it is contained in the container, clients must not dispose the object. When inserted, the name of the object is fixed and is used to - identify it within the container. An implementation should support - <member scope="com::sun::star::container">XNamed::setName</member> even in + identify it within the container. An implementation may support + <member scope="com::sun::star::container">XNamed::setName()</member> even in this case. If it does, changing the name has the same effect of removing the object (under the old name) and then reinserting it into the same container (using the new name). </p> - <p>When an instance is removed from a set (which includes being replaced by + <p>When an instance is removed from a set (this includes being replaced by a new element), ownership is transferred to the client again. It can then be - disposed of or reinserted into a container. An instance can only be inserted - into a container if it was obtained from the same hierarchy. + disposed or reinserted into a container. An instance can only be inserted + into a container, if it was obtained from the same hierarchy. </p> <p>When a set element is removed from its set from outside the hierarchy, the @@ -160,12 +157,12 @@ service SetElement <p>In this service, this interface is mandatory</p> - <p><member scope="com::sun::star::container">XChild::getParent</member> + <p><member scope="com::sun::star::container">XChild::getParent()</member> returns <NULL/>, if the object is currently not contained in a container. </p> <p>An implementation may also support - <member scope="com::sun::star::container">XChild::setParent</member>. + <member scope="com::sun::star::container">XChild::setParent()</member>. If it does, changing the parent has the effect of first removing the object from its old parent (if any) and then inserting it into the new parent (unless that is <NULL/>) under the same name. The new parent must be part of @@ -178,9 +175,9 @@ service SetElement /** allows controlling or observing the lifetime of the object. <p>Clients may dispose of the object using - <member scope="com::sun::star::lang">XComponent::dispose</member>, only if + <member scope="com::sun::star::lang">XComponent::dispose()</member>, only if the object is currently not contained in a container ( - <member scope="com::sun::star::container">XChild::getParent</member> + <member scope="com::sun::star::container">XChild::getParent()</member> returns <NULL/>). </p> diff --git a/offapi/com/sun/star/configuration/SetUpdate.idl b/offapi/com/sun/star/configuration/SetUpdate.idl index beb85a33ff01..7241a787296a 100644 --- a/offapi/com/sun/star/configuration/SetUpdate.idl +++ b/offapi/com/sun/star/configuration/SetUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: SetUpdate.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ module com { module sun { module star { module configuration { //============================================================================= /** provides write access to a dynamic homogeneous set of values or nested - trees within a (by name) hierarchy. + trees within a hierarchy. <p>Allows adding and removing elements. Helps creates new elements to be added. @@ -89,9 +89,6 @@ module com { module sun { module star { module configuration { unless they represent a read-only tree element (as indicated by <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>). </p> - - <!-- Dennis: "again"? --> - <!-- Developer: As in GroupUpdate --> */ service SetUpdate { @@ -120,12 +117,12 @@ service SetUpdate <p>Implementations that support insertion of objects that weren't obtained from within the hierarchy must reject elements that don't have the correct structure as described by the template, even if the object returns the - correct template name from <member>XTemplateInstance::getTemplateName</member>. + correct template name from <member>XTemplateInstance::getTemplateName()</member>. </p> <p>Other ways in which an element may be moved among or within compatible sets - include <member scope="com::sun::star::container">XChild::setParent</member> - and <member scope="com::sun::star::container">XNamed::setName</member>, if + include <member scope="com::sun::star::container">XChild::setParent()</member> + and <member scope="com::sun::star::container">XNamed::setName()</member>, if the element implements them. </p> diff --git a/offapi/com/sun/star/configuration/SimpleSetAccess.idl b/offapi/com/sun/star/configuration/SimpleSetAccess.idl index dd84ec819fab..da7f2d46bbfc 100644 --- a/offapi/com/sun/star/configuration/SimpleSetAccess.idl +++ b/offapi/com/sun/star/configuration/SimpleSetAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleSetAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,7 +100,7 @@ service SimpleSetAccess /** is the basic service for accessing child and descendent nodes. <p>External names from foreign namespaces should be normalized using - <member scope="com::sun::star::util">XStringEscape::escapeString</member>, + <member scope="com::sun::star::util">XStringEscape::escapeString()</member>, if available, before using them as element names. </p> */ diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index c2669459dbfc..7ed40fc3e55d 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleSetUpdate.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-26 09:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -113,11 +113,11 @@ service SimpleSetUpdate </p> <p>If the elements of this set are of simple type (the type returned by - <member scope="com::sun::star::container">XElementAccess::getElementType</member> + <member scope="com::sun::star::container">XElementAccess::getElementType()</member> is not an interface type), then values of that type can directly be passed to - <member scope="com::sun::star::container">XNameContainer::insertByName</member> + <member scope="com::sun::star::container">XNameContainer::insertByName()</member> and - <member scope="com::sun::star::container">XNameContainer::replaceByName</member>. + <member scope="com::sun::star::container">XNameContainer::replaceByName()</member>. </p> <p>Otherwise new elements have to be constructed to match the type @@ -127,22 +127,20 @@ service SimpleSetUpdate </p> <p>Objects to be inserted must not be contained in any set at the time of - insertion. <member scope="com::sun::star::container">XChild::getParent</member> + insertion. <member scope="com::sun::star::container">XChild::getParent()</member> must return <NULL/>. If a name had been assigned to the object prior to insertion (using <member scope="com::sun::star::container">XNamed::setName()</member> or by other means), this name is ignored and will be lost. After insertion the name of the object is the name that was used as argument - to <member scope="com::sun::star::container">XNameContainer::insertByName</member> - or <member scope="com::sun::star::container">XNameContainer::replaceByName</member>. + to <member scope="com::sun::star::container">XNameContainer::insertByName()</member> + or <member scope="com::sun::star::container">XNameContainer::replaceByName()</member>. </p> - <!-- Dennis: The last sentence is vague. --> - <!-- Developer: Now described in detail --> <p>Objects that are removed using - <member scope="com::sun::star::container">XNameContainer::removeByName</member> + <member scope="com::sun::star::container">XNameContainer::removeByName()</member> or replaced using - <member scope="com::sun::star::container">XNameContainer::replaceByName</member> + <member scope="com::sun::star::container">XNameContainer::replaceByName()</member> remain valid and can be reinserted into a set supporting the same template and even under a different name. </p> @@ -159,24 +157,24 @@ service SimpleSetUpdate <p>This interface shall be implemented by an implementation, if and only if the element type of the set, as returned by - <member scope="com::sun::star::container">XElementAccess::getElementType</member>, + <member scope="com::sun::star::container">XElementAccess::getElementType()</member>, is an object type, such as an interface. </p> - <p>Using <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member> + <p>Using <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance()</member> an instance of the element template of this set is created. If the set supports multiple templates or variations of the basic template, a default variant of the basic template is instantiated. If an implementation supports variations, they may be specified by passing arguments to - <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</member>. + <member scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments()</member>. There are no predefined arguments for all versions of this service. </p> <p>The object created is not contained in the set and does not have a name yet. It may subsequently be inserted into the set and named using - <member scope="com::sun::star::container">XNameContainer::insertByName</member> + <member scope="com::sun::star::container">XNameContainer::insertByName()</member> or - <member scope="com::sun::star::container">XNameContainer::replaceByName</member>. + <member scope="com::sun::star::container">XNameContainer::replaceByName()</member>. </p> */ interface com::sun::star::lang::XSingleServiceFactory; @@ -192,17 +190,17 @@ service SimpleSetUpdate <p>This interface may only be implemented if the element type of the set (as returned by - <member scope="com::sun::star::container">XElementAccess::getElementType</member>) + <member scope="com::sun::star::container">XElementAccess::getElementType()</member>) is an object type, such as an interface. An implementation should also implement interface <type>XTemplateContainer</type> which is optional in this service. </p> <p>The service identifier argument passed - to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstance</member> - or <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments</member> + to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstance()</member> + or <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> names the template to be instantiated or otherwise identifies the structure to be built. The implementation must at least support using the template - name obtained from <member>XTemplateContainer::getElementTemplateName</member> + name obtained from <member>XTemplateContainer::getElementTemplateName()</member> as a service identifier, in which case the result shall be the same as if the corresponding member of <type scope="com::sun::star::lang">XSingleServiceFactory</type> had been called. diff --git a/offapi/com/sun/star/configuration/UpdateRootElement.idl b/offapi/com/sun/star/configuration/UpdateRootElement.idl index eb887fe23d7b..96013aaeab80 100644 --- a/offapi/com/sun/star/configuration/UpdateRootElement.idl +++ b/offapi/com/sun/star/configuration/UpdateRootElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: UpdateRootElement.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jb $ $Date: 2001-04-06 16:24:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,12 +74,9 @@ module com { module sun { module star { module configuration { //============================================================================= -/** provides update control for a (by name) hierarchy +/** provides update control for a hierarchy of configuration items and information about the hierarchy as a whole as well as its root. - <!-- Dennis: "by name" ??? --> - <!-- Developer: See the description in GroupAccess,GroupElement, HierarchyAccess. --> - <p>Extends <type>AccessRootElement</type> by adding support for collecting changes and applying them to a backend store as a single batch. </p> @@ -100,7 +97,7 @@ module com { module sun { module star { module configuration { <p>The accumulated changes within this hierarchy can be managed using <type scope="com::sun::star::util">XChangesBatch</type>. Pending changes will become persistent and visible from other overlapping hierarchies - only when <member scope="com::sun::star::util">XChangesBatch::commitChanges</member> + only when <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> is called. If the hierarchy is disposed or discarded without committing changes, the changes will be lost. </p> @@ -118,19 +115,19 @@ service UpdateRootElement /** allows managing changes within the hierarchy. - <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges</member> + <p><member scope="com::sun::star::util">XChangesBatch::getPendingChanges()</member> reports all changes within the hierarchy that are done through (direct or indirect) descendants of this element. The same set of changes is committed to persistent storage and/or made visible to other objects accessing the same data set, when - <member scope="com::sun::star::util">XChangesBatch::commitChanges</member> + <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> is invoked. </p> <p>If the implementation supports - <member scope="com::sun::star::lang">XLocalizable::setLocale</member>, changes + <member scope="com::sun::star::lang">XLocalizable::setLocale()</member>, changes will be considered to apply to the locale that is set when - <member scope="com::sun::star::util">XChangesBatch::commitChanges</member> + <member scope="com::sun::star::util">XChangesBatch::commitChanges()</member> is invoked. </p> diff --git a/offapi/com/sun/star/configuration/XTemplateContainer.idl b/offapi/com/sun/star/configuration/XTemplateContainer.idl index 840f5928068e..a1726013b277 100644 --- a/offapi/com/sun/star/configuration/XTemplateContainer.idl +++ b/offapi/com/sun/star/configuration/XTemplateContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTemplateContainer.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: arellano $ $Date: 2001-04-16 21:20:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,8 @@ //============================================================================= -/** implemented by objects that contain instances of a named template. +/** is implemented by objects that contain instances of a named template to + provide information about the template. <p> An implementation will also implement <type scope="com::sun::star::lang">XSingleServiceFactory</type>, in which case @@ -80,8 +81,8 @@ <p> If multiple templates are supported, the supported factory interface may be <type scope="com::sun::star::lang">XMultiServiceFactory</type>, in which case the <atom>string</atom> returned from - <member>XTemplateContainer::getElementTemplateName</member> can be used as - the service name parameter. + <member>XTemplateContainer::getElementTemplateName()</member> can be used as + the service name argument. </p> @see XTemplateInstance @@ -90,18 +91,17 @@ interface XTemplateContainer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns + /** retrieves the name of the template - the name of the element's template. - <p> If instances of multiple templates are accepted by the container, - this is the name of the basic or primary template. - </p> - <p> Instances of the template must be created - using an appropriate factory. - </p> + <p> If instances of multiple templates are accepted by the container, + this is the name of the basic or primary template. + </p> + <p> Instances of the template must be created + using an appropriate factory. + </p> - <!-- Dennis: is the "@returns" a valid structure? --> - <!-- Developer: Yes. Means the same as @return. --> + @returns + the name of the (default) template for elements. */ string getElementTemplateName(); @@ -114,6 +114,12 @@ interface XTemplateContainer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8.14.1 2002/06/20 15:36:10 jb + reviewed + + Revision 1.8 2001/04/16 21:20:19 arellano + Punctuation changes + Revision 1.7 2001/04/06 16:24:30 jb Adjusted documentation; added developer's comments diff --git a/offapi/com/sun/star/configuration/XTemplateInstance.idl b/offapi/com/sun/star/configuration/XTemplateInstance.idl index 12a30ad215ca..d36129e2778a 100644 --- a/offapi/com/sun/star/configuration/XTemplateInstance.idl +++ b/offapi/com/sun/star/configuration/XTemplateInstance.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTemplateInstance.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-16 21:24:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,8 @@ //============================================================================= -/** implemented by objects that are instances of a named template. +/** is implemented by objects that are instances of a named template to provide + information about the template. <p> Template names are similar to service names, but apply to structure and content, rather than to type. @@ -87,7 +88,9 @@ interface XTemplateInstance: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns + /** retrieves the name of the template + + @returns the name of the template this object was built from or conforms to. */ string getTemplateName(); @@ -101,6 +104,12 @@ interface XTemplateInstance: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.14.1 2002/06/20 15:36:10 jb + reviewed + + Revision 1.6 2001/04/16 21:24:36 arellano + grammar changes + Revision 1.5 2001/03/16 16:41:17 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/datatransfer/DataFlavor.idl b/offapi/com/sun/star/datatransfer/DataFlavor.idl index d4ca0134b480..b5eb6bf8da55 100644 --- a/offapi/com/sun/star/datatransfer/DataFlavor.idl +++ b/offapi/com/sun/star/datatransfer/DataFlavor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataFlavor.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:37:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,8 @@ struct DataFlavor { //------------------------------------------------------------------------- /** The MIME content-type (type/subtype) string describing the data format - of the object to transfer. + of the object to transfer. MimeType must be conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>) */ string MimeType; diff --git a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl index 78f6c532996e..b4a93ef61db9 100644 --- a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataFormatTranslator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,14 +79,18 @@ module com { module sun { module star { module datatransfer { interface XDataFormatTranslator; //============================================================================= -/** manages a list of data flavors. +/** Different platforms use different types to describe data formats available + during data exchange operations like clipboard or drag&drop. + Implementations of this service do convert system dependent data types to a + <type>DataFlavor</type> and vice versa. - @see com::sun::star::datatransfer::XDTransFormatTranslator + @see com::sun::star::datatransfer::XDataFormatTranslator + @see com::sun::star::datatransfer::DataFlavor */ service DataFormatTranslator { //------------------------------------------------------------------------- - /** converts data flavors to system data types and vice versa. + /** Converts a <type>DataFlavor</type> to system data types and vice versa. */ interface XDataFormatTranslator; diff --git a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl index bc1154566e96..0173c857f6a2 100644 --- a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: MimeContentTypeFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:37:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,14 +83,22 @@ module com { module sun { module star { module datatransfer { interface XMimeContentTypeFactory; //============================================================================= -/** the MimeContentType service creates instances of MIME content-type +/** Used to create an instance that implement the interface + <type>XMimeContentType</type> from a string + representation of such a MIME content-type that is conform to + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. @see com::sun::star::datatransfer::XMimeContentTypeFactory */ service MimeContentTypeFactory { //------------------------------------------------------------------------- - /** creates mime content types from strings. + /** Creates an instance that implement the interface + <type>XMimeContentType</type> from the string + representation of such a MIME content-types that is conform to + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a>, + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. */ interface XMimeContentTypeFactory; diff --git a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl index fcae62e20531..78171993b2bc 100644 --- a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl +++ b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnsupportedFlavorException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-03-01 17:53:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,10 +71,11 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** exception thrown if a transfer data object is requested in a DataFlavor not - supported by the data source. +/** Exception will be thrown if there is a request for data in a + <type>DataFlavor</type> that is not supported by a data source. @see com::sun::star::datatransfer::DataFlavor + @see com::sun::star::datatransfer::XTransferable */ exception UnsupportedFlavorException: com::sun::star::uno::Exception { diff --git a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl index 3a1f1f8a90e1..f16f90448fbb 100644 --- a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataFormatTranslator.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:37:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,32 +74,40 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** Interface to be implemented by objects used to translate DataFlavors to - system dependent data transfer types and vice versa. +/** Interface to be implemented by objects used to translate a <type>DataFlavor</type> to + a system dependent data transfer type and vice versa. - <p>Different platforms - use different data transfer types to describe date during data exchange - operations like clipboard or drag&drop, for example, Windows uses interger values, - Unix uses atoms, other platforms may use strings.</p> - - <p>Under Windows, a data type of format int32 will be interpreted as a - clipboard format value, whereas a string will be interpreted as a format name - which has to be registered in order to get a valid clipboard format value.</p> + <p>Different platforms use different types to describe data formats available + during data exchange operations like clipboard or drag&drop. Windows for instance + uses integer values to describe an available clipboard or drag&drop format, Unix + X11 uses so called Atoms etc.</p> */ interface XDataFormatTranslator : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** Converts a <type>DataFlavor</type> to system dependend data type. + + @param aDataFlavor + Describes the format for which a system dependent data types is requested. + @returns - a DataFlavor for the given system data type. + A system dependent data transfer type for the given <type>DataFlavor</type> + if there is one available. + <p>If the is no system dependent data type for a given <type>DataFlavor</type> + the returned any is empty.</p> */ any getSystemDataTypeFromDataFlavor( [in] DataFlavor aDataFlavor ); //------------------------------------------------------------------------- - /** + /** Converts a system dependent data type to a <type>DataFlavor</type>. + + @param aSysDataType + A system dependent data type. If aSysDataType is empty so is the returned <type>DataFlavor</type>. + @returns - a system data type for the given DataFlavor. + A <type>DataFlavor</type> for the given system dependent data transfer type. + <p>If there is no appropriate mapping for a sytem dependent data type, the returned <type>DataFlavor</type> will be empty.</p> */ DataFlavor getDataFlavorFromSystemDataType( [in] any aSysDataType ); }; diff --git a/offapi/com/sun/star/datatransfer/XMimeContentType.idl b/offapi/com/sun/star/datatransfer/XMimeContentType.idl index ae58b5cb6b31..62674c99face 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentType.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentType.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMimeContentType.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,44 +73,71 @@ module com { module sun { module star { module datatransfer { +//------------------------------------------------------------------------- +/** An implementation of this interface represents a MIME content-type that + is conform to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. + Instances that implement this interface could be created using the + interface <type>XMimeContentTypeFactory</type>. +*/ + interface XMimeContentType : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the media type of the content-type. + /** To get the media type of the MIME content-type. + + @returns + The media type of the MIME content-type. */ string getMediaType( ); //------------------------------------------------------------------------- - /** @returns - the media subtype of the content-type + /** To get the media subtype of the MIME content-type. + + @returns + The media subtype of the MIME content-type. */ string getMediaSubtype( ); //------------------------------------------------------------------------- - /** @returns - the full media type of the content-type (type/subtype) + /** To get the full media/submedia type of the MIME content-type. + + @returns + The full media/submedia type of the MIME content-type. */ string getFullMediaType( ); //------------------------------------------------------------------------- - /** @returns - a list of the names of all parameters of the content-type + /** To get a list of parameters that the MIME content-type contains. + + @returns + A list of the names of all parameters of the MIME content-type. */ sequence< string > getParameters( ); //------------------------------------------------------------------------- - /** @returns - <true/> if the content-type has the specified parameter + /** To query if a specific parameter is supported. + + @param aName + The name of the parameter to query for. + + @returns + A value of <TRUE/> if the MIME content-type has the specified parameter. + <p>A value of <FALSE/> if the MIME content-type has not the specified parameter.</p> */ boolean hasParameter( [in] string aName ); //------------------------------------------------------------------------- - /** @returns - the value of the parameter + /** To get the value of a specified parameter. + + @param aName + The name of the parameter for which the value is requested. + + @returns + The value of the specified parameter. - @param - the name of the parameter + @throws com::sun::star::container::NoSuchElementException + if the specified parameter doesn't exist. */ string getParameterValue( [in] string aName ) raises ( com::sun::star::container::NoSuchElementException ); diff --git a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl index 3306e7872dfa..f814477c89de 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMimeContentTypeFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tra $ $Date: 2001-03-21 07:09:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,23 +77,36 @@ module com { module sun { module star { module datatransfer { +//------------------------------------------------------------------------- +/** Implementations of this interface do create a + <type scope="com::sun::star::datatransfer">XMimeContentType</type> from + a given string that represents a MIME content-type + (see <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>). + +*/ interface XMimeContentTypeFactory : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** Creates an object that implements <type>XMimeContentType</type>. + @param aContentType - a mime content-type as specified in rfc2045/rfc2046 + A string that represents a MIME content-type as specified in + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. @returns - com::sun::star::datatransfer::XMimeContentType + An object that implements <type>XMimeContentType</type>. @throws com::sun::star::lang::IllegalArgumentException - if the string does not conform to rfc2045 or rfc2046; - exception: quoted parameter values may contain spaces + if the string does not conform to + <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and + <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>; + <p><strong>Exception:</strong> Quoted parameter values may contain spaces.</p> @see com::sun::star::datatransfer::XMimeContentType */ - com::sun::star::datatransfer::XMimeContentType createMimeContentType( [in] string aContentTypeaContentType ) + com::sun::star::datatransfer::XMimeContentType createMimeContentType( [in] string aContentType ) raises ( com::sun::star::lang::IllegalArgumentException ); }; diff --git a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl index fb97ea38871c..fdc4ea26e01c 100644 --- a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSystemTransferable.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:37:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,7 @@ module com { module sun { module star { module datatransfer { //============================================================================= /** Interface to be implemented by objects used to provide system dependent data - for a transfer operation. Those objects usually also implement - com::sun::star:datatransfer::XTransferable; - - @see com::sun::star::datatransfer::XTransferable - + for a transfer operation. Those objects usually also implement <type>XTransferable</type>. */ interface XSystemTransferable: com::sun::star::uno::XInterface @@ -86,21 +82,21 @@ interface XSystemTransferable: com::sun::star::uno::XInterface source. The data object is returned in an any. The contained type may differ on different platforms. - The argument aProcessId contains a process identifier of the caller's process. - The process ID can be obtained by the C function rtl_getGlobalProcessId - (rtl/process.h). + + @param aProcessId + The argument aProcessId is a process identifier of the caller's process. The interface implementation must ensure that the system data object can be used in that process. If the data object is not valid in the caller process then the returned any must be empty. - Windows: The returned any contains an unsigned long which represents a pointer to + @returns + The system dependent data object. + + <br/><br/><p><strong>Notes:</strong>Under Windows the returned any contains an unsigned long which represents a pointer to an IDataObject interface. The caller of getData has to release the data object (IDataObject::Release) if it is no longer needed. - The caller must make sure that the current thread has been initialized for - OLE ( OleInitialize). - - @returns - the system dependent data object. + The caller must also make sure that the current thread has been initialized for + OLE (use OleInitialize).</p> */ any getData( [in] sequence < byte > aProcessId); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl index c7d294c0dad9..62dd17c3b9db 100644 --- a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl +++ b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferDataAccess.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:02:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,21 +85,28 @@ module com { module sun { module star { module datatransfer { interface XTransferDataAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the number of bytes of the transfer data in the specified data flavors. + /** To query for the summarized data size in bytes of a sequence of <type>DataFlavor</type>. @param aFlavorList - the requested data flavors. Unsupported flavors will be ignored. + A squence of requested <type>DataFlavor</type>. + <p>An unsupported <type>DataFlavor</type> will be ignored.</p> + + @returns + The number of bytes of the transfer data in the specified sequence of <type>DataFlavor</type>. */ hyper queryDataSize( [in] sequence < DataFlavor > aFlavorList ); //------------------------------------------------------------------------- - /** @returns - the data in the requested data flavors. For unsupported data flavors an - empty any (an any without a value) will be returned. + /** To get all the data of a sequence of <type>DataFlavor</type>. @param aFlavorList - the requested data flavors. Unsupported data flavors will be ignored. + The sequence of requested <type>DataFlavor</type>. + <p>An unsupported <type>DataFlavor</type> will be ignored.</p> + + @returns + The data in the requested <type>DataFlavor</type>. + <p>For unsupported <type>DataFlavor</type> an + empty any will be returned.</p> */ sequence < any > getData( [in] sequence < DataFlavor > aFlavorList ); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl index 7c0de4a0203d..1ecbb8108f0d 100644 --- a/offapi/com/sun/star/datatransfer/XTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferable.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,8 +83,8 @@ module com { module sun { module star { module datatransfer { //============================================================================= -/** Interface to be implemented by objects used to provide data for a transfer - operation. +/** Interface to be implemented by objects used to provide data for a data + transfer operation. @see com::sun::star::datatransfer::DataFlavor */ @@ -95,38 +95,44 @@ interface XTransferable: com::sun::star::uno::XInterface /** Called by a data consumer to obtain data from the source in a specified format. + @param aFlavor + Describes the requested data format + @returns - the data in the specified data flavor. + The data in the specified <type>DataFlavor</type>. @throws com::sun::star::io::IOException if the data is no longer available in the requested flavor. - @throws UnsupportedFlavorException - if the requested data flavor is not supported. + @throws com::sun::star::datatransfer::UnsupportedFlavorException + if the requested <type>DataFlavor</type> is not supported. */ any getTransferData( [in] DataFlavor aFlavor ) raises ( UnsupportedFlavorException, com::sun::star::io::IOException ); //------------------------------------------------------------------------- - /** Returns the list of supported data flavors. + /** Returns a sequence of supported <type>DataFlavor</type>. @returns - the list of supported data flavors. + The sequence of supported <type>DataFlavor</type>. + + @see com::sun::star::datatransfer::DataFlavor */ sequence < DataFlavor > getTransferDataFlavors(); //------------------------------------------------------------------------- /** Checks if the data object supports the specified data flavor. - @returns - <TRUE/> if the data flavor is supported by the transfer source, - <FALSE/> otherwise. + @param aFlavor + Describes the format that should be checked - @remarks - This method is only for analogy with the JAVA Clipboard interface. To - avoid many calls, the caller should instead use getTransferDataFlavors. + @returns + A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source. + <p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p> - @see com::sun::star::datatransfer::XTransferable::getTransferDataFlavors + <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To + avoid many calls, the caller should instead use + <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. */ boolean isDataFlavorSupported( [in] DataFlavor aFlavor ); }; diff --git a/offapi/com/sun/star/datatransfer/XTransferableEx.idl b/offapi/com/sun/star/datatransfer/XTransferableEx.idl index c4c443ce2522..15a76ff9f1ac 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableEx.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableEx.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferableEx.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,13 +86,13 @@ module com { module sun { module star { module datatransfer { interface XTransferableEx: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @requestedFlavors - Sequence of data flavors of interest. Specify an empty sequence for interest + /** @param requestedFlavors + Sequence of <type>DataFlavor</type> of interest. Specify an empty sequence for interest in all data flavors with top-level MIME content-types. To get all MIME - content-types, call com::sun::star::datatransfer::XTransferable. + content-types, call <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. @returns - the list of the matching supported flavors that were requested. For + The list of the matching supported <type>DataFlavor</type> that were requested. For each requested top-level MIME content-type, all supported subtypes are returned. */ sequence < DataFlavor > queryTransferDataFlavors( [in] sequence< DataFlavor > requestedFlavors ); diff --git a/offapi/com/sun/star/datatransfer/XTransferableSource.idl b/offapi/com/sun/star/datatransfer/XTransferableSource.idl index 06ecea32b154..b53230f8d03a 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableSource.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransferableSource.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ interface XTransferableSource: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** @returns - a human presentable description of the source that created the + A human presentable description of the source that created the transferable object. */ string getDataSourceDescription(); diff --git a/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl b/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl index c42096018d1b..9bb02d1ee01f 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/ClipboardEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ClipboardEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:16:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,13 +76,14 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= /** A clipboard uses this object to notify its listeners of content changes. + @see com::sun::star::datatransfer::clipboard::XClipboardListener */ struct ClipboardEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** The current contents of the clipboard. + /** The current content of the clipboard. */ XTransferable Contents; }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl b/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl index 14535140ea92..0ff52a7c1919 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/ClipboardManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: ClipboardManager.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,18 +86,17 @@ interface XClipboardManager; /** The clipboard manager is a one-instance service that holds a list of all known clipboard instances. - @see XClipboardManager */ service ClipboardManager { //------------------------------------------------------------------------- - /** manages internal and external clipboard implementations. + /** Manages internal and external clipboard implementations. */ interface XClipboardManager; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; diff --git a/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl index f8cea3d00640..cd3a4e42502a 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/GenericClipboard.idl @@ -2,9 +2,9 @@ * * $RCSfile: GenericClipboard.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tra $ $Date: 2001-04-10 07:32:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,38 +89,36 @@ interface XClipboardNotifier; //============================================================================= /** A generic clipboard service is a simple container for transferable objects. - - @see XClipboard */ service GenericClipboard { //------------------------------------------------------------------------- - /** provides access to the clipboard content. + /** Provides access to the clipboard content. */ interface XClipboardEx; //------------------------------------------------------------------------- - /** provides the ability to request notifications on content changes. + /** Provides the ability to request notifications on content changes. */ interface XClipboardNotifier; //------------------------------------------------------------------------- - /** provides the ability to initially set the name of the clipboard. + /** Provides the ability to initially set the name of the clipboard. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** a service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** a service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl b/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl index d3f16a728b9f..aa05e899a356 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/RenderingCapabilities.idl @@ -2,9 +2,9 @@ * * $RCSfile: RenderingCapabilities.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-03-01 18:51:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,21 +67,21 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** this flags describe the capabilities a system clipboard has to transfer +/** These flags describe the capabilities a system clipboard has to transfer data to other applications via the OS. - @see SystemClipboard + @see com::sun::star::datatransfer::clipboard::SystemClipboard */ constants RenderingCapabilities { //------------------------------------------------------------------------- - /** the implementation supports delayed rendering. + /** The implementation supports delayed rendering. */ const byte Delayed = 1; //------------------------------------------------------------------------- - /** the implementation is able to store the data persistant in the system - so that it does not get lost when the datasource exits. + /** The implementation is able to store the data persistant in the system + so that it does not get lost when the source application no longer exist. */ const byte Persistant = 2; }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl index 8eb11b835c79..44ab40c2a790 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/SystemClipboard.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemClipboard.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: pl $ $Date: 2001-06-25 12:28:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,6 +74,10 @@ #include <com/sun/star/lang/XTypeProvider.idl> #endif +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + //============================================================================= module com { module sun { module star { module datatransfer { module clipboard { @@ -88,47 +92,51 @@ interface XFlushableClipboard; /** The system clipboard service builds a bridge to the OS specific clipboard interfaces. - Notes: The Unix implementation needs to be instantiated with 2 Arguments: + <br/><br/><p><strong>Notes:</strong> The Unix implementation needs to be instantiated with 2 Arguments: <ul> - <li>a <type scope="com::sun::star::awt">XDisplayConnection</type> that provides the + <li>A <type scope="com::sun::star::awt">XDisplayConnection</type> that provides the display to be used.</li> - <li>a string that names the selection to be used</li> + <li>A string that names the selection to be used</li> </ul> - It is possible to use clipboards for different selections simultaneously. - - @see XClipboard + It is possible to use clipboards for different selections simultaneously.</p> */ service SystemClipboard { //------------------------------------------------------------------------- - /** provides access to the clipboard content. + /** Provides access to the clipboard content. */ interface XClipboardEx; //------------------------------------------------------------------------- - /** provides the ability to request notifications on content changes. + /** Provides the ability to request notifications on content changes. */ interface XClipboardNotifier; //------------------------------------------------------------------------- - /** provides the ability to render the complete clipboard content. this - interface is only available if the method getRenderingCapabilities of - the interface XClipboardEx returns Persistant + /** Provides the ability to render the complete clipboard content. This + interface is only available if the method + <member scope="com::sun::star::datatransfer::clipboard">XClipboardEx::getRenderingCapabilities()</member> + returns Persistant */ [optional] interface XFlushableClipboard; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** Provides the ability to initialize the clipboard + */ + [optional] interface com::sun::star::lang::XInitialization; + + //------------------------------------------------------------------------- + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl index 642ecf0d0936..958061ddc46c 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboard.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboard.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,6 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= /** The default interface to access clipboard instances. - @see com::sun::star::datatransfer::XTransferable */ interface XClipboardListener; @@ -85,9 +84,13 @@ interface XClipboardOwner; interface XClipboard: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the transferable object representing the current content of + /** To get the current content of the clipboard. + + @returns + The transferable object representing the current content of this clipboard. + + @see com::sun::star::datatransfer::XTransferable */ XTransferable getContents(); @@ -97,16 +100,29 @@ interface XClipboard: com::sun::star::uno::XInterface as the owner of the new contents. @param xTrans - the transferable object to set as new content. + The transferable object to set as new content. + <p>If the given <type scope="com::sun::star::datatransfer">XTransferable</type> + has no <type scope="com::sun::star::datatransfer">DataFlavor</type> the clipboard + will be deleted. + <p>A NULL value is not allowed.</p> @param xClipboardOwner - the new owner of the clipboard. + The new owner of the clipboard. + <p>NULL is an acceptable value and means that the + caller is not interested in lost ownership notifications.</p> + + @see com::sun::star::datatransfer::XTransferable + @see com::sun::star::datatransfer::clipboard::XClipboardOwner */ [oneway] void setContents( [in] XTransferable xTrans, [in] XClipboardOwner xClipboardOwner ); //------------------------------------------------------------------------- - /** @returns - the name of this clipboard object. + /** To get the name of the clipboard instance. + + @returns + The name of this clipboard object. + <p>If the returned string is empty the + clipboard instance ist the system clipboard.</p> */ string getName(); }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl index c39ce9ce3e4c..b8f63ce1aa31 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardEx.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardEx.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,18 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** The extended clipboard interface +/** The extended clipboard interface. + @see com::sun::star::datatransfer::clipbaord::XClipboard */ interface XClipboardEx: com::sun::star::datatransfer::clipboard::XClipboard { //------------------------------------------------------------------------- - /** @returns - a set of flags describing the rendering capabilities of the clipboard. + /** To determine the supported rendering capabilities of the clipboard instance. + + @returns + A set of flags describing the rendering capabilities of the clipboard instance. @see RenderingCapabilities */ diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl index 6eaaabc01fde..ce5386bbdaba 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ module com { module sun { module star { module datatransfer { module clipboard { interface XClipboard; //============================================================================= -/** should be implemented by a clipboard factory that simplifies the creation of +/** Should be implemented by a clipboard factory that simplifies the creation of multiple clipboard instances. @see com::sun::star::datatransfer::clipboard::XClipboard @@ -86,15 +86,17 @@ interface XClipboard; interface XClipboardFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - a newly created instance of a <type>GenericClipboard</type> + /** Creates a new named clipboard instance. + + @returns + A newly created instance of a <type>GenericClipboard</type> implementation. @param aName - the name the clipboard should have. + The name the clipboard should have. @throws com::sun::star::lang::IllegalArgumentException - if an empty string is passed. + If an empty string is passed as clipboard name. */ XClipboard createClipboard( [in] string aName ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl index 6629f5c18102..0d2215a684eb 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,19 +75,19 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** interface to be implemented to receive notifications on clipboard content +/** Interface to be implemented to receive notifications on clipboard content changes. - @see com::sun::star::datatransfer::clipboard::XClipboard */ - interface XClipboardListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** the contents of the clipboard have changed. + /** The content of the clipboard has changed. @param event - the event object containing the new contents. + The event object containing the new clipboard content. + + @see com::sun::star::datatransfer::clipboard::ClipboardEvent */ [oneway] void changedContents( [in] ClipboardEvent event ); }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl index fb66020527fa..a3198a9040cd 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,11 +93,13 @@ interface XClipboard; interface XClipboardManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the clipboard object with the specified name. + /** Get a clipboard instance by name. + + @returns + The clipboard object with the specified name. @param aName - the name of clipboard to return. To retrieve the default (system) + The name of clipboard to return. To retrieve the default (system) clipboard, pass an empty string. @throws com::sun::star::container::NoSuchElementException @@ -107,10 +109,10 @@ interface XClipboardManager: com::sun::star::uno::XInterface raises ( com::sun::star::container::NoSuchElementException ); //------------------------------------------------------------------------- - /** add a clipboard instance to the manager's list. + /** Add a clipboard instance to the manager's list. @param xClipboard - the clipboard to add. + The clipboard to add. @throws com::sun::star::IllegalArgumentException if xClipboard is not a valid clipboard. @@ -123,16 +125,18 @@ interface XClipboardManager: com::sun::star::uno::XInterface com::sun::star::container::ElementExistException ); //------------------------------------------------------------------------- - /** removes the clipboard with the specified name from the list. + /** Removes the clipboard with the specified name from the list. @param aName - the name of the clipboard to remove. + The name of the clipboard to remove. */ void removeClipboard( [in] string aName ); //------------------------------------------------------------------------- - /** @returns - a list of all clipboard names. + /** Get a list of a managed clipboards. + + @returns + A sequence of the names of all available clipboards. */ sequence < string > listClipboardNames(); }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl index a25ccdc4cc5c..d42fe28164ad 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardNotifier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,8 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** provides the ability to request notifiations on clipboard content changes. +/** Provides the ability to request notifiations on clipboard content changes. + @see com::sun::star::datatransfer::clipboard::XClipboardListener */ @@ -80,18 +81,18 @@ interface XClipboardListener; interface XClipboardNotifier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** requests notifications on clipboard content changes. + /** Requests notifications on clipboard content changes. @param listener - the object receiving the notifications. + The object receiving the notifications. */ [oneway] void addClipboardListener( [in] XClipboardListener listener ); //------------------------------------------------------------------------- - /** removes listener from notification list. + /** Removes listener from notification list. @param listener - the object to remove from notification list. + The object to remove from notification list. */ [oneway] void removeClipboardListener( [in] XClipboardListener listener ); }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl index ec85a3daecff..ad2ba13ef135 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardOwner.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClipboardOwner.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,23 +76,26 @@ module com { module sun { module star { module datatransfer { module clipboard { interface XClipboard; //============================================================================= -/** The owner of a transferable object must pass this interface to the +/** The owner of a transferable object may pass this interface to the clipboard instance. - @see com::sun::star::datatransfer::XClipboard + @see com::sun::star::datatransfer::clipboard::XClipboard */ interface XClipboardOwner: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** notifies the tranferable object source that it is no longer the owner of + /** Notifies the tranferable object source that it is no longer the owner of the clipboard. @param xClipboard - the clipboard for which the ownership was lost. + The clipboard for which the ownership was lost. @param xTrans - the transferable object that has been the contents of the clipboard. + The transferable object that has been the contents of the clipboard. + + @see com::sun::star::datatransfer::clipboard::XClipboard + @see com::sun::star::datatransfer::XTransferable */ [oneway] void lostOwnership( [in] XClipboard xClipboard, [in] XTransferable xTrans ); }; diff --git a/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl b/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl index 01ae4418eda9..c8d0bf70b95c 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XFlushableClipboard.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFlushableClipboard.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,18 @@ module com { module sun { module star { module datatransfer { module clipboard { //============================================================================= -/** An interface for flushable clipboards. +/** An interface for flushable clipboards may optionally be implemented by a + system clipboard service. + + @see com::sun::star::datatransfer::clipboard::SystemClipboard */ interface XFlushableClipboard: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** - renders all current clipboard data + /** Renders the current content of the clipboard to the system so that it + is available even if the source application no longer exist. */ void flushClipboard(); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl index c87ffd65acd6..727a8164b980 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DNDConstants.idl @@ -2,9 +2,9 @@ * * $RCSfile: DNDConstants.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 15:04:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,46 @@ module com { module sun { module star { module datatransfer { module dnd { constants DNDConstants { + //============================================================================= + /** No action. + */ + const byte ACTION_NONE = 0x00; + + //============================================================================= + /** Action copy. + */ + const byte ACTION_COPY = 0x01; + + //============================================================================= + /** Action move. + */ + const byte ACTION_MOVE = 0x02; - const byte ACTION_COPY_OR_MOVE = 0x03; + + //============================================================================= + /** Action copy or move. + */ + + const byte ACTION_COPY_OR_MOVE = 0x03; + + //============================================================================= + /** Action link. + */ + const byte ACTION_LINK = 0x04; + + //============================================================================= + /** Action reference. + */ + const byte ACTION_REFERENCE = 0x04; + + //============================================================================= + /** Action default. + */ + const byte ACTION_DEFAULT = 0x80; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index e7dfb9026e2b..dc83eb4cc9dc 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragGestureEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:07:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,46 +73,49 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSource; //============================================================================= -/** A DragGestureEvent is passed to DragGestureListener's dragGestureRecognized() - method when a particular DragGestureRecognizer detects that a platform - dependent drag initiating gesture has occurred on the Component that it is +/** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member> + when a particular <type>XDragGestureRecognizer</type> detects that a platform + dependent drag initiating gesture has occurred on the component that it is tracking. - - <!-- Editor: Should Component be capitalized? --> */ struct DragGestureEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** the action selected by the user. + /** The action selected by the user. + <p>Different constants may be combined using a logical OR.</p> + It's further possible to combine the ACTION_DEFAULT with one of the other + actions defined in <type scope="com::sun::star::datatransfer::dnd">DNDConstants</type>. + This means the user did not press any key during the Drag and Drop operation + and the action that was combined with ACTION_DEFAULT is the system default action.</p> + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DragAction; //------------------------------------------------------------------------- - /** the x coordinate where the drag originated in Component coords. - - <!-- Editor: Is "coords" an actual term or the abbreviation of coordinates? --> + /** The x coordinate where the drag originated in component coordinates. */ long DragOriginX; //------------------------------------------------------------------------- - /** the y coordinate where the drag originated in Component coords. + /** The y coordinate where the drag originated in component coordinates. */ long DragOriginY; //------------------------------------------------------------------------- - /** the DragSource associated with this drag action. + /** The DragSource associated with this drag action. */ XDragSource DragSource; //------------------------------------------------------------------------- - /** the last event comprising the gesture. + /** The last event comprising the gesture. - <p> The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event. + <p>The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event. If it is not, the implementation should either react accordingly or presume that the left mouse button was clicked. </p> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl index c2740fddd117..f7db139ef95e 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceDragEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-20 20:34:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,25 +71,30 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DragSourceDragEvent is delivered from the DragSourceContext to the - currently registered DragSourceListener. +/** The <type>DragSourceDragEvent</type> is delivered from an object that + implements the <type>XDragSourceContext</type> to the + currently registered drag source listener. <p>It contains state regarding the current state of the operation to enable the operations initiator to provide the end user with the appropriate drag over feedback.</p> - <!-- Editor: Please reword "It contains state" --> + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ struct DragSourceDragEvent: com::sun::star::datatransfer::dnd::DragSourceEvent { //------------------------------------------------------------------------- - /** the drag action selected by the current drop target. + /** The drag action selected by the current drop target. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** the user's currently selected drop action. + /** The user's currently selected drop action. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte UserAction; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl index 8671d03df035..dbcae848a93b 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceDropEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-01-26 11:27:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,27 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DragSourceDropEvent is delivered from the DragSourceContext to its - currently registered DragSourceListener's dragDropEnd() method. +/** The <type>DragSourceDropEvent</type> is delivered from an object that implements + <type>XDragSourceContext</type> to its currently registered drag source listener's. <p>It contains sufficient information for the originator of the operation to provide appropriate feedback to the end user when the operation completes.</p> + + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ struct DragSourceDropEvent: com::sun::star::datatransfer::dnd::DragSourceEvent { //------------------------------------------------------------------------- - /** the action performed by the target on the subject of the drop. + /** The action performed by the target on the subject of the drop. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** indicates if the drop was successful. + /** Indicates if the drop was successful. */ boolean DropSuccess; diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl index 0f93adf21cfa..d0639741e7c1 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DragSourceEvent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: obr $ $Date: 2001-01-29 10:38:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ interface XDragSource; interface XDragSourceContext; //============================================================================= -/** This class is the base class for DragSourceDragEvent and DragSourceDropEvent. +/** This class is the base class for <type>DragSourceDragEvent</type> and <type>DragSourceDropEvent</type>. <p>To access the <type>XDragSource</type> that originated this event, use the <member scope="com::sun::star::lang">EventObject::Source</member> member of @@ -84,13 +84,17 @@ interface XDragSourceContext; struct DragSourceEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /** the DragSourceContext of the current drag operation. + /** The drag source context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDragSourceContext */ XDragSourceContext DragSourceContext; //------------------------------------------------------------------------- - /** the DragSource on which the drag and drop operation was initiated. + /** The drag source on which the Drag and Drop operation was initiated. + + @see com::sun::star::datatransfer::dnd::XDragSource */ XDragSource DragSource; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl index 461cb0a60fc7..e2da2416c6b0 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDragEnterEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-02-09 10:55:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,19 +75,22 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** The DropTargetDragEnterEvent is delivered from the DropTarget to the - currently registered DropTargetListeners whenever the logical cursor +/** The <type>DropTargetDragEnterEvent</type> is delivered from the drop target to the + currently registered drop target listeners whenever the logical cursor associated with a Drag and Drop operation enters the visible geometry - of a window associated with a DropTarget. + of a window associated with a drop target. - <p>It contains the dataflavors supported by the transferable object of - the current Drag and Drop operation. </p> + <p>It contains the <type scope="com::sun::star::datatransfer">DataFlavor</type> + types supported by the transferable object of the current Drag and Drop operation. </p> + + @see com::sun::star::datatransfer::XTransferable */ struct DropTargetDragEnterEvent: DropTargetDragEvent { //------------------------------------------------------------------------- - /** The dataflavors supported by the transferable object. + /** A sequence of supported <type scope="com::sun::star::datatransfer">DataFlavor</type> types. + */ sequence< DataFlavor > SupportedDataFlavors; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl index d5d13930cf80..aa8805e1a839 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDragEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:38:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,44 +73,52 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetDragContext; //============================================================================= -/** The DropTargetDragEvent is delivered from the DropTarget to the currently - registered DropTargetListener. +/** The <type>DropTargetDragEvent</type> is delivered from the drop target + to the currently registered drop target listener. - <p>It contains state regarding the current state of the operation to enable + <p>It contains information regarding the current state of the operation to enable the operations initiator to provide the end user with the appropriate drag over feedback.</p> - <!-- Editor: Please reword, "It contains state regarding the current state" --> + @see com::sun::star::datatransfer::dnd::XDropTargetListener */ struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent { //------------------------------------------------------------------------- - /** the DropTargetContext of the current drag operation. + /** The drop target context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDropTargetDragContext */ XDropTargetDragContext Context; //------------------------------------------------------------------------- - /** this value represents the currently selected drop action. + /** This value represents the currently selected drop action. + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** the cursor's current x location within the window's coordinates. + /** The cursor's current x location within the window's coordinates. */ long LocationX; //------------------------------------------------------------------------- - /** the cursor's current y location within the window's coordinates. + /** The cursor's current y location within the window's coordinates. */ long LocationY; //------------------------------------------------------------------------- - /** this value represents the action or actions supported by the source. + /** This value represents the action or actions supported by the source. + This may be a combination of arbitrary source actions except ACTION_DEFAULT. + <p>To combine different actions use a logical OR.</p> + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte SourceActions; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl index 2863cd6a6d0f..89b8454b6b18 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetDropEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:31:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,8 +77,8 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetDropContext; //============================================================================= -/** The DropTargetDropEvent is delivered from the DropTarget to its currently - registered DropTargetListener's dragDropEnd() method. +/** The <type>DropTargetDropEvent</type> is delivered from the drop target to + its currently registered drop target listener. <p>It contains sufficient information for the originator of the operation to provide appropriate feedback to the end user when the operation completes.</p> @@ -87,41 +87,47 @@ interface XDropTargetDropContext; struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTargetEvent { //------------------------------------------------------------------------- - /** the DropTargetContext of the current drag operation. + /** The drop target context of the current drag operation. + + @see com::sun::star::datatransfer::dnd::XDropTargetDropContext */ XDropTargetDropContext Context; //------------------------------------------------------------------------- - /** this value represents the action or actions selected by the user at the time of - the drop. + /** This value represents the action or actions selected by the user at + the time of the drop. - <p>If more than one action is specified, the <type>DropTargetListener</type> + <p>If more than one action is specified, the <type>XDropTargetListener</type> should raise a dialog to ask the user which action to use.</p> + + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte DropAction; //------------------------------------------------------------------------- - /** the cursor's current x location within the windows' coordinates. + /** The cursor's current x location within the windows' coordinates. */ long LocationX; //------------------------------------------------------------------------- - /** the cursor's current y location within the windows' coordinates. + /** The cursor's current y location within the windows' coordinates. */ long LocationY; //------------------------------------------------------------------------- - /** this value represents the action or actions supported by the source. + /** This value represents the action or actions supported by the source. */ byte SourceActions; //------------------------------------------------------------------------- - /** the transferable object associated with the drop. + /** The transferable object associated with the drop. + + @see com::sun::star::datatransfer::XTransferable */ com::sun::star::datatransfer::XTransferable Transferable; diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl index 5a218de654a2..feb86d7a0fdc 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DropTargetEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: obr $ $Date: 2001-01-26 11:27:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl index a9ccc894d7af..fed5b349da97 100644 --- a/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl +++ b/offapi/com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvalidDNDOperationException.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 20:02:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ module com { module sun { module star { module datatransfer { module dnd { <p>It is usually thrown to indicate that the target in question is unable to undertake the requested operation at the present time, since the - underlying DnD system is not in the appropriate state.</p> + underlying Drag and Drop system is not in the appropriate state.</p> */ exception InvalidDNDOperationException: com::sun::star::uno::RuntimeException diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl index 6b42147bccd1..689ae65e2d1f 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleDragSource.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:12:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,38 +96,35 @@ interface XDragSource; service OleDragSource { //------------------------------------------------------------------------- - /** used to provide data to other applications via Ole DND protocol. + /** Used to provide data to other applications via the Ole Drag & Drop protocol. */ interface XDragSource; //------------------------------------------------------------------------- - /** the service expects a byte sequence uniquely identifying the machine as + /** The service expects a byte sequence uniquely identifying the machine as the first, and only, parameter. This idenifier should be checked to ensure that the window ids used for creating DropTargets are valid for the service, that is, come from the same machine. <p>TODO: specify how such a machine id should look like.</p> - <!-- Editor: Should the last sentence be seen by the user? --> - The second parameter is a window handle of the native windows window. Is is passed as an unsigned long. - */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl index 2de3900ae4fe..480fba301aef 100644 --- a/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/OleDropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleDropTarget.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 15:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,7 +87,7 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTarget; //============================================================================= -/** This service connects the Java-like UNO drag and drop protocol to the protocol +/** This service connects the Java-like UNO Drag & Drop protocol to the protocol used on window platforms. It realizes the drop target. @see XDropTarget @@ -96,29 +96,27 @@ interface XDropTarget; service OleDropTarget { //------------------------------------------------------------------------- - /** used to provide data to other applications via Ole DND protocol. + /** Used to provide data to other applications via Ole Drap & Drop protocol. */ interface XDropTarget; //------------------------------------------------------------------------- - /** - the service expects a windows window handle. It is passed as unsigned long. - + /** The service expects a windows window handle. It is passed as unsigned long. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl index 8aa86b6290db..0e97a8f6a10d 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: X11DragSource.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 19:52:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,9 +87,9 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSource; //============================================================================= -/** This service connects the Java-like UNO drag and drop protocol to the XDND - protocol used on Xservers to transfer data between applications via drag and - drop operations. +/** This service connects the Java-like UNO Drag and Drop protocol to the + X Drag and Drop protocol used on X-Servers to transfer data between + applications via Drag and Drop operations. @see XDragSource */ @@ -97,28 +97,29 @@ interface XDragSource; service X11DragSource { //------------------------------------------------------------------------- - /** used to provide data to other applications via XDND protocol. + /** Used to provide data to other applications via X Drag and Drop protocol. */ interface XDragSource; //------------------------------------------------------------------------- - /** the service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> - as the first parameter. + /** The service expects an instance of + <type scope="com::sun::star::awt">XDisplayConnection</type> + as the first parameter. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl index 66e8fa60e4d5..425272b30302 100644 --- a/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/X11DropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: X11DropTarget.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: pl $ $Date: 2001-02-06 10:32:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,9 +87,9 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTarget; //============================================================================= -/** This service connects the java like UNO drag and drop protocol to the XDND - protocol used on X servers to transfer data between application via drag and - drop operations. +/** This service connects the Java-like UNO Drag and Drop protocol to the + X Drag and Drop protocol used on X-Servers to transfer data between + application via Drag and Drop operations. @see XDragSource @see XDropTarget @@ -98,30 +98,31 @@ interface XDropTarget; service X11DropTarget { //------------------------------------------------------------------------- - /** used to get data from other applications via XDND protocol. + /** Used to get data from other applications via X Drag and Drop protocol. */ interface XDropTarget; //------------------------------------------------------------------------- - /** the service expects an instance of <type scope="com::sun::star::awt">XDisplayConnection</type> - as the first parameter. The second parameter must be a <type>long</type> - that contains an Xwindow <type>Window</type> which shall be registered + /** The service expects an instance of + <type scope="com::sun::star::awt">XDisplayConnection</type> + as the first parameter. The second parameter must be a long + that contains an XWindow window which shall be registered as drop target. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl index 62cff63550f5..ccdf120a6b95 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XAutoscroll.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAutoscroll.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: obr $ $Date: 2001-10-30 11:26:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,39 +71,47 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** interface for autoscroll support. +/** Interface for autoscroll support. - <p>During DnD operations it is possible that a user may wish to drop the + <p>During Drag and Drop operations it is possible that a user may wish to drop the subject of the operation on a region of a scrollable GUI control that is - not currently visible to the user. </p> + not currently visible to the user.</p> <p>In such situations it is desirable that the GUI control detect this and institute a scroll operation in order to make obscured region(s) visible to - the user. This feature is known as autoscrolling. </p> + the user. This feature is known as autoscrolling.</p> <p>If a GUI control is both an active DropTarget and is also scrollable, it can receive notifications of autoscrolling gestures by the user from - the DnD system by implementing this interface. </p> + the Drag and Drop system by implementing this interface.</p> <p>An autoscrolling gesture is initiated by the user by keeping the drag cursor motionless with a border region of the Component, referred to as the "autoscrolling region", for a predefined period of time, this will result in repeated scroll requests to the Component until the drag Cursor resumes its motion. </p> - */ interface XAutoscroll: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** notify the Component to autoscroll. + /** Notify the component to autoscroll. + + @param cursorLocationX + X location of the cursor in pixel. + + @param cursorLocationY + Y location of the cursor in pixel. */ [oneway] void autoscroll( [in] long cursorLocationX, [in] long cursorLocationY ); //------------------------------------------------------------------------- - /** @returns the regions describing the autoscrolling region or border - relative to the geometry of the implementing Component. + /** Returns the regions describing the autoscrolling region. + + @returns + The regions describing the autoscrolling region or border + relative to the geometry of the implementing component. */ any getAutoscrollRegion(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl index e3a01d364efa..a5a7512e75ed 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragGestureListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 16:02:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,23 +75,23 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is sourced from a DragGestureRecognizer and is invoked when - an object of that (sub)class detects a drag initiating gesture. +/** This interface will be used by a <type>XDragGestureRecognizer</type> + when it detects a drag initiating gesture. - <p> The implementor of this interface is responsible for starting the drag - as a result of receiving such notification. </p> + <p>The implementor of this interface is responsible for starting the drag + as a result of receiving such notification.</p> */ interface XDragGestureListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** A DragGestureRecognizer has detected a platform-dependent drag initiating - gesture and is notifying this listener in order for it to initiate the - action for the user. + /** A <type>XDragGestureRecognizer</type> has detected a platform-dependent + drag initiating gesture and is notifying this listener in order + for it to initiate the action for the user. @param dge - the DragGestureEvent describing the gesture that has just occurred. + The DragGestureEvent describing the gesture that has just occurred. */ [oneway] void dragGestureRecognized( [in] DragGestureEvent dge ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl index 2efc13c0f344..9238d7312865 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragGestureRecognizer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 20:00:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ interface XDragGestureListener; operations. <p>Different to Java, the association between view and interface is fixed - and cannot be changed. Otherwise, the awt messaging would have to be + and cannot be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a performance issue.</p> */ @@ -85,25 +85,27 @@ interface XDragGestureListener; interface XDragGestureRecognizer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** registers a new DragGestureListener. + /** Registers a new <type>XDragGestureListener</type>. @param dgl - the DragGestureListener to register with this DragGestureRecognizer. + The <type>XDragGestureListener</type> to register with this + <type>XDragGestureRecognizer</type>. */ [oneway] void addDragGestureListener( [in] XDragGestureListener dgl ); //------------------------------------------------------------------------- - /** unregisters the specified DragGestureListener. + /** Unregisters the specified <type>XDragGestureListener</type>. @param dgl - the DragGestureListener to register with this DragGestureRecognizer. + The <type>XDragGestureListener</type> to register with this + <type>XDragGestureRecognizer</type>. */ [oneway] void removeDragGestureListener( [in] XDragGestureListener dgl ); //------------------------------------------------------------------------- - /** reset the Recognizer. If it is currently recognizing a gesture, ignore it. + /** Reset the recognizer. If it is currently recognizing a gesture, ignore it. */ void resetRecognizer(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl index 66662f994466..5aca3af9fb42 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSource.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:13:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,78 +86,82 @@ interface XDragSourceListener; //============================================================================= /** This interface is implemented by a view or window that supports drag - operations and can be received through a dragGestureRecognized() call - when imlpementing <type>XDragGestureListener</type>. + operations and will be received as part of a <type>DragGestureEvent</type> + through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> + callback. - <p>Different to Java, the association between view and interface is fixed - and can not be changed. Otherwise, the awt messaging would have to be - implemented for any window supporting Drag and Drop operations, what would + <p>Differently to Java, the association between view and interface is fixed + and can not be changed. Otherwise, the AWT messaging would have to be + implemented for any window supporting Drag and Drop operations, which would be a real performance issue.</p> - - <!-- Editor: Do you mean Java does it differently? --> - - <!-- Editor: Can the last phrase read: which would be a performance issue. --> */ interface XDragSource: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - a boolean indicating whether or not drag Image support is + /** In order to query if drag image support is available. + + @returns + A boolean indicating whether or not drag image support is available on the underlying platform. */ boolean isDragImageSupported(); //------------------------------------------------------------------------- - /** @returns - the default drag cursor for the specified drag action. + /** To get the default cursor for a specified drag action. @param dragAction - a drag action. + A drag action as specified in <type>DNDConstants</type>. + + @returns + The default drag cursor for the specified drag action. + <p>The returned value may be used as parameter for the method + <member scope="com::sun::star::datatransfer::dnd">XDragSourceContext::setCursor()</member>.</p> */ long getDefaultCursor( [in] byte dragAction ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** starts the drag operation. + /** Starts the drag operation. <p>Note: this call does <em>not</em> block until the drag and drop operation ends. If the Drag and Drop system is unable to initiate a drag operation or if the user attempts to start a drag while an existing drag operation is still executing, the action fails immediately. - This is indicated by calling endDragDrop on the listener parameter with - a DragSourceDragEvent showing failure. - </p> - - <!-- Editor: Is "block" the right word in the previous paragraph? --> + This is indicated by calling + <member scope="com::sun::star::datatransfer::dnd">XDragSourceListener::dragDropEnd()</member> + on the parameter listener with a DragSourceDragEvent showing a failure.</p> @param trigger - the <type>DragGestureEvent</type> that initiated the drag. + The <type>DragGestureEvent</type> that initiated the drag. @param sourceActions - the action or actions supported for this transferable. + The action or actions supported for this transferable as defined + in <type>DNDConstants</type>. @param cursor - the initial drag cursor id or 0 for defaults. + The initial drag cursor id or 0 as default. @param image - the initial drag image id or 0 for defaults. + The initial drag image id or 0 as default. @param trans - the transferable object dragged. + The transferable object dragged. @param listener - the <type>XDragSourceListener</type>. + The <type>XDragSourceListener</type>. + @see com::sun::star::datatransfer::XTransferable */ [oneway] void startDrag( [in] DragGestureEvent trigger, [in] byte sourceActions, - [in] long cursor, [in] long image, + [in] long cursor, + [in] long image, [in] com::sun::star::datatransfer::XTransferable trans, [in] XDragSourceListener listener ); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl index 67ebdcf17f5b..399d9b5e9e66 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSourceContext.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 15:48:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,56 +73,62 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDragSourceListener; //============================================================================= -/** The DragSourceContext class is responsible for managing the initiator side +/** The drag source context class is responsible for managing the initiator side of the Drag and Drop protocol. <p>In particular, it is responsible for managing event notifications to the DragSourceListener and providing the Transferable state to enable the data transfer. </p> - <p>An instance of this class is created as a result of a DragSource's - startDrag() method being successfully invoked. This instance is responsible - for tracking the state of the operation on behalf of the DragSource and - dispatching state changes to the DragSourceListener. </p> + <p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member> + being successfully invoked. This instance is responsible + for tracking the state of the operation on behalf of the drag source and + dispatching state changes to the drag source listener. </p> + + @see com::sun::star::datatransfer::dnd::XDragSourceContext + @see com::sun::star::datatransfer::dnd::XDragSourceListener */ interface XDragSourceContext: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - the currently selected drag cursor. + /** Get the identifier of the currently used cursor. + + @returns + The currently selected drag cursor. */ long getCurrentCursor(); //------------------------------------------------------------------------- - /** this method sets the current drag Cursor. - - <!-- Editor: Should Cursor have a leading capital? --> + /** This method sets the current drag cursor. <p>This method should only be called to set another cursor than the - default one for drag action currently selected by the user. - Invalid cursor Ids will be ignored.</p> + default one for drag action currently selected by the user.</p> + <p>Invalid cursor identifiers will be ignored.</p> @param cursorId - the id the drag source returned when registering the cursor. + The identifier the drag source returned when registering the cursor. */ [oneway] void setCursor( [in] long cursorId ); //------------------------------------------------------------------------- - /** this method sets the current drag Image. + /** This method sets the current drag image. @param dragImage - the id the drag source returned when registering the image (0 = none). - Invalid Ids will be ignored. + The identifier the drag source returned when registering the image (0 = none). + Invalid identifier will be ignored. */ [oneway] void setImage( [in] long imageId ); //------------------------------------------------------------------------- - /** this method notifies the context that the Transferable's DataFlavors - have changed. + /** This method notifies the context that the + <type scope="com::sun::star::datatransfer">DataFlavor</type> types + of the transferable object have changed. + + @see com::sun::star::datatransfer::XTransferable */ [oneway] void transferablesFlavorsChanged(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl index 0a5fded116b7..d24da4cd0286 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDragSourceListener.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,60 +79,63 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface must be implemented by any <type>DragGestureRecognizer</type> - implementation that a <type>DragSource</type> supports. +/** This interface must be implemented by any drag gesture recognizer + implementation that a drag source supports. + + @see com::sun::star::datatransfer::dnd::XDragGestureRecognizer + @see com::sun::star::datatransfer::dnd::XDragSource */ interface XDragSourceListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** this method is invoked to signify that the Drag and Drop operation is + /** This method is invoked to signify that the Drag and Drop operation is complete. @param dsde - the DragSourceDropEvent + The <type>DragSourceDropEvent</type> */ [oneway] void dragDropEnd( [in] DragSourceDropEvent dsde ); //------------------------------------------------------------------------- - /** called as the hotspot enters a platform dependent drop site. + /** Called as the hotspot enters a platform dependent drop site. - <p>NOTE: currently this notification can not be ensured by all + <p><strong>NOTE:</strong> currently this notification can not be ensured by all implementations. Do not rely on it ! </p> @param dsde - the DragSourceDragEvent + The <type>DragSourceDragEvent</type>. */ [oneway] void dragEnter( [in] DragSourceDragEvent dsde ); //------------------------------------------------------------------------- - /** called as the hotspot exits a platform dependent drop site. + /** Called as the hotspot exits a platform dependent drop site. - <p>NOTE: currently this notification can not be ensured by all + <p><strong>NOTE:</strong> Currently this notification can not be ensured by all implementations. Do not rely on it ! </p> @param dse - the DragSourceEvent + The <type>DragSourceEvent</type>. */ [oneway] void dragExit( [in] DragSourceEvent dse ); //------------------------------------------------------------------------- - /** called as the hotspot moves over a platform dependent drop site. + /** Called as the hotspot moves over a platform dependent drop site. @param dsde - the DragSourceEvent + The <type>DragSourceEvent</type> */ [oneway] void dragOver( [in] DragSourceDragEvent dsde ); //------------------------------------------------------------------------- - /** called when the user has modified the drop gesture. + /** Called when the user has modified the drop gesture. @param dsde - the DragSourceEvent + The <type>DragSourceEvent</type>. */ [oneway] void dropActionChanged( [in] DragSourceDragEvent dsde ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl index 9375142e447f..bf120257f625 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTarget.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:26:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,8 @@ interface XDropTargetListener; /** This interface is implemented by a view or window that supports drop operations. - <p>Different to Java, the association between view and interface is fixed - and cannot be changed. Otherwise, the awt messaging would have to be + <p>Differently to Java, the association between view and interface is fixed + and cannot be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a performance issue.</p> */ @@ -89,69 +89,70 @@ interface XDropTargetListener; interface XDropTarget: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** add a DropTargetListener. + /** Add a DropTargetListener. - <p>The listener will be querried for the <type>XAutoscroll</type> interface + <p>The listener will be queried for the <type>XAutoscroll</type> interface to see if it supports autoscrolling.</p> @param dtl - the listener to add to the notification list. + The listener to add to the notification list. */ [oneway] void addDropTargetListener( [in] XDropTargetListener dtl ); //------------------------------------------------------------------------- - /** remove a DropTargetListener. + /** Remove a drop target listener. @param dtl - the listener to remove from notification list. + The listener to remove from notification list. */ [oneway] void removeDropTargetListener( [in] XDropTargetListener dtl ); //------------------------------------------------------------------------- - /** @returns - a boolean indicating whether or not this DropTarget is + /** Indicates either a drop target object is active or not. + + @returns + A boolean indicating whether or not this drop target object is currently active, that is ready to accept drops. */ boolean isActive(); //------------------------------------------------------------------------- - /** sets the DropTarget active if <TRUE/>, inactive if <FALSE/>. + /** Sets the drop target object active or inactive. @param active - see describtion above. - - <!-- Editor: Should the first sentence be an @return ? --> + A value of <TRUE/> sets the drop target object active. + <p>A value of <FALSE/> sets the drop target object inactive. */ void setActive( [in] boolean active ); //------------------------------------------------------------------------- - /** @returns - the current action or actions supported by this DropTarget. + /** Determine the actions supported by a drop target. + + @returns + The current action or actions supported by this drop target. <p>By default this will include all drag and drop actions.</p> - @see DNDConstants + @see com::sun::star::datatransfer::dnd::DNDConstants */ byte getDefaultActions(); //------------------------------------------------------------------------- - /** sets the default acceptable actions for this DropTarget. + /** Sets the default acceptable actions for this drop target. - <p>This method is a way to reduce the number of drag and drop events + <p>This method is a way to reduce the number of Drag and Drop events by blocking events for actions not supported by this target.</p> - <p>By default the listener will receive notifications for all actions.</p> - @param actions - the actions. + The actions. - @see DNDConstants + @see com::sun::star::datatransfer::dnd::DNDConstants */ [oneway] void setDefaultActions( [in] byte actions ); }; diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl index df24130b4173..851a47f90a68 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetDragContext.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,33 +75,33 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is implemented by any DropTargetContext object. +/** This interface is implemented by any drop target context object. - <p>A DropTargetContext is created whenever the logical cursor associated + <p>A drop target context is created whenever the logical cursor associated with a Drag and Drop operation moves within the visible geometry of a - window associated with a DropTarget. </p> + window associated with a drop target. </p> - <p>The DropTargetContext provides the mechanism for a potential receiver + <p>The drop target context provides the mechanism for a potential receiver of a drop operation to both provide the end user with the appropriate drag - under feedback and effect the subsequent data transfer, if - appropriate. </p> - + under feedback and effect the subsequent data transfer, if appropriate. </p> */ interface XDropTargetDragContext: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** accept the Drag. - - <p>This method should be called from the <type>XDropTargetListener</type>s - <member>XDropTargetListener::dragEnter</member>, - <member>XDropTargetListener::dragOver</member>, and - <member>XDropTargetListener::dragActionChanged</member> methods if the - implementation wishes to accept the drag operation with the specified + /** Accept the Drag. + + <p>This method should be called from the methods of <type>XDropTargetListener</type> + <ul> + <li><member>XDropTargetListener::dragEnter()</member></li> + <li><member>XDropTargetListener::dragOver()</member></li> + <li><member>XDropTargetListener::dragActionChanged()</member></li> + </ul> + if the implementation wishes to accept the drag operation with the specified action.</p> @param dragOperation - the operation accepted by the target. + The operation accepted by the target. @see DNDConstants @see DropTargetDragEvent @@ -110,13 +110,9 @@ interface XDropTargetDragContext: com::sun::star::uno::XInterface [oneway] void acceptDrag( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** reject the Drag. - - <p>Reject the drag as a result of examining either or the available + /** Reject the drag as a result of examining the available <type scope="com::sun::star::datatransfer">DataFlavor</type> types - received in the <member>XDropTargetListener::dragEnter</member>. - - <!-- Editor: Something is missing between the "either or" --> + received in the <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::dragEnter()</member> method. */ [oneway] void rejectDrag(); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl index 35f7acf50bdf..28fcd1e5bae4 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetDropContext.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 18:11:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,31 +75,28 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is implemented by any DropTargetContext object. +/** This interface is implemented by any drop target context object. <p>A DropTargetContext is created whenever the logical cursor associated - with a Drag and Drop operation moves with the visible geometry of a + with a Drag and Drop operation moves within the visible geometry of a window associated with a DropTarget. </p> - <!-- Editor: Should the word be "within" instead of "with"? --> - - <p>The DropTargetContext provides the mechanism for a potential receiver + <p>The drop target context provides the mechanism for a potential receiver of a drop operation to provide the end user with the appropriate drag under feedback and to effect the subsequent data transfer, if appropriate. </p> - */ interface XDropTargetDropContext : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** accept the Drop. + /** Accept the Drop. - <p>This method should be called from the <type>XDropTargetListener</type>s - <member>XDropTargetListener::drop</member> method if the implementation - wishes to accept the drop operation with the specified action.</p> + <p>This method should be called from the + <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member> + method if the implementation wishes to accept the drop operation with the specified action.</p> @param dragOperation - the operation accepted by the target. + The operation accepted by the target. @see DNDConstants @see DropTargetDragEvent @@ -108,24 +105,19 @@ interface XDropTargetDropContext : com::sun::star::uno::XInterface [oneway] void acceptDrop( [in] byte dragOperation ); //------------------------------------------------------------------------- - /** reject the Drag. - - <p>Reject the drop as a result of examining either or the available + /** Reject the drop as a result of examining the available <type scope="com::sun::star::datatransfer">DataFlavor</type> types - received in the <member>XDropTargetListener::dragEnter</member>. - - <!-- Editor: "either" and "or" should have some text between them --> + received in the <member>XDropTargetListener::dragEnter()</member> method. */ [oneway] void rejectDrop(); //------------------------------------------------------------------------- - /** signals that the drop is completed and if it was successful or not. + /** Signals that the drop is completed and if it was successful or not. @param success - <TRUE/> if drop completed successful, <FALSE/> otherwise. - - <!-- Editor: Should this be @return ? --> + A value of <TRUE/> means the drop completed successfully + <p>A value of <FALSE/> means the drop completed unsuccessfully.</p> */ [oneway] void dropComplete( [in] boolean success ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index 10f96f1a43ef..9a5821e2d2b2 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropTargetListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-07-27 19:48:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,9 @@ module com { module sun { module star { module datatransfer { module dnd { //============================================================================= -/** This interface is the callback interface used by the DropTarget class to - provide notification of DnD operations that involve the subject DropTarget. +/** This interface is the callback interface used by the drop target object to + provide notification of Drag and Drop operations that involve the subject + drop target. <p>Methods of this interface may be implemented to provide "drag under" visual feedback to the user throughout the Drag and Drop operation.</p> @@ -89,55 +90,54 @@ module com { module sun { module star { module datatransfer { module dnd { interface XDropTargetListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** the drag operation has terminated with a drop on this DropTarget. + /** The drag operation has terminated with a drop on this drop target. - <p> NOTE: This method should not be one-way. The implentation - has to wait until dropComplete on the <type>XDropTargetDropContext</type> + <p><strong>NOTE:</strong> This method should not be oneway. The implentation + has to wait until the method <type>XDropTargetDropContext::dropComplete()</type> is called before releasing the data for the drop operation. This should occur before returning from drop in a normal flow of operation. - Also, the implementor of XDropTargetListener should not assume + Also, the implementor of <type>XDropTargetListener</type> should not assume the <type>DropTargetDropEvent</type> to be meaningful after returning - from the <member>XDropTargetListener::drop</member> method. - </p> + from the <member>XDropTargetListener::drop()</member> method.</p> @param dtde - the DropTargetDropEvent + The <type>DropTargetDropEvent</type>. */ void drop( [in] DropTargetDropEvent dtde ); //------------------------------------------------------------------------- - /** called when a drag operation has encountered the DropTarget. + /** Called when a drag operation has encountered the drop target. @param dtde - the DropTargetDragEvent + The <type>DropTargetDragEvent</type>. */ [oneway] void dragEnter( [in] DropTargetDragEnterEvent dtdee ); //------------------------------------------------------------------------- - /** the drag operation has departed the DropTarget without dropping. + /** The drag operation has departed the drop target without dropping. @param dte - the DropTargetEvent + The <type>DropTargetEvent</type>. */ [oneway] void dragExit( [in] DropTargetEvent dte ); //------------------------------------------------------------------------- - /** called when a drag operation is ongoing on the DropTarget. + /** Called when a drag operation is ongoing on the drop target. @param dtde - the DropTargetEvent + The <type>DropTargetEvent</type>. */ [oneway] void dragOver( [in] DropTargetDragEvent dtde ); //------------------------------------------------------------------------- - /** called when the user has modified the drop gesture. + /** Called when the user has modified the drop gesture. @param dtde - the DropTargetEvent + The <type>DropTargetEvent</type>. */ [oneway] void dropActionChanged( [in] DropTargetDragEvent dtde ); diff --git a/offapi/com/sun/star/document/AmbigousFilterRequest.idl b/offapi/com/sun/star/document/AmbigousFilterRequest.idl index 234f8a96646d..3304494cb293 100644 --- a/offapi/com/sun/star/document/AmbigousFilterRequest.idl +++ b/offapi/com/sun/star/document/AmbigousFilterRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: AmbigousFilterRequest.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2001-12-19 13:06:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,28 @@ module com { module sun { module star { module document { //============================================================================= /** should be used for interaction to handle states of ambigous filter detection - to ask user of operation for his decision + + <p> + This exception indicates, that generic filter detection can't decide which of + two filters is the right one. In this case an interaction will be made. + Given URL can be used to decide between given two filters. + Decision can be made e.g. by a dialog, on which the user must select one + of these filters. + A possible continuation of type <type>XInteractionFilterSelect</type> + transport this decision back to source of started interaction. + </p> + + @see XInteractionFilterSelect */ exception AmbigousFilterRequest : ::com::sun::star::uno::Exception { + //------------------------------------------------------------------------- /** transport URL which couldn't be detected right */ string URL; - /** two filters as possible result of user decision + //------------------------------------------------------------------------- + /** two filters as possible result */ string SelectedFilter; string DetectedFilter; diff --git a/offapi/com/sun/star/document/DocumentInfo.idl b/offapi/com/sun/star/document/DocumentInfo.idl index 24a0ce434233..3c8dead5c449 100644 --- a/offapi/com/sun/star/document/DocumentInfo.idl +++ b/offapi/com/sun/star/document/DocumentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentInfo.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,320 +81,235 @@ #include <com/sun/star/util/DateTime.idl> #endif +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif //============================================================================= module com { module sun { module star { module document { //============================================================================= - -// DocMerge from xml: service com::sun::star::document::DocumentInfo -/** This service provides document-specific information like the - author, creation date and user fields.@see StandaloneDocumentInfo +/** this service provides document-specific information like the + author, creation date and user fields + + <p> + Contrary to the service <type>StandaloneDocumentInfo</type> the document - which + contains such informations - must be loaded completly. As a result of that this + DocumengInfo service is available on an open document via the interface + <type>XDocumentInfoSupplier</type> only. + </p> + + @see StandaloneDocumentInfo + @see XDocumentInfoSupplier */ service DocumentInfo { - // DocMerge: empty anyway - interface com::sun::star::document::XDocumentInfo; + //------------------------------------------------------------------------- + /** provides access to the user fields for the information regarding the + document - // DocMerge: empty anyway - interface com::sun::star::lang::XComponent; + <p> + These fields are additional to normal properties. + (see below) + </p> + */ + interface XDocumentInfo; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + /** neccessary to support normal properties + */ interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway - interface com::sun::star::beans::XFastPropertySet; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Author - /** contains the intial author of the document. + /** supports faster access on well known properties by using index */ - [property] string Author; + interface com::sun::star::beans::XFastPropertySet; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::BlindCopiesTo - /** contains the recipients who have received or will - receive a blind copy by email. - - - - <p>Recipients who receive a blind copy are not visible to other - recipients. - - </p> - <p>If there is more than one recipient, a comma is used as a delimiter.</p> + /** contains the intial author of the document */ - [property] string BlindCopiesTo; + [property] string Author; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::CopyTo - /** contains the recipients who have received or will - receive a copy by email. - - - - <p>These recipients are visible to other recipients. - - </p> - <p>If there is more than one recipient, a comma is used as a delimiter.</p> + /** identifies application was used to create or last modify the document */ - [property] string CopyTo; + [property] string Generator; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::CreationDate /** contains the date and time of the first time the - document was stored. + document was stored */ [property] com::sun::star::util::DateTime CreationDate; //------------------------------------------------------------------------- + /** contains the title of the document + */ + [property] string Title; - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Description - /** contains a multi-line comment of the document. - - <p>Line delimiters can be UNIX, Macintosh or DOS style.</p> + //------------------------------------------------------------------------- + /** subject of document */ - [property] string Description; + [property] string Subject; //------------------------------------------------------------------------- + /** contains a multi-line comment of the document - // DocMerge from xml: property com::sun::star::document::DocumentInfo::InReplyTo - /** contains the message ID to which this is an answer. + <p> + Line delimiters can be UNIX, Macintosh or DOS style. + </p> */ - [property] string InReplyTo; + [property] string Description; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Keywords /** contains a comma separated list of keywords for - the document. + the document */ [property] string Keywords; //------------------------------------------------------------------------- + /** contains the MIME-type of the document's resource - // DocMerge from xml: property com::sun::star::document::DocumentInfo::MIMEType - /** contains the MIME-type of the document's resource. - - <p>The MIME-type is neither stored in the document information nor in + <p> + The MIME-type is neither stored in the document information nor in the document; it is sent within a protocol header or is - detected, thus it cannot be changed.</p> + detected, thus it cannot be changed. + </p> */ [readonly, property] string MIMEType; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::ModifyDate - /** contains the date and time of the last time the - document was stored. + /** default language of the document */ - [property] com::sun::star::util::DateTime ModifyDate; + [property] com::sun::star::lang::Locale Language; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::ModifiedBy /** contains the name of the editor who was the last - person to store this document. + person to store this document */ [property] string ModifiedBy; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Newsgroups - /** contains the list of newsgroups where this document - was or will be posted. - - <p>If there is more than one entry, the list is separated by a comma(s).</p> + /** contains the date and time of the last time the + document was stored */ - [property] string Newsgroups; + [property] com::sun::star::util::DateTime ModifyDate; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Original - /** contains the source of the document, - <p>i.e., the message ID for a locally stored message.</p> */ - [property] string Original; + /** contains the name of the editor who was the last + person to print the document + */ + [property] string PrintedBy; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Priority - /** contains the priority of the document. - - <p>The value can be between 0 (very high) and 4 (very low).</p> + /** contains the date and time of when the document was + last printed */ - [property] short Priority; + [property] com::sun::star::util::DateTime PrintDate; //------------------------------------------------------------------------- + /** contains the path and name of the template from + which the document was created - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Recipient - /** contains the recipient of the document. + <p> + The value is an empty string if the document was not created + from a template or if it was detached from the template. + </p> */ - [property] string Recipient; + [property] string Template; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::References - /** contains a list of referred message IDs. + /** contains the date and time of when the document + was created or updated from the template */ - [property] string References; + [property] com::sun::star::util::DateTime TemplateDate; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::ReplyTo - /** contains the mailto:-URL for where to send an answer. + /** contains the URL to load automatically after a + specified time after the document is loaded into a desktop frame */ - [property] string ReplyTo; + [property] string AutoloadURL; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Theme - /** contains a theme describing the topic of the document. + /** contains the number of seconds after which a specified + URL is to be loaded after the document is loaded into a desktop + frame */ - [property] string Theme; + [property] long AutoloadSecs; //------------------------------------------------------------------------- + /** contains the name of the default frame into which + links should be loaded if no target is specified - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Title - /** contains the title of the document. + <p> + This applies to the autoload feature too, but to others as well. + </p> */ - [property] string Title; + [property] string DefaultTarget; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::Template - /** contains the path and name of the template from - which the document was created. - - - - <p>The value is an empty string if the document was not created - from a template or if it was detached from the template.</p> + /** @deprecated */ - [property] string Template; + [property] string BlindCopiesTo; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::TemplateDate - /** contains the date and time of when the document - was created or updated from the template. + /** @deprecated */ - [property] com::sun::star::util::DateTime TemplateDate; + [property] string CopyTo; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::IsEncrypted - /** determines if the document is encrypted with a - password. - - - - <p>It is not possible to set this value because the document - which belongs to this <type>DocumentInfo</type> would no - longer be loadable. - - </p> - <p>The password itself is not stored in the document.</p> + /** @deprecated */ - [readonly, property] boolean IsEncrypted; + [property] string InReplyTo; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::PrintDate - /** contains the date and time of when the document was - last printed. + /** @deprecated */ - [property] com::sun::star::util::DateTime PrintDate; + [property] string Newsgroups; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::PrintedBy - /** contains the name of the editor who was the last - person to print the document. + /** @deprecated */ - [property] string PrintedBy; + [property] string Original; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadEnabled - /** determines if another (or the same) URL is to be - reloaded automatically after a specified time after the document - is loaded into a desktop frame. + /** @deprecated */ - [property] boolean AutoloadEnabled; + [property] short Priority; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadURL - /** contains the URL to load automatically after a - specified time after the document is loaded into a desktop frame. + /** @deprecated */ - [property] string AutoloadURL; + [property] string Recipient; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadSecs - /** contains the number of seconds after which a specified - URL is to be loaded after the document is loaded into a desktop - frame. + /** @deprecated */ - [property] long AutoloadSecs; + [property] string References; //------------------------------------------------------------------------- + /** @deprecated + */ + [property] string ReplyTo; - // DocMerge from xml: property com::sun::star::document::DocumentInfo::DefaultTarget - /** contains the name of the default frame into which - links should be loaded if no target is specified. - - + //------------------------------------------------------------------------- + /** @deprecated + */ + [property] string Theme; - <p>This applies to the autoload feature too, but to others as well.</p> + //------------------------------------------------------------------------- + /** @deprecated */ - [property] string DefaultTarget; + [readonly, property] boolean IsEncrypted; + //------------------------------------------------------------------------- + /** @deprecated + */ + [property] boolean AutoloadEnabled; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/01/23 10:08:08 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.4 2000/12/21 08:35:05 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.9 2000/09/11 11:52:18 mi - documentation merged from XML - - Revision 1.5 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.4 2000/02/21 16:17:58 mi - string documentation from stardiv...*.idl-files - - Revision 1.3 2000/02/07 11:24:26 mi - zu #70728# missing documentation marked - - Revision 1.2 1999/11/18 11:49:55 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/EventDescriptor.idl b/offapi/com/sun/star/document/EventDescriptor.idl index b4b25350b636..f48331d2d844 100644 --- a/offapi/com/sun/star/document/EventDescriptor.idl +++ b/offapi/com/sun/star/document/EventDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: EventDescriptor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-01-24 16:26:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,51 +58,45 @@ * * ************************************************************************/ -#ifndef __com_sun_star_document_DocumentEvent_idl__ -#define __com_sun_star_document_DocumentEvent_idl__ - -#ifndef __com_sun_star_comtainer_XIndexReplace_idl__ -#include <com/sun/star/container/XIndexReplace.idl> -#endif +#ifndef __com_sun_star_document_EventDescriptor_idl__ +#define __com_sun_star_document_EventDescriptor_idl__ //============================================================================= module com { module sun { module star { module document { //============================================================================= - -/** specifies an event binding for a document or a document content. +/** specifies an event binding for a document or a document content @see Events @see XEventsSupplier */ service EventDescriptor { - /** specifies the type of the event handler. - - <p>Usually this is one of the following: - "None", "StarBasic", "JavaScript", "Presentation". - This list is extensible. </p> + //------------------------------------------------------------------------- + /** specifies the type of the event handler + + <p> + Usually this is one of the following: + <ul> + <lie>"None"</li> + <lie>"StarBasic"</li> + <lie>"JavaScript"</li> + <lie>"Presentation"</li> + </ul> + This list is extensible. + </p> */ [property] string EventType; - /** specifies the script source code. + //------------------------------------------------------------------------- + /** specifies the script source code */ [property] string Script; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1 2001/01/24 16:16:45 mi - stored document events and runtime document events structurally unified - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/EventObject.idl b/offapi/com/sun/star/document/EventObject.idl index b8068dca2fae..f21c4347d52f 100644 --- a/offapi/com/sun/star/document/EventObject.idl +++ b/offapi/com/sun/star/document/EventObject.idl @@ -2,9 +2,9 @@ * * $RCSfile: EventObject.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-01-24 16:26:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,17 +70,19 @@ module com { module sun { module star { module document { //============================================================================= - -/** is thrown on document and document content events. +/** is thrown on document and document content events @see XEventListener @see XEventBroadcaster */ struct EventObject: com::sun::star::lang::EventObject { - /** specifies the type of the event handler. + //------------------------------------------------------------------------- + /** specifies the type of the event handler - <p>For a list of possible event names see <type>Events</type>. + <p> + For a list of possible event names see <type>Events</type>. + </p> */ string EventName; }; @@ -89,13 +91,4 @@ struct EventObject: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1 2001/01/24 13:21:26 mi - stored document events and runtime document events structurally unified - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/Events.idl b/offapi/com/sun/star/document/Events.idl index b4ca1e7af0bc..c8bc6272f849 100644 --- a/offapi/com/sun/star/document/Events.idl +++ b/offapi/com/sun/star/document/Events.idl @@ -2,9 +2,9 @@ * * $RCSfile: Events.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,8 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_document_DocumentEvent_idl__ -#define __com_sun_star_document_DocumentEvent_idl__ +#ifndef __com_sun_star_document_Events_idl__ +#define __com_sun_star_document_Events_idl__ #ifndef __com_sun_star_container_XNameReplace_idl__ #include <com/sun/star/container/XNameReplace.idl> @@ -70,50 +70,58 @@ module com { module sun { module star { module document { //============================================================================= - /** is a collection of all events supported by a document or content of a - document. + document + + <p> + Such Events will be broadcasted by a <type>XEventBroadcaster</type> + to any <type>XEventListener</type> packed as <type>EventObject</type>s. + </p> */ service Events { - /** offers access to the list of <type>EventDescriptor</type>s. - <p>The following events are usually available: </p> + //------------------------------------------------------------------------- + /** offers access to the list of <type>EventDescriptor</type>s + + <p> + The following events are usually available: <dl> - <dt>OnSelect - <dt>OnInsertStart - <dt>OnInsertDone - <dt>OnMailMerge - <dt>OnAlphaCharInput - <dt>OnNonAlphaCharInput - <dt>OnResize - <dt>OnMove - <dt>OnPageCountChange - <dt>OnMouseOver - <dt>OnClick - <dt>OnMouseOut - <dt>OnLoadError - <dt>OnLoadCancel - <dt>OnLoadDone - <dt>OnLoad OnUnload - <dt>OnStartApp - <dt>OnCloseApp - <dt>OnNew - <dt>OnSave - <dt>OnSaveAs - <dt>OnFocus - <dt>OnUnfocus - <dt>OnPrint - <dt>OnError - <dt>OnLoadFinished - <dt>OnSaveFinished - <dt>OnModifyChanged - <dt>OnPrepareUnload - <dt>OnNewMail - <dt>OnToggleFullscreen - <dt>OnSaveDone - <dt>OnSaveAsDone + <dt>OnAlphaCharInput</dt> + <dt>OnClick</dt> + <dt>OnCloseApp</dt> + <dt>OnError</dt> + <dt>OnFocus</dt> + <dt>OnInsertDone</dt> + <dt>OnInsertStart</dt> + <dt>OnLoad</dt> + <dt>OnLoadCancel</dt> + <dt>OnLoadDone</dt> + <dt>OnLoadError</dt> + <dt>OnLoadFinished</dt> + <dt>OnMailMerge</dt> + <dt>OnModifyChanged</dt> + <dt>OnMouseOut</dt> + <dt>OnMouseOver</dt> + <dt>OnMove</dt> + <dt>OnNew</dt> + <dt>OnNewMail</dt> + <dt>OnNonAlphaCharInput</dt> + <dt>OnPageCountChange</dt> + <dt>OnPrepareUnload</dt> + <dt>OnPrint</dt> + <dt>OnResize</dt> + <dt>OnSave</dt> + <dt>OnSaveAs</dt> + <dt>OnSaveAsDone</dt> + <dt>OnSaveDone</dt> + <dt>OnSaveFinished</dt> + <dt>OnSelect</dt> + <dt>OnStartApp</dt> + <dt>OnToggleFullscreen</dt> + <dt>OnUnfocus</dt> + <dt>OnUnload</dt> </dl> - + </p> */ interface com::sun::star::container::XNameReplace; }; @@ -122,19 +130,4 @@ service Events }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/01/24 16:26:20 mi - compiles now - - Revision 1.1 2001/01/24 16:17:49 mi - stored document events and runtime document events structurally unified - - Revision 1.1 2001/01/23 10:08:08 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/ExportFilter.idl b/offapi/com/sun/star/document/ExportFilter.idl index ccc84088a156..e6ad7902dcd8 100644 --- a/offapi/com/sun/star/document/ExportFilter.idl +++ b/offapi/com/sun/star/document/ExportFilter.idl @@ -2,9 +2,9 @@ * * $RCSfile: ExportFilter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,95 +61,129 @@ #ifndef __com_sun_star_document_ExportFilter_idl__ #define __com_sun_star_document_ExportFilter_idl__ -#ifndef __com_sun_star_document_XFilter_idl__ -#include <com/sun/star/document/XFilter.idl> -#endif - #ifndef __com_sun_star_document_XExporter_idl__ #include <com/sun/star/document/XExporter.idl> #endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_document_XFilter_idl__ +#include <com/sun/star/document/XFilter.idl> #endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> #endif +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + //============================================================================= module com { module sun { module star { module document { //============================================================================= +/** filter for exports + + <p> + Such filters can be used for exporting a content. + Of course it's possible to combine it with the service <type>ImportFilter</type> + if import functionality should be available at same implementation too. + </p> -/** filter for exports. + @see ImportFilter */ service ExportFilter { //------------------------------------------------------------------------- - /** filter interface. + /** set source(!) document for this filter <p> - This interface is used to filter a document at saving time. - </p> + The document must be used as the source for following filter operation. + Any content from there will be exported to another format. + </p> */ - interface com::sun::star::document::XFilter; + interface XExporter; //------------------------------------------------------------------------- - /** set document for this filter. + /** filter interface <p> - The document can used as the target of a filter output. + It's used to filter a document at saving time. + The source document should be already setted by using another interface + <member>ExportFilter::XExporter</member> which is supported by this service too. </p> + + <p> + Tip:<br> + If same implementation provides the service <type>ImportFilter</type> too, + code must distinguish between filtering from a source document (for export) or + filtering to a target document (for import). This can be recognized by saving + state of used interfaces <type>XExporter</type> or <type>XImporter</type>! + Otherwise it's not clear which action is required here. + </p> */ - interface ::com::sun::star::document::XExporter; + interface XFilter; //------------------------------------------------------------------------- - /** support initialization of filter with its own configuration. + /** support initialization of filter with its own configuration + + <p> + A filter object must be created by global service <type>FilterFactory</type>. + If filter supports this optional interface, he will be initialized by the factory directly + after creation. The factory will pass follow informations to this new instance: + <ul> + <li>first item will be a set of configuration data of the filter</li> + <li>after that will follow may given optional parameters of call + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + of service <type>FilterFactory</type>. + </li> + </ul> + See description of service <member>FilterFactory::XNameAccess</member> for a description of + possible configuration data too. + </p> + <p> - A filter must support readonly access to its own configuration, but - readonly properties couldn't be set. - That is the reason for this interface. - All Anys of given sequence are from Type <type>PropertyValue</type>. + Java Example: + <listing> + void XInitialization::initialize( java.lang.Object[] lData ) + { + // Config part exist every time - it's guaranted by FilterFactory! + int i=0; + com.sun.star.beans.NamedValue[] lConfig = lData[i]; + for( y=0; y<lConfig.length(); ++y ) + { + // ... work with this config data + } + // Arguments of call createInstanceWithArguments() are optional ones. + // They mustn't exist. + // Note: i starts with + for( ; i<lData.length(); ++i ) + { + // ... work with this optional data + } + } + </listing> </p> */ [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** readonly access to filter configuration. + /** provides access to the internal name of this filter <p> - This interface supports readonly access to our internal configuration of this filter. - The filter gets the configuration about <type>XInitialization</type> at creation by using - the <type>FilterFactory</type>. + This internal filter name can be used on service <type>FilterFactory</type> + to get further informations about it (e.g. his registration for mime types or extensions etc.) + It's important that returned string is the "internal name" of the filter which must be + unambigous against all other registered filter in current instalation. + </p> + <p> + <strong>Attention!</strong><br> + Supported method setName() sould be ignored or forwarded to the FilterFactory. + It's not allowed to set it directly to the configuration. Because it depends + from real implementation of the FilterFactory if it will be allowed or not! </p> */ - interface com::sun::star::beans::XPropertySet; - - /// filter is registered for this type. - [property, readonly] string Type; - - /// localized name of filter to show at UI elements. - [property, readonly] string UIName; - - /// service name which presents the document. - [property, readonly] string DocumentService; - - /// service name of this filter implementation. - [property, readonly] string FilterService; - - /// flags to describe the filter. - [property, readonly] string Flags; - - /// additional information with private structure. - [property, readonly] string UserData; - - /// version number of file format. - [property, readonly] string FileFormatVersion; - - /// name of suitable template. - [property, readonly] string TemplateName; + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= diff --git a/offapi/com/sun/star/document/FilterFactory.idl b/offapi/com/sun/star/document/FilterFactory.idl index a8194ce9d0c2..9f057ab9c336 100644 --- a/offapi/com/sun/star/document/FilterFactory.idl +++ b/offapi/com/sun/star/document/FilterFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilterFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,54 +69,155 @@ #include <com/sun/star/container/XNameAccess.idl> #endif +#ifndef __com_sun_star_container_XContainerQuery_idl__ +#include <com/sun/star/container/XContainerQuery.idl> +#endif + //============================================================================= module com { module sun { module star { module document { //============================================================================= +/** factory to create filter objects or search on filter configuration -/** factory to create filter objects + <p> + After a generic <type>TypeDetection</type> an internal type name + will be well known (or may not if it failed to detect requested document). + For such internal type names filters will be registered. If there are more then + ones any of them can use the default flag to be preferred. + This factory can be used to the follow then: + <ul> + <li>search on filter configuration (includes searching for suitable filter for + a given internal type name too) + </li> + <li>create the filter object + </li> + <li>get/set properties of any registered filter. + (means in configuration, not on the filter) + </li> + </ul> + </p> */ service FilterFactory { //------------------------------------------------------------------------- - /** search suitable filter for given internal type name and additional arguments - and create it + /** provides search on flat filter configuration + + <p> + After a <type>TypDetection</type> an internal name of a type which presents + the requested document will be well known. With this interface it's possible + to find out which filter(s) are registered for that. It's possible to use + implementation dependend query commands (strings) or sets of properties which + must supported by searched filter(s). Returned enumerations contains a reference + to sub sets of filter(s) (means to her flat data structures represented as + <type scope="com::sun::star::beans" dim="[]">NamedValue</type>) which can be used + for further steps then; e.g, to create the filter(s). + (see list of properties below on <member>FilterFactory::XNameAccess</member>) + </p> <p> - After a <type>TypDetection</type> you have an internal name of a type which presents - your document. Call createInstance() or createInstanceWithArguments() with these - informations and we create a suitable filter for you. - There exist two types of filters: <type>ImportFilter</type> and <type>ExportFilter</type>. - A combination of both services in one implementation is also possible. - You can regulate search for filter by giving correct arguments - like flags for import/export ... - - @attention Don't use getAvailableServiceNames()! - Please use XNameAccess to get informations about our configuration of accessible filters. - </p> + Same functionality (for searching) will be provided by the follow interface + <member>FilterFactory::XNameAccess</member> - but that willn't be very comfortable + to do so. + </p> */ - interface com::sun::star::lang::XMultiServiceFactory; + interface com::sun::star::container::XContainerQuery; //------------------------------------------------------------------------- - /** readonly access to filter configuration + /** provides simple access on flat filter configuration + <p + Every filter (<type>ExportFilter</type>/<type>ImportFilter</type>) is specified by + some properties wich are represented as <type scope="com::sun::star::beans" dim="[]">NamedValue</type>. + This interface provides pure access (read/write) on these data. + A name for the calling methods must the internal filter name be used only. + Returned any capsulate the flat property lists then. May this interface will be neccessary + to extend missing funtionality of <member>FilterFactory::XContainerQuery</member> or for + changing the configuration (if implementation of this service allow that! may they will be readonly). + Query interface before provides readonly access only. + </p> <p> - These interfaces support a readonly access to our internal configuration of all accessible filters. - The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any! - - Supported properties are: - name of property value type of property description - "Type" [string ] filter is registered for this type - "UIName" [string ] localized name of filter to show at the UI - "DocumentService" [string ] service name which presents the document - "FilterService" [string ] service name of filter implementation - "Flags" [integer] flags to describe the filter - "UserData" [string ] additional information with private structure! - "FileFormatVersion" [integer] version number of file format - "TemplateName" [string ] name of suitable template - </p> + Follow properties are supported by a filter: + <table border=1> + <tr> + <td><strong>property name</strong></td> + <td><strong>value type</strong></td> + <td><strong>description</strong></td> + </tr> + <tr> + <td><em>Type<em></td> + <td>[string]</td> + <td>filter is registered for this internal type name<br> + (see <type>TypeDetection</type> for further informations)</td> + </tr> + <tr> + <td><em>UIName<em></td> + <td>[string]</td> + <td>localized name of filter to show at the UI</td> + </tr> + <tr> + <td><em>DocumentService<em></td> + <td>[string]</td> + <td>service name which presents the document type<br> + (e.g. <type scope="com::sun::star::text">TextDocument</type>)</td> + </tr> + <tr> + <td><em>FilterService<em></td> + <td>[string]</td> + <td>service name of filter implementation<br> + Note: It means the implementation name of the service realy. + Because it's not possible to distinguish between + more then one filters otherwise.</td> + </tr> + <tr> + <td><em>Flags<em></td> + <td>[integer]</td> + <td>describe the filter more specific<br> + (e.g. for import/export or as default)</td> + </tr> + <tr> + <td><em>UserData<em></td> + <td>[string]</td> + <td>contains filter specific configuration formated as string + for historical reasons</td> + </tr> + <tr> + <td><em>FileFormatVersion<em></td> + <td>[integer]</td> + <td>specifies supported format version if there exist more then ones</td> + </tr> + <tr> + <td><em>TemplateName<em></td> + <td>[string]</td> + <td>name of suitable template</td> + </tr> + </table> + </p> */ interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + /** factory to create filter objects + + <p> + After using the interfaces before (or if it was already clear) an internal + filter name should be well known. This can be used at this interface to create + the real filter object for using. It's possible to use optional arguments + for initializing too. + If created filter supports the interface <type scope="com::sun::star::lang">XInitialization</type> + this factory will pass his own configuration data and the may given optional + arguments to it. (see <member>ExportFilter::XInitialization</member> or + <member>ImportFilter::XInitialization</member> for further informations about that) + If it doesn't support it nothing will be done then. The filter will be returned + uninitialized then and must get his configuration by another way himself. + But he should supports the interface <type scope="com::sun::star::container">XNamed</type> + to privide his own internal name. Any user of it can use this information + to get more information about it on this FilterFactory service. + Note: Return value can be <NULL/> if unknown filter was requested or + coudln't be created successfully. + </p> + */ + interface com::sun::star::lang::XMultiServiceFactory; }; //============================================================================= diff --git a/offapi/com/sun/star/document/ImportFilter.idl b/offapi/com/sun/star/document/ImportFilter.idl index 4cde134b79e6..b97336e851d1 100644 --- a/offapi/com/sun/star/document/ImportFilter.idl +++ b/offapi/com/sun/star/document/ImportFilter.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImportFilter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-04-16 21:39:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,96 +61,129 @@ #ifndef __com_sun_star_document_ImportFilter_idl__ #define __com_sun_star_document_ImportFilter_idl__ -#ifndef __com_sun_star_document_XFilter_idl__ -#include <com/sun/star/document/XFilter.idl> -#endif - #ifndef __com_sun_star_document_XImporter_idl__ #include <com/sun/star/document/XImporter.idl> #endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_document_XFilter_idl__ +#include <com/sun/star/document/XFilter.idl> #endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include <com/sun/star/lang/XInitialization.idl> #endif +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + //============================================================================= module com { module sun { module star { module document { //============================================================================= +/** filter for imports -/** filter for imports. + <p> + Such filters can be used for importing a content. + Of course it's possible to combine it with the service <type>ExportFilter</type> + if export functionality should be available at same implementation too. + </p> + + @see ExportFilter */ service ImportFilter { //------------------------------------------------------------------------- - /** filter interface. + /** set target(!) document for this filter <p> - This interface is used to filter a document at loading time. - </p> + The document must be used as the target of the filter. + Any external content will be written there. + </p> */ - interface com::sun::star::document::XFilter; + interface XImporter; //------------------------------------------------------------------------- - /** set document for this filter. + /** filter interface <p> - The document can be used as source of filter input. + It's used to filter a document at loading time. + The target document should be already setted by using another interface + <member>ImportFilter::XImporter</member> which is supported by this service too. </p> + + <p> + Tip:<br> + If same implementation provides the service <type>ExportFilter</type> too, + code must distinguish between filtering into a target document (for import) or + filtering from a source document (for export). This can be recognized by saving + state of used interfaces <type>XExporter</type> or <type>XImporter</type>! + Otherwise it's not clear which action is required here. + </p> */ - interface com::sun::star::document::XImporter; + interface XFilter; //------------------------------------------------------------------------- - /** support initialization of filter with its own configuration. + /** support initialization of filter with its own configuration + <p> - A filter must support a readonly access to its own configuration. - but readonly properties could not be set. - That is the reason for this interface. - All Anys of given sequence are from Type <type>PropertyValue</type>. + A filter object must be created by global service <type>FilterFactory</type>. + If filter supports this optional interface, he will be initialized by the factory directly + after creation. The factory will pass follow informations to this new instance: + <ul> + <li>first item will be a set of configuration data of the filter</li> + <li>after that will follow may given optional parameters of call + <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> + of service <type>FilterFactory</type>. + </li> + </ul> + See description of service <member>FilterFactory::XNameAccess</member> for a description of + possible configuration data too. + </p> + + <p> + Java Example: + <listing> + void XInitialization::initialize( java.lang.Object[] lData ) + { + // Config part exist every time - it's guaranted by FilterFactory! + int i=0; + com.sun.star.beans.NamedValue[] lConfig = lData[i]; + for( y=0; y<lConfig.length(); ++y ) + { + // ... work with this config data + } + // Arguments of call createInstanceWithArguments() are optional ones. + // They mustn't exist. + // Note: i starts with + for( ; i<lData.length(); ++i ) + { + // ... work with this optional data + } + } + </listing> </p> */ - interface com::sun::star::lang::XInitialization; + [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /** readonly access to filter configuration. + /** provides access to the internal name of this filter <p> - This interface supports readonly access to our internal configuration of this filter. - The filter gets its configuration about <type>XInitialization</type> at creation by using - the <type>FilterFactory</type>. + This internal filter name can be used on service <type>FilterFactory</type> + to get further informations about it (e.g. his registration for mime types or extensions etc.) + It's important that returned string is the "internal name" of the filter which must be + unambigous against all other registered filter in current instalation. + </p> + <p> + <strong>Attention!</strong><br> + Supported method setName() sould be ignored or forwarded to the FilterFactory. + It's not allowed to set it directly to the configuration. Because it depends + from real implementation of the FilterFactory if it will be allowed or not! </p> */ - interface com::sun::star::beans::XPropertySet; - - /// filter is registered for this type. - [property, readonly] string Type; - - /// localized name of filter to show at UI elements. - [property, readonly] string UIName; - - /// service name which presents the document. - [property, readonly] string DocumentService; - - /// service name of this filter implementation. - [property, readonly] string FilterService; - - /// flags to describe the filter. - [property, readonly] string Flags; - - /// additional information with private structure. - [property, readonly] string UserData; - - /// version number of file format. - [property, readonly] string FileFormatVersion; - - /// name of suitable template. - [property, readonly] string TemplateName; - + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= diff --git a/offapi/com/sun/star/document/LinkTarget.idl b/offapi/com/sun/star/document/LinkTarget.idl index 1660d7d6583d..984859d3477a 100644 --- a/offapi/com/sun/star/document/LinkTarget.idl +++ b/offapi/com/sun/star/document/LinkTarget.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinkTarget.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,40 +72,25 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: service com::sun::star::document::LinkTarget /** This service is implemented by objects inside a document object model that can be the target of a link inside a document */ service LinkTarget { - // DocMerge: empty anyway - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - - // DocMerge: from idl - - // DocMerge from xml: service com::sun::star::document::LinkTarget: interface com::sun::star::document::XLinkTargetSupplier - /** Optional, this object could also have children that can be the - target of a link. + /** a link target may have child objects which can be link targets too. + These are accessible by this optinonal interface. */ - interface com::sun::star::document::XLinkTargetSupplier; + [optional] interface com::sun::star::document::XLinkTargetSupplier; //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: property com::sun::star::document::LinkTarget::LinkDisplayName - /** Contrary to the name of this link, this property should be a human - readable name for this object that could be displayed in a user - interface + /** contains a human readable name for this object that could be displayed in a user + interface. */ [readonly, property] string LinkDisplayName; @@ -115,33 +100,4 @@ service LinkTarget }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.10 2000/09/11 11:52:18 mi - documentation merged from XML - - Revision 1.5 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.4 2000/04/26 11:21:39 bm - orthographical error in comment - - Revision 1.3 2000/02/21 16:17:59 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:27 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/LinkTargets.idl b/offapi/com/sun/star/document/LinkTargets.idl index 4078a8e74126..1bdfb375ee0f 100644 --- a/offapi/com/sun/star/document/LinkTargets.idl +++ b/offapi/com/sun/star/document/LinkTargets.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinkTargets.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,28 +68,19 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: service com::sun::star::document::LinkTargets /** This service gives access to a collection of names that are child links of the parent object that supplied this service. - - <p>The <type scope="com::sun::star::container">XNameAccess</type> returns elements of <type scope="com::sun::star::beans">XPropertySet</type> that implement - the service <type>LinkTarget</type> - </p> + the service <type>LinkTarget</type>. </p> */ service LinkTargets { - // DocMerge: empty anyway - - // DocMerge: empty anyway interface com::sun::star::container::XNameAccess; }; @@ -98,24 +89,4 @@ service LinkTargets }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.7 2000/09/11 11:52:18 mi - documentation merged from XML - - Revision 1.3 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.2 2000/02/07 11:24:27 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index a1f222dd47f7..896ba2cabd2a 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: MediaDescriptor.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: as $ $Date: 2002-07-23 13:36:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -446,10 +446,12 @@ service MediaDescriptor [property] string TemplateName; //------------------------------------------------------------------------- - /** name of the region of the template + /** name of the template instead of the URL <p> - Use always in conjunction with <member>MediaDescriptor::TemplateName</member>. + The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</type> + property it can be used instead of the URL of the template. Use always in conjunction with + <member>MediaDescriptor::TemplateRegionName</member>. </p> */ [property] string TemplateRegionName; @@ -488,7 +490,6 @@ service MediaDescriptor //------------------------------------------------------------------------- /** set special view state - <p> Data to set a special view state after loading. The type depends on the component and is usually retrieved from a <type scope="com::sun::star::frame">Controller</type> diff --git a/offapi/com/sun/star/document/NoSuchFilterRequest.idl b/offapi/com/sun/star/document/NoSuchFilterRequest.idl index 675990220185..a2a2bff0b40c 100644 --- a/offapi/com/sun/star/document/NoSuchFilterRequest.idl +++ b/offapi/com/sun/star/document/NoSuchFilterRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSuchFilterRequest.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2001-11-08 11:55:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,9 +71,26 @@ module com { module sun { module star { module document { //============================================================================= /** should be used for interaction to handle states of unknown filter during detection + + <p> + If during loading time the filter can't be detected and wasn't given at calling time, + a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. + (it's a a part of used <type>MediaDescriptor</type>) + Such "NoSuchFilterRequest" will be used then to start right interaction on that to + get a decision wich filter should be used for given URL. A possible continiuation + of type <type>XInteractionFilterSelect</type> will transport this decision back to + generic filter detection and force using of it. Of course it's possible to abort + the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>. + </p> + + @see MediaDescriptor + @see com::sun::star::task::InteractionHandler + @see XInteractionFilterSelect + @see com::sun::star::task::XInteractionAbort */ exception NoSuchFilterRequest : ::com::sun::star::uno::Exception { + //------------------------------------------------------------------------- /** transport URL which couldn't be detected */ string URL; diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index 0bd3a67e479f..1a331a2be1d9 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: OfficeDocument.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,6 +61,14 @@ #ifndef __com_sun_star_document_OfficeDocument_idl__ #define __com_sun_star_document_OfficeDocument_idl__ +#ifndef __com_sun_star_frame_XModel_idl__ +#include <com/sun/star/frame/XModel.idl> +#endif + +#ifndef __com_sun_star_util_XModifiable_idl__ +#include <com/sun/star/util/XModifiable.idl> +#endif + #ifndef __com_sun_star_frame_XStorable_idl__ #include <com/sun/star/frame/XStorable.idl> #endif @@ -69,90 +77,149 @@ #include <com/sun/star/view/XPrintable.idl> #endif +#ifndef __com_sun_star_document_XEventBroadcaster_idl__ +#include <com/sun/star/document/XEventBroadcaster.idl> +#endif + #ifndef __com_sun_star_document_XEventSupplier_idl__ #include <com/sun/star/document/XEventsSupplier.idl> #endif +#ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__ +#include <com/sun/star/document/XDocumentInfoSupplier.idl> +#endif -//============================================================================= - - module com { module sun { module star { module document { +#ifndef __com_sun_star_document_XViewDataSupplier_idl__ +#include <com/sun/star/document/XViewDataSupplier.idl> +#endif //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: service com::sun::star::document::OfficeDocument -/** This abstract service specifies a storable and printable document. +module com { module sun { module star { module document { +//============================================================================= +/** abstract service which specifies a storable and printable document + <p> + All major document-like components should support this service + instead of simple components which supports a <type scope="com::sun::star::frame">Controller</type> + or pure <type scope="com::sun::star::awt">XWindow</type> only. + </p> - <p>All major document-like components should support this service.</p> + @see com::sun::star::frame::Controller */ service OfficeDocument { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + /** represents a component which is created from an URL and arguments + + <p> + It is a representation of a resource in the sense that it was + created/loaded from the resource. The arguments are passed to the loader + to modify its behavior. + </p> + */ + interface com::sun::star::frame::XModel; + + //------------------------------------------------------------------------- + /** a storable document should provide information about his modify state + + <p> + With this interface it's possible too, to reset the modify state. + That can be neccessary to prevent code against problem during closing + of the document without saving any changes. + </p> + */ + interface com::sun::star::util::XModifiable; + + //------------------------------------------------------------------------- + /** offers a simple way to store a component to an URL + + <p> + This interface supports functionality + <ul> + <li>to make a copy of current component by saving it to another location</li> + <li>to commit made changes</li> + <li>to convert it by saving it by using suitable filter name.</li> + </ul> + </p> + */ interface com::sun::star::frame::XStorable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + /** offers a way to print a component + + <p> + It's possible to specify wich printer should be used and of course + print the document on it. + </p> + */ interface com::sun::star::view::XPrintable; - /** access to bound event handlers. + //------------------------------------------------------------------------- + /** makes it possible to register listeners which are called whenever + a document event occurs @optional */ - [optional] interface XEventsSupplier; + [optional] interface XEventBroadcaster; - /** controls the focus behaviour of the form controls in the document - <p>If this flag is set to <TRUE/>, any view belonging to the document should focus the - first control in the document.</p> - <p>With this, you may control if your document works primarily as a form document.</p> - */ - [property, optional] boolean AutomaticControlFocus; + //------------------------------------------------------------------------- + /** access to bound event handlers - /** controls the initial (on-load) behavior of the form controls in the document - <p>If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br> - If set to <FALSE/>, they will be alive (i.e., connected to the data source specified for the form - they belong to).</p> - <p>With this, you may control if your document works primarily as a form document.</p> - */ - [property, optional] boolean ApplyFormDesignMode; -}; + @optional + */ + [optional] interface XEventsSupplier; -//============================================================================= + //------------------------------------------------------------------------- + /** document can provide a <type>DocumentInfo</type> -}; }; }; }; + <p> + Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type> + will be available on an already opened document only. + </p> -/*============================================================================= + @optional + */ + [optional] interface XDocumentInfoSupplier; - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/19 12:50:25 fs - #83970# +AutomaticControlFocus / +ApplyFormDesignMode + //------------------------------------------------------------------------- + /** access to some properties describing all open views to a document - Revision 1.5 2001/02/05 15:03:45 kz - XEventSupplier -> XEventsSupplier + @optional + */ + [optional] interface XViewDataSupplier; - Revision 1.4 2001/01/23 10:08:08 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact + //------------------------------------------------------------------------- + /** controls the focus behaviour of the form controls in the document - Revision 1.3 2000/11/08 12:42:40 mi - moved from api + <p> + If this flag is set to <TRUE/>, any view belonging to the document + should focus the first control in the document. With this, you may + control if your document works primarily as a form document. + </p> - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import + @optional + */ + [property, optional] boolean AutomaticControlFocus; - Revision 1.7 2000/09/15 15:11:10 mi - new interface XEventSupplier + //------------------------------------------------------------------------- + /** controls the initial (on-load) behavior of the form controls in the document - Revision 1.6 2000/09/11 11:52:18 mi - documentation merged from XML + <p> + If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br> + If set to <FALSE/>, they will be alive (i.e., connected to the data source specified for the form + they belong to).<br> + With this, you may control if your document works primarily as a form document. + </p> - Revision 1.2 2000/08/04 15:18:44 mi - #76800# document events + @optional + */ + [property, optional] boolean ApplyFormDesignMode; +}; - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/RedlineDisplayType.idl b/offapi/com/sun/star/document/RedlineDisplayType.idl index c16f7e971109..7332026bb0bc 100644 --- a/offapi/com/sun/star/document/RedlineDisplayType.idl +++ b/offapi/com/sun/star/document/RedlineDisplayType.idl @@ -2,9 +2,9 @@ * * $RCSfile: RedlineDisplayType.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2001-01-16 13:13:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,11 +63,10 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= - /** specifies which changes in a document are displayed. */ constants RedlineDisplayType @@ -75,17 +74,21 @@ constants RedlineDisplayType /** no changes are displayed. */ const short NONE = 0; + /** only inserted parts are displayed and attributed. */ const short INSERTED = 1; + /** only inserted parts are displayed and attributed. */ const short INSERTED_AND_REMOVED = 2; + /** only removed parts are displayed and attributed. */ const short REMOVED = 3; }; - };};};}; + +};};};}; #endif diff --git a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl b/offapi/com/sun/star/document/StandaloneDocumentInfo.idl index 3260e4778e9c..0bfd298f01f9 100644 --- a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl +++ b/offapi/com/sun/star/document/StandaloneDocumentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: StandaloneDocumentInfo.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: as $ $Date: 2002-09-09 12:11:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/document/TypeDetection.idl b/offapi/com/sun/star/document/TypeDetection.idl index ab4f54dc3e37..c05decb83fc0 100644 --- a/offapi/com/sun/star/document/TypeDetection.idl +++ b/offapi/com/sun/star/document/TypeDetection.idl @@ -2,9 +2,9 @@ * * $RCSfile: TypeDetection.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,35 +74,81 @@ module com { module sun { module star { module document { //============================================================================= +/** capsulate a type detection service and supports access on taht configuration -/** type detection of a specified resource (document) + <p> + It's possible to make a "flat" detection wich may use internal configuration + data only - or a "deep" detection which use special <type>DetectService</type>s + to look into the document to specify it unambigous. Last mode can be supressed + to perform. + </p> */ service TypeDetection { //------------------------------------------------------------------------- /** detect resource + <p> - Use XTypeDetection interface to get information about type of given document. + Use this interface to get information about type of given document. + Return value will be always an internal name of a registered document type. + It can be used may on other services (e.g. <type>FilterFactory</type>) for + further things (especialy to get the default filter for it). </p> */ - interface com::sun::star::document::XTypeDetection; + interface XTypeDetection; //------------------------------------------------------------------------- - /** readonly access to complete type configuration list + /** provides access to complete type configuration <p> - These interface support a readonly access to our internal configuration of all accessible types. - The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any! - - Supported properties are: - name of property value type of property description - "UIName" [string] localized name of type to show at UI elements - "MediaType" [string] mime type - "ClipboardFormat" [string] name of clipboard format - "URLPattern" [sequence<string>] a list of URL patterns which identify this type - "Extensions" [sequence<string>] a list of file extensions which identify this type - "DocumentIconID" [integer] an ID which present the number of corresponding icon + This configuration is organized as a collection of flat data structures. + The representation of such data structures will pe represented by + the type sequence<com::sun::star::beans::PropertyValue>. + Follow properties will be supported: + <table border=1> + <tr> + <td><strong>property name</strong></td> + <td><strong>Value type</strong></td> + <td><strong>description</strong></td> + </tr> + <tr> + <td>UIName</td> + <td>[string]</td> + <td>localized name of type to show at UI elements</td> + </tr> + <tr> + <td>MediaType</td> + <td>[string]</td> + <td>MIME or content type</td> + </tr> + <tr> + <td>ClipboardFormat</td> + <td>[string]</td> + <td>name of supported clipboard format</td> + </tr> + <tr> + <td>URLPattern</td> + <td>[sequence< string >]</td> + <td>a list of URL patterns which identify this type</td> + </tr> + <tr> + <td>Extensions</td> + <td>[sequence< string >]</td> + <td>a list of file extensions which identify this type</td> + </tr> + <tr> + <td>DocumentIconID</td> + <td>[integer]</td> + <td>an ID which present the number of corresponding icon</td> + </tr> + </table> </p> + + <p> + Note:<br> + All elements of this container will be adressed by his internal type name. + This must be an unambigous name. + </p> */ interface com::sun::star::container::XNameAccess; }; diff --git a/offapi/com/sun/star/document/XActionLockable.idl b/offapi/com/sun/star/document/XActionLockable.idl index 148b9af7bbc5..d3e10c6481b4 100644 --- a/offapi/com/sun/star/document/XActionLockable.idl +++ b/offapi/com/sun/star/document/XActionLockable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActionLockable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,53 +68,35 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XActionLockable -/** enables the object to lock actions. +/** makes it possible to prevent object internal updates for a certain period + to be able to quickly change multiple parts of the objects, where the + updates would invalidate each other, anyway. */ interface XActionLockable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XActionLockable::isActionLocked - /** determines if at least one lock exists. + /** @returns + <TRUE/> if at least one lock exists. */ boolean isActionLocked(); //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XActionLockable::addActionLock /** increments the lock count of the object by one. */ void addActionLock(); //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XActionLockable::removeActionLock /** decrements the lock count of the object by one. */ void removeActionLock(); //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XActionLockable::setActionLocks /** sets the locking level. - - <p>This method is used for debugging purposes. The programming environment can restore the locking after a break of a debug session.</p> @@ -122,14 +104,8 @@ interface XActionLockable: com::sun::star::uno::XInterface void setActionLocks( [in] short nLock ); //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XActionLockable::resetActionLocks /** resets the locking level. - - <p>This method is used for debugging purposes. The debugging environment of a programming language can reset the locks to allow refreshing of the view if a breakpoint is reached or @@ -143,24 +119,4 @@ interface XActionLockable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.6 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.2 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XBinaryStreamResolver.idl b/offapi/com/sun/star/document/XBinaryStreamResolver.idl index 3ae9d589f8e2..cd4cffd7c162 100644 --- a/offapi/com/sun/star/document/XBinaryStreamResolver.idl +++ b/offapi/com/sun/star/document/XBinaryStreamResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBinaryStreamResolver.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: ka $ $Date: 2001-06-12 14:14:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,26 +73,40 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -/** this interface encapsulates functionality to get/resolve binary data streams. +/** + <p>This interface encapsulates functionality to get/resolve binary data streams. + It is used to transform binary data to an url or to transform an url to binary + data. The binary data is represented through input and output streams.</p> + + <p>In the case of transforming an url to binary data, the <code>getInputStream</code> + method is used. This returns a <type scope="com::sun::star::io">XInputStream</type> + from which the binary data, transformed from the given url, can be read.</p> + + <p>In the case of transforming binary data to an url, a + <type scope="com::sun::star::io">XOutputStream</type> is created first to write + the binary data to. After this, the <code>resolveOutputStream</code> method can + be used to transform the binary data, represented through the + <type scope="com::sun::star::io">XOutputStream</type> interface, to an url.</p> */ interface XBinaryStreamResolver: com::sun::star::uno::XInterface { - /** converts the given url from the source url namespace to an input stream, + /** converts the given URL from the source URL namespace to an input stream, from which binary data can be read */ com::sun::star::io::XInputStream getInputStream( [in] string aURL ); /** creates an output stream, to which binary data can be written. - After writing, an url can be retrieved by a call to resolveOutputStream + After writing, an URL can be retrieved by a call to + <method>XBinaryStreamResolver::resolveOutputStream</method>. */ com::sun::star::io::XOutputStream createOutputStream(); - /** converts the output stream, data has been written to, to an url in - source url namespace + /** converts the output stream, data has been written to, to an URL in + source URL namespace. */ string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream ); }; diff --git a/offapi/com/sun/star/document/XDocumentInfo.idl b/offapi/com/sun/star/document/XDocumentInfo.idl index 0927af46c2a5..7b04f5462802 100644 --- a/offapi/com/sun/star/document/XDocumentInfo.idl +++ b/offapi/com/sun/star/document/XDocumentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentInfo.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,119 +69,111 @@ #include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl> #endif - //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= - -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XDocumentInfo /** provides access to the user fields for the information regarding the - document. - - - - <p>Other fields are accessed as properties (interface XPropertySet and - interface XFastPropertySet). </p>@see DocumentInfo - @see XStandaloneDocumentInfo - @see com::sun::star::beans::XPropertySet - @see com::sun::star::beans::XFastPropertySet + document + + <p> + These fields are special one of the set of available document properties. + Other ones are accessed as properties (by using the interface + <type scope="com::sun::star::beans">XPropertySet</type>) of service + <type>DocumentInfo</type>. + </p> + + @see DocumentInfo + @see StandaloneDocumentInfo + @see com::sun::star::beans::XPropertySet */ interface XDocumentInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** provides information about count of available fields - // DocMerge: from idl + <p> + This count marks the top range of possible requests for get/set + any of these fields. Range = [0..count-1] + </p> - // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldCount - /** @returns - the number of user fields available in the document information. + @returns + current count */ short getUserFieldCount(); //------------------------------------------------------------------------- + /** returns the name of an user field - // DocMerge: from idl + @param Index + specifies the position of requested field + Range = [0..count-1] - // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldName - /** @returns - the name of the user field at the specified position. + @returns + the name of the requested field + + @throws com::sun::star::lang::ArrayIndexOutOfBoundsException + if <var>Index</var> don't fit range of [0..count-1] */ - string getUserFieldName( [in] short nIndex ) - raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); + string getUserFieldName( [in] short Index ) + raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); //------------------------------------------------------------------------- + /** returns the value of an user field + + @param Index + specifies the position of requested field + Range = [0..count-1] - // DocMerge: from idl + @returns + the value of the requested field - // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldValue - /** @returns - the value of the user field at the specified position. + @throws com::sun::star::lang::ArrayIndexOutOfBoundsException + if <var>Index</var> don't fit range of [0..count-1] */ - string getUserFieldValue( [in] short nIndex ) - raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); + string getUserFieldValue( [in] short Index ) + raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); //------------------------------------------------------------------------- + /** changes the name of one of the user fields + + @param Index + specifies the position of requested field + Range = [0..count-1] - // DocMerge: from xml + @param Name + the new name for this field to be set - // DocMerge from xml: method com::sun::star::document::XDocumentInfo::setUserFieldName - /** changes the name of one of the user fields. + @throws com::sun::star::lang::ArrayIndexOutOfBoundsException + if <var>Index</var> don't fit range of [0..count-1] */ - void setUserFieldName( [in] short nIndex, - [in] string aName ) + void setUserFieldName( + [in] short Index , + [in] string Name ) raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); //------------------------------------------------------------------------- + /** changes the value of one of the user fields + + @param Index + specifies the position of requested field + Range = [0..count-1] - // DocMerge: from xml + @param Value + the new value for this field to be set - // DocMerge from xml: method com::sun::star::document::XDocumentInfo::setUserFieldValue - /** changes the value of the <var>nIndex</var>th user field. + @throws com::sun::star::lang::ArrayIndexOutOfBoundsException + if <var>Index</var> don't fit range of [0..count-1] */ - void setUserFieldValue( [in] short nIndex, - [in] string aValue ) + void setUserFieldValue( + [in] short Index , + [in] string Value ) raises( com::sun::star::lang::ArrayIndexOutOfBoundsException ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:05 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.2 2000/10/09 14:24:55 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.8 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.4 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/02/07 11:24:27 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl b/offapi/com/sun/star/document/XDocumentInfoSupplier.idl index ac2a308810ea..c1e2066e52c5 100644 --- a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl +++ b/offapi/com/sun/star/document/XDocumentInfoSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentInfoSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,62 +69,38 @@ #include <com/sun/star/document/XDocumentInfo.idl> #endif - //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= - -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XDocumentInfoSupplier -/** Through this interface documents can provide a <type>DocumentInfo</type>. +/** through this interface documents can provide a <type>DocumentInfo</type> + + <p> + A <type>DocumentInfo</type> is available on already opened documents only + and must be provides by this supplier interface. + Instead of that you can use the service <type>StandaloneDocumentInfo</type> + to have access to such informations without opening the whole file. + It read/write parts of the document, which include the required informations, + only. + </p> + + @see DocumentInfo + @see StandaloneDocumentInfo */ interface XDocumentInfoSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** provides the document information object - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XDocumentInfoSupplier::getDocumentInfo - /** This method contains the document information object. - - - - <p>The object supports the DocumentInfo service. - - </p>@see DocumentInfo + @returns + an object of type <type>DocumentInfo</type> */ - com::sun::star::document::XDocumentInfo getDocumentInfo(); - + XDocumentInfo getDocumentInfo(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:05 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.6 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.2 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XDocumentInsertable.idl b/offapi/com/sun/star/document/XDocumentInsertable.idl index ead580769a04..cd6855b96e3e 100644 --- a/offapi/com/sun/star/document/XDocumentInsertable.idl +++ b/offapi/com/sun/star/document/XDocumentInsertable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentInsertable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,23 +80,16 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XDocumentInsertable /** makes it possible to import a document from a given URL into this document. */ interface XDocumentInsertable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XDocumentInsertable::insertDocumentFromURL /** inserts the document that is specified by the URL. */ void insertDocumentFromURL( [in] string aURL, @@ -110,24 +103,4 @@ interface XDocumentInsertable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:10 hjs - initial import - - Revision 1.6 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.2 2000/08/04 15:18:44 mi - #76800# document events - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl index a8bed374563a..aaf7bfb14af5 100644 --- a/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl +++ b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEmbeddedObjectResolver.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= diff --git a/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl index 01606f452226..3e02c13a0be1 100644 --- a/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl +++ b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEmbeddedObjectSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,22 +72,15 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XEmbeddedObjectSupplier /** represents something that provides an embedded object. */ interface XEmbeddedObjectSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XEmbeddedObjectSupplier::getEmbeddedObject /** returns the object which is embedded into this object. */ com::sun::star::lang::XComponent getEmbeddedObject(); @@ -98,27 +91,4 @@ interface XEmbeddedObjectSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:11 hjs - initial import - - Revision 1.7 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.3 2000/08/04 15:18:45 mi - #76800# document events - - Revision 1.2 1999/11/18 11:49:55 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XEventBroadcaster.idl b/offapi/com/sun/star/document/XEventBroadcaster.idl index 7fd31b4ca74c..a009067a3c41 100644 --- a/offapi/com/sun/star/document/XEventBroadcaster.idl +++ b/offapi/com/sun/star/document/XEventBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventBroadcaster.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-06-25 15:51:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:03:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,50 +65,39 @@ #include <com/sun/star/uno/XInterface.idl> #endif -#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__ -#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl> +#ifndef __com_sun_star_document_XEventListener_idl__ +#include <com/sun/star/document/XEventListener.idl> #endif - //============================================================================= - module com { module sun { module star { module document { - -interface XEventListener; +module com { module sun { module star { module document { //============================================================================= - /** makes it possible to register listeners which are called whenever - a document event (see <type>EventObject</type>) occurs. + a document event (see <type>EventObject</type>) occurs */ interface XEventBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** registers the given listener - /** registers the given <type>XEventListener</type>. + @param Listener + listener which is interested on such events */ - [oneway] void addEventListener( [in] XEventListener xListener ); + [oneway] void addEventListener( [in] XEventListener Listener ); //------------------------------------------------------------------------- + /** unregisters the given listener - /** unregisters the given <type>XEventListener</type>. + @param Listener + listener which isn't interested on such events any longer */ - [oneway] void removeEventListener( [in] XEventListener xListener ); + [oneway] void removeEventListener( [in] XEventListener Listener ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/03/16 16:41:20 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.1 2001/01/24 13:30:25 mi - stored document events and runtime document events structurally unified - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XEventListener.idl b/offapi/com/sun/star/document/XEventListener.idl index 4c61c6a9f7fd..f82fe08140cf 100644 --- a/offapi/com/sun/star/document/XEventListener.idl +++ b/offapi/com/sun/star/document/XEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,12 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_document_XDocumentEventListener_idl__ -#define __com_sun_star_document_XDocumentEventListener_idl_ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif +#ifndef __com_sun_star_document_XEventListener_idl__ +#define __com_sun_star_document_XEventListener_idl__ #ifndef __com_sun_star_lang_XEventListener_idl__ #include <com/sun/star/lang/XEventListener.idl> @@ -78,39 +74,26 @@ module com { module sun { module star { module document { //============================================================================= - /** makes it possible to register listeners, which are called whenever - a document or document content event occurs. + a document or document content event occurs + + <p> + Such events will be broadcasted by a <type>XEventBroadcaster</type>. + </p> */ interface XEventListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- + /** is called whenever a document event (see <type>EventObject</type>) occurs - /** is called whenever a document event (see <type>EventObject</type>) occurs. + @param Event + specifies the event type */ - [oneway] void notifyEvent( [in] EventObject aEvent ); + [oneway] void notifyEvent( [in] EventObject Event ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/06/25 15:51:19 mi - #1008# wrong references to Event - - Revision 1.3 2001/03/16 16:41:20 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.2 2001/01/26 15:50:42 mi - new XDocumentListener now correctly derived from lang::XEventListener - - Revision 1.1 2001/01/24 13:30:25 mi - stored document events and runtime document events structurally unified - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XEventsSupplier.idl b/offapi/com/sun/star/document/XEventsSupplier.idl index da5a3d73eae5..272c08b95aed 100644 --- a/offapi/com/sun/star/document/XEventsSupplier.idl +++ b/offapi/com/sun/star/document/XEventsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,48 +70,22 @@ module com { module sun { module star { module document { //============================================================================= -/** gives access to a list of URLs bound to events of this object. -*/ +/** gives access to a list of URLs bound to events of this object + */ interface XEventsSupplier: com::sun::star::uno::XInterface { -//------------------------------------------------------------------------- -/** offers a list of event handlers which are be bound to events of - this object. - - @returns - an <type>Events</type> object. - */ -com::sun::star::container::XNameReplace getEvents(); + //------------------------------------------------------------------------- + /** offers a list of event handlers which are be bound to events of + this object + + @returns + an <type>Events</type> description object + */ + com::sun::star::container::XNameReplace getEvents(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2001/02/15 14:14:12 mi - workaround for wrong typedef - - Revision 1.2 2001/01/24 16:26:20 mi - compiles now - - Revision 1.1 2001/01/24 13:21:26 mi - stored document events and runtime document events structurally unified - - Revision 1.4 2001/01/23 10:08:08 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:11 hjs - initial import - - Revision 1.1 2000/09/15 15:00:12 mi - new interface XEventSupplier - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XExporter.idl b/offapi/com/sun/star/document/XExporter.idl index f00478000ccc..46d7d76f88eb 100644 --- a/offapi/com/sun/star/document/XExporter.idl +++ b/offapi/com/sun/star/document/XExporter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExporter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-16 21:52:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,22 +74,33 @@ module com { module sun { module star { module document { //============================================================================= -/** makes it possible to connect a document with an <type>Exporter</type>. +/** makes it possible to connect a document with an <type>ExportFilter</type> + + <p> + An <type>ExportFilter</type> must know the source of his filter operation. + To set this on a filter is part of this interface. + Same mechanism exist for import too. + </p> + + @see ExportFilter + @see ImportFilter + @see XImporter */ interface XExporter: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** sets the source document for the exporter. + /** sets the source document for the exporter - @throws com::sun::star::lang::IllegalArgumentException - if <var>xDoc</var> does not support any service which is - supported by this exporter. - - <!-- Dennis: Is there some missing markup around com::sun::star::lang::IllegalArgumentException --> + @param Document + the source document + @throws com::sun::star::lang::IllegalArgumentException + if <var>Document</var> does not support any service which is + supported by this exporter */ - void setSourceDocument( [in] com::sun::star::lang::XComponent xDoc ) - raises( com::sun::star::lang::IllegalArgumentException ); + void setSourceDocument( + [in] com::sun::star::lang::XComponent Document ) + raises( com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= diff --git a/offapi/com/sun/star/document/XExtendedFilterDetection.idl b/offapi/com/sun/star/document/XExtendedFilterDetection.idl index 1b2de10c5f93..9efae0ed20bb 100644 --- a/offapi/com/sun/star/document/XExtendedFilterDetection.idl +++ b/offapi/com/sun/star/document/XExtendedFilterDetection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExtendedFilterDetection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,34 +71,46 @@ //============================================================================ - module com { - module sun { - module star { - module document { +module com { module sun { module star { module document { //============================================================================ +/** provides a "deep" filter detection -/** extended filter detection. - */ + <p> + A "deep" filter detection means looking into the document stream to detect + the format of it. Services of type <type>DetectService</type> must support this + interface to be called from generic load mechanism of the office for that. + </p> + @see DetectService + @see TypeDetection + @see FilterFactory + */ interface XExtendedFilterDetection: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** controls agreement of a type detection with given URL or arguments. + /** controls agreement of a "flat" <type>TypeDetection</type> + with given URL or arguments <p> - Register services which support this interface for diferent mime types in configuration. - A service which implements this interfare will be created to make a deep content detection. - Add the collected information about detected documents in given <type>MediaDescriptor</type>. - You need an internal type name as a return value. + Registerd services in configuration, which support this interface for different mime types, + will be called automaticly to look into the document stream and cdecide wich format it represent. + Add the collected information about detected documents in given <type>MediaDescriptor</type> + <var>Descriptor</var>. The decision must be returned as any valid type name (which specifies + the detected format) or an empty value for unknown formats. </p> + + @param Descriptor + represent a <type>MediaDescriptor</type> which can be used to get/set informations + about the detected document + + @returns + an internal type name if format was detected successfully + <br> + or an empty value for an unknown document format. */ - string detect( [inout] sequence< com::sun::star::beans::PropertyValue > seqDescriptor ); + string detect( [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor ); - }; // XExtendedFilterDetection - }; // document - }; // star - }; // sun -}; // com +}; }; }; }; }; #endif diff --git a/offapi/com/sun/star/document/XFilter.idl b/offapi/com/sun/star/document/XFilter.idl index e459ef04f981..345561e6af89 100644 --- a/offapi/com/sun/star/document/XFilter.idl +++ b/offapi/com/sun/star/document/XFilter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,24 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= - -/** interface to filter documents. +/** interface to filter documents + + <p> + This interface will be used by service <type>ImportFilter</type> or + <type>ExportFilter</type> to supports loading/saving of documents with + different formats. The target/source of such filter operations must + well known BEFORE filtering will be started. + (see <type>XImporter</type> and <type>XExporter</type> too) + Otherwise this interface can't work right. + <p> + + @see ImportFilter + @see ExportFilter + @see XImporter + @see XExporter */ interface XFilter: com::sun::star::uno::XInterface { @@ -86,13 +99,9 @@ interface XFilter: com::sun::star::uno::XInterface The given <type>MediaDescriptor</type> holds all neccessary information about the document. - @attention Don't hold hard references to these descriptors. You must copy needed informations! - Otherwise we couldn't destroy (for example) an existing input stream! + Don't hold hard references to these descriptors. You must copy needed informations! + Otherwise we couldn't destroy (for example) an existing input stream! </p> - - <!-- Dennis: The HTML output of @attention does not appear correct --> - - */ boolean filter( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor ); diff --git a/offapi/com/sun/star/document/XGraphicObjectResolver.idl b/offapi/com/sun/star/document/XGraphicObjectResolver.idl index 00acd1aa030f..4f001edcd1cd 100644 --- a/offapi/com/sun/star/document/XGraphicObjectResolver.idl +++ b/offapi/com/sun/star/document/XGraphicObjectResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGraphicObjectResolver.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= diff --git a/offapi/com/sun/star/document/XImporter.idl b/offapi/com/sun/star/document/XImporter.idl index 2405ee295e76..c85966007a50 100644 --- a/offapi/com/sun/star/document/XImporter.idl +++ b/offapi/com/sun/star/document/XImporter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImporter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,19 +74,33 @@ module com { module sun { module star { module document { //============================================================================= -/** makes it possible to connect a document with an <type>Importer</type>. +/** makes it possible to connect a document with an <type>ImportFilter</type> + + <p> + An <type>ImportFilter</type> must know the target of his filter operation. + To set this on a filter is part of this interface. + Same mechanism exist for export too. + </p> + + @see ExportFilter + @see ImportFilter + @see XExporter */ interface XImporter: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** sets the target document for the importer. + /** sets the target document for the importer + + @param Document + the target document @throws com::sun::star::lang::IllegalArgumentException - if <var>xDoc</var> does not support any service which is - supported by this importer. + if <var>Document</var> does not support any service which is + supported by this importer */ - void setTargetDocument( [in] com::sun::star::lang::XComponent xDoc ) - raises( com::sun::star::lang::IllegalArgumentException ); + void setTargetDocument( + [in] com::sun::star::lang::XComponent Document ) + raises( com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= diff --git a/offapi/com/sun/star/document/XInteractionFilterSelect.idl b/offapi/com/sun/star/document/XInteractionFilterSelect.idl index 168e92ad17fe..2c7769a1ad7b 100644 --- a/offapi/com/sun/star/document/XInteractionFilterSelect.idl +++ b/offapi/com/sun/star/document/XInteractionFilterSelect.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionFilterSelect.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2001-11-08 11:55:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,10 +70,41 @@ module com { module sun { module star { module document { //============================================================================= -interface XInteractionFilterSelect : ::com::sun::star::task::XInteractionContinuation +/** continuation used by interaction mechanism at filter detection during + loading documents + + <p> + If during loading time the filter can't be detected and wasn't given at calling time, + a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. + (it's a a part of used <type>MediaDescriptor</type>) + A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to + get a decision wich filter should be used for given URL. A possible continiuation + of that can be this XInteractionFilterSelect. It will transport the decision back to + generic filter detection and force using of it. Of course it's possible to abort + the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>. + </p> + + @see MediaDescriptor + @see com::sun::star::task::InteractionHandler + @see NoSuchFilterRequest + @see com::sun::star::task::XInteractionAbort + */ +interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation { - void setFilter( [in] string sName ); - string getFilter( ); + //------------------------------------------------------------------------- + /** used by interaction to set selected filter + + <p> + This value must be save till another one will be set + and must be provided on getFilter() for interest users. + </p> + */ + void setFilter( [in] string Name ); + + //------------------------------------------------------------------------- + /** used by detection to get selected filter + */ + string getFilter(); }; //============================================================================= diff --git a/offapi/com/sun/star/document/XLinkTargetSupplier.idl b/offapi/com/sun/star/document/XLinkTargetSupplier.idl index 2dce2bd25c8a..5b56407d4cda 100644 --- a/offapi/com/sun/star/document/XLinkTargetSupplier.idl +++ b/offapi/com/sun/star/document/XLinkTargetSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinkTargetSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,30 +72,21 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XLinkTargetSupplier /** interface is supplied by objects inside a document object model that have children that can be the target of a link inside a document. - - <p>These targets implement the service <type>LinkTarget</type> - </p> + <p>These targets implement the service <type>LinkTarget</type>. </p> */ interface XLinkTargetSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: from idl - - // DocMerge from idl: method com::sun::star::document::XLinkTargetSupplier::getLinks - /** @returns the names of possible links to children of this object inside - a document object model. It implements the service - <type>LinkTargets</type>. + /** @returns + the names of possible links to children of this object inside a + document object model. It implements the service <type>LinkTargets</type>. */ com::sun::star::container::XNameAccess getLinks(); @@ -105,27 +96,4 @@ interface XLinkTargetSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:20 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:11 hjs - initial import - - Revision 1.6 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.2 2000/08/04 15:18:45 mi - #76800# document events - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XMimeTypeInfo.idl b/offapi/com/sun/star/document/XMimeTypeInfo.idl index 47a9951b11de..70ce0537080c 100644 --- a/offapi/com/sun/star/document/XMimeTypeInfo.idl +++ b/offapi/com/sun/star/document/XMimeTypeInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMimeTypeInfo.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,20 +72,20 @@ module com { module sun { module star { module document { //============================================================================= -/** provides information regarding which Mime types are supported by a filter +/** provides information regarding which MIME types are supported by a filter. */ interface XMimeTypeInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** asks whether a Mime type is supported or not. + /** asks whether a MIME type is supported or not. */ boolean supportsMimeType( [in] string MimeTypeName ); //------------------------------------------------------------------------- /** @returns - a sequence of the names of all supported Mime types. + a sequence of the names of all supported MIME types. */ sequence<string> getSupportedMimeTypeNames(); }; diff --git a/offapi/com/sun/star/document/XRedlinesSupplier.idl b/offapi/com/sun/star/document/XRedlinesSupplier.idl index 7d3fe4c9b0ad..ba187615b40c 100644 --- a/offapi/com/sun/star/document/XRedlinesSupplier.idl +++ b/offapi/com/sun/star/document/XRedlinesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRedlinesSupplier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= @@ -76,7 +76,8 @@ interface XRedlinesSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** returns an enumeration access that provides access to the redline objects of the document. + /** @returns + an enumeration access that provides access to the redline objects of the document. */ com::sun::star::container::XEnumerationAccess getRedlines(); }; diff --git a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl b/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl index f79f0ed1a131..cb72303a9858 100644 --- a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl +++ b/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStandaloneDocumentInfo.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,98 +69,69 @@ #include <com/sun/star/io/IOException.idl> #endif - //============================================================================= - module com { module sun { module star { module document { +module com { module sun { module star { module document { //============================================================================= - -// DocMerge: from xml - -// DocMerge from xml: interface com::sun::star::document::XStandaloneDocumentInfo /** makes it possible to load document information from a resource specified by a URL and to store it into a resource also - specified by a URL. - - - - <p>Only the document information part of the resource is transferred. </p>@see DocumentInfo - @see XDocumentInfo - @see com::sun::star::beans::XPropertySet - @see com::sun::star::beans::XFastPropertySet + specified by a URL + + <p> + Only the document information part of the resource is transferred. + Instead of <type>DocumentInfo</type> not the whole document will be opened. + Note: Without specifying the source or target of this info (the document) + nothing can work and will be handled as void (for reading) or ignored (for writing). + After specigiying the source/target by using this interface, + the interface <type>XDocumentInfo</type> (which must be implemented on same + object then this one!) provides access to the info properties. + </p> + + @see DocumentInfo + @see StandaloneDocumentInfo + @see XDocumentInfo */ -interface XStandaloneDocumentInfo: com::sun::star::document::XDocumentInfo +interface XStandaloneDocumentInfo: XDocumentInfo { //------------------------------------------------------------------------- + /** loads the document information from a file referred by an URL - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XStandaloneDocumentInfo::loadFromURL - /** This method loads the document information from a file referred by a URL. - - - - <p>After an unsuccessful call the contents of the document - information are undefined. - + <p> + After an unsuccessful call the contents of the document + information are undefined (void). + This method only works for storage file formats. </p> - <p>This method only works for storage file formats. - </p> + @param URL + specifies the source of information + + @throws com::sun::star::io::IOException + if storage couldn't be found or opened */ - void loadFromURL( [in] string aURL ) - raises( com::sun::star::io::IOException ); + void loadFromURL( [in] string URL ) + raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- + /** stores the document information into a file referred by a URL - // DocMerge: from xml - - // DocMerge from xml: method com::sun::star::document::XStandaloneDocumentInfo::storeIntoURL - /** This method stores the document information into a file referred by a URL. - - - - <p>Only the document information part of the document is overwritten. - + <p> + Only the document information part of the document is overwritten. + This method only works for storage file formats. </p> - <p>This method only works for storage file formats. - </p> - */ - void storeIntoURL( [in] string aURL ) - raises( com::sun::star::io::IOException ); + @param URL + specifies the target for saving + @throws com::sun::star::io::IOException + if storage couldn't be found or opened + */ + void storeIntoURL( [in] string URL ) + raises( com::sun::star::io::IOException ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:05 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:42:40 mi - moved from api - - Revision 1.2 2000/10/09 14:24:55 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:11 hjs - initial import - - Revision 1.6 2000/09/11 11:52:19 mi - documentation merged from XML - - Revision 1.2 2000/08/04 15:18:45 mi - #76800# document events - - Revision 1.1.1.1 1999/11/11 09:48:42 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl index 473fc169067e..610194cc76e7 100644 --- a/offapi/com/sun/star/document/XTypeDetection.idl +++ b/offapi/com/sun/star/document/XTypeDetection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTypeDetection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,33 +74,81 @@ module com { module sun { module star { module document { //============================================================================ +/** support "flat" and "deep" type detection of a given document -/** support "flat" and "deep" type detection of a given document. + <p> + A "flat" detection means specifying the document format by using + the URL and some configuration data only. That will perform but produce + may invalid results if e.g., the extension of the document is wrong. + A "deep" detection means looking into the document stream to be right + which format it supports. Of course that includes a "flat" detection before. + The combination of both ones should produce stable results everytime. + </p> + + @see TypeDetection */ interface XTypeDetection: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** return internal type name which is suitable to given URL + /** make a "flat" detection by using the URL of the document <p> - We make a "flat" type detection only. + It use given URL in combination with the internal configuration of well known + types only to specify the format of given document. </p> + + @param URL + specify the document by name + + @returns + an internal type name which represent the detected format + <br> + or an empty value for unknown ones */ - string queryTypeByURL( [in] string sURL ); + string queryTypeByURL( [in] string URL ); //------------------------------------------------------------------------- - /** return internal type name which is suitable to given document properties - by a <type>MediaDescriptor</type> + /** make a "deep" detection or optional a "flat" detection by using a + <type>MediaDescriptor</type> <p> - These do the same as "queryTypeByURL()" before. - As an additional feature, you can specify more document properties - and select the detection mode. Available modes are "flat" (bDeep=FALSE) - and "deep" (bDeep=TRUE) detection. + Instead of <member>XTypeDetection::queryTypeByURL()</member> this function + use a <type>MediaDescriptor</type> to specify the document for detection. + Such descriptor hold different informations about the document. + He will be passed to any part of made detection process and every part + can change it to actualize it. + The property <member>MediaDescriptor::URL</member> should be set on + this descriptor as minimum. It specifies the location of the document. + If this parameter is missing another one is required: <member>MediaDescriptor::InputStream</member>. + This can be usefull to prevent operaton against multiple opening of the stream + and perform the operation. If this stream isn't already included the detection + will open it (if allowed!) and add it to the descriptor so it will be available for + all following parts. + A combination of both parameters can be usefull to perform the operation + and make results more stable; but only one of them is required. + Of course its possible to specify more document properties (e.g. + <member>MediaDescriptor::ReadOnly</member>). + <br> + As an additional feature it's possible to suppress "deep" detection by using argument + <var>AllowDeep</var>. </p> + + @param Descriptor + means the <type>MediaDescriptor</type> which specify the ressource for detection + + @param AllowDeep + if it is set to <TRUE/> a "deep" detection will be follow a "flat" detection + <br> + if it is set to <FALSE/> a "flat" detection will be made only + + @returns + an internal type name which represent the detected format + <br> + or an empty value for unknown ones */ - string queryTypeByDescriptor( [inout] sequence< com::sun::star::beans::PropertyValue > aDescriptor , - [in] boolean bDeep ); + string queryTypeByDescriptor( + [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor, + [in] boolean AllowDeep ); }; //============================================================================ diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl index 1a0fb3dc9ab6..6c7329e1fa8d 100644 --- a/offapi/com/sun/star/document/XViewDataSupplier.idl +++ b/offapi/com/sun/star/document/XViewDataSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewDataSupplier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mba $ $Date: 2001-03-22 16:13:58 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,26 +70,37 @@ module com { module sun { module star { module document { //============================================================================= -/** Gives access to some properties describing all open views to a document. - Each view is described by a sequence < ::com::sun::star::beans::PropertyValue >. +/** gives access to some properties describing all open views to a document + + <p> + Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >. Through this interface the state of all open views can be retrieved and restored later. These states can also be made persistent so that a document loader can create all views of the correct types and restore their state to the state when the document was saved. -*/ - + </p> + */ interface XViewDataSupplier: com::sun::star::uno::XInterface { - /** @returns - a < ::com::sun::star::container::XIndexAccess >, that gives - access to a sequence < ::com::sun::star::beans::PropertyValue > - for every open view + //------------------------------------------------------------------------- + /** retrieve informations about currently opened view to restore it later + + @returns + a <type scope="com::sun::star::container">XIndexAccess</type>, + that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type> + for every open view. May <NULL/> if no view is currently available. */ - ::com::sun::star::container::XIndexAccess getViewData(); + ::com::sun::star::container::XIndexAccess getViewData(); + + //------------------------------------------------------------------------- + /** restore all views which will be represented by given data argument - /** + @param Data + a list of <type scope="com::sun::star::beans">PropertyValue</type>s + with information about last opened views to restore it + <NULL/> isn't allowed here. */ - void setViewData( [in] ::com::sun::star::container::XIndexAccess aData ); + void setViewData( [in] com::sun::star::container::XIndexAccess Data ); }; //============================================================================= diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index 7ccdbd8535e5..05d8e60fef78 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataAwareControlModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,72 +88,123 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::DataAwareControlModel /** is an abstract service for specialized <type>FormControlModel</type>s which are data aware and thus can be bound to a data source. + + <p>The connection between a data-aware control model and a form which's data the + control should display is made by parentship relations. The parent of a data-aware + control model (see <type scope="com::sun::star::container">XChild</type>, inherited + via the <type>FormControlModel</type> and <type>FormComponent</type> services) has + always to be a <type scope="com::sun::star::form::component">DataForm</type>.</p> */ service DataAwareControlModel { - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - - // DocMerge from xml: service com::sun::star::form::DataAwareControlModel: interface com::sun::star::form::XBoundComponent - /** makes it possible to transfer - The data of the model to the connected data field.<BR> - This interface is optional, if a component doesn't support it, - it has to forward the changes of it's value to the field - it is connected to immediately. + /** makes it possible to transfer the data of the model to the connected data field. + <p> + This interface is optional, if a component doesn't support it, it has to forward + the changes of it's value to the field it is connected to immediately (means whenever a user + interaction changes it's content). + </p> */ [optional] interface com::sun::star::form::XBoundComponent; - // DocMerge from xml: service com::sun::star::form::DataAwareControlModel: interface com::sun::star::form::XLoadListener - /** must be implemented in order to recognize when the - containing form of the model connects to its data source - (loads its data). After loading the form, the model may - bind to its related field source. + /** must be implemented in order to recognize when the containing form of the model connects + to its data source (loads its data). After loading the form, the model may bind to its + related field source.<br/> + This interface will seldom be used directly from outside. */ interface com::sun::star::form::XLoadListener; - // DocMerge from xml: service com::sun::star::form::DataAwareControlModel: interface com::sun::star::form::XReset - /** Each <type>DataAwareControlModel</type> should be resettable for - setting default values. In general the <type>XReset</type> - interface is used before a user starts editing a new record to - set the desired default values for the model. - */ + /** Each <type>DataAwareControlModel</type> should be resettable for setting default values. + + <p>In the context of a control model which is data-aware, the semantics of <em>default value</em> + (see <type>XReset</type>) is as follows:<br/> + If (and only if) the control is valid bound to a column of it's <type>DataForm</type>, and the form + is not positioned on a new record (see <member scope="com::sun::star::sdb">RowSet::IsNew</member>), then + <member>XReset::reset</member> does not reset the model's value to it's default value, but uses the + underlying column value.<br/> + In all other cases, the model is reset to the default value as specified by the respective property.</p> + + <p>For an example, have a look at the <type scope="com::sun::star::form::component">TextField</type>. It inherites + the <member scope="com::sun::star::awt">UnoControlEditModel::Text</member> property from the underlying + service, and additionally specifies the <member scope="com::sun::star::form::component">TextField::DefaultText</member>. + </p> + + <p>In the context of a <type scope="com::sun::star::form::component">DataForm</type>, controls are + automatically reset when one of the following applies + <ul><li>The form is reset by invoking it's <type>XReset</type> interface.</li> + <li>The form moves to a new record.</li> + <li>The changes in the current record of the form are undone</li> + </ul> + </p> + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::DataAwareControlModel::DataField /** specifies the name of the bound database field. + + <p>This property makes sense in the <em>context</em> of the control model only. Normally, a control model + is a child of a <type scope="com::sun::star::form::component">DataForm</type>, which is bound + to a higher level object such as a table or query - more general, a result set.<br/> + This member here describes the column of this result set which the control should act for.</p> + + <p>Not every control model can be bound to every database column. Usually, super services of the + <type>DataAwareControlModel</type> restrict the column types they can be used with.</p> + + @see DataAwareControlModel::BoundField */ [property] string DataField; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::DataAwareControlModel::BoundField - /** references to the cursor field to which the control is bound. Applies only if the form the control model - belongs to (the models parent) is loaded and the control is valid bound. + /** references to the cursor field to which the control is bound. + <p>Applies only if the form the control model belongs to is loaded and the control is valid bound. The referenced field supports the <type scope="com::sun::star::sdb">Column</type> service. + </p> + @see DataAwareControlModel::DataField */ [readonly, property] com::sun::star::beans::XPropertySet BoundField; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::DataAwareControlModel::LabelControl - /** references to a control model within the same document which should be used as a label. Any - user interface action which needs to refer to the control is assumed to use this property.<br> - When setting this property a number of constraints apply: the object which is to be set has to support - the <type scope="com::sun::star::awt">XControlModel</type>, - <type scope="com::sun::star::lang">XServiceInfo</type>, - <type scope="com::sun::star::beans">XPropertySet</type> and - <type scope="com::sun::star::container">XChild</type> - interfaces. It has to be a part of the same document as the model who's property is to be modified. Additionally - the support of a special service, indicating that the model is of the right type, is required. Which kind of - service is in the request depends on the type of the control model. + /** references to a control model within the same document which should be used as a label. + <p>Any user interface action which needs to refer to the control is assumed to use this + property. <br/> + A very common design method for forms is to group a data aware control with a label control, + with the latter describing the content of the former. For instance, you may have a + <type scope="com::sun::star::form::component">TextField</type>, which is bound to the e-mail + column of your data source. Then you will probably add a + <type scope="com::sun::star::form::component">FixedText</type> which's label is "E-Mail", + and associate it with the TextField by setting it as <member>LabelControl</member>.<br/> + Now if you imagine a component offering data search in a form, this component will examine + the <member>LabelControl</member> property, find the <type scope="com::sun::star::form::component">FixedText</type>, + examine it's label, and use this label to refer to the <type scope="com::sun::star::form::component">TextField</type>. + </p> + <p>When setting the property, a number of constraints apply: + <ul> + <li>The object which is to be set has to support the following interfaces + <ul><li><type scope="com::sun::star::awt">XControlModel</type></li> + <li><type scope="com::sun::star::lang">XServiceInfo</type></li> + <li><type scope="com::sun::star::beans">XPropertySet</type></li> + <li><type scope="com::sun::star::container">XChild</type></li> + </ul> + </il> + <li>It has to be a part of the same document as the model who's property is to be modified.</il> + <li>Additionally, the support of a special service, indicating that the model is of the right type, + is required. Which kind of service is in the request depends on the type of the control model.<br/> + + For instance, text fields (<type scope="com::sun::star::form::component">TextField</type>) can be + labelled by label controls only (<type scope="com::sun::star::form::component">FixedText</type>), + and radio buttons (<type scope="com::sun::star::form::component">RadioButton</type>) can be labelled + by group boxes (<type scope="com::sun::star::form::component">GroupBox</type>) only. + </li> + </ul> + </p> */ [property] com::sun::star::beans::XPropertySet LabelControl; @@ -166,6 +217,21 @@ service DataAwareControlModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.4 2002/07/26 09:59:51 fs + IDL review form layer + + Revision 1.4.20.3 2002/07/12 09:54:38 fs + reviewed + + Revision 1.4.20.2 2002/02/19 08:17:48 oj + #96946# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 14:52:18 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/01/23 10:08:21 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/DataSelectionType.idl b/offapi/com/sun/star/form/DataSelectionType.idl index 30450fe5545d..a5dbfb3a5253 100644 --- a/offapi/com/sun/star/form/DataSelectionType.idl +++ b/offapi/com/sun/star/form/DataSelectionType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataSelectionType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,46 +69,15 @@ //============================================================================= // DocMerge from xml: enum com::sun::star::form::DataSelectionType -/** DataSelectionType" describes the type of datasource used for a form. - - - <p>This may be a database table, a database query, or an SQL statement. - </p> - - - - - - - - - +/** describes the type of datasource used for a form. + <p>Please do <em><b>not</b></em> use anymore, this enum is deprecated. @deprecated */ enum DataSelectionType { - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR DataSelectionType:: TABLE, - - // DocMerge: empty anyway TABLE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR DataSelectionType:: QUERY, - - // DocMerge: empty anyway QUERY, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR DataSelectionType:: SQL, - - // DocMerge: empty anyway SQL, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR DataSelectionType:: SQLPASSTHROUGH - - // DocMerge: empty anyway SQLPASSTHROUGH }; @@ -120,6 +89,12 @@ enum DataSelectionType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:51 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/DatabaseDeleteEvent.idl b/offapi/com/sun/star/form/DatabaseDeleteEvent.idl index b178f22c792e..a313127b2a0c 100644 --- a/offapi/com/sun/star/form/DatabaseDeleteEvent.idl +++ b/offapi/com/sun/star/form/DatabaseDeleteEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseDeleteEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,28 +72,12 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::form::DatabaseDeleteEvent /** is fired if a database record is going to be deleted. - - - - - - - - - - - - + <p>Please do <em><b>not</b></em> use anymore, this struct is deprecated. @deprecated */ struct DatabaseDeleteEvent: com::sun::star::lang::EventObject { - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR DatabaseDeleteEvent::Bookmarks - - // DocMerge: empty anyway sequence<any> Bookmarks; }; @@ -105,6 +89,12 @@ struct DatabaseDeleteEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:52 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/DatabaseParameterEvent.idl b/offapi/com/sun/star/form/DatabaseParameterEvent.idl index ed75c92019b4..9c5cc408b092 100644 --- a/offapi/com/sun/star/form/DatabaseParameterEvent.idl +++ b/offapi/com/sun/star/form/DatabaseParameterEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseParameterEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,20 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::form::DatabaseParameterEvent /** is fired if values for parameters are needed. */ struct DatabaseParameterEvent: com::sun::star::lang::EventObject { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DatabaseParameterEvent::Parameters + /** specifies the list of parameters which are required for opening a result set. - // DocMerge from xml: field com::sun::star::form::DatabaseParameterEvent::Parameters - /** specifies the list of parameters. Each parameter contains a complete - description of the value and the value itself.@see com::sun::star::sdb::Column + <p>Usually, a <type scope="com::sun::star::form::component">DataForm</type> fires this + event when loading the form requires parameters to be filled in.</p> + + <p>Every parameter object supports the <type scope="com::sun::star::beans">XPropertySet</type> + interface, and at least the properties <em>Name</em> and <em>Value</em></p> + + @see com::sun::star::sdb::RowSet + @see com::sun::star::form::component::DataForm */ com::sun::star::container::XIndexAccess Parameters; }; @@ -98,6 +101,12 @@ struct DatabaseParameterEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:53 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/ErrorEvent.idl b/offapi/com/sun/star/form/ErrorEvent.idl index 14f9c78223a1..2ec5e69bc5d6 100644 --- a/offapi/com/sun/star/form/ErrorEvent.idl +++ b/offapi/com/sun/star/form/ErrorEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ErrorEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,30 +74,12 @@ // DocMerge from xml: struct com::sun::star::form::ErrorEvent /** occurs in case of fired database exceptions triggered by - a DatabaseForm. - - - - <p> It contains the fired exception. - - </p> - - - - - - - - - + a <type scope="com::sun::star::form::component">DatabaseForm</type> + <p>Please do <em><b>not</b></em> use anymore, this struct is deprecated. @deprecated */ struct ErrorEvent: com::sun::star::lang::EventObject { - //------------------------------------------------------------------------- - // DOCUMENTATION OMMITTED FOR ErrorEvent::Reason - - // DocMerge: empty anyway any Reason; }; @@ -109,6 +91,12 @@ struct ErrorEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:53 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/FormButtonType.idl b/offapi/com/sun/star/form/FormButtonType.idl index 52949c3dc2c2..c820018be3c5 100644 --- a/offapi/com/sun/star/form/FormButtonType.idl +++ b/offapi/com/sun/star/form/FormButtonType.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormButtonType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,36 +68,34 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::FormButtonType -/** specify the default actions of a button. +/** specifies the action to execute when a button is pressed. + @see com::sun::star::form::component::CommandButton */ enum FormButtonType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormButtonType::PUSH - /** acts like a common push button. + /** requires the button to act like a common push button, means no special action is triggered. */ PUSH, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormButtonType::SUBMIT - /** performs a submit on its containing form if the button is clicked. + /** When the button is clicked, it performs a submit on its containing form. */ SUBMIT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormButtonType::RESET - /** performs a reset on its containing form if the button is clicked. + /** When the button is clicked, it performs a reset on its containing form. */ RESET, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormButtonType::URL - /** opens an URL set for the button if the button is clicked. + /** When the button is clicked, an URL set for the button is opened. + @see com::sun::star::form::component::CommandButton::TargetURL + @see com::sun::star::form::component::CommandButton::TargetFrame */ URL @@ -110,6 +108,12 @@ enum FormButtonType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:54 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/FormComponent.idl b/offapi/com/sun/star/form/FormComponent.idl index 1e5ddbcb6e53..5cc02fbffd63 100644 --- a/offapi/com/sun/star/form/FormComponent.idl +++ b/offapi/com/sun/star/form/FormComponent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormComponent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,46 +88,42 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::FormComponent -/** specifies a component which can be part - of a form.@see FormControlModel - @see com::sun::star::form::component::Form +/** specifies a component which can be part of a form. + + @see FormControlModel + @see com::sun::star::form::component::Form */ service FormComponent { - - - // DocMerge from xml: service com::sun::star::form::FormComponent: interface com::sun::star::form::XFormComponent - /** identifies the component as a candidate for being part - of a form. It provides the access to the component's parent. + /** identifies the component as a candidate for being part of a form. + <p>This interface also provides the access to the component's parent.</p> */ interface com::sun::star::form::XFormComponent; - // DocMerge from xml: service com::sun::star::form::FormComponent: interface com::sun::star::lang::XComponent - /** Each component must be disposable. + /** allows life-time control of form components. */ interface com::sun::star::lang::XComponent; - // DocMerge from xml: service com::sun::star::form::FormComponent: interface com::sun::star::container::XNamed /** Each FormComponent must supply a name for identification. */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + /** gives access to the properties. + */ interface com::sun::star::beans::XPropertySet; - // DocMerge from xml: service com::sun::star::form::FormComponent: interface com::sun::star::io::XPersistObject - /** Each FormComponent must be able to be stored. + /** Each FormComponent must be able to be stored into and read from a stream. */ interface com::sun::star::io::XPersistObject; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::FormComponent::Name /** the name of the component. + <p>Note that the name accessed here is the same as when using the + <type scope="com::sun::star::container">XNamed</type> interface.</p> */ [property] string Name; @@ -140,6 +136,18 @@ service FormComponent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.3 2002/07/26 09:59:54 fs + IDL review form layer + + Revision 1.4.20.2 2002/02/18 15:22:01 oj + #96946# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 14:49:19 oj + #96946# parameter,return value and exception description + + Revision 1.4 2000/12/21 08:35:08 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/FormComponentType.idl b/offapi/com/sun/star/form/FormComponentType.idl index 1a8a8485fb7f..5a0ae8e04756 100644 --- a/offapi/com/sun/star/form/FormComponentType.idl +++ b/offapi/com/sun/star/form/FormComponentType.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormComponentType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,125 +68,90 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::form::FormComponentType /** These constants specify the class types used to identify a component. */ constants FormComponentType { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::form::FormComponentType::CONTROL - /** This identifier is for controls which cannot be identified by - a specific identifier. + /** This generic identifier is for controls which cannot be identified by + an other specific identifier. */ const short CONTROL = 1; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::2 - - // DocMerge: empty anyway + /** specifies a control that is used to begin, interrupt, or end a process. + */ const short COMMANDBUTTON = 2; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::3 - - // DocMerge: empty anyway + /** specifies a control that acts like a radio button. Grouped together, such radio buttons + present a set of two or more mutually exclusive choices to the user. + */ const short RADIOBUTTON = 3; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::4 - - // DocMerge: empty anyway + /** specifies a control that displays an image that responds to mouse clicks. + */ const short IMAGEBUTTON = 4; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::5 - - // DocMerge: empty anyway + /** specifies a control that is used to check or uncheck to turn an option on or off. + */ const short CHECKBOX = 5; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::6 - - // DocMerge: empty anyway + /** specifies a control that displays a list from which the user can select one or more items. + */ const short LISTBOX = 6; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::7 - - // DocMerge: empty anyway + /** specifies a control that is used when a list box combined with a static text control or an edit + control is needed. + */ const short COMBOBOX = 7; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::8 - - // DocMerge: empty anyway + /** specifies a control that displays a frame around a group of controls with or without a caption. + */ const short GROUPBOX = 8; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::9 - - // DocMerge: empty anyway + /** specifies a control that is a text component that allows for the editing of a single line of text. + */ const short TEXTFIELD = 9; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::10 - - // DocMerge: empty anyway + /** specifies a control to display a fixed text, usually used to label other controls. + */ const short FIXEDTEXT = 10; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::11 - - // DocMerge: empty anyway + /** is a table like control to display database data. + */ const short GRIDCONTROL = 11; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::12 - - // DocMerge: empty anyway + /** specifies an control which can be used to enter text, extended by an (user-startable) file dialog + to browse for files. + */ const short FILECONTROL = 12; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::13 - - // DocMerge: empty anyway + /** specifies a control that should not be visible. + */ const short HIDDENCONTROL = 13; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::14 - - // DocMerge: empty anyway + /** specifies a control to display an image. + */ const short IMAGECONTROL = 14; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::15 - - // DocMerge: empty anyway + /** specifies a control to display and edit a date value. + */ const short DATEFIELD = 15; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::16 - - // DocMerge: empty anyway + /** specifies a control to display and edit a time value. + */ const short TIMEFIELD = 16; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::17 - - // DocMerge: empty anyway + /** specifies a field to display and edit a numeric value. + */ const short NUMERICFIELD = 17; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::18 - - // DocMerge: empty anyway + /** specifies a field to display and edit a currency value. + */ const short CURRENCYFIELD = 18; - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR constants::19 - - // DocMerge: empty anyway + /** specifies a control to display and edit a string according to a pattern. + */ const short PATTERNFIELD = 19; }; @@ -198,6 +163,18 @@ constants FormComponentType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:59:55 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:20:02 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:51:09 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/FormComponents.idl b/offapi/com/sun/star/form/FormComponents.idl index f5b7868a52b6..db06e10d105b 100644 --- a/offapi/com/sun/star/form/FormComponents.idl +++ b/offapi/com/sun/star/form/FormComponents.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormComponents.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,11 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif +#ifndef __com_sun_star_container_XContainer_idl__ +#include <com/sun/star/container/XContainer.idl> +#endif + +#include <com/sun/star/script/XEventAttacherManager.idl> //============================================================================= @@ -80,30 +85,37 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::FormComponents -/** specifies the capabilities of a collection of FormComponents. - +/** specifies the capabilities of a collection of <type>FormComponent</type>s. - - <p> The collection must provide the possibility of adding and removing + <p>The collection must provide the possibility of adding and removing components by name and by index. The name of a component is not necessarily unique, so the collection must be able to handle duplicate - entry names. - + entry names.</p> - </p>@see FormComponent + @see FormComponent */ service FormComponents { - // DocMerge: empty anyway + /** allows to register listeners to be notified of changes in the container. + */ + interface com::sun::star::container::XContainer; + + /** allows to add/remove elements by name. + */ interface com::sun::star::container::XNameContainer; - // DocMerge: empty anyway + /** gives access to the elements by index. + */ interface com::sun::star::container::XIndexContainer; - // DocMerge: empty anyway + /** creates an enumeration of the elements. + */ interface com::sun::star::container::XEnumerationAccess; + /** This interface has to be implemented to supply the scripting environment + for the contained components. + */ + interface com::sun::star::script::XEventAttacherManager; }; //============================================================================= @@ -113,6 +125,24 @@ service FormComponents /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.5 2002/07/26 09:59:56 fs + IDL review form layer + + Revision 1.4.20.4 2002/07/12 10:47:14 fs + reviewed + + Revision 1.4.20.3 2002/03/04 11:11:05 fs + #96998# moved XEventAttacherManager herein from component::Form + + Revision 1.4.20.2 2002/02/18 15:22:37 oj + #96946# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 14:51:26 oj + #96946# parameter,return value and exception description + + Revision 1.4 2000/12/21 08:35:08 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/FormControlModel.idl b/offapi/com/sun/star/form/FormControlModel.idl index 906149641409..5df7770ae484 100644 --- a/offapi/com/sun/star/form/FormControlModel.idl +++ b/offapi/com/sun/star/form/FormControlModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormControlModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,32 +84,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::FormControlModel /** specifies a control model within a form. - - - <p>In general, a control in a form consists of a model, which is - loaded and stored and which contains the data, and the control, - which contains the view and user interaction.</p> + <p>Note that the model-view-paradigm is used for form controls, too.</p> */ service FormControlModel { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlModel; - // DocMerge: empty anyway service com::sun::star::form::FormComponent; - - // DocMerge from xml: service com::sun::star::form::FormControlModel: interface com::sun::star::beans::XFastPropertySet /** This optional interface gives an efficient access to all properties at once or an ability to set more than one property at once. */ [optional] interface com::sun::star::beans::XFastPropertySet; - // DocMerge from xml: service com::sun::star::form::FormControlModel: interface com::sun::star::beans::XPropertyState /** This optional interface gives access to the state of the properties, e.g. whether a default value is to be used or not for a certain property. @@ -118,27 +108,30 @@ service FormControlModel //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::FormControlModel::ClassId - /** specifies the ID for classification of the component.@see FormComponentType + /** specifies the ID for classification of the component. + @see FormComponentType */ [readonly, property] short ClassId; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::FormControlModel::TabIndex - /** determines the taborder; default is -1 used for auto order. - + /** determines the relative taborder of the control associated with the model. + <p>The default -1 is used to indicate that the tab-order of this control should be + determined automatically.</p> <p>Each component which supports a tabstop must provide a - <type>FormControlModel::TabIndex</type>.</p> + <type>FormControlModel::TabIndex</type> property.</p> + + <p>Normally, a <type>FormController</type> instance is evaluating this property.</p> */ [optional, property] short TabIndex; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::FormControlModel::Tag /** used for additional information. + <p>No semantics is given for this property, it will usually be used by the creator of a document + containing form controls.</p> */ [property] string Tag; @@ -151,6 +144,12 @@ service FormControlModel /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/07/26 09:59:57 fs + IDL review form layer + + Revision 1.4 2001/01/23 10:08:21 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/FormController.idl b/offapi/com/sun/star/form/FormController.idl index 11af228afa27..26670dbc0c67 100644 --- a/offapi/com/sun/star/form/FormController.idl +++ b/offapi/com/sun/star/form/FormController.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormController.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,74 +85,105 @@ #include <com/sun/star/util/XModifyBroadcaster.idl> #endif +#ifndef __com_sun_star_form_XConfirmDeleteBroadcaster_idl__ +#include <com/sun/star/form/XConfirmDeleteBroadcaster.idl> +#endif -//============================================================================= +#ifndef __com_sun_star_sdb_XSQLErrorBroadcaster_idl__ +#include <com/sun/star/sdb/XSQLErrorBroadcaster.idl> +#endif + +#ifndef __com_sun_star_sdb_XRowSetApproveBroadcaster_idl__ +#include <com/sun/star/sdb/XRowSetApproveBroadcaster.idl> +#endif + +#ifndef __com_sun_star_form_XDatabaseParameterBroadcaster_idl__ +#include <com/sun/star/form/XDatabaseParameterBroadcaster.idl> +#endif - module com { module sun { module star { module form { //============================================================================= -// DocMerge from xml: service com::sun::star::form::FormController -/** specifies the view representation of a form. + module com { module sun { module star { module form { +//============================================================================= +/** specifies a component controlling the interaction between the user and form functionality. - <p>Like controls, forms are divided into two parts. One is the model, which - contains the information about the structure of the form and its components, - and the other part is the <type>FormController</type>, which contains all - controls (the view representation) related to the form. - The <type>FormController</type> is responsible for dialog processing, - like controlling the tab order and the grouping of controls. + <p>As soon as a form (containing controls) is to be presented to the user, + there is a need for an instance controlling the user interaction.<br/> + Such a <type>FormController</type> is responsible for dialog processing, + like controlling the tab order and the grouping of controls.</p> - </p> <p>As a form may contain one or many subforms, a <type>FormController</type> may - contain one or many <type>FormController</type>s, so the model structure or hierarchy - is reflected by the structure of <type>FormController</type>s. </p>@see com::sun::star::form::component:Form - @see com::sun::star::awt::XTabController + contain one or more other <type>FormController</type>s, so the form model structure or hierarchy + is reflected in the structure of <type>FormController</type>s.</p> + + @see com::sun::star::form::component:Form + @see com::sun::star::awt::XTabController */ service FormController { - - - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::form::XFormController - /** is used for notifying the (de)activation of - the controller. + /** is used for notifying the (de)activation of the controller. */ interface com::sun::star::form::XFormController; - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::awt::XTabController - /** is used for tab controlling and grouping of - the controls. + /** is used for tab controlling and grouping of the controls. */ interface com::sun::star::awt::XTabController; - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::container::XChild - /** A FormController may have a parent controller, such as when the - related form is a subform. + /** A FormController may have a parent controller, such as when the related form is a subform. */ interface com::sun::star::container::XChild; - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::lang::XComponent /** A FormController must be disposable. */ interface com::sun::star::lang::XComponent; - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::container::XEnumerationAccess /** A FormController must provide access to its sub controllers. */ interface com::sun::star::container::XEnumerationAccess; - // DocMerge from xml: service com::sun::star::form::FormController: interface com::sun::star::util::XModifyBroadcaster - /** A FormController must communicate if any of its children or contained - controls have been modified. + /** A FormController must communicate if any of its children (means sub controllers) or contained + controls have been modified. */ interface com::sun::star::util::XModifyBroadcaster; + /** used to notify deletions of data in the form before they happen. + + <p>A form controller listens for deletion events at the form it is responsible for.<br/> + If and only if no <type>XConfirmDeleteListener</type> is registered at + the controller, it uses an own dialog to ask the user for confirmation.</p> + + <p>You may use this interface to integrate your own confirmation dialogs.</p> + */ + interface com::sun::star::form::XConfirmDeleteBroadcaster; + + /** used to notify errors which happen in the form the controller is responsible for. + + <p>A form controller listens for error events at the form it is responsible for.<br/> + If and only if no <type>XSQLErrorListener</type> is registered at the controller, it + uses an own dialog to notify the user of the error.</p> + + */ + interface com::sun::star::sdb::XSQLErrorBroadcaster; + + /** is used for multiplexing row set events happening on the form which the controller is responsible for. + */ + interface com::sun::star::sdb::XRowSetApproveBroadcaster; + + /** is used broadcasting parameter events in the form. + + <p>A form controller listens for parameter events at the form it is responsible for.<br/> + If and only if no <type>XDatabaseParameterListener</type> is registered at the controller, it + uses an own dialog to ask the user for parameter values.</p> + */ + interface com::sun::star::form::XDatabaseParameterBroadcaster; }; //============================================================================= @@ -162,6 +193,12 @@ service FormController /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/07/15 11:07:12 fs + -m reviewed + + Revision 1.4 2000/12/21 08:35:08 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/FormSubmitEncoding.idl b/offapi/com/sun/star/form/FormSubmitEncoding.idl index ebf52bf7ee69..d25c881284ca 100644 --- a/offapi/com/sun/star/form/FormSubmitEncoding.idl +++ b/offapi/com/sun/star/form/FormSubmitEncoding.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormSubmitEncoding.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,33 +68,29 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::FormSubmitEncoding -/** specify the MIME encoding of the - form data sent. +/** specify the MIME encoding to be used when form data is submitted. */ enum FormSubmitEncoding { //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::form::FormSubmitEncoding::URL - /** URL ("application/x-www-form-urlencoded") is usually used - if the FormSubmitMethod attribute has the value POST. + /** Specifies to use "application/x-www-form-urlencoded" as submit encoding. + <p>Usually used if the FormSubmitMethod attribute has the value POST. + </p> */ URL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormSubmitEncoding::MULTIPART - /** MULTIPART ("multipart/form-data") is used when the form - contains a file upload element. + /** Specifies to use "multipart/form-data" as submit encoding. + <p>Usually used when the form contains a file upload element.</p> */ MULTIPART, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormSubmitEncoding::TEXT - /** text/plain is usually used if the FormSubmitMethod attribute - has the value POST and the content should be reviewed as full text. + /** specifies to use "text/plain" + <p>Usually used if the FormSubmitMethod attribute has the value POST and + the content should be reviewed as full text.</p> */ TEXT }; @@ -106,6 +102,12 @@ enum FormSubmitEncoding /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:58 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/FormSubmitMethod.idl b/offapi/com/sun/star/form/FormSubmitMethod.idl index cd5e84cbbc39..3c5270dab81e 100644 --- a/offapi/com/sun/star/form/FormSubmitMethod.idl +++ b/offapi/com/sun/star/form/FormSubmitMethod.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormSubmitMethod.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,25 +68,21 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::FormSubmitMethod -/** specify how information is sent - to a program invoked by submitting a form. +/** specifies how information is sent to a program invoked by submitting a form. */ enum FormSubmitMethod { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormSubmitMethod::GET - /** GET appends the input information of a form to the target + /** specifies to append the input information of a form to the target URL as parameters. */ GET, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::FormSubmitMethod::POST - /** POST sends the input information in a data body. - */ + /** speficies to send the input information in a data body. + */ POST }; @@ -98,6 +94,12 @@ enum FormSubmitMethod /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:58 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/Forms.idl b/offapi/com/sun/star/form/Forms.idl index f51c8f19050b..b94cbc6fef37 100644 --- a/offapi/com/sun/star/form/Forms.idl +++ b/offapi/com/sun/star/form/Forms.idl @@ -2,9 +2,9 @@ * * $RCSfile: Forms.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,9 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif +#ifndef __com_sun_star_form_FormComponents_idl__ +#include <com/sun/star/form/FormComponents.idl> +#endif //============================================================================= @@ -80,26 +83,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::Forms /** specifies the capabilities of a collection of forms. + <p>Basically, a <type>Forms</type> is a <type>FormComponents</type>, + with the additional restriction that the contained elements support the + <type scope="com::sun::star::form::component">Form</type> service.</p> - - <p> The collection must provide the possibility of adding and removing - forms by name and by index. The name of a form is not necessarily unique, - so the collection must be able to handle duplicate entry names. </p>@see com::sun::star::form::component::Form + @see com::sun::star::form::component::Form */ service Forms { - // DocMerge: empty anyway - interface com::sun::star::container::XNameContainer; - - // DocMerge: empty anyway - interface com::sun::star::container::XIndexContainer; - - // DocMerge: empty anyway - interface com::sun::star::container::XEnumerationAccess; - + service FormComponents; }; //============================================================================= @@ -109,6 +103,27 @@ service Forms /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.6 2002/08/29 14:51:56 fs + corrected a reference + + Revision 1.4.20.5 2002/08/09 12:36:33 fs + <type> instead of <service> + + Revision 1.4.20.4 2002/07/12 10:47:13 fs + reviewed + + Revision 1.4.20.3 2002/03/04 10:50:49 fs + #97303# ascribe the service on FormComponents + + Revision 1.4.20.2 2002/02/18 15:20:16 oj + #96946# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 14:50:08 oj + #96946# parameter,return value and exception description + + Revision 1.4 2000/12/21 08:35:08 mi + @see interface/service/... ident -> @see ident - for new docu generator + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/ListSourceType.idl b/offapi/com/sun/star/form/ListSourceType.idl index 7b1051ed5ffc..96931dc8aefa 100644 --- a/offapi/com/sun/star/form/ListSourceType.idl +++ b/offapi/com/sun/star/form/ListSourceType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListSourceType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,52 +68,46 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::ListSourceType -/** describes the kind of data source used - to fill the list data of a listbox or a combobox. +/** describes the kind of data source used to fill the list data of a listbox or a combobox control. + @see com::sun::star::form::component::ListBox + @see com::sun::star::form::component::ComboBox */ enum ListSourceType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::VALUELIST - /** filled with a stringlist of values. + /** The control should be filled with a list of string values. */ VALUELIST, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::TABLE - /** filled with the data of a table. + /** The control should be filled with the data of a table. */ TABLE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::QUERY - /** filled with the results of a database query. + /** The control should be filled with the results of a database query. */ QUERY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::SQL - /** filled with the results of a database statement. + /** The control should be filled with the results of a database statement. */ SQL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::SQLPASSTHROUGH - /** filled with the results of a database statement, + /** The control should be filled with the results of a database statement, which is not evaluated by the database engine. */ SQLPASSTHROUGH, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::ListSourceType::TABLEFIELDS - /** filled with the field names of a database table. + /** The control should be filled with the field names of a database table. */ TABLEFIELDS @@ -126,6 +120,12 @@ enum ListSourceType /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:59 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/NavigationBarMode.idl b/offapi/com/sun/star/form/NavigationBarMode.idl index 68fa5c7ed922..8390122ae2ef 100644 --- a/offapi/com/sun/star/form/NavigationBarMode.idl +++ b/offapi/com/sun/star/form/NavigationBarMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: NavigationBarMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,33 +68,40 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::NavigationBarMode -/** describes in which way the navigation of the - records of a database form is performed. +/** describes in which way the navigation of the records of a database form is performed. */ enum NavigationBarMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::NavigationBarMode::NONE /** no navigation bar is provided and navigation on the current form is only possible with the keyboard (TAB/SHIFT TAB). + + <p>Note that when this mode is set, a simultaneous <type>TabulatorCycle</type> + value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel + between records anymore.</p> + + @see TabulatorCycle */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::NavigationBarMode::CURRENT /** a navigation bar is provided and navigation will be performed on the current/active form. + <p>This is the default and most often encountered mode.</p> */ CURRENT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::NavigationBarMode::PARENT /** a navigation bar is provided and navigation will be performed on the parent of the current/active form. + + <p>This options is usually used for forms containing an grid control only. + In such a form, the control has it's own navigation elements, so there is + no need to use the navigation bar for the form, but rather for it's parent. + </p> */ PARENT @@ -107,6 +114,12 @@ enum NavigationBarMode /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:59:59 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/TabulatorCycle.idl b/offapi/com/sun/star/form/TabulatorCycle.idl index 6c8e58571925..706650cbef90 100644 --- a/offapi/com/sun/star/form/TabulatorCycle.idl +++ b/offapi/com/sun/star/form/TabulatorCycle.idl @@ -2,9 +2,9 @@ * * $RCSfile: TabulatorCycle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:42:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,15 +68,25 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::form::TabulatorCycle -/** values are used to specify what happens when the TAB key - is pressend and the focus is in the last control of a data bound form. +/** specifies how the TAB key should be used in a form. + + <p>If the last control of a form is focused, and the user pressed the TAB key, there are + several possibilities how a <type>FormController</type> should handle this. + <type>TabulatorCycle</type> specifies these possibilities.</p> + + <p>Note that the <type>TabulatorCycle</type> determines what happens when SHIFT-TAB + is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the + <em>last</em> control.</p> + + <p><em>First</em> and <em>last</em> refers to the tabbing order of controls.</p> + + @see FormControlModel::TabIndex + @see FormController */ enum TabulatorCycle { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::TabulatorCycle::RECORDS /** pressing the TAB key from the last control moves the focus to the first control in the tab order of the next record. */ @@ -84,7 +94,6 @@ enum TabulatorCycle //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::TabulatorCycle::CURRENT /** pressing the TAB key from the last control moves the focus to the first control in the tab order of the same record. */ @@ -92,7 +101,6 @@ enum TabulatorCycle //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::form::TabulatorCycle::PAGE /** pressing the TAB key from the last control of a form moves the focus to the first control of the next form in the tab order. */ @@ -107,6 +115,12 @@ enum TabulatorCycle /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 10:00:00 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:42:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:16 hjs initial import diff --git a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl index 5cd8b522a359..24d9fd5b0a01 100644 --- a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl +++ b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XApproveActionBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,30 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XApproveActionBroadcaster -/** XApproveActionBroadcaster" notifies the specific listeners before - an action on a component is performed. +/** allows to probably veto actions to be performed on components. - - - <p> In general a component which supports the + <p> Usually, a component which supports the <type>XApproveActionBroadcaster</type> interface implements - the possibility of adding an <type scope="com::sun::star::awt">XActionListener</type> as well.</p> */ interface XApproveActionBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XApproveActionBroadcaster::addApproveActionListener - /** addApproveActionListener" adds the specified listener to - receive the "approveAction" event. + /** adds the specified listener to receive the <member>XApproveActionListener::approveAction</member> + event. + + @param aListener + the listener to be added */ [oneway] void addApproveActionListener( [in] com::sun::star::form::XApproveActionListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XApproveActionBroadcaster::removeApproveActionListener - /** removes the specified listener. + /** removes the specified listener + + @param aListener + the listener to be removed */ [oneway] void removeApproveActionListener( [in] com::sun::star::form::XApproveActionListener aListener ); @@ -113,6 +112,18 @@ interface XApproveActionBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:00 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/18 15:23:33 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:52:23 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XApproveActionListener.idl b/offapi/com/sun/star/form/XApproveActionListener.idl index 50d049912ecb..8270a0733c63 100644 --- a/offapi/com/sun/star/form/XApproveActionListener.idl +++ b/offapi/com/sun/star/form/XApproveActionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XApproveActionListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,26 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XApproveActionListener -/** the listener interface for receiving the "approveAction" event. +/** can be implemented to listen and probably veto actions to be performed on components. + <p>An example for an action would be the click of a + CommandButton.</p> - - <p>The action may be cancelled. An action may, for example, be - a mouse click on a command button. - - </p>@see XActionApproveBroadcaster + @see XApproveActionBroadcaster + @see com::sun::star::form::component::CommandButton + @see com::sun::star::form::control::CommandButton */ interface XApproveActionListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XApproveActionListener::approveAction /** is invoked when an action is performed. + + @param aEvent + A descriptor specifying the source of the event. + + @returns + <TRUE/> when the action is permitted, otherwise <FALSE/>. */ boolean approveAction( [in] com::sun::star::lang::EventObject aEvent ); @@ -104,6 +108,18 @@ interface XApproveActionListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:01 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/18 15:23:42 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:52:29 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XBoundComponent.idl b/offapi/com/sun/star/form/XBoundComponent.idl index 7530b3154f18..6367edb0449e 100644 --- a/offapi/com/sun/star/form/XBoundComponent.idl +++ b/offapi/com/sun/star/form/XBoundComponent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBoundComponent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,29 +72,28 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XBoundComponent -/** makes it possible to connect a data-aware component to a data source. +/** specifies a (form) component which is bound to a data source. - - - <p>It provides the possibility of committing its respective data to a - data source. A commit will be performed by the environment. For - example, suppose you have a data-bound control that is connected + <p>The interface provides the possibility of committing its respective + data to a data source it is bound to. A <member>commit</member> will be + performed by the environment (usually, a <type>FormController</type>).<br/> + For example, suppose you have a data-bound control that is connected to a database field. Each time the control loses its focus, the model (component) of the control is triggered by the environment - to store its value in the database field. + to store its value in the database field.</p> - </p> - <p>A commit may fail if an "UpdateListener" rejects the commitment - of data. - </p> + <p>A commit may fail if an <type>XUpdateListener</type> vetoes the it.</p> + + @see com::sun::star::form::XUpdateListener */ interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XBoundComponent::commit - /** triggers the update of the bound data source. + /** commits the content of the component into the data source it is bound to. + + @returns + <TRUE/> when the commitment was successful, otherwise <FALSE/>. */ boolean commit(); @@ -107,6 +106,15 @@ interface XBoundComponent: com::sun::star::form::XUpdateBroadcaster /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:02 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:52:35 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XBoundControl.idl b/offapi/com/sun/star/form/XBoundControl.idl index 265d316a5475..98a3e469cca4 100644 --- a/offapi/com/sun/star/form/XBoundControl.idl +++ b/offapi/com/sun/star/form/XBoundControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBoundControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,30 +72,27 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XBoundControl -/** are related to data-bound components and provide the - possibility of locking the input for data related controls. - - - - <p> The relation between bound controls and bound components follows - the Model-View-Controller paradigm as used in Smalltalk.<br> - </p> +/** allows locking the input on components. */ + interface XBoundControl: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XBoundControl::getLock /** determines whether the input is currently locked or not. + + @returns + <TRUE/> when it is currently locked, otherwise <FALSE/>. */ boolean getLock(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XBoundControl::setLock /** is used for altering the current lock state of the component. + + @param bLock + the new lock state. */ [oneway] void setLock( [in] boolean bLock ); @@ -108,6 +105,18 @@ interface XBoundControl: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:02 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/18 15:24:17 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:52:41 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XChangeBroadcaster.idl b/offapi/com/sun/star/form/XChangeBroadcaster.idl index 03e3e0f37a9e..7fa2c6f654f6 100644 --- a/offapi/com/sun/star/form/XChangeBroadcaster.idl +++ b/offapi/com/sun/star/form/XChangeBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangeBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,34 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XChangeBroadcaster -/** provides functionality to notify listeners of context changes.@see XChangeBroadcaster +/** provides functionality to notify listeners of data changes. + + <p>The concrete semantics of a change (i.e. the conditions for when a change event + is fired) must be specified in the service description of the providing service.</p> + + @see XChangeListener */ interface XChangeBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XChangeBroadcaster::addChangeListener /** adds the specified listener to receive the "changed" event. + + @param aListener + the listener to add. + + @see com::sun::star::form::XChangeListener */ [oneway] void addChangeListener( [in] com::sun::star::form::XChangeListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XChangeBroadcaster::removeChangeListener /** removes the specified listener. + + @param aListener + the listener to remove. + + @see com::sun::star::form::XChangeListener */ [oneway] void removeChangeListener( [in] com::sun::star::form::XChangeListener aListener ); @@ -104,6 +116,15 @@ interface XChangeBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:02 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:52:47 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XChangeListener.idl b/offapi/com/sun/star/form/XChangeListener.idl index ff71f4a0e98c..6a0b6cd16ada 100644 --- a/offapi/com/sun/star/form/XChangeListener.idl +++ b/offapi/com/sun/star/form/XChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangeListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,22 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XChangeListener -/** is the listener interface for receiving "changed" events. +/** is the listener interface for receiving notifications about data changes. + <p>The concrete semantics of a change (i.e. the conditions for when a change event + is fired) must be specified in the description of the service broadcasting the + change.</p> - - <p>A "changed" event should be fired if the context of the - component has been changed. For example a text field in HTML - fires a "changed" event if the text of the field has been - modified and the field loses its focus. - - </p> - <p>The moment when the event occurs must be specified in - the service description of the providing service. - - </p>@see XChangeBroadcaster + @see XChangeBroadcaster */ interface XChangeListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XChangeListener::changed - /** is invoked when the context of a component has been changed. + /** is invoked when the data of a component has been changed. + + @param rEvent + A dedscriptor specifying the source of the event. */ [oneway] void changed( [in] com::sun::star::lang::EventObject rEvent ); @@ -110,6 +104,15 @@ interface XChangeListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:03 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:52:53 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl index fd67f35a1ab3..cd02c8fefef5 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConfirmDeleteBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,35 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XConfirmDeleteBroadcaster -/** provides the possibility of reviving an event for confirmation of delete. +/** provides the possibility of receiving an event for confirming deletions of + rows in a <type scope="com::sun::star::form::component">DataForm</type>. + + @see XConfirmDeleteListener */ interface XConfirmDeleteBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XConfirmDeleteBroadcaster::addConfirmDeleteListener - /** adds the specified listener to receive the event "confirmDelete." + /** remembers the specified listener to receive an event for confirming deletions + + <p><member>XConfirmDeleteListener::confirmDelete</member> is called before a + deletion is performed. You may use the event to write your own confirmation messages.</p> + + @param aListener + the listener to add. + + @see com::sun::star::form::XConfirmDeleteListener */ [oneway] void addConfirmDeleteListener( [in] com::sun::star::form::XConfirmDeleteListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XConfirmDeleteBroadcaster::removeConfirmDeleteListener /** removes the specified listener. + + @param aListener + the listener to remove. + + @see com::sun::star::form::XConfirmDeleteListener */ [oneway] void removeConfirmDeleteListener( [in] com::sun::star::form::XConfirmDeleteListener aListener ); @@ -104,6 +117,15 @@ interface XConfirmDeleteBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:03 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:50:17 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XConfirmDeleteListener.idl b/offapi/com/sun/star/form/XConfirmDeleteListener.idl index 8923dcabe698..1c5acde7c476 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteListener.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConfirmDeleteListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,22 +75,22 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XConfirmDeleteListener -/** is the listener interface for receiving "confirmDelete" events - posted by a database form. +/** allows to register a component for confirming deletions of + rows in a <type scope="com::sun::star::form::component">DataForm</type>. - - - <p>"confirmDelete" must be posted by a component before a deletion - is performed. You may use the event to write your own confirmation - messages. </p>@see com::sun::star::form::component::DatabaseForm + @see XConfirmDeleteBroadcaster */ interface XConfirmDeleteListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XConfirmDeleteListener::confirmDelete - /** is invoked when the current record of a database form will be deleted.@see XDatabaseForm + /** is invoked when the current record of a database form will be deleted. + + @param aEvent + A dedscriptor specifying the deletion request. + + @returns + <TRUE/> when the row caan be deleted, otherwise <FALSE/>. */ boolean confirmDelete( [in] com::sun::star::sdb::RowChangeEvent aEvent ); }; @@ -102,6 +102,15 @@ interface XConfirmDeleteListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.2 2002/07/26 10:00:04 fs + IDL review form layer + + Revision 1.5.16.1 2002/02/18 14:51:39 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:08 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl index bdb13b99f043..cb321409e22c 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseParameterBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,32 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XDatabaseParameterBroadcaster -/** provides the possibility of reveiving an event for configuration of parameters. +/** provides the possibility of receiving an event for configuration of parameters. + <p>This interface is usually implemented by components which are to execute a statement, + and may need parameter information. For example, the + <type scope="com::sun::star::form::component">DataForm</type> is such a component. When it is + bound to a statement which contains parameters, or to a query which is based upon a parametrized + statement, it needs values to fill in the parameters with actual values when it is being loaded. + One method to gather these values is calling the <type>XDatabaseParameterListener</type> listeners, which + can fill them in.</p> */ interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XDatabaseParameterBroadcaster::addParameterListener - /** adds the specified listener to receive the event "approveParameter." + /** adds the specified listener, to allow it to fill in necessary parameter values. + @param aListener + the listener to add. + @see com::sun::star::form::XDatabaseParameterListener */ [oneway] void addParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XDatabaseParameterBroadcaster::removeParameterListener /** removes the specified listener. + @param aListener + the listener to remove. + @see com::sun::star::form::XDatabaseParameterListener */ [oneway] void removeParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener ); @@ -104,6 +114,15 @@ interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:05 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:50:29 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XDatabaseParameterListener.idl b/offapi/com/sun/star/form/XDatabaseParameterListener.idl index 1fa1fc5ff2d2..647bd993e5ce 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterListener.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseParameterListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,21 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XDatabaseParameterListener -/** this event is posted if an execution of a parameterized SQL statement needs - the values for the parameters.@see com::sun::star::form::component::DatabaseForm +/** allows to intercept value request for parametrized SQL statements. */ interface XDatabaseParameterListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XDatabaseParameterListener::approveParameter - /** is invoked before execution of a parameterized SQL statement.@see XDatabaseForm + /** is invoked when there is a need for parameter values + + @param aEvent + the event describing the parameter value request. + + @returns + <TRUE/> when the execution of the parametrized statement should continue, <FALSE/> otherwise. + + @see com::sun::star::form::DatabaseParameterEvent */ boolean approveParameter( [in] com::sun::star::form::DatabaseParameterEvent aEvent ); @@ -98,6 +103,15 @@ interface XDatabaseParameterListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.2 2002/07/26 10:00:06 fs + IDL review form layer + + Revision 1.5.16.1 2002/02/18 14:49:04 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:08 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/form/XDeleteListener.idl b/offapi/com/sun/star/form/XDeleteListener.idl index 59b9f59b559b..0d84f2e14626 100644 --- a/offapi/com/sun/star/form/XDeleteListener.idl +++ b/offapi/com/sun/star/form/XDeleteListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDeleteListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,25 +76,14 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XDeleteListener /** This is the listener interface for receiving "approveDelete" and "deleted" events posted by a database form. - - <p> "approveDelete" may be used to abort a deletion of the current data - record. The events are posted in the following order:<br> - aForm.deleteRecord() -&gt; approveDelete -&gt; "do Delete" -&gt; deleted - - </p> - - - - - - - + record.</p> + <p>Please do <em><b>not</b></em> use anymore, this interface is superseeded + by <type scope="com::sun::star::form">XConfirmDeleteListener</type>.</p> @deprecated */ @@ -102,16 +91,16 @@ interface XDeleteListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XDeleteListener::approveDelete - /** is invoked when the current record of the database form will be deleted.@see XDatabaseForm + /** is invoked when the current record of the database form will be deleted. + @see XDatabaseForm */ boolean approveDelete( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XDeleteListener::deleted /** is invoked when a database form has finished the delete processing and - the data has been successfully deleted from the datasource.@see XDatabaseForm + the data has been successfully deleted from the datasource. + @see XDatabaseForm */ void deleted( [in] com::sun::star::lang::EventObject aEvent ); @@ -124,6 +113,15 @@ interface XDeleteListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:06 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 15:22:28 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XErrorBroadcaster.idl b/offapi/com/sun/star/form/XErrorBroadcaster.idl index 8777e33c51eb..30cfb6d06aad 100644 --- a/offapi/com/sun/star/form/XErrorBroadcaster.idl +++ b/offapi/com/sun/star/form/XErrorBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XErrorBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,19 +76,10 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XErrorBroadcaster -/** provides the possibility of reviving database error events. - - - - - - - - - - +/** provides the possibility of receiving database error events. + <p>Please do <em><b>not</b></em> use anymore, this interface is superseeded + by <type scope="com::sun::star::sdb">XSQLErrorBroadcaster</type>.</p> @deprecated */ @@ -96,14 +87,12 @@ interface XErrorBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XErrorBroadcaster::addErrorListener - /** adds the specified listener to receive the event "errorOccured." + /** adds the specified listener to be notified of errors. */ [oneway] void addErrorListener( [in] com::sun::star::form::XErrorListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XErrorBroadcaster::removeErrorListener /** removes the specified listener. */ [oneway] void removeErrorListener( [in] com::sun::star::form::XErrorListener aListener ); @@ -117,6 +106,12 @@ interface XErrorBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:06 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XErrorListener.idl b/offapi/com/sun/star/form/XErrorListener.idl index c71e34bd6d4d..6100ded3311c 100644 --- a/offapi/com/sun/star/form/XErrorListener.idl +++ b/offapi/com/sun/star/form/XErrorListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XErrorListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,30 +76,24 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XErrorListener -/** This is the listener interface for receiving "errorOccured" events - posted by a database form. - - +/** used to be notified when errors in a <type scope="com::sun::star::component">DatabaseForm</type> happen. <p>Each time an exception is triggered by a database form, the error event is posted to the error listeners. This event may be used to - configure the error handling of a database form. </p> - - - + configure the error handling of a database form.</p> + <p>Please do <em><b>not</b></em> use anymore, this interface is superseeded + by <type scope="com::sun::star::sdb">XSQLErrorListener</type>.</p> - - @deprecated@see com::sun::star::form::component::DatabaseForm + @deprecated */ interface XErrorListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XErrorListener::errorOccured /** is invoked when a database action performed by a database form raises - an exception.@see XDatabaseForm + an exception. + @see XDatabaseForm */ void errorOccured( [in] com::sun::star::form::ErrorEvent aEvent ); @@ -112,6 +106,15 @@ interface XErrorListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.2 2002/07/26 10:00:07 fs + IDL review form layer + + Revision 1.5.16.1 2002/02/18 15:24:52 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:08 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/form/XForm.idl b/offapi/com/sun/star/form/XForm.idl index c57ca5c62a6c..0f75837ad3f1 100644 --- a/offapi/com/sun/star/form/XForm.idl +++ b/offapi/com/sun/star/form/XForm.idl @@ -2,9 +2,9 @@ * * $RCSfile: XForm.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,12 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XForm -/** identifies a form component as being a (sub-) form. +/** identifies a <type>FormComponent</type> as being a (sub-) form. + + <p>This interface does not really provide an own functionality, it is only for easier + runtime identification of form components.</p> + + @see XFormComponent */ interface XForm: com::sun::star::form::XFormComponent { @@ -86,6 +90,12 @@ interface XForm: com::sun::star::form::XFormComponent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:07 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XFormComponent.idl b/offapi/com/sun/star/form/XFormComponent.idl index 094d0d4f8036..f0949ef95ef0 100644 --- a/offapi/com/sun/star/form/XFormComponent.idl +++ b/offapi/com/sun/star/form/XFormComponent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormComponent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,17 +72,12 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XFormComponent /** describes a component which may be part of a form. + <p>This interface does not really provide an own functionality, it is only for easier + runtime identification of form components.</p> - - <p> A form may contain form components, like controls, which provide a - user interface, but may also contain other components which provide several - services within a form, for example, this could be a timer which - schedules an event periodically. - - </p>@see XForm + @see XForm */ interface XFormComponent: com::sun::star::container::XChild { @@ -95,6 +90,12 @@ interface XFormComponent: com::sun::star::container::XChild /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:07 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XFormController.idl b/offapi/com/sun/star/form/XFormController.idl index 3f52f53649ec..2046f53d1679 100644 --- a/offapi/com/sun/star/form/XFormController.idl +++ b/offapi/com/sun/star/form/XFormController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormController.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,36 +80,55 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XFormController -/** provides functionality to control the activation - of forms. +/** provides functionality to control the activation of forms controls. + <p>There is a duality of forms (<type scope="com::sun::star::form::component">DataForm</type>) + and form controllers. In a document view, for every loaded form there is a form controller which is + responsible for exactly the controls which's models are direct children of the form.<br/> + In some sense, a form controller is the view representation of a form, like a <em>form control</em> is the + view representation of a <em>form control model</em>.<br/> - <p>It should represent all controls which belong to a form.</p> + This is also reflected in this interface: If you call + <method scope="com::sun::star::awt">XTabController::getModel</method> on a form controller, the form which + the controller is responsible for will be returned.<br/> + + As always in the model-view-paradigm, there is no way from a model to its controller, mostly, because for + <em>one</em> given form, there is one controller for <em>every</em> view of the document.</p> + + <p>A controller is called <em>active</em> if one of the controls it is responsible for has the focus, + else inactive. To be notified whenever this activation state of a given controller changes, you can + add listeners.</p> + + @see com::sun::star::form::component::Form */ interface XFormController: com::sun::star::awt::XTabController { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::getCurrentControl - /** access to the current control may be null. + /** access to the currently active control + + @returns + the currently active control, or <NULL/> if there is no such control */ com::sun::star::awt::XControl getCurrentControl(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::addActivateListener - /** adds the specified listener to receive events "formActivated" - and "formDeactivated." + /** adds the specified listener to receive notifications whenever the activation state of + the controller changes. + + @param l + the listener to add. */ [oneway] void addActivateListener( [in] com::sun::star::form::XFormControllerListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::removeActivateListener - /** removes the specified listener so it does not receive any events - from the form controller. + /** removes the specified listener + + @param l + the listener to remove. */ [oneway] void removeActivateListener( [in] com::sun::star::form::XFormControllerListener l ); @@ -122,6 +141,18 @@ interface XFormController: com::sun::star::awt::XTabController /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:08 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/19 08:26:14 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:49:58 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XFormControllerListener.idl b/offapi/com/sun/star/form/XFormControllerListener.idl index 9641ebdc36cc..a80345a9d5f6 100644 --- a/offapi/com/sun/star/form/XFormControllerListener.idl +++ b/offapi/com/sun/star/form/XFormControllerListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormControllerListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,33 +76,33 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XFormControllerListener -/** makes it possible to receive "formActivated" and - "formDeactivated" events posted by a form controller. - - +/** allows to be notified when the activation status of a <type>FormController</type> changes. <p> A form controller is activated if a form control gains the - focus and none of its controls currently owns the focus. + focus and none of its controls currently owned the focus before.</p> - </p>@see XFormController + @see XFormController */ interface XFormControllerListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormControllerListener::formActivated /** is invoked when a control of the controller gained the focus and - the controller was not previously activated.@see XFormController + the controller was not previously activated. + + @param rEvent + the event happend. */ [oneway] void formActivated( [in] com::sun::star::lang::EventObject rEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormControllerListener::formDeactivated /** is invoked when a control of the "XFormController" lost the focus - and any control of the controller received the focus. In other - words, no control of the controller owns the focus.@see XFormController + and no control of the controller received the focus. In other + words, no control of the controller owns the focus. + + @param rEvent + the event happend. */ [oneway] void formDeactivated( [in] com::sun::star::lang::EventObject rEvent ); @@ -115,6 +115,15 @@ interface XFormControllerListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:08 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:51:15 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XFormsSupplier.idl b/offapi/com/sun/star/form/XFormsSupplier.idl index ed82d2b66583..b5f296968e81 100644 --- a/offapi/com/sun/star/form/XFormsSupplier.idl +++ b/offapi/com/sun/star/form/XFormsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,41 +76,54 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XFormsSupplier -/** provides the access to a collection - of forms. +/** provides the access to a collection of forms. */ interface XFormsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormsSupplier::getForms /** accesses the forms. - - - - - - - - - @example <listing> - 'creating a new combobox and inserting it into the Standard form. - xShape = xDoc.createInstance( "com::sun::star::drawing::ControlShape" ) - xShape.Position = Point( 5, 80 ) - xShape.Size = Size( 120, 16 ) - - xControlModel = xDoc.createInstance( "com::sun::star::form::component::ComboBox" ) - xControlModel.Name = "ColorSelection" - xControlModel.Text = "red" - xControlModel.StringItemList = ... - - xShape.ControlModel = xControlModel - xDoc.DrawPage.Forms.Standard.insertAtIndex( n%, xControlModel ) - xDoc.Text.insertTextContent( xTextRange, xShape ) - + @example StarBASIC + <listing> + REM ***** BASIC ***** + + Sub createColorSelectionBox + ' create a new shape + xShape = thisComponent.createInstance( "com.sun.star.drawing.ControlShape" ) + Dim aPos as new com.sun.star.awt.Point + aPos.X = 200 + aPos.Y = 100 + xShape.Position = aPos + Erase aPos + Dim aSize as new com.sun.star.awt.Size + aSize.Width = 2500 + aSize.Height = 5000 + xShape.Size = aSize + Erase aSize + + ' create a combo box model + xControlModel = thisComponent.createInstance( "com.sun.star.form.component.ComboBox" ) + xControlModel.Name = "ColorSelection" + xControlModel.Text = "red" + + ' marry the shape and the model + xShape.Control = xControlModel + + if ( 0 = thisComponent.DrawPage.Forms.getCount() ) Then + xForm = thisComponent.createInstance( "com.sun.star.form.component.DataForm" ) + xForm.Name = "SampleForm" + thisComponent.DrawPage.Forms.insertByIndex( 0, xForm ) + End If + ' insert the control model into the first form of the forms collection of the + ' draw page of the document + thisComponent.DrawPage.Forms.getByIndex(0).insertByIndex( 0, xControlModel ) + thisComponent.DrawPage.add( xShape ) + End Sub </listing> + + @returns + the container of all the top-level forms belonging to the component. */ com::sun::star::container::XNameContainer getForms(); @@ -123,6 +136,15 @@ interface XFormsSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:09 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:50:49 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XGrid.idl b/offapi/com/sun/star/form/XGrid.idl index b71b1bf7715c..075b74b25d1d 100644 --- a/offapi/com/sun/star/form/XGrid.idl +++ b/offapi/com/sun/star/form/XGrid.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGrid.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,36 +72,31 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XGrid /** provides the possibility of setting and retrieving the position - of the current cell. - - - - - - - - - - - - - + of the current cell in a grid control. + + <p>Note that a grid control does not allow free control over the current row: + In such a control, every line represents a row of data of the underlying + <type scope="com::sun::star::form::component">DataForm</type>. Thus, the <em>current + row</em> of the grid control always equals the current row of the + <type scope="com::sun::star::form::component">DataForm</type>, and can be affected only + by changing the latter.<br/> + The current column of a grid control, whoever, can be freely controlled.</p> + + @see com::sun::star::form::component::GridControl + @see com::sun::star::form::control::GridControl @deprecated */ interface XGrid: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XGrid::getCurrentColumnPosition /** retrieves the current column position. */ short getCurrentColumnPosition(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XGrid::setCurrentColumnPosition /** sets the current column position. */ [oneway] void setCurrentColumnPosition( [in] short nPos ); @@ -115,6 +110,12 @@ interface XGrid: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:09 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XGridColumnFactory.idl b/offapi/com/sun/star/form/XGridColumnFactory.idl index 76684b0e5875..2ec748ae938a 100644 --- a/offapi/com/sun/star/form/XGridColumnFactory.idl +++ b/offapi/com/sun/star/form/XGridColumnFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGridColumnFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,40 +80,39 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XGridColumnFactory -/** provides the functionality of creating columns for a grid component. +/** allows to create columns to be added into a grid control model. + <p>Grid columns (more precise: models of grid columns) are direct children of + the grid control model they belong to. Grid columns can't be created on a global + service factory, instead, you need to create them on the grid, where you want to + insert them later on.</p> - - <p> With - - - - - it is possible - to inspect all possible column types which may be instanciated using - - - - - - .</p> + @see com::sun::star::form::component::GridControl */ interface XGridColumnFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XGridColumnFactory::createColumn - /** creates a new column object. + /** creates a new column object + + @param aColumnType + the type of column to be created + + @returns + the new column object + + @throws com::sun::star::lang::IllegalArgumentException + if <arg>aColumnType</arg> is not available. */ com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XGridColumnFactory::getColumnTypes - // DocMerge from idl: method com::sun::star::form::XGridColumnFactory::getColumnTypes /** returns a list of available column types. + + @returns + a list of column types. */ sequence<string> getColumnTypes(); }; @@ -125,6 +124,18 @@ interface XGridColumnFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:09 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/19 08:11:36 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:48:42 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl index 6cee7c9ca7fa..57c9e5d0112e 100644 --- a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl +++ b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGridFieldDataSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,37 +76,47 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XGridFieldDataSupplier -/** provides access to the data of a GridControl. - - - - <p> You can retrieve the data type information and the data in a row. - - </p> - - - - - +/** provides access to the data of a GridControl + <p>You can retrieve the data type information and the data in a row.</p> + <p>This interface allows to retrieve data even for rows which are not current, which is quite usefull, + as normally, you can't affect the current row in a grid control without moving the cursor of the underlying + <type scope="com::sun::star::form::component">DataForm</type>.</p> + @see XGrid + @see com::sun::star::form::control::GridControl + @see com::sun::star::form::component::GridControl @deprecated */ interface XGridFieldDataSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XGridFieldDataSupplier::queryFieldDataType + /** checks whether or not the content of the grid's columns can be retrieved in the requested format. + + <p>Not every cell content can be retrieved in every representation. For example, in a text column, + you usually won't be able to retrieve the content as double.<br/> + To check if the type you need is supported by the columns, use this method.</p> + + @return + A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates + that the column content can be retrieved in the requested format, <FALSE/> denies this. - // DocMerge: empty anyway + @see XGridColumnFactory + @see DataAwareControlModel + @see XGridFieldDataSupplier::queryFieldData + */ sequence<boolean> queryFieldDataType( [in] type xType ); //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XGridFieldDataSupplier::queryFieldData + /** retrieves the actual column data for the given row - // DocMerge: empty anyway + <p>If a column does not support the requested type, <NULL/> is returned at the respective + position.</p> + + @see XGridFieldDataSupplier::queryFieldDataType + */ sequence<any> queryFieldData( [in] long nRow, [in] type xType ); }; @@ -118,6 +128,12 @@ interface XGridFieldDataSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/07/26 10:00:10 fs + IDL review form layer + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2001/01/31 09:57:00 mi TYPE_XIDLCLASS is now 'type' diff --git a/offapi/com/sun/star/form/XGridPeer.idl b/offapi/com/sun/star/form/XGridPeer.idl index 3133b22a18b6..beddc8d4f8ee 100644 --- a/offapi/com/sun/star/form/XGridPeer.idl +++ b/offapi/com/sun/star/form/XGridPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGridPeer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,28 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XGridPeer /** represents the window peer of a GridControl and allows you to set and retrieve the model data. + <p>Usually, the columns used are the columns as supplied by the grid control model.</p> + <p>You should use this interface only if you know exactly what you are doing. Tampering + with the columns of a grid control which is part of a complex form can really hurt ....</p> - - - - - @deprecated@see com::sun::star::awt::XWindowPeer + @deprecated + @see com::sun::star::awt::XWindowPeer + @see com::sun::star::form::component::GridControl */ interface XGridPeer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XGridPeer::getColumns - /** retrieves the currently used column definitions - of the peer. + /** retrieves the currently used column definitions of the peer. */ com::sun::star::container::XIndexContainer getColumns(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XGridPeer::setColumns /** sets the column definition for the peer. */ [oneway] void setColumns( [in] com::sun::star::container::XIndexContainer aColumns ); @@ -114,6 +111,15 @@ interface XGridPeer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:10 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 15:21:07 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XImageProducerSupplier.idl b/offapi/com/sun/star/form/XImageProducerSupplier.idl index 6669076047dc..265ea2391aa1 100644 --- a/offapi/com/sun/star/form/XImageProducerSupplier.idl +++ b/offapi/com/sun/star/form/XImageProducerSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImageProducerSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,18 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XImageProducerSupplier -/** provides the access to an image producer.@see com::sun::star::awt::XImageProducer +/** provides the access to an image producer. + + @see com::sun::star::awt::XImageProducer */ interface XImageProducerSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XImageProducerSupplier::getImageProducer /** accesses the image producer. + + @returns + the image producer. */ com::sun::star::awt::XImageProducer getImageProducer(); @@ -97,6 +100,15 @@ interface XImageProducerSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:11 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:49:48 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XInsertListener.idl b/offapi/com/sun/star/form/XInsertListener.idl index 4b14bb26ec46..eb4806b29395 100644 --- a/offapi/com/sun/star/form/XInsertListener.idl +++ b/offapi/com/sun/star/form/XInsertListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInsertListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,12 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XInsertListener -/** receives "inserting" and - "inserted" events posted by a database form. - - - - - - - - - - - +/** allows to receive notifications about insertions into a database form. + <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and + superseeded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> + service, as well as the <type scope="com::sun::star::sdbc">XRowSetListener</type> and + <type scope="com::sun::star::sdb">XRowSetApproveListener</type> interfaces.</p> @deprecated */ @@ -98,15 +89,17 @@ interface XInsertListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XInsertListener::inserting - /** is invoked when a database form starts inserting a record.@see XDatabaseForm + /** is invoked when a database form starts inserting a record. + + @see XDatabaseForm */ void inserting( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XInsertListener::inserted - /** is invoked after a database form has inserted a record to a data source.@see XDatabaseForm + /** is invoked after a database form has inserted a record to a data source. + + @see XDatabaseForm */ void inserted( [in] com::sun::star::lang::EventObject aEvent ); @@ -119,6 +112,12 @@ interface XInsertListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:11 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XLoadListener.idl b/offapi/com/sun/star/form/XLoadListener.idl index b7dea863ddc4..e3e1de717fc8 100644 --- a/offapi/com/sun/star/form/XLoadListener.idl +++ b/offapi/com/sun/star/form/XLoadListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLoadListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,55 +76,64 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XLoadListener -/** receives "loaded" and - "unloaded" events posted by a loadable object. - - +/** receives load-related events from a loadable object. <p>The interface is typically implemented by data-bound components, which want to listen to the data source that contains their database - form. </p>@see com::sun::star::form::component::XLoadable + form.</p> + + @see com::sun::star::form::XLoadable + @see DataAwareControlModel */ interface XLoadListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadListener::loaded - /** is invoked when the object has successfully connected to - a datasource.@see XLoadable + /** is invoked when the object has successfully connected to a datasource. + + @param aEvent + the event happend. */ [oneway] void loaded( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadListener::unloading - /** is invoked when the object is about to be unloaded. Components may use - this to stop any other event processing related to the event source before - the object is unloaded.@see XLoadable + /** is invoked when the object is about to be unloaded. + <p>Components may use this to stop any other event processing related to + the event source before the object is unloaded.</p> + + @param aEvent + the event happend. */ [oneway] void unloading( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadListener::unloaded - /** is invoked after the object has disconnected from a datasource.@see XLoadable + /** is invoked after the object has disconnected from a datasource. + + @param aEvent + the event happend. */ [oneway] void unloaded( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadListener::reloading - /** is invoked when the object is about to be reloaded. Components may use - this to stop any other event processing related to the event source until - they get the reloaded event.@see XLoadable + /** is invoked when the object is about to be reloaded. + + <p>Components may use this to stop any other event processing related + to the event source until they get the reloaded event.</p> + + @param aEvent + the event happend. */ [oneway] void reloading( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadListener::reloaded - /** is invoked when the object has been reloaded.@see XLoadable + /** is invoked when the object has been reloaded. + + @param aEvent + the event happend. */ [oneway] void reloaded( [in] com::sun::star::lang::EventObject aEvent ); }; @@ -136,6 +145,18 @@ interface XLoadListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.3 2002/07/26 10:00:11 fs + IDL review form layer + + Revision 1.5.16.2 2002/02/18 15:20:26 oj + #96946# parameter,return value and exception description + + Revision 1.5.16.1 2002/02/18 14:49:31 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:08 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/form/XLoadable.idl b/offapi/com/sun/star/form/XLoadable.idl index 561d835b5a11..928b202f5b7a 100644 --- a/offapi/com/sun/star/form/XLoadable.idl +++ b/offapi/com/sun/star/form/XLoadable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLoadable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: fs $ $Date: 2001-05-18 12:37:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,52 +75,56 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XLoadable -/** interface provides functionality to implement objects which may be loaded. +/** provides functionality to implement objects which may be loaded. + + <p>The object is typically implemented by high-level objects which can connect to a data source.</p> + + @see XLoadListener */ interface XLoadable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::load - /** starts the data processing.@see XLoadListener + /** loads the data. */ [oneway] void load(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::unload - /** stops the data processing.@see XLoadListener + /** unloads the data. */ [oneway] void unload(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::reload - /** does a smart refresh of the object. The final state will be the same as if - unload and load were called, but reload is the more efficient way to do the same. - If the object isn't loaded, nothing happens.@see XLoadListener + /** does a smart refresh of the object. + + <p>The final state will be the same as if unload and load were called, but reload + is the more efficient way to do the same. If the object isn't loaded, nothing happens.</p> */ [oneway] void reload(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::isLoaded - /** returns if the object is in loaded state.@see XLoadListener + /** returns if the object is in loaded state. */ boolean isLoaded(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::addLoadListener - /** adds the specified listener to receive events "loaded" and "unloaded." + /** adds the specified listener to receive load-related events + + @param aListener + the listener to add. */ [oneway] void addLoadListener( [in] com::sun::star::form::XLoadListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XLoadable::removeLoadListener /** removes the specified listener. + + @param aListener + the listener to remove. */ [oneway] void removeLoadListener( [in] com::sun::star::form::XLoadListener aListener ); }; @@ -132,6 +136,15 @@ interface XLoadable: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.14.2 2002/07/26 10:00:12 fs + IDL review form layer + + Revision 1.5.14.1 2002/02/18 14:48:51 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/05/18 12:37:30 fs + #65293# corrected the include protection + Revision 1.4 2001/03/16 16:41:23 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/form/XPositioningListener.idl b/offapi/com/sun/star/form/XPositioningListener.idl index 01a3255a53be..a14ff665072b 100644 --- a/offapi/com/sun/star/form/XPositioningListener.idl +++ b/offapi/com/sun/star/form/XPositioningListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPositioningListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,11 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XPositioningListener -/** receives "positioned" events - posted by a database form. - - - - - - - - - - - +/** allows to receive notifications about cursor movements into a database form. + <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and + superseeded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> + service, as well as the <type scope="com::sun::star::sdbc">XRowSetListener</type>.</p> @deprecated */ @@ -98,8 +88,8 @@ interface XPositioningListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XPositioningListener::positioned - /** is invoked when the database form has been positioned on a data record.@see XDatabaseForm + /** is invoked when the database form has been positioned on a data record. + @see XDatabaseForm */ [oneway] void positioned( [in] com::sun::star::lang::EventObject aEvent ); @@ -112,6 +102,12 @@ interface XPositioningListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:12 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api diff --git a/offapi/com/sun/star/form/XReset.idl b/offapi/com/sun/star/form/XReset.idl index cb2e7d958c01..9abe54d80409 100644 --- a/offapi/com/sun/star/form/XReset.idl +++ b/offapi/com/sun/star/form/XReset.idl @@ -2,9 +2,9 @@ * * $RCSfile: XReset.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,30 +76,34 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XReset -/** provides functionality to reset components to their default values. +/** provides functionality to reset components to some default values. + + <p>The semantincs of <em>default value</em> depends on the providing service.</p> */ interface XReset: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XReset::reset - /** resets a component to its default value. + /** resets a component to some default value. */ [oneway] void reset(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XReset::addResetListener - /** adds the specified listener to receive the - "approveReset" and "reset" events. + /** adds the specified listener to receive events related to resetting the + component. + + @param aListener + the listener to add. */ [oneway] void addResetListener( [in] com::sun::star::form::XResetListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XReset::removeResetListener - /** removes the specified listener. + /** removes the specified listener + + @param aListener + the listener to remove */ [oneway] void removeResetListener( [in] com::sun::star::form::XResetListener aListener ); @@ -112,6 +116,15 @@ interface XReset: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:13 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:49:37 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XResetListener.idl b/offapi/com/sun/star/form/XResetListener.idl index 2a1a8245ed9f..e5e80a0b7066 100644 --- a/offapi/com/sun/star/form/XResetListener.idl +++ b/offapi/com/sun/star/form/XResetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResetListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,49 +76,40 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XResetListener -/** XResetListener" is the listener interface for - receiving "approveReset" and "resetted" events. - - +/** is the interface for receiving notificaions about reset events. <p>The listener is called if a component implementing the - <type>XReset</type> interface performs a reset. Before the - component performs the reset, "approveReset" is called from - the listener. Within "approveReset" you may check conditions - to prove if the reset should be executed or not, so you may - cancel the action. - + <type>XReset</type> interface performs a reset.</br> + Order of events: + <ul><li>a reset is triggered on a component</li> + <li>the component calls <member>XReset::approveReset</member> on all its listeners</li> + <li>if all listeners approve the reset operation, the data is reset</li> + <li>the component calls <member>XReset::resetted</member> on all its listeners</li> + </ul> </p> - <p>The events occur in the following order: - </p> - <pre> - reset -&gt; "approveReset -&gt; "perform reset" -&gt; "resetted" - <pre> - - </pre> - </pre>@see XReset + @see XReset */ interface XResetListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XResetListener::approveReset - /** is invoked before resetting a component. - + /** is invoked before a component is reset. + @param rEvent + the event happend. - <p>This action may be cancelled. - - </p> + @returns + <TRUE/> when reset was approved, <FALSE/> when the reset operation should be cancelled. */ boolean approveReset( [in] com::sun::star::lang::EventObject rEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XResetListener::resetted - /** is invoked when a component is reset. + /** is invoked when a component has been reset. + + @param rEvent + the event happend. */ [oneway] void resetted( [in] com::sun::star::lang::EventObject rEvent ); @@ -131,6 +122,15 @@ interface XResetListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:13 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:50:23 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XRestoreListener.idl b/offapi/com/sun/star/form/XRestoreListener.idl index 0f83bf7f68ad..f6c337b0a6fc 100644 --- a/offapi/com/sun/star/form/XRestoreListener.idl +++ b/offapi/com/sun/star/form/XRestoreListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRestoreListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,25 +76,15 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XRestoreListener -/** receives "restored" events - posted by a database form. - - - - <p>A "restore" is typically called when the user cancels updating the - current record without saving the data. After restoring, the user - operates on the original data. - - </p> - - - - - - +/** receives notifications about data beeing restored. + <p>Such a notification is typically sent when the user cancels updating the + current record of a <type scope="com:.sun::star::form::component">DatabaseForm</type> + without saving the data. After restoring, the user operates on the original data.</p> + <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and + superseeded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> + and <type scope="com::sun::star::sdb">RowSet</type> services</p> @deprecated */ @@ -102,8 +92,7 @@ interface XRestoreListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XRestoreListener::restored - /** is invoked when a modified record should be restored.@see XDatabaseForm + /** is invoked when a modified record has been restored */ void restored( [in] com::sun::star::lang::EventObject aEvent ); @@ -116,6 +105,12 @@ interface XRestoreListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/07/26 10:00:14 fs + IDL review form layer + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XSubmit.idl b/offapi/com/sun/star/form/XSubmit.idl index b3112aaef1a0..34623e8a4381 100644 --- a/offapi/com/sun/star/form/XSubmit.idl +++ b/offapi/com/sun/star/form/XSubmit.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubmit.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,39 +84,47 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XSubmit -/** provides functionality to submit a component. - This is used in common by forms. +/** provides functionality to submit data from a component. + <p>Usually, this is used by <type scope="com::sun::star::form::component">HTMLForm</type>s. - - <p>When a form is submitted, the data contained in the form is sent - to the target URL as a series of name/value pairs. The name portion - of each pair is the name of a form component as specified by its NAME - attribute. In most cases the value portion is the value displayed - by the element, for example, the text displayed in a text field.</p> + <p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A> + to learn about submitting forms.</p> */ interface XSubmit: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XSubmit::submit - /** submits the component to a specified target. + /** submits the component's data to a specified target. + + @param aControl + the control which's data is to be be submitted + + @param aMouseEvt + the event which triggered the submit, if it was a mouse event + + @see com::sun::star::awt::MouseEvent */ [oneway] void submit( [in] com::sun::star::awt::XControl aControl, [in] com::sun::star::awt::MouseEvent aMouseEvt ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XSubmit::addSubmitListener /** adds the specified listener to receive the "approveSubmit" event. + + @param aListener + the listener to add. + + @see com::sun::star::form::XSubmitListener */ [oneway] void addSubmitListener( [in] com::sun::star::form::XSubmitListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XSubmit::removeSubmitListener /** removes the specified listener. + @param aListener + the listener to remove. + @see com::sun::star::form::XSubmitListener */ [oneway] void removeSubmitListener( [in] com::sun::star::form::XSubmitListener aListener ); @@ -129,6 +137,15 @@ interface XSubmit: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:14 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:49:13 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl index a3e7a44ec3de..4d6a3e5d9224 100644 --- a/offapi/com/sun/star/form/XSubmitListener.idl +++ b/offapi/com/sun/star/form/XSubmitListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubmitListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,24 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XSubmitListener -/** receives the "approveSubmit" event. - - +/** receives notifications about data beeing submitted. <p>The submission may be cancelled, so the listener has the possibility - of verifying the data before submission. + of verifying the data before submission.</p> - </p>@see XSubmit + @see XSubmit */ interface XSubmitListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XSubmitListener::approveSubmit - /** is invoked when a component is submitted. + /** is invoked when a component is about to submit it's data. + + @param aEvent + the event happend + + @returns + <TRUE/> when submitting was approved, otherwise <FALSE/>. */ boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent ); @@ -104,6 +106,15 @@ interface XSubmitListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:15 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:49:25 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XUpdateBroadcaster.idl b/offapi/com/sun/star/form/XUpdateBroadcaster.idl index ca893930d88a..67ea20b64693 100644 --- a/offapi/com/sun/star/form/XUpdateBroadcaster.idl +++ b/offapi/com/sun/star/form/XUpdateBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUpdateBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,23 +76,33 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XUpdateBroadcaster -/** is the listener interface for receiving "approveUpdate" and "updated" events. +/** is the broadcaster interface for sending "approveUpdate" and "updated" events. + + <p>The component supporting this interface must do approval calls + (<member>XUpdateListener::approveUpdate</member>) immediately + before the data is updated, and notification calls + (<member>XUpdateListener::updated</member>) immediately afterwards.</p> + + @see XUpdateListener */ interface XUpdateBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XUpdateBroadcaster::addUpdateListener /** adds the specified listener to receive the events "approveUpdate" - and "updated." + and "updated". + @param aListener + the listener to add. + @see com::sun::star::form::XUpdateListener */ [oneway] void addUpdateListener( [in] com::sun::star::form::XUpdateListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XUpdateBroadcaster::removeUpdateListener /** removes the specified listener. + @param aListener + the listener to remove. + @see com::sun::star::form::XUpdateListener */ [oneway] void removeUpdateListener( [in] com::sun::star::form::XUpdateListener aListener ); @@ -105,6 +115,15 @@ interface XUpdateBroadcaster: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/07/26 10:00:15 fs + IDL review form layer + + Revision 1.4.16.1 2002/02/18 14:50:36 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:53 mi moved from api diff --git a/offapi/com/sun/star/form/XUpdateListener.idl b/offapi/com/sun/star/form/XUpdateListener.idl index cccdaff4ee5c..ceb042c8f059 100644 --- a/offapi/com/sun/star/form/XUpdateListener.idl +++ b/offapi/com/sun/star/form/XUpdateListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUpdateListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,36 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XUpdateListener -/** receives "approveUpdate" and - "updated" events posted by objects which allow controlling - the updating of its data. +/** used to listen on objects which allow updating their data. + <p>In addition to just get notified when an data update happened, the listener + has a chance to veto updates <em>before</em> they happen.</p> - - - <p> "approveUpdate" may be used to abort the updating of the current data - record. The events are posted in the following order:<br> - "changing data" -&gt; approveUpdate -&gt; "do update" -&gt; updated </p>@see com::sun::star::form::component::DatabaseForm + @see XUpdateBroadcaster */ interface XUpdateListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XUpdateListener::approveUpdate /** is invoked to check the current data. + + <p>For a given update process, if one of the <type>XUpdateListener</type>s + vetos the change, the update is canceled, and no further notification happens.</p> + + @param aEvent + An event dedscriptor specifying the broadcaster of the change. + + @returns + <TRUE/> when the update was approved, otherwise <FALSE/>. */ boolean approveUpdate( [in] com::sun::star::lang::EventObject aEvent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XUpdateListener::updated /** is invoked when an object has finished processing the updates and - the data has been successfully written to the data source. + the data has been successfully written. + + @param aEvent + A event dedscriptor specifying the broadcaster of the change. */ void updated( [in] com::sun::star::lang::EventObject aEvent ); @@ -113,6 +118,18 @@ interface XUpdateListener: com::sun::star::lang::XEventListener /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.3 2002/07/26 10:00:16 fs + IDL review form layer + + Revision 1.5.16.2 2002/02/18 15:23:19 oj + #96946# parameter,return value and exception description + + Revision 1.5.16.1 2002/02/18 14:51:48 oj + #96946# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:08 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/form/component/CheckBox.idl b/offapi/com/sun/star/form/component/CheckBox.idl index e57db12c9c91..eafe5cde1623 100644 --- a/offapi/com/sun/star/form/component/CheckBox.idl +++ b/offapi/com/sun/star/form/component/CheckBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: CheckBox.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: fs $ $Date: 2001-11-07 15:10:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,8 +61,8 @@ #ifndef __com_sun_star_form_component_CheckBox_idl__ #define __com_sun_star_form_component_CheckBox_idl__ -#ifndef __com_sun_star_form_DataAwareControlModel_idl__ -#include <com/sun/star/form/DataAwareControlModel.idl> +#ifndef __com_sun_star_form_FormControlModel_idl__ +#include <com/sun/star/form/FormControlModel.idl> #endif #ifndef __com_sun_star_awt_UnoControlCheckBoxModel_idl__ @@ -80,33 +80,41 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::CheckBox -/** specifies a check box extended by the required properties for HTML. +/** specifies the model of a check box control + + <p>The model supports the properties required for HTML, thus you can build up + <type>HTMLForm</type>s with it</p> */ service CheckBox { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlCheckBoxModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default state. + + @see CheckBox::DefaultState + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::CheckBox::DefaultState - /** contains a default value for the check box. + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> + + @see com::sun::star::awt::UnoControlCheckBoxModel::State + @see com::sun::star::form::XReset */ [property] short DefaultState; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR CheckBox::RefValue - // DocMerge from xml: property com::sun::star::form::component::CheckBox::RefValue /** contains a reference value which is used for submission in a HTML - form, if the checkbox is checked. + form + + <p>When submitting a <type>HTMLForm</type> which contains a check box, + which is checked, the RefValue is used for submission. */ [property] string RefValue; @@ -119,6 +127,18 @@ service CheckBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.3 2002/07/26 09:49:06 fs + IDL review form layer + + Revision 1.4.2.2 2002/02/18 15:23:21 oj + #96946# parameter,return value and exception description + + Revision 1.4.2.1 2002/02/18 14:55:47 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/11/07 15:10:53 fs + the CheckBox is no DataAwareControlModel, but a FormControlModel + =============================================================================*/ #endif diff --git a/offapi/com/sun/star/form/component/ComboBox.idl b/offapi/com/sun/star/form/component/ComboBox.idl index 1c3037dd34d0..ab18fdbb58bd 100644 --- a/offapi/com/sun/star/form/component/ComboBox.idl +++ b/offapi/com/sun/star/form/component/ComboBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: ComboBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,8 @@ #include <com/sun/star/awt/UnoControlComboBoxModel.idl> #endif -#ifndef __com_sun_star_form_DataAwareControlModel_idl__ -#include <com/sun/star/form/DataAwareControlModel.idl> +#ifndef __com_sun_star_form_FormControlModel_idl__ +#include <com/sun/star/form/FormControlModel.idl> #endif #ifndef __com_sun_star_form_XReset_idl__ @@ -80,27 +80,27 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::ComboBox /** specifies a component which allows the input of text or selection of text from a list of text values. */ service ComboBox { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlComboBoxModel; - // DocMerge: empty anyway - service com::sun::star::form::DataAwareControlModel; + service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default text. + + @see ComboBox::DefaultText + */ interface com::sun::star::form::XReset; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ComboBox::DefaultText + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> - // DocMerge from xml: property com::sun::star::form::component::ComboBox::DefaultText - /** specifies the default text for the component, which is initially displayed - or used to reset the component. + @see com::sun::star::awt::UnoControlComboBoxModel::Text + @see com::sun::star::form::XReset */ [property] string DefaultText; }; @@ -112,6 +112,18 @@ service ComboBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:06 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:22:36 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:55:51 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/CommandButton.idl b/offapi/com/sun/star/form/component/CommandButton.idl index 91451c4e7907..a4e6f140eb2e 100644 --- a/offapi/com/sun/star/form/component/CommandButton.idl +++ b/offapi/com/sun/star/form/component/CommandButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: CommandButton.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,48 +88,48 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::CommandButton -/** This service specifies the ControlModel for a clickable button which - may be represented by an image. +/** specifies the a control model for a clickable button which is part of a form + component hierarchy. + + @see ImageButton */ service CommandButton { - // DocMerge: empty anyway + service com::sun::star::awt::UnoControlButtonModel; + service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway - service com::sun::star::awt::UnoControlButtonModel; + /** supplies the image producer when the button is to display an image. + <p>If the <member scope="com::sun::star::awt">UnoButtonControlModel::ImageURL</member> points to the location of an + image to be displayed on the button, this interface can be used to retrieve an image + producer, which itself will supply the image.</p> - // DocMerge from xml: service com::sun::star::form::component::CommandButton: interface com::sun::star::form::XImageProducerSupplier - /** is necessary if you want to display images - on a button. + <p>Usually, a control belonging to the model will use this interface to obtain the + image to be painted</p> */ interface com::sun::star::form::XImageProducerSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::CommandButton::ButtonType - /** The ButtonType describes the default action executed by the button. + /** describes the action to be executed by the button when pressed. */ [property] com::sun::star::form::FormButtonType ButtonType; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR CommmandButton::TargetFrame - - // DocMerge from xml: property com::sun::star::form::component::CommandButton::TargetFrame /** describes the frame, where to open the document specified by the TargetURL. + + <p>This property is evaluated if the button is of type URL.</p> + + <p>As always, there is a number of target names which have a special meaning, and force + a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> */ [property] string TargetFrame; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR CommmandButton::TargetURL - // DocMerge from xml: property com::sun::star::form::component::CommandButton::TargetURL /** specifies the URL, which should be opened if the button was clicked. + <p>This property is evaluated if the button is of type URL.</p> - <p> This property is evaluated if the button is of type URL. - </p>@see com::sun::star::form::FormButtonType + @see com::sun::star::form::FormButtonType */ [property] string TargetURL; }; @@ -141,6 +141,12 @@ service CommandButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:07 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/CurrencyField.idl b/offapi/com/sun/star/form/component/CurrencyField.idl index 27b5ccfdfa92..1b6b1f3ba5e2 100644 --- a/offapi/com/sun/star/form/component/CurrencyField.idl +++ b/offapi/com/sun/star/form/component/CurrencyField.idl @@ -2,9 +2,9 @@ * * $RCSfile: CurrencyField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,8 @@ #include <com/sun/star/awt/UnoControlCurrencyFieldModel.idl> #endif -#ifndef __com_sun_star_form_DataAwareControlModel_idl__ -#include <com/sun/star/form/DataAwareControlModel.idl> +#ifndef __com_sun_star_form_FormControlModel_idl__ +#include <com/sun/star/form/FormControlModel.idl> #endif #ifndef __com_sun_star_form_XReset_idl__ @@ -80,25 +80,25 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::CurrencyField /** This service specifies the ControlModel for an edit field which contains a currency value. */ service CurrencyField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlCurrencyFieldModel; - // DocMerge: empty anyway - service com::sun::star::form::DataAwareControlModel; + service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default state. + + @see CurrencyField::DefaultValue + */ interface com::sun::star::form::XReset; - //------------------------------------------------------------------------- + /** contains a default value for the control. - // DocMerge from xml: property com::sun::star::form::component::CurrencyField::DefaultValue - /** returns the default value used by reset. + @see com::sun::star::awt::UnoControlCurrencyFieldModel::Value + @see com::sun::star::form::XReset */ [property] double DefaultValue; @@ -111,6 +111,18 @@ service CurrencyField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:07 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:22:51 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:56:03 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl index ee066d23e2c7..4c546048de5d 100644 --- a/offapi/com/sun/star/form/component/DataForm.idl +++ b/offapi/com/sun/star/form/component/DataForm.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataForm.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: fs $ $Date: 2001-05-16 08:37:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,13 +81,20 @@ #include <com/sun/star/form/XLoadable.idl> #endif +#ifndef __com_sun_star_sdb_XCompletedExecution_idl__ +#include <com/sun/star/sdb/XCompletedExecution.idl> +#endif +#ifndef __com_sun_star_awt_TabControllerModel_idl__ +#include <com/sun/star/awt/TabControllerModel.idl> +#endif //============================================================================= module com { module sun { module star { module form { interface XReset; +interface XDatabaseParameterBroadcaster; module component { //============================================================================= @@ -97,30 +104,62 @@ module component { <p>A database form is a special kind of enhanced database row set which provides all information for displaying the data and has more - possibilities for configuring the data manipulation. + possibilities for configuring the data manipulation.</p> */ service DataForm { - service com::sun::star::form::component::Form; service com::sun::star::sdb::RowSet; + service com::sun::star::form::component::Form; + /** is used to initialize a data row which should be inserted. + + TODO: define the conditions under which forms and controls are (or should be) reset */ interface com::sun::star::form::XReset; /** used to load/unload the form <p>Loading a form is basically the same as executing the underlying row set. In fact, all the functionality of this interface could be simulated by using setting some properties manually, - <method scope="com.sun.star.sdbc">XRowSet::execute</method>, moving the row set cursor and so on.</p> + <method scope="com::sun::star::sdbc">XRowSet::execute</method>, moving the row set cursor and so on.</p> - <p>One main difference between <method>XLoadable::load</method> and <method scope="com.sun.star.sdbc">XRowSet::execute</method> + <p>One main difference between <method>XLoadable::load</method> and <method scope="com::sun::star::sdbc">XRowSet::execute</method> is that if you use the former, the row set is positioned on the first record, while in the latter case it is position <em>before</em> the it.</p> */ interface com::sun::star::form::XLoadable; + /** can be used to allow an interaction handler to supply missing data during a load process. + + <p>If data is needed during loading a form, then this is usually obtained via broadcaster-listener + mechanisms. An example for this (and currently the only one) are parameter values.</p> + <p>However, if you use this method, you can pass an interaction handler which should supply these + additional data.</p> + + @see com::sun::star::sdb::InteractionHandler + */ + interface com::sun::star::sdb::XCompletedExecution; + + /** can be used for filling parameters. + + <p>You can add your component as + <type scope="com::sun::star::form">XDatabaseParameterListener</type> + to a form to get notified whenever the form needs parameter values to be filled in<br/> + In a first approach, the form tries to fill any parameters from it's master-detail relation + (if any). All values which can't be filled are then passed to all listeners, which can + fill them by their own choice.</p> + + <p>This is sligtly changed if the form is loaded using the + <member>XCompletedExecution::connectWithCompletion</member> method. In this case, the parameters + are obtained from the interaction handler, not from the listeners</p> + + @see XCompletedExecution + @see MasterFields + @see DetailFields + */ + interface com::sun::star::form::XDatabaseParameterBroadcaster; + //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DatabaseForm::MasterFields /**is used for subforms and contains the names of columns of the parent form. <p> These columns are typically the foreign key fields of the parent form. The values of theses columns are used to identify the data for the subform. @@ -130,7 +169,6 @@ service DataForm [property] sequence<string> MasterFields; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DatabaseForm::DetailFields /**is used for subforms and contains the names of the columns of the subform which are related to the master fields of the parent form. <p> These columns represent typically a part of the primary key fields or their aliases @@ -145,22 +183,37 @@ service DataForm [property] com::sun::star::form::TabulatorCycle Cycle; //------------------------------------------------------------------------- - /** How to use a NavigationBar? + /** determines how an navigation bar for this form should act. */ [property] com::sun::star::form::NavigationBarMode NavigationBarMode; //------------------------------------------------------------------------- - /** Are insertions of new records allowed? + /** determines if insertions into the form's row set are allowed. + + <p>Note that this is a recommendation for user interface components displaying the + form. Form implementations may decide to allow for insertions done via the API, even + if the property is set to <FALSE/>, but the user interface should respect the property + value.</p> */ [property] boolean AllowInserts; //------------------------------------------------------------------------- - /** Are modifications of the current record allowed? + /** determines if modifications of the current record of the form are allowed. + + <p>Note that this is a recommendation for user interface components displaying the + form. Form implementations may decide to allow for updates done via the API, even + if the property is set to <FALSE/>, but the user interface should respect the property + value.</p> */ [property] boolean AllowUpdates; //------------------------------------------------------------------------- - /** Are deletions of records allowed? + /** determines if deletions of records of the form are allowed. + + <p>Note that this is a recommendation for user interface components displaying the + form. Form implementations may decide to allow for deletions done via the API, even + if the property is set to <FALSE/>, but the user interface should respect the property + value.</p> */ [property] boolean AllowDeletes; }; diff --git a/offapi/com/sun/star/form/component/DatabaseCheckBox.idl b/offapi/com/sun/star/form/component/DatabaseCheckBox.idl index ec94c0198f85..5ffd02f00c7c 100644 --- a/offapi/com/sun/star/form/component/DatabaseCheckBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseCheckBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseCheckBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseCheckBox -/** This service specifies a data-aware CheckBox. +/** This service specifies a check box which is data-aware, and can be bound to a database field. + <p>Mostly, you will create data-aware checkboxes as tristate checkboxes, because this + is a requirement to correctly handle <NULL/> values in databases.</p> - - <p>Data-aware checkboxes should always be used as tristate - check boxes because only tryistate boxes can handle NULL values. - </p> + @see ::com::sun::star::awt::UnoControlCheckBoxModel::TriState */ service DatabaseCheckBox { - // DocMerge: empty anyway service com::sun::star::form::component::CheckBox; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -102,6 +98,15 @@ service DatabaseCheckBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/07/26 09:49:08 fs + IDL review form layer + + Revision 1.3.24.1 2002/02/19 08:46:43 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseComboBox.idl b/offapi/com/sun/star/form/component/DatabaseComboBox.idl index 15782791fef5..df55d28c66e0 100644 --- a/offapi/com/sun/star/form/component/DatabaseComboBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseComboBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseComboBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,38 +80,45 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseComboBox -/** This service specifies a data-aware ComboBox. +/** This service specifies a combo box which is data-aware, and can be bound to a database field. + + <p>Like most other data aware controls, such a combo box will display the actual content + of the field it is bound to. In addition, as a combo box contains a list where the user + can choose items to fill into the control, this list can be filled with different data from + a database, too.</p> */ service DatabaseComboBox { - // DocMerge: empty anyway service com::sun::star::form::component::ComboBox; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseComboBox::ConvertEmptyToNull - /** determines if an empty text should be regarded as a NULL value. + /** determines if an empty text should be treated as a <NULL/> value. + + <p>When the user enters text into a combo box, and after this, the control + content is to be committed into the database field the control is bound to, + a decision must be made how to deal with empty strings.<br/> + This is controlled by <member>ConvertEmptyToNull</member>.</p> + + <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is + converted into <NULL/>, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DatabaseComboBox::ListSource - // DocMerge from xml: property com::sun::star::form::component::DatabaseComboBox::ListSource - /** describes the data for the ComboBox entries. This could be e.g. a - SQL-Statement. + /** describes the source of items in the combo box' list. + + <p>The concrete meaning of this property depends on the value of <member>ListSourceType</member></p> */ [property] string ListSource; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseComboBox::ListSourceType /** specifies the kind of list source. - - <p>A value list is not allowed for a combobox.</p> + <p>Note: A value of <member scope="com::sun::star::form">ListSourceType::VALUELIST</member> + is not valid for a combo box. It won't be rejected when setting it, but controls will usually ignore it + and leave the list empty.</p> */ [property] com::sun::star::form::ListSourceType ListSourceType; }; @@ -123,6 +130,15 @@ service DatabaseComboBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/07/26 09:49:08 fs + IDL review form layer + + Revision 1.3.24.1 2002/02/19 08:46:48 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseCurrencyField.idl b/offapi/com/sun/star/form/component/DatabaseCurrencyField.idl index 9660a839d951..6a092d307a76 100644 --- a/offapi/com/sun/star/form/component/DatabaseCurrencyField.idl +++ b/offapi/com/sun/star/form/component/DatabaseCurrencyField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseCurrencyField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseCurrencyField -/** This service specifies a data-aware currency field. +/** This service specifies a currency field which is data-aware, and can be bound to a database field. */ service DatabaseCurrencyField { - // DocMerge: empty anyway service com::sun::star::form::component::CurrencyField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -96,6 +93,12 @@ service DatabaseCurrencyField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:09 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseDateField.idl b/offapi/com/sun/star/form/component/DatabaseDateField.idl index a1125da5c819..19433177df2f 100644 --- a/offapi/com/sun/star/form/component/DatabaseDateField.idl +++ b/offapi/com/sun/star/form/component/DatabaseDateField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseDateField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseDateField -/** This service specifies a data-aware date field. +/** This service specifies a date field which is data-aware, and can be bound to a database field. */ service DatabaseDateField { - // DocMerge: empty anyway service com::sun::star::form::component::DateField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -96,6 +93,12 @@ service DatabaseDateField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:09 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseFormattedField.idl b/offapi/com/sun/star/form/component/DatabaseFormattedField.idl index e09b072ea6a2..e685e11c7bad 100644 --- a/offapi/com/sun/star/form/component/DatabaseFormattedField.idl +++ b/offapi/com/sun/star/form/component/DatabaseFormattedField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseFormattedField.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: fs $ $Date: 2001-02-20 13:35:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,25 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseFormattedField -/** This service specifies a data-aware FormattedField. +/** This service specifies a formatted field model which is data-aware, and can be bound to a database field. */ service DatabaseFormattedField { - /** provides the basic functionality for a formatted field. - */ service com::sun::star::form::component::FormattedField; - /** provides the functionality to bind the field to a database field. - */ service com::sun::star::form::DataAwareControlModel; //------------------------------------------------------------------------- - /** determines if empty text should be regarded as a NULL value. + /** determines if an empty text should be treated as a <NULL/> value. + + <p>When the user enters text into a formatted field control, and after this, the control + content is to be committed into the database field the control is bound to, + a decision must be made how to deal with empty strings.<br/> + This is controlled by <member>ConvertEmptyToNull</member>.</p> + + <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is + converted into <NULL/>, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; @@ -104,6 +107,15 @@ service DatabaseFormattedField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.18.2 2002/07/26 09:49:10 fs + IDL review form layer + + Revision 1.1.18.1 2002/02/19 08:46:05 oj + #96946# parameter,return value and exception description + + Revision 1.1 2001/02/20 13:35:26 fs + initial checkin - service description for a data aware formatted field + =============================================================================*/ #endif diff --git a/offapi/com/sun/star/form/component/DatabaseImageControl.idl b/offapi/com/sun/star/form/component/DatabaseImageControl.idl index bc66f83f83fd..302c9e4f0c1e 100644 --- a/offapi/com/sun/star/form/component/DatabaseImageControl.idl +++ b/offapi/com/sun/star/form/component/DatabaseImageControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseImageControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: fs $ $Date: 2001-01-23 16:05:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,27 +80,70 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseImageControl -/** returns control for displaying images stored in a database. +/** specifies the model of a control used for displaying images stored in a database. + + <p>As every <type scope="com::sun::star::form">DataAwareControlModel</type>, an image control + can be bound to a database field. This means that for instance with every record change, the content + of the database field is taken, interpreted as image, and displayed in the control.<br/> + Unlike other more text-based controls, it does not interpret the content of the field as text or double, + but as binary stream (see <member scope="com::sun::star::sdb">XColumn::getBinaryStream</member>).</p> + + <p>Usually, an image control model can be bound to binary columns only, namely + <member scope="com::sun::star::sdbc">DataType::BINARY</member>, + <member scope="com::sun::star::sdbc">DataType::VARBINARY</member>, + <member scope="com::sun::star::sdbc">DataType::LONGVARBINARY</member>, + <member scope="com::sun::star::sdbc">DataType::OTHER</member>, + <member scope="com::sun::star::sdbc">DataType::LONGVARCHAR</member></p> + + <p/> + + <p>Note that besides taking the image to be displayed from the bound field, there is another option. The + <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> property specifies + the URL of an image to be displayed. If this property is changed from outside, the respective file + is loaded and set as image source.</p> + + <p>In a usual data form, the scenario will be as follows: + <ul><li>There is a DatabaseImageControl as part of the document model, which acts as + control model for an <type scope="com::sun::star::form::control">ImageControl</type>.</li> + + <li>The control is an <type scope="com::sun::star::awt">XImageConsumer</type> for the + <type scope="com::sun::star::awt">XImageProducer</type> supplied by the model.</li> + + <li>Whenever the form's cursor is positioned on a new record, the column the control + model is bound to is examined for a binary data stream. This stream is set as source + at the image producer, which notifies it's consumers, which leads to the control + displaying the image.</li> + + <li>When the user by some interaction tells the control to contain a new image, this is + exchanged by URL. For example, implementations of the control service may allow the user + to browse for image. After this, the URL of the image is set as + <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + property at the model.<br/> + Now the control loads the image determined by the property value, and starts producing + a new data stream, which is displayed by the control (which is a consumer for this stream).<br/> + From now on, the control and thus the database record counts as modified. If the cursor of the + form is moved further, the modified record is saved, means the content of the image pointed to + by <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + is saved into the column.</li> + </ul> + </p> */ service DatabaseImageControl { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlImageControlModel; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; + /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. - // DocMerge from xml: service com::sun::star::form::component::DatabaseImageControl: interface com::sun::star::form::XImageProducerSupplier - /** is necessary for displaying images. + <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + at this producer. Then they will be notified of any change in the image to be displayed.</p> */ interface com::sun::star::form::XImageProducerSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseImageControl::IsReadOnly - /** Is it possible to set new images? + /** indicates if it is possible to change the image being displayed. */ [property] boolean ReadOnly; @@ -113,6 +156,12 @@ service DatabaseImageControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/07/26 09:49:11 fs + IDL review form layer + + Revision 1.4 2001/01/23 16:05:23 fs + #82676# corrected the property name for readonly + Revision 1.3 2000/11/08 12:43:10 mi moved from api diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl index 3e11d27651cd..da5db7dd59e4 100644 --- a/offapi/com/sun/star/form/component/DatabaseListBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseListBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,51 +80,107 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseListBox -/** This service specifies a data-aware ListBox. +/** This service specifies a data-aware list box control model. + + <p>The base service for list boxes (<type>ListBox</type>) offers only + one possibility to specify the list entries: the <member>ListBox::ListSource</member> + property, which contains all the strings to be displayed.</p> + + <p>This service here extends this mimic. It allows to fill the list from a data source. + This means that a second result set is opened, which works on the same connection as the + form which the list box belongs to, but can be based on an arbitrary table or SQL statement.</p> + + <p>For instance, you may have a form which is bound to a table <em>invoice</em>, and you use it + to enter invoices for your customers. Probably, you will have a second table (say <em>customer</em>), + which (amonst other data) contains a unique key for identifying customers. In your invoice table, you will + have a foreign key referring to these customers.<br/> + Now, besides the result set the form is based on (all your invoices), the list box can be caused + to open a second result set, this time for the <em>customer</em> table, and fill it's list with entries + from this result set.<br/> + Additionally, it allows to model the relation between the two tables: When the user selects a customer from + the list, this customer has the unique id we just talked about (which is not necessarily visible to the + user in any way). The list box then automatically transfers this id into the foreign key column of + <em>invoice</em>, thus allowing the user to transparently work with human-readable strings instead of + pure numbers.<br/> + Let's call this result set the list is filled from the <em>list result set</em> here ...</p> + */ service DatabaseListBox { - // DocMerge: empty anyway service com::sun::star::form::component::ListBox; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseListBox::BoundColumn - /** When you make a selection from a list box, the "BoundColumn" + /** specifies which column of the list result set should be used for data exchange. + + <p>When you make a selection from a list box, the "BoundColumn" property reflects which column value of a result set should be used as the value of the component. If the control is bound to a database field, the column value is stored in the - database field identified by the property "DataField". + database field identified by the property + <member scope="com::sun::star::form">DataAwareControlModel::DataField</member>. <dl> - <dt>0 - </dt> - <dd>The selected (displayed) list box string is stored in - the current database field. - - </dd> - <dt>1 or greater - </dt> - <dd>The column value of the result set at the position is - stored in the current database field. - </dd> - </dl> - - The bound column property is only used if a list source is defined - and the list source matches with the types TABLE, QUERY, SQL or - SQLPASSTHROUGH. Otherwise the property is ignored, as there is - no result set from which to get the column values. - */ + <dt>0</dt> + <dd>The selected (displayed) list box string is stored in + the current database field.</dd> + + <dt>1 or greater</dt> + <dd>The column value of the result set at the position is + stored in the current database field.</dd> + </dl></p> + + <p>The bound column property is only used if a list source is defined + and the list source matches with the types + <member scope="com::sun::star::form">ListSourceType::TABLE</member>, + <member scope="com::sun::star::form">ListSourceType::QUERY</member>, + <member scope="com::sun::star::form">ListSourceType::SQL</member> or + <member scope="com::sun::star::form">ListSourceType::SQLPASSTHROUGH</member>. + Otherwise the property is ignored, as there is no result set from which to + get the column values.</p> + */ [property] short BoundColumn; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseListBox::ListSourceType /** describes the kind of list source used. + + <p>Depending on the value of this property, the way the value of <member>ListBox::ListSource</member> + is evaluated varies. + <dl> + <dt><member scope="com::sun::star::form">ListSourceType::VALUELIST</member></dt> + <dd>The elements in the string sequence in <member>ListBox::ListSource</member> + build up the entry list.</dd> + + <dt><member scope="com::sun::star::form">ListSourceType::TABLE</member></dt> + <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + determines the table which the list result set should be based on.</dd> + + <dt><member scope="com::sun::star::form">ListSourceType::QUERY</member></dt> + <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + determines the query which the list result set should be based on.<br/> + For retrieving the query, the connection which the data form is working with + (<member scope="com::sun::star::sdb">RowSet::ActiveConnection</member>) is queried for + the <type scope="com::sun::star::sdb">XQueriesSupplier</type> interface.</dd> + + <dt><member scope="com::sun::star::form">ListSourceType::SQL</member></dt> + <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + contains the SQL statement which the list result set should be based on.</p> + + <dt><member scope="com::sun::star::form">ListSourceType::SQLPASSTHROUGH</member></dt> + <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + contains the SQL statement which the list result set should be based on.<br/> + The statement is not analyzed by the parser. This means that you can use database specific + SQL features here, but, on the other hand, loose features like parameter value substitution.</dd> + + <dt><member scope="com::sun::star::form">ListSourceType::TABLEFIELDS</member></dt> + <dd>The first element of the string sequence in <member>ListBox::ListSource</member> + determines the table which's column names should fill the list.</dd> + </dl> + </p> + */ [property] com::sun::star::form::ListSourceType ListSourceType; @@ -137,6 +193,12 @@ service DatabaseListBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:11 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseNumericField.idl b/offapi/com/sun/star/form/component/DatabaseNumericField.idl index 125eb9ec6c25..c0e4b088b408 100644 --- a/offapi/com/sun/star/form/component/DatabaseNumericField.idl +++ b/offapi/com/sun/star/form/component/DatabaseNumericField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseNumericField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseNumericField -/** This service specifies a data-aware numeric field. +/** This service specifies a numeric field which is data-aware, and can be bound to a database field. */ service DatabaseNumericField { - // DocMerge: empty anyway service com::sun::star::form::component::NumericField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -96,6 +93,12 @@ service DatabaseNumericField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:12 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabasePatternField.idl b/offapi/com/sun/star/form/component/DatabasePatternField.idl index 875007ece29a..8dd7a388f4a2 100644 --- a/offapi/com/sun/star/form/component/DatabasePatternField.idl +++ b/offapi/com/sun/star/form/component/DatabasePatternField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabasePatternField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabasePatternField -/** This service specifies a data-aware pattern field. +/** This service specifies a data-aware control model for entering text which matches a specific + pattern. */ service DatabasePatternField { - // DocMerge: empty anyway service com::sun::star::form::component::PatternField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabasePatternField::ConvertEmptyToNull - /** determines if an empty textshould be regarded as a NULL value. + /** determines if an empty text should be treated as a <NULL/> value. + + <p>When the user enters text into a pattern field, and after this, the control + content is to be committed into the database field the control is bound to, + a decision must be made how to deal with empty strings.<br/> + This is controlled by this property.</p> + + <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is + converted into <NULL/>, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; @@ -103,6 +108,15 @@ service DatabasePatternField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/07/26 09:49:12 fs + IDL review form layer + + Revision 1.3.24.1 2002/02/19 08:45:03 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseRadioButton.idl b/offapi/com/sun/star/form/component/DatabaseRadioButton.idl index 67f2edd04a62..2a2c044ba701 100644 --- a/offapi/com/sun/star/form/component/DatabaseRadioButton.idl +++ b/offapi/com/sun/star/form/component/DatabaseRadioButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseRadioButton.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,19 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseRadioButton -/** This service specifies a data-aware radio button. - - - - <p>It should only be used in a group of radio buttons.</p> +/** This service specifies a radio button which is data-aware, and can be bound to a database field. */ service DatabaseRadioButton { - // DocMerge: empty anyway service com::sun::star::form::component::RadioButton; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -100,6 +93,12 @@ service DatabaseRadioButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:13 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:18 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseTextField.idl b/offapi/com/sun/star/form/component/DatabaseTextField.idl index fa7a2628b805..d07e2ec39544 100644 --- a/offapi/com/sun/star/form/component/DatabaseTextField.idl +++ b/offapi/com/sun/star/form/component/DatabaseTextField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseTextField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,25 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseTextField -/** This service specifies a data-aware TextField. +/** This service specifies a text field which is data-aware, and can be bound to a database field. */ service DatabaseTextField { - // DocMerge: empty anyway service com::sun::star::form::component::TextField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DatabaseTextField::ConvertEmptyToNull - /** determines if empty text should be regarded as a NULL value. + /** determines if an empty text should be treated as a <NULL/> value. + + <p>When the user enters text into a text field, and after this, the control + content is to be committed into the database field the control is bound to, + a decision must be made how to deal with empty strings.<br/> + This is controlled by this property.</p> + + <p>If the property is set to <TRUE/>, and an empty text is to be commited, this is + converted into <NULL/>, else it is written as empty string.</p> */ [property] boolean ConvertEmptyToNull; @@ -103,6 +107,15 @@ service DatabaseTextField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/07/26 09:49:13 fs + IDL review form layer + + Revision 1.3.24.1 2002/02/19 08:46:24 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/DatabaseTimeField.idl b/offapi/com/sun/star/form/component/DatabaseTimeField.idl index 9b8b8b30967f..e05d6c95a946 100644 --- a/offapi/com/sun/star/form/component/DatabaseTimeField.idl +++ b/offapi/com/sun/star/form/component/DatabaseTimeField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseTimeField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,12 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DatabaseTimeField -/** This service specifies a data-aware TimeField. +/** This service specifies a data-aware field for inputting a time value. */ service DatabaseTimeField { - // DocMerge: empty anyway service com::sun::star::form::component::TimeField; - // DocMerge: empty anyway service com::sun::star::form::DataAwareControlModel; }; @@ -96,6 +93,12 @@ service DatabaseTimeField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:13 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/DateField.idl b/offapi/com/sun/star/form/component/DateField.idl index f99ef932aefe..11ab74b7712c 100644 --- a/offapi/com/sun/star/form/component/DateField.idl +++ b/offapi/com/sun/star/form/component/DateField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DateField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,26 +80,30 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::DateField -/** This service specifies the ControlModel for an edit field which - contains a date value. - */ +/** specifies the model of a date field control, which is an edit field used to enter a date. +*/ service DateField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlDateFieldModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** resets the control. + + <p>If you do not set a value for the <member>DefaultDate</member>, then resetting the control + will result in setting to to the current system date. This is for HTML compatibility.</p> + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::DateField::DefaultDate - /** returns the default date used by reset. - */ + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> + + @see com::sun::star::awt::UnoControlDateFieldModel::Date + @see com::sun::star::form::XReset + */ [property] long DefaultDate; }; @@ -111,6 +115,18 @@ service DateField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:14 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:23:35 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:56:09 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/FileControl.idl b/offapi/com/sun/star/form/component/FileControl.idl index a7c0bf8070cd..0efc08a4834e 100644 --- a/offapi/com/sun/star/form/component/FileControl.idl +++ b/offapi/com/sun/star/form/component/FileControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: FileControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,9 @@ #include <com/sun/star/form/FormControlModel.idl> #endif +#ifndef __com_sun_star_form_XReset_idl__ +#include <com/sun/star/form/XReset.idl> +#endif //============================================================================= @@ -76,24 +79,27 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::FileControl -/** This service specifies the ControlModel of an edit field for a +/** This service specifies the control model of an edit field for a file name. */ service FileControl { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlFileControlModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FileControl::DefaultText + /** can be used to reset the control to it's default text. + + @see FileControl::DefaultText + */ + interface com::sun::star::form::XReset; + + /** contains a default value for the control. - // DocMerge from xml: property com::sun::star::form::component::FileControl::DefaultText - /** specifies the default text for the component, which is initially displayed - or used to reset the component. + <p>This value is used when the control is initially displayed, and for resetting it.</p> + + @see com::sun::star::awt::UnoControlFileControlModel::Text + @see com::sun::star::form::XReset */ [property] string DefaultText; @@ -106,6 +112,12 @@ service FileControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:14 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/FixedText.idl b/offapi/com/sun/star/form/component/FixedText.idl index 626c25250d99..913ea755cd10 100644 --- a/offapi/com/sun/star/form/component/FixedText.idl +++ b/offapi/com/sun/star/form/component/FixedText.idl @@ -2,9 +2,9 @@ * * $RCSfile: FixedText.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::FixedText -/** This service specifies the ControlModel of a text which can be - displayed but not edited by the user. +/** This service specifies the control model for a text which can be + displayed, but not edited by the user. + + <p>These kind of controls is usually used to label other controls.</p> + + @see com::sun::star::form::DataAwareControlModel::LabelControl */ service FixedText { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlFixedTextModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; }; @@ -97,6 +98,12 @@ service FixedText /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:15 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/Form.idl b/offapi/com/sun/star/form/component/Form.idl index ca9523c2fad9..63711324c11d 100644 --- a/offapi/com/sun/star/form/component/Form.idl +++ b/offapi/com/sun/star/form/component/Form.idl @@ -2,9 +2,9 @@ * * $RCSfile: Form.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,52 +88,36 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::Form /** This service specifies a form which is a group of FormComponents. - - <p>A form fulfills several tasks, like storing the structure of its form components, storing the information concerning tab ordering and control grouping, and last but not least, it provides the - event environment for its contained elements. + event environment for its contained elements.</p> - </p> <p>A form acts on the one hand like a container of FormComponents and on the other hand like a FormComponent. This generic construction allows the definition of hierarchies of forms and their - dependent subforms. + dependent subforms.</p> - </p>@see service com::sun::star::form::FormComponent + @see com::sun::star::form::FormControlModel */ service Form { - // DocMerge: empty anyway service com::sun::star::form::FormComponent; - // DocMerge: empty anyway service com::sun::star::form::FormComponents; - - // DocMerge from xml: service com::sun::star::form::component::Form: interface com::sun::star::form::XForm /** identifies a component as form. */ interface com::sun::star::form::XForm; - // DocMerge from xml: service com::sun::star::form::component::Form: interface com::sun::star::awt::XTabControllerModel - /** The interface has to be implemented to supply the information - for tab ordering and component grouping. - */ - interface com::sun::star::awt::XTabControllerModel; - + /** This interface has to be implemented to supply the information for tab ordering and component grouping. - // DocMerge from xml: service com::sun::star::form::component::Form: interface com::sun::star::script::XEventAttacherManager - /** The interface has to be implemented to supply the scripting - environment for the contained components. + @see com::sun::star::form::FormControlModel::TabIndex */ - interface com::sun::star::script::XEventAttacherManager; - + interface com::sun::star::awt::XTabControllerModel; }; //============================================================================= @@ -143,6 +127,15 @@ service Form /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/07/26 09:49:15 fs + IDL review form layer + + Revision 1.3.24.1 2002/03/04 11:11:43 fs + #96998# moved XEventAttacherManager to css::form::FormComponents + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.2 2000/10/09 14:24:56 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/offapi/com/sun/star/form/component/FormattedField.idl b/offapi/com/sun/star/form/component/FormattedField.idl index 8d5c7d2c453a..ca88033a54b2 100644 --- a/offapi/com/sun/star/form/component/FormattedField.idl +++ b/offapi/com/sun/star/form/component/FormattedField.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormattedField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-03-19 06:21:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,22 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::FormattedField -/** This service specifies the ControlModel of an edit field for - single/multi-line text. +/** This service specifies the control model of an edit field for entering text which can be + (nearly) arbirtrarily formatted. + + @see com::sun::star::util::XNumberFormatsSupplier */ service FormattedField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlFormattedFieldModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default state. + + @see com::sun::star::awt::UnoControlFormattedFieldModel::EffectiveValue + @see com::sun::star::awt::UnoControlFormattedFieldModel::EffectiveDefault + */ interface com::sun::star::form::XReset; }; @@ -103,6 +106,18 @@ service FormattedField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.16.3 2002/07/26 09:49:15 fs + IDL review form layer + + Revision 1.2.16.2 2002/02/18 15:24:23 oj + #96946# parameter,return value and exception description + + Revision 1.2.16.1 2002/02/18 14:56:15 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/03/19 06:21:09 fs + removed DefaultText (copy'n'paste error) + Revision 1.1 2001/02/20 14:05:34 fs initial checkin - service description for a formatted field diff --git a/offapi/com/sun/star/form/component/GridControl.idl b/offapi/com/sun/star/form/component/GridControl.idl index b84451724700..68b168c1feca 100644 --- a/offapi/com/sun/star/form/component/GridControl.idl +++ b/offapi/com/sun/star/form/component/GridControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: GridControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,10 @@ #include <com/sun/star/form/XGridColumnFactory.idl> #endif +#ifndef __com_sun_star_form_FormComponents_idl__ +#include <com/sun/star/form/FormComponents.idl> +#endif + #ifndef __com_sun_star_container_XContainer_idl__ #include <com/sun/star/container/XContainer.idl> #endif @@ -108,44 +112,71 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::GridControl -/** This service specifies a ControlModel to represent data in a table. +/** specifies a model for a control which can display form data in a table-like way. + + <p>In opposite to other <type>FormControl</type>s, grid controls do not only + display the single current value of a column they are bound to. Moreover, they do + display not only the current row of the form, but all rows (at least potentially, limited + by the control size, of course).</p> + + <p>The table rows in a grid control correspond to the rows in the <type>DataForm</type> + the control belongs to, and the columns correspond to single columns of the form's row set.</p> + + <p>Columns of a grid control are modeled by own objects, too. They are very similar to usual + <type>DataAwareControlModel</type>s modeling other "single-value" controls, but they are not described + as own services. Instead, they need to be created using the <type>XGridColumnFactory</type> interface.</p> */ service GridControl { - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway - interface com::sun::star::form::XGridColumnFactory; + /** provides basic functionality of a container of <type scope="com::sun::star::form">FormComponent</type>s. - // DocMerge: empty anyway - interface com::sun::star::container::XContainer; + <p>All the container-related methods of this service related to control models, + this is what are the container elements for a <type>GridControl</type>.</p> - // DocMerge: empty anyway - interface com::sun::star::view::XSelectionSupplier; + <p>As the <type scope="com::sun::star::form">FormComponents</type> service also specifies + the <type scope"com::sun::star::script">XEventAttacherManager</type> service, grid control models + also provide a scripting environment for their columns.</p> + */ + service com::sun::star::form::FormComponents; + + /** allows to create column models to be inserted into the control model. + + <p>Note that the object returned by the <member>XGridColumnFactory::createColumn</member> + method is not part of the grid control, yet. It needs to be inserted using any of the + container interfaces.</p> + + <p>You always need to use this interface for creating columns for the grid control. + Column models not created this way will not be accepted when inserted later on.</p> + */ + interface com::sun::star::form::XGridColumnFactory; + + /** gives access to the currently selection. - // DocMerge: empty anyway - interface com::sun::star::container::XNameContainer; + <p>In a grid control, single columns can be selected (at most one at a time).<br/> + For various unfortunate reaons, this selection is an aspect of the model, not of the + control as you would expect.</p> - // DocMerge: empty anyway - interface com::sun::star::container::XIndexContainer; + <p>This interface is deprecated, new implementations should not use it anymore, as it is to + be superseeded by a solution which is bound to the control, not the model.</p> - // DocMerge: empty anyway - interface com::sun::star::container::XEnumerationAccess; + @deprecated + */ + interface com::sun::star::view::XSelectionSupplier; - // DocMerge: empty anyway - interface com::sun::star::script::XEventAttacherManager; + /** resets the control. - // DocMerge: empty anyway + <p>The reset of the control is forwarded to all it's elements, means to all the column models. + As grid columns are very much like data-aware stand-alone controls, you can find a description + of the reset functionality in <member scope="com::sun::star::form">DataAwareControlModel::XReset</member>. + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::Border /** returns the border style of the control. - <pre> 0: No border 1: 3D border @@ -156,35 +187,35 @@ service GridControl //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::Enabled /** determines whether the control is enabled or disabled. */ [property] boolean Enabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::FontDescriptor /** contains the font attributes of the text in the control. */ [property] com::sun::star::awt::FontDescriptor FontDescriptor; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::RowHeight /** specifies the height of a row of the grid. + + <p>If the value is set to <NULL/>, the height is determined automatically according + to the current font used.</p> + + @see GridControl::FontDescriptor */ [property] long RowHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::Tabstop /** determines whether the control can be reached by the tabulator key. */ [property] boolean Tabstop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::GridControl::TextColor /** specifies the text color (RGB) of the control. */ [property] long TextColor; @@ -198,6 +229,18 @@ service GridControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:16 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:24:14 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:56:21 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/GroupBox.idl b/offapi/com/sun/star/form/component/GroupBox.idl index 2b04578027f1..682ca0f545b4 100644 --- a/offapi/com/sun/star/form/component/GroupBox.idl +++ b/offapi/com/sun/star/form/component/GroupBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: GroupBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,13 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::GroupBox -/** This service specifies the ControlModel to group several controls. +/** This service specifies a model for a control which can be used to visually + group controls. */ service GroupBox { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlGroupBoxModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; }; @@ -96,6 +94,12 @@ service GroupBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:17 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/HTMLForm.idl b/offapi/com/sun/star/form/component/HTMLForm.idl index 43967dee1326..060bcfa6f243 100644 --- a/offapi/com/sun/star/form/component/HTMLForm.idl +++ b/offapi/com/sun/star/form/component/HTMLForm.idl @@ -2,9 +2,9 @@ * * $RCSfile: HTMLForm.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,51 +88,47 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::HTMLForm -/** This service specifies the special form kind for HTML documents. - - +/** This service specifies the special kind of <type>Form</type>s for HTML documents. <p>An HTMLForm fulfills the specification of forms in HTML. It supplies the possibility of submitting or resetting the contents of a form. - For more information on HTML forms, see the documentation of HTML. - </p> + For more information on HTML forms, please see the documentation of HTML.</p> */ service HTMLForm { - // DocMerge: empty anyway service com::sun::star::form::component::Form; - // DocMerge: empty anyway + /** resets the control. + */ interface com::sun::star::form::XReset; - // DocMerge: empty anyway - interface com::sun::star::form::XSubmit; + /** allows to submit changes. - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR HTMLForm::TargetFrame + <p>When a form is submitted, the data contained in the form is sent + to the target URL as a series of name/value pairs. The name portion + of each pair is the name of a form component as specified by its NAME + attribute. In most cases the value portion is the value displayed + by the element, for example, the text displayed in a text field.</p> + */ + interface com::sun::star::form::XSubmit; - // DocMerge from xml: property com::sun::star::form::component::HTMLForm::TargetFrame /** describes the frame, where to open the document specified by the TargetURL. */ [property] string TargetFrame; + //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR HTMLForm::TargetURL - // DocMerge from xml: property com::sun::star::form::component::HTMLForm::TargetURL /** specifies the URL, which should be used for submission. */ [property] string TargetURL; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::HTMLForm::SubmitMethod - /** returns the kind of submission. + /** specifies the kind of submission. */ [property] com::sun::star::form::FormSubmitMethod SubmitMethod; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::HTMLForm::SubmitEncoding - /** returns the kind of encoding for submission. + /** specifies the kind of encoding for submission. */ [property] com::sun::star::form::FormSubmitEncoding SubmitEncoding; }; @@ -144,6 +140,18 @@ service HTMLForm /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:17 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:23:05 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:54:11 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/HiddenControl.idl b/offapi/com/sun/star/form/component/HiddenControl.idl index cc9c13102131..6927704cee0c 100644 --- a/offapi/com/sun/star/form/component/HiddenControl.idl +++ b/offapi/com/sun/star/form/component/HiddenControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: HiddenControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,26 +72,20 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::HiddenControl -/** This service specifies the ControlModel of a hidden control, - which can be used to store values in the form without being visible - for the user. +/** This service specifies the model of a hidden control. + <p>The only sense of a hidden control is to store data in the form which is + not visible to the user.</p> - - <p> - <type>HiddenControl</type>s are HTML specific. They are not related - to a visual component. They are only used for data used in a submission.</p> + <p>Usually, hidden controls are used in <type scope="com::sun::star::form">HTMLForm</type>s, + where they contain data which is to be submitted.<br/> + Nevertheless, you can use them in your own forms for storing any data, for instance + to evaluate it in some scripting macro.</p> */ service HiddenControl { - // DocMerge: empty anyway service com::sun::star::form::FormComponent; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR HiddenControl::HiddenValue - - // DocMerge from xml: property com::sun::star::form::component::HiddenControl::HiddenValue /** specifies the value of the component. */ [property] string HiddenValue; @@ -105,6 +99,12 @@ service HiddenControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:17 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/ImageButton.idl b/offapi/com/sun/star/form/component/ImageButton.idl index f7deace970a2..01f0edc8c58b 100644 --- a/offapi/com/sun/star/form/component/ImageButton.idl +++ b/offapi/com/sun/star/form/component/ImageButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImageButton.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,46 +88,57 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::ImageButton -/** This service specifies the ControlModel for a clickable button which +/** This service specifies the control model for a clickable button which is represented by an image. - */ + + <p>The image to be displayed is determined by <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + property specifies the URL of an image to be displayed.</p> + + @see CommandButton +*/ service ImageButton { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlImageControlModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge from xml: service com::sun::star::form::component::ImageButton: interface com::sun::star::form::XImageProducerSupplier - /** is necessary if you want to display images on a button. + /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. + + <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + at this producer. Then they will be notified of any change in the image to be displayed.</p> + + <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> + property is changed, the model loads the specified image, and sets it as image source + at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all + <type scope="com::sun::star::awt">XImageConsumers</type> are notified and supplied with + the binary data of the image.<br/> + Usually, controls acting for an <type>ImageButton</type> model are consumers, and use the + data stream to display the image</p> */ interface com::sun::star::form::XImageProducerSupplier; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::form::component::ImageButton::ButtonType - /** The ButtonType describes the default action executed by the button. + /** describes the action to be executed by the button when pressed. */ [property] com::sun::star::form::FormButtonType ButtonType; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ImageButton::TargetFrame - // DocMerge from xml: property com::sun::star::form::component::ImageButton::TargetFrame + //------------------------------------------------------------------------- /** describes the frame, where to open the document specified by the TargetURL. + + <p>This property is evaluated if the button is of type URL.</p> + + <p>As always, there is a number of target names which have a special meaning, and force + a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> */ [property] string TargetFrame; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ImageButton::TargetURL - // DocMerge from xml: property com::sun::star::form::component::ImageButton::TargetURL + //------------------------------------------------------------------------- /** specifies the URL, which should be opened if the button was clicked. + <p>This property is evaluated if the button is of type URL.</p> - <p> This property is evaluated if the button is of type URL. - </p>@see com::sun::star::form::FormButtonType + @see com::sun::star::form::FormButtonType */ [property] string TargetURL; }; @@ -139,6 +150,12 @@ service ImageButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/26 09:49:18 fs + IDL review form layer + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/ListBox.idl b/offapi/com/sun/star/form/component/ListBox.idl index bd09f3633aa8..051c30c6f2c2 100644 --- a/offapi/com/sun/star/form/component/ListBox.idl +++ b/offapi/com/sun/star/form/component/ListBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListBox.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,34 +80,31 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::ListBox -/** This service specifies the ControlModel of a box which contains a - list of strings to select from. +/** specifies a model for a control which allows to choose in a list of alternative values. */ service ListBox { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlListBoxModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default state. + + @see ListBox::DefaultSelection + */ interface com::sun::star::form::XReset; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ListBox::DefaultSelection + /** contains the indexes of entries of the listbox, which should selected + by default. + + <p>This selection is used initially or for a reset.</p> - // DocMerge from idl: property com::sun::star::form::component::ListBox::DefaultSelection - /** contains the indexes for entries of the listbox, which should selected - by default. These selection is used initially or for a reset. + @see com::sun::star::awt::UnoControlListBoxModel::Selection + @see com::sun::star::form::XReset */ [property] sequence<short> DefaultSelection; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ListBox::ListSource - // DocMerge from idl: property com::sun::star::form::component::ListBox::ListSource /** contains the listbox entries. */ [property] sequence<string> ListSource; @@ -121,6 +118,18 @@ service ListBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:18 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:23:49 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:54:23 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/NumericField.idl b/offapi/com/sun/star/form/component/NumericField.idl index db06e32ad6ad..f7e394e300c2 100644 --- a/offapi/com/sun/star/form/component/NumericField.idl +++ b/offapi/com/sun/star/form/component/NumericField.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumericField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,25 +80,28 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::NumericField -/** This service specifies the ControlModel of an edit field for a - numeric value. +/** specifies a component which allows the input of a numeric value. */ service NumericField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlNumericFieldModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default value. + + @see NumericField::DefaultValue + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::NumericField::DefaultValue - /** returns the default value used by reset. + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> + + @see com::sun::star::awt::UnoControlNumericFieldModel::Value + @see com::sun::star::form::XReset */ [property] double DefaultValue; @@ -111,6 +114,18 @@ service NumericField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:19 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:20:42 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:54:48 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/PatternField.idl b/offapi/com/sun/star/form/component/PatternField.idl index d3a2535f445b..accd44a0917e 100644 --- a/offapi/com/sun/star/form/component/PatternField.idl +++ b/offapi/com/sun/star/form/component/PatternField.idl @@ -2,9 +2,9 @@ * * $RCSfile: PatternField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,27 +80,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::PatternField -/** This service specifies the ControlModel of an edit field for - strings which match a specified pattern. +/** specifies a component which allows the input of text which matches a specific pattern. */ service PatternField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlPatternFieldModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default text. + + @see PatternField::DefaultText + */ interface com::sun::star::form::XReset; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR PatternField::DefaultText + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> - // DocMerge from xml: property com::sun::star::form::component::PatternField::DefaultText - /** specifies the default text for the component, which is initially displayed - or used to reset the component. + @see com::sun::star::awt::UnoControlPatternFieldModel::Text + @see com::sun::star::form::XReset */ [property] string DefaultText; @@ -113,6 +112,18 @@ service PatternField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:19 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:20:30 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:54:18 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/RadioButton.idl b/offapi/com/sun/star/form/component/RadioButton.idl index ad27e528c383..cfa99f217981 100644 --- a/offapi/com/sun/star/form/component/RadioButton.idl +++ b/offapi/com/sun/star/form/component/RadioButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: RadioButton.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,46 +80,50 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::RadioButton -/** is a radio button extended by the required properties for HTML. +/** specifies a component which acts as a radio button as needed in <type>HTMLForm</type>s. + <p>Radio buttons are controls which can be grouped together, and in every + group, only one of the controls can be check. This means if one of them + is checked by a user interaction, all other controls in the same group + are automatically unchecked</p> - - <p>Radio buttons are grouped like in HTML if they have the same name. - If they are grouped, they act like an automatic radio button; - if you check one of the group, all the other radio buttons of the - same group are unchecked. - </p> + <p>Like in HTML, radio buttons are grouped together if and only if they have the + same name (see <member>FormComponent::Name</member>).</p> */ service RadioButton { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlRadioButtonModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default text. + + @see RadioButton::DefaultState + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::form::component::RadioButton::DefaultState - /** specifies the default value for the button. - + /** contains a default value for the control. + <p>This value is used when the control is initially displayed, and for resetting it.</p> <p> In a group of radio buttons only one button should be checked by default.</p> + + @see com::sun::star::awt::UnoControlRadioButtonModel::State + @see com::sun::star::form::XReset */ [property] short DefaultState; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR RadioButton::RefValue - // DocMerge from xml: property com::sun::star::form::component::RadioButton::RefValue /** contains a reference value which is used for submission in a HTML - form, if the radiobutton is checked. + form. + + <p>If the form the control belongs to is to be submitted (see + <type scope="com::sun::star::form">XSubmit</type>), and the control is checked, this reference + value is used for submission.</p> */ [property] string RefValue; @@ -132,6 +136,18 @@ service RadioButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:20 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:22:23 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:55:11 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/TextField.idl b/offapi/com/sun/star/form/component/TextField.idl index 31b014776516..34b09969557b 100644 --- a/offapi/com/sun/star/form/component/TextField.idl +++ b/offapi/com/sun/star/form/component/TextField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,28 +80,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::TextField -/** This service specifies the ControlModel of an edit field for - single/multi-line text. +/** specifies a component which allows the input of text, either single- or multi-line. */ service TextField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlEditModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** can be used to reset the control to it's default text. + + @see TextField::DefaultText + */ interface com::sun::star::form::XReset; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TextField::DefaultText - //------------------------------------------------------------------------- + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> - // DocMerge from xml: property com::sun::star::form::component::TextField::DefaultText - /** specifies the default text for the component, which is initially displayed - or used to reset the component. + @see com::sun::star::awt::UnoControlEditModel::Text + @see com::sun::star::form::XReset */ [property] string DefaultText; }; @@ -113,6 +111,18 @@ service TextField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:20 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:21:38 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:54:55 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/component/TimeField.idl b/offapi/com/sun/star/form/component/TimeField.idl index e5a1dee96321..29c426d6296d 100644 --- a/offapi/com/sun/star/form/component/TimeField.idl +++ b/offapi/com/sun/star/form/component/TimeField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TimeField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,26 +80,30 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::form::component::TimeField -/** This service sepecifies the ControlModel of an edit field for a - time value. +/** sepecifies the the control model for a field which can be used to input time values. */ service TimeField { - // DocMerge: empty anyway service com::sun::star::awt::UnoControlTimeFieldModel; - // DocMerge: empty anyway service com::sun::star::form::FormControlModel; - // DocMerge: empty anyway + /** resets the control. + + <p>If you do not set a value for the <member>DefaultTime</member>, then resetting the control + will result in setting to to the current system time. This is for HTML compatibility.</p> + */ interface com::sun::star::form::XReset; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::form::component::TimeField::DefaultTime - /** returns the default time used by reset. - */ + /** contains a default value for the control. + + <p>This value is used when the control is initially displayed, and for resetting it.</p> + + @see com::sun::star::awt::UnoControlTimeFieldModel::Time + @see com::sun::star::form::XReset + */ [property] long DefaultTime; }; @@ -111,6 +115,18 @@ service TimeField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.3 2002/07/26 09:49:21 fs + IDL review form layer + + Revision 1.3.24.2 2002/02/18 15:21:51 oj + #96946# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 14:55:17 oj + #96946# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:10 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:19 hjs initial import diff --git a/offapi/com/sun/star/form/control/CheckBox.idl b/offapi/com/sun/star/form/control/CheckBox.idl index ff6cb2a66724..a38561ac4094 100644 --- a/offapi/com/sun/star/form/control/CheckBox.idl +++ b/offapi/com/sun/star/form/control/CheckBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: CheckBox.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: fs $ $Date: 2001-04-19 08:44:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,18 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">CheckBox</type> model. +/** describes a check box control which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">CheckBox</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service CheckBox { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlCheckBox; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +98,15 @@ service CheckBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.14.2 2002/07/26 11:03:12 fs + IDL review form layer + + Revision 1.1.14.1 2002/02/19 08:11:45 oj + #96946# parameter,return value and exception description + + Revision 1.1 2001/04/19 08:44:32 fs + initial checkin - service description for form related controls + =============================================================================*/ @@ -105,6 +115,15 @@ service CheckBox /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.1.14.2 2002/07/26 11:03:12 fs + * IDL review form layer + * + * Revision 1.1.14.1 2002/02/19 08:11:45 oj + * #96946# parameter,return value and exception description + * + * Revision 1.1 2001/04/19 08:44:32 fs + * initial checkin - service description for form related controls + * * * Revision 1.0 19.04.01 09:21:55 fs ************************************************************************/ diff --git a/offapi/com/sun/star/form/control/ComboBox.idl b/offapi/com/sun/star/form/control/ComboBox.idl index c948e1f989c5..2c694c5726e8 100644 --- a/offapi/com/sun/star/form/control/ComboBox.idl +++ b/offapi/com/sun/star/form/control/ComboBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: ComboBox.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,18 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">ComboBox</type> model. +/** describes a combo box control. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">ComboBox</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service ComboBox { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlComboBox; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +98,15 @@ service ComboBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:13 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:11:51 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:44:43 fs initial checkin - service description for form related controls @@ -108,6 +118,15 @@ service ComboBox /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:13 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:11:51 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:44:43 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/CommandButton.idl b/offapi/com/sun/star/form/control/CommandButton.idl index 5378854b83fc..3ffb59286010 100644 --- a/offapi/com/sun/star/form/control/CommandButton.idl +++ b/offapi/com/sun/star/form/control/CommandButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: CommandButton.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,19 +76,35 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">CommandButton</type> model. +/** describes a button control. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type> + service.</p> <p>The control is clickable, the action taken upon clicking depends on the settings of the model the control belongs to.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel + @see com::sun::star::form::component::CommandButton::ButtonType */ service CommandButton { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlButton; /** allows external instances to register as veto listener for the button's actions. + + <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on + it's approve-method will prevent any action which would usually be triggered - this includes + not only submitting or resetting forms, but also calling the + <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/> + This may be interesting for e.g. forms which want to provide input validation before submitting + data.<br/> + + @see com::sun::star::form::HTMLForm + @see com::sun::star::form::XSubmit + @see com::sun::star::form::XReset + @see com::sun::star::awt::XButton */ interface com::sun::star::form::XApproveActionBroadcaster; }; @@ -100,6 +116,15 @@ service CommandButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:13 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:11:57 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:44:50 fs initial checkin - service description for form related controls @@ -111,6 +136,15 @@ service CommandButton /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:13 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:11:57 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:44:50 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/CurrencyField.idl b/offapi/com/sun/star/form/control/CurrencyField.idl index 68e5eaeeb58c..135cb9dbfdaf 100644 --- a/offapi/com/sun/star/form/control/CurrencyField.idl +++ b/offapi/com/sun/star/form/control/CurrencyField.idl @@ -2,9 +2,9 @@ * * $RCSfile: CurrencyField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,19 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">CurrencyField</type> model. +/** describes a control which can be used for inputting currency values, and + which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">CurrencyField</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service CurrencyField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlCurrencyField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +99,15 @@ service CurrencyField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:13 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:03 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:44:56 fs initial checkin - service description for form related controls @@ -108,6 +119,15 @@ service CurrencyField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:13 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:03 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:44:56 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/DateField.idl b/offapi/com/sun/star/form/control/DateField.idl index 90cd9182e16a..9727accb56f2 100644 --- a/offapi/com/sun/star/form/control/DateField.idl +++ b/offapi/com/sun/star/form/control/DateField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DateField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,19 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">DateField</type> model. +/** describes a control which can be used for inputting date values, and + which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">DateField</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service DateField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlDateField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +99,15 @@ service DateField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:14 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:10 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:03 fs initial checkin - service description for form related controls @@ -108,6 +119,15 @@ service DateField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:14 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:10 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:03 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/FormattedField.idl b/offapi/com/sun/star/form/control/FormattedField.idl index d9a18895291b..febf86eff149 100644 --- a/offapi/com/sun/star/form/control/FormattedField.idl +++ b/offapi/com/sun/star/form/control/FormattedField.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormattedField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,24 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">FormattedField</type> model. +/** describes a control which can be used for inputting values with a arbitrary formatting, and + can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">FormattedField</type> + service.</p> <p>In addition, this control can be used in HTML forms. It triggers the - <method scope="com.sun.star.form">XSubmit::submit</method> method of the form it belongs to if - the <em>enter</em> is pressed while it has the focus.</p> + <method scope="com::sun::star::form">XSubmit::submit</method> method of the form it belongs to if + the <em>enter</em> key is pressed while it has the focus.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel + @see com::sun::star::util::XNumberFormatsSupplier */ service FormattedField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlFormattedField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -101,6 +104,15 @@ service FormattedField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:14 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:16 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:10 fs initial checkin - service description for form related controls @@ -112,6 +124,15 @@ service FormattedField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:14 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:16 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:10 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/GridControl.idl b/offapi/com/sun/star/form/control/GridControl.idl index 82e1ed899272..b3fb00dbe060 100644 --- a/offapi/com/sun/star/form/control/GridControl.idl +++ b/offapi/com/sun/star/form/control/GridControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: GridControl.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-05-16 15:15:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -113,8 +113,12 @@ //============================================================================= /** describes a table-like control for displaying data. - <p>The control is usually used together with a model implementing the - <service scope="com.sun.star.form.component">GridControl</service> service.</p> + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">GridControl</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service GridControl { @@ -125,6 +129,7 @@ service GridControl interface com::sun::star::form::XBoundComponent; /** allows access to the active cell within the grid. + <p>Only the column position can be modified using this interface, as the row position within a table control bound to a data source is given implicitly (by the cursor position of the data source).</p> */ @@ -146,38 +151,41 @@ service GridControl */ interface com::sun::star::container::XEnumerationAccess; - interface com::sun::star::container::XContainer; - /** is used to switch the operating modes of the control. + <p>Besides the normal opreration mode (which is used to display the database form's data) the control may for instance support a filter mode.</p> */ [optional] interface com::sun::star::util::XModeSelector; /** used to control the selection of rows in the grid control. - <p>The selection used with the methods <method scope="com.sun.star.view">XSelectionSupplier::getSelection</method> - and <method scope="com.sun.star.view">XSelectionSupplier::select</method> is a sequence of Any's.<br/> - Here the elements of the Sequence are the bookmarks (in the <service scope="com.sun.star.sdb">RowSet</service>) + + <p>The selection used with the methods <method scope="com::sun::star::view">XSelectionSupplier::getSelection</method> + and <method scope="com::sun::star::view">XSelectionSupplier::select</method> is a sequence of Any's.<br/> + Here the elements of the Sequence are the bookmarks (in the <service scope="com::sun::star::sdb">RowSet</service>) of the (to-be-) selected rows.</p> */ [optional] interface com::sun::star::view::XSelectionSupplier; /** allows external components to register dispatchers for some common form actions. + <p>A grid control can contain own UI elements for traveling within the database form it belongs to (This concept seems to make sense, as a grid control - in opposite to other data aware controls - displayes not only one record at a time, but a larger number of records of the database form.)<br/> With the help of this interface, external components which wish to handle such travelings themself can register interceptors for the actions in question.</p> + <p>Usual URLs to use include - <ul> - <li><em>.uno:FormSlots/moveToFirst</em>: move the cursor to the first record</li> - <li><em>.uno:FormSlots/moveToPrev</em>: move the cursor to the previous record</li> - <li><em>.uno:FormSlots/moveToNext</em>: move the cursor to the next record</li> - <li><em>.uno:FormSlots/moveToLast</em>: move the cursor to the last record</li> - <li><em>.uno:FormSlots/moveToNew</em>: move the cursor to the (one and only) <em>new</em> record</li> - <li><em>.uno:FormSlots/undoRecord</em>: undo the changes done so far in the current record</li> - </ul> + <dl> + <dt>.uno:FormSlots/moveToFirst</dt><dd> move the cursor to the first record</dd> + <dt>.uno:FormSlots/moveToPrev</dt><dd> move the cursor to the previous record</dd> + <dt>.uno:FormSlots/moveToNext</dt><dd> move the cursor to the next record</dd> + <dt>.uno:FormSlots/moveToLast</dt><dd> move the cursor to the last record</dd> + <dt>.uno:FormSlots/moveToNew</dt><dd> move the cursor to the (one and only) <em>new</em> record</dd> + <dt>.uno:FormSlots/undoRecord</dt><dd> undo the changes done so far in the current record</dd> + </dl> </p> + <p>A concrete implementation of this service may offer more or less URLs, but if it offers some of the URLs above, it must stick to the meanings defined above.</p> */ @@ -191,6 +199,21 @@ service GridControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.4 2002/08/29 15:00:41 fs + corrected references + + Revision 1.2.14.3 2002/07/26 11:03:15 fs + IDL review form layer + + Revision 1.2.14.2 2002/05/23 15:38:15 fs + #99490# removed the XContainer interface - the same functionality can be obtained from the model (the control itself does not even allow container actions, it _always_ reacts on model container actions) + + Revision 1.2.14.1 2002/02/19 08:13:16 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/05/16 15:15:33 fs + #84686# added the XSelectionSupplier to the GridControl service + Revision 1.1 2001/04/19 10:53:59 fs initial checkin diff --git a/offapi/com/sun/star/form/control/GroupBox.idl b/offapi/com/sun/star/form/control/GroupBox.idl index 8736ba547044..98130f9eb6a4 100644 --- a/offapi/com/sun/star/form/control/GroupBox.idl +++ b/offapi/com/sun/star/form/control/GroupBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: GroupBox.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,13 +76,16 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">GroupBox</type> model. +/** describes a control which can be used for visually grouping controls + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">GroupBox</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service GroupBox { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlGroupBox; }; @@ -93,6 +96,15 @@ service GroupBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:15 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:21 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:17 fs initial checkin - service description for form related controls @@ -104,6 +116,15 @@ service GroupBox /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:15 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:21 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:17 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/ImageButton.idl b/offapi/com/sun/star/form/control/ImageButton.idl index 1c89bbdf7d07..f5b26a817447 100644 --- a/offapi/com/sun/star/form/control/ImageButton.idl +++ b/offapi/com/sun/star/form/control/ImageButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImageButton.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,19 +76,35 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">ImageButton</type> model. +/** describes a control which can be used for displaying images on a control acting like a button. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">ImageButton</type> + service.</p> <p>The control is clickable, the action taken upon clicking depends on the settings of the model the control belongs to.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel + @see com::sun::star::form::component::ImageButton::ButtonType */ service ImageButton { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlImageControl; /** allows external instances to register as veto listener for the button's actions. + + <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on + it's approve-method will prevent any action which would usually be triggered - this includes + not only submitting or resetting forms, but also calling the + <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/> + This may be interesting for e.g. forms which want to provide input validation before submitting + data.<br/> + + @see com::sun::star::form::HTMLForm + @see com::sun::star::form::XSubmit + @see com::sun::star::form::XReset + @see com::sun::star::awt::XButton */ interface com::sun::star::form::XApproveActionBroadcaster; }; @@ -100,6 +116,15 @@ service ImageButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:16 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:28 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:23 fs initial checkin - service description for form related controls @@ -111,6 +136,15 @@ service ImageButton /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:16 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:28 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:23 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/ImageControl.idl b/offapi/com/sun/star/form/control/ImageControl.idl index 66470788d5d0..4e8902078e26 100644 --- a/offapi/com/sun/star/form/control/ImageControl.idl +++ b/offapi/com/sun/star/form/control/ImageControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImageControl.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,22 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">DatabaseImageControl</type> model. +/** describes a control used for displaying images stored in a database. - <p>If the model of the control is bound to a database field, the control allows + <p>The model of the control has to support the <type scope="com::sun::star::form::component">DatabaseImageControl</type> + service.</p> + + <p>If the model of the control is valid bound to a database field, the control allows to select an image (browsing the file system) upon double clicking into it, - and forwards the URL of the chosen image to th ImageURL property of its model.</p> + and forwards the URL of the chosen image to the ImageURL property of its model.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service ImageControl { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlImageControl; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -101,6 +102,15 @@ service ImageControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:16 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:34 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:29 fs initial checkin - service description for form related controls @@ -112,6 +122,15 @@ service ImageControl /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:16 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:34 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:29 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/InteractionGridControl.idl b/offapi/com/sun/star/form/control/InteractionGridControl.idl index abc88c5c4b95..e0d396cfa080 100644 --- a/offapi/com/sun/star/form/control/InteractionGridControl.idl +++ b/offapi/com/sun/star/form/control/InteractionGridControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionGridControl.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: fs $ $Date: 2001-04-19 11:51:55 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,27 +79,28 @@ */ service InteractionGridControl { - /** provides the basic functionallity of the control - */ service com::sun::star::form::control::GridControl; /** allows access to the UI features of the control + <p>Though concret implementations of the service may offer different sets of aspects which can be customized, the following commands have, if supported, a defined meaning: - <ul> - <li><em>.uno:GridSlots/BrowserAttribs</em>: (interactively) customize the overall appearance of the grid (font etc.)</li> - <li><em>.uno:GridSlots/RowHeight</em>: (interactively) customize the row height appearance of the grid</li> - <li><em>.uno:GridSlots/ColumnAttribs</em>: (interactively) customize the format of a given column</li> - <li><em>.uno:GridSlots/ColumnWidth</em>: (interactively) customize the width of a given column</li> - </ul> - The following parameters may occur when dispatching the commands above (as before, concrete implementations + <dl> + <dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd> + <dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd> + <dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd> + <dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd> + </dl> + </p> + + <p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations may extend this list): - <ul> - <li><em>ColumnId</em>: the id of the column in question, if the command is executed for a column</li> - <li><em>ColumnModelPos</em>: the model position of the column in question, if the command is executed for a column</li> - <li><em>ColumnViewPos</em>: the view position of the column in question, if the command is executed for a column. The - view position may differ from the model position, as in a grid control, columns can be hidden.</li> - </ul> + <dl> + <dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd> + <dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd> + <dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The + view position may differ from the model position, as in a grid control, columns can be hidden.</dd> + </dl> </p> */ interface com::sun::star::frame::XDispatch; @@ -112,6 +113,12 @@ service InteractionGridControl /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.14.1 2002/07/26 11:03:17 fs + IDL review form layer + + Revision 1.1 2001/04/19 11:51:55 fs + initial checkin + =============================================================================*/ @@ -120,6 +127,12 @@ service InteractionGridControl /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.1.14.1 2002/07/26 11:03:17 fs + * IDL review form layer + * + * Revision 1.1 2001/04/19 11:51:55 fs + * initial checkin + * * * Revision 1.0 19.04.01 09:21:55 fs ************************************************************************/ diff --git a/offapi/com/sun/star/form/control/ListBox.idl b/offapi/com/sun/star/form/control/ListBox.idl index bba111a41995..ad95534ba30d 100644 --- a/offapi/com/sun/star/form/control/ListBox.idl +++ b/offapi/com/sun/star/form/control/ListBox.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListBox.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,20 +80,29 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">ListBox</type> model. +/** describes a list box control which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">ListBox</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service ListBox { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlListBox; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; - /** allows broadcasts of HTML-compatible change events + /** allows broadcasts of HTML-compatible change events. + + <p>HTML-compatible means that a change event is broadcasted if and only if all of + the following applies. + <ul> + <li>the control loses the focus</li> + <li>the content of the control has changed, compared to the moment where it got the focus.</li> + </ul> + <p/> */ interface com::sun::star::form::XChangeBroadcaster; }; @@ -105,6 +114,15 @@ service ListBox /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:17 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:39 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:35 fs initial checkin - service description for form related controls @@ -116,6 +134,15 @@ service ListBox /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:17 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:39 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:35 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/NumericField.idl b/offapi/com/sun/star/form/control/NumericField.idl index b24ffedf3282..0aa526b26096 100644 --- a/offapi/com/sun/star/form/control/NumericField.idl +++ b/offapi/com/sun/star/form/control/NumericField.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumericField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,19 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">NumericField</type> model. +/** describes a control for inputting numeric values and which can (but not necessarily has to) + be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">NumericField</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service NumericField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlNumericField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +99,15 @@ service NumericField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:17 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:45 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:47 fs initial checkin - service description for form related controls @@ -108,6 +119,15 @@ service NumericField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:17 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:45 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:47 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/PatternField.idl b/offapi/com/sun/star/form/control/PatternField.idl index 3ebbbd036001..0c84253ff931 100644 --- a/offapi/com/sun/star/form/control/PatternField.idl +++ b/offapi/com/sun/star/form/control/PatternField.idl @@ -2,9 +2,9 @@ * * $RCSfile: PatternField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,19 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">PatternField</type> model. +/** describes a control for inputting text complying to a given pattern, + and which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">PatternField</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service PatternField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlPatternField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +99,15 @@ service PatternField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:18 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:51 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:45:54 fs initial checkin - service description for form related controls @@ -108,6 +119,15 @@ service PatternField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:18 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:51 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:45:54 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/RadioButton.idl b/offapi/com/sun/star/form/control/RadioButton.idl index a332876ae413..9f16d9ccf203 100644 --- a/offapi/com/sun/star/form/control/RadioButton.idl +++ b/offapi/com/sun/star/form/control/RadioButton.idl @@ -2,9 +2,9 @@ * * $RCSfile: RadioButton.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,18 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">RadioButton</type> model. +/** describes a radio button control which can (but not necessarily has to) be bound to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">RadioButton</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service RadioButton { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlRadioButton; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +98,15 @@ service RadioButton /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:18 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:12:57 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:46:00 fs initial checkin - service description for form related controls @@ -108,6 +118,15 @@ service RadioButton /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:18 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:12:57 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:46:00 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/TextField.idl b/offapi/com/sun/star/form/control/TextField.idl index c3b249fcd59f..ef96aaab7b25 100644 --- a/offapi/com/sun/star/form/control/TextField.idl +++ b/offapi/com/sun/star/form/control/TextField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,24 +79,34 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">TextField</type> model. +/** describes a control for entering arbiotrary text which can (but not necessarily has to) be bound + to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">TextField</type> + service.</p> <p>In addition, this control can be used in HTML forms. It triggers the - <method scope="com.sun.star.form">XSubmit::submit</method> method of the form it belongs to if + <method scope="com::sun::star::form">XSubmit::submit</method> method of the form it belongs to if the <em>enter</em> is pressed while it has the focus.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service TextField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlEdit; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; - /** allows broadcasts of HTML-compatible change events + /** allows broadcasts of HTML-compatible change events. + + <p>HTML-compatible means that a change event is broadcasted if and only if all of + the following applies. + <ul> + <li>the control loses the focus</li> + <li>the content of the control has changed, compared to the moment where it got the focus.</li> + </ul> + <p/> */ interface com::sun::star::form::XChangeBroadcaster; }; @@ -108,6 +118,15 @@ service TextField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:18 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:13:03 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:46:07 fs initial checkin - service description for form related controls @@ -119,6 +138,15 @@ service TextField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:18 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:13:03 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:46:07 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/form/control/TimeField.idl b/offapi/com/sun/star/form/control/TimeField.idl index 8bbdbdd17153..cccff1fb344f 100644 --- a/offapi/com/sun/star/form/control/TimeField.idl +++ b/offapi/com/sun/star/form/control/TimeField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TimeField.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-04-19 10:56:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,19 @@ //============================================================================= -/** describes a radio button usually used together with a - <type scope="com.sun.star.form.component">TimeField</type> model. +/** describes a control for inputting time values which can (but not necessarily has to) be bound + to a database field. + + <p>The model of the control has to support the <type scope="com::sun::star::form::component">TimeField</type> + service.</p> + + @see com::sun::star::awt::UnoControl + @see com::sun::star::awt::UnoControlModel */ service TimeField { - /** provides the basic functionallity of the control - */ service com::sun::star::awt::UnoControlTimeField; - /** allows locking of the input of the control - */ interface com::sun::star::form::XBoundControl; }; @@ -97,6 +99,15 @@ service TimeField /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.14.2 2002/07/26 11:03:19 fs + IDL review form layer + + Revision 1.2.14.1 2002/02/19 08:13:11 oj + #96946# parameter,return value and exception description + + Revision 1.2 2001/04/19 10:56:41 fs + corrected the include protection + Revision 1.1 2001/04/19 08:46:13 fs initial checkin - service description for form related controls @@ -108,6 +119,15 @@ service TimeField /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.2.14.2 2002/07/26 11:03:19 fs + * IDL review form layer + * + * Revision 1.2.14.1 2002/02/19 08:13:11 oj + * #96946# parameter,return value and exception description + * + * Revision 1.2 2001/04/19 10:56:41 fs + * corrected the include protection + * * Revision 1.1 2001/04/19 08:46:13 fs * initial checkin - service description for form related controls * diff --git a/offapi/com/sun/star/formula/FormulaProperties.idl b/offapi/com/sun/star/formula/FormulaProperties.idl index 01ea7f9e4577..d03dad01dd29 100644 --- a/offapi/com/sun/star/formula/FormulaProperties.idl +++ b/offapi/com/sun/star/formula/FormulaProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormulaProperties.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,6 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::formula::FormulaProperties /** The formula properties provide access to the properties of a formula in a formula generator */ @@ -75,351 +74,304 @@ service FormulaProperties { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::Alignment - /** contains the alignment of the formula.@see HorizontalAlignment + /** contains the alignment of the formula. + @see HorizontalAlignment */ - [property] short Alignment ; + [property] short Alignment; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::BaseFontHeight /** contains the base font height in point the formula will be formatted in. - <p> All properties containing relative values are related to this value. </p> */ - [property] short BaseFontHeight ; + [property] short BaseFontHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameFixed /** customized name for fixed font. */ - [property] string CustomFontNameFixed ; + [property] string CustomFontNameFixed; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFixedIsItalic - /** determins if the customized fixed font italic. + /** determines if the customized fixed font is italic. */ [property] boolean FontFixedIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFixedIsBold - /** determins if the customized fixed font is bold. + /** determines if the customized fixed font is bold. */ [property] boolean FontFixedIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameSans /** customized name for sans serif font */ - [property] string CustomFontNameSans ; + [property] string CustomFontNameSans; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSansIsItalic - /** determins if the customized sans serif font is italic. + /** determines if the customized sans serif font is italic. */ [property] boolean FontSansIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSansIsBold - /** determins if the customized sans serif font is bold. + /** determines if the customized sans serif font is bold. */ [property] boolean FontSansIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::CustomFontNameSerif /** customized name for serif font */ - [property] string CustomFontNameSerif ; + [property] string CustomFontNameSerif; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSerifIsItalic - /** determins if the customized serif is italic. + /** determines if the customized serif font is italic. */ [property] boolean FontSerifIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontSerifIsBold - /** determins if the customized serif is bold. + /** determines if the customized serif font is bold. */ [property] boolean FontSerifIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameFunctions /** contains the name of the font that is used to display functions contained in the formula. */ - [property] string FontNameFunctions ; + [property] string FontNameFunctions; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFunctionsIsItalic - /** determins if the font that is used to - display functions is italic. + /** determines if the font that is used to display functions is italic. */ [property] boolean FontFunctionsIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontFunctionsIsBold - /** determins if the font that is used to - display functions is bold. + /** determines if the font that is used to display functions is bold. */ [property] boolean FontFunctionsIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameNumbers /** contains the name of the font that is used to display numbers contained in the formula. */ - [property] string FontNameNumbers ; + [property] string FontNameNumbers; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontNumbersIsItalic - /** determins if the font that is used to - display numbers is italic. + /** determines if the font that is used to display numbers is italic. */ [property] boolean FontNumbersIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontNumbersIsBold - /** determins if the font that is used to - display numbers is bold. + /** determines if the font that is used to display numbers is bold. */ [property] boolean FontNumbersIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameText /** contains the name of the font that is used to display text contained in the formula. */ - [property] string FontNameText ; + [property] string FontNameText; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontTextIsItalic - /** determins if the font that is used to - display text is italic. + /** determines if the font that is used to display text is italic. */ [property] boolean FontTextIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontTextIsBold - /** determins if the font that is used to - display text is bold. + /** determines if the font that is used to display text is bold. */ [property] boolean FontTextIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::FontNameVariables /** contains the name of the font that is used to display variables contained in the formula. */ - [property] string FontNameVariables ; + [property] string FontNameVariables; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontVariablesIsItalic - /** determins if the font that is used to - display variables is italic. + /** determines if the font that is used to display variables is italic. */ [property] boolean FontVariablesIsItalic; //------------------------------------------------------------------------- - // DocMerge from idl: property com::sun::star::formula::FormulaProperties::FontVariablesIsBold - /** determins if the font that is used to - display variables is bold. + /** determines if the font that is used to display variables is bold. */ [property] boolean FontVariablesIsBold; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::Formula /** contains the command string of the formula */ - [property] string Formula ; + [property] string Formula; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::IsScaleAllBrackets - /** decides if all brackets are scaled + /** decides if all brackets (even those without 'left'/'right' + modifier) are scaled. */ - [property] boolean IsScaleAllBrackets ; + [property] boolean IsScaleAllBrackets; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::IsTextMode /** switches into text mode. */ - [property] boolean IsTextMode ; + [property] boolean IsTextMode; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightFunctions /** contains the relative height of the font for functions. + + The values unit is percent of the + <member scope="com.sun.star.formula">FormulaProperties::BaseFontHeight</member> */ - [property] short RelativeFontHeightFunctions ; + [property] short RelativeFontHeightFunctions; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightIndices /** contains the relative height of the font for indices. + + The values unit is percent of the + <member scope="com.sun.star.formula">FormulaProperties::BaseFontHeight</member> */ - [property] short RelativeFontHeightIndices ; + [property] short RelativeFontHeightIndices; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightLimits /** contains the relative height of the font for limits. + + The values unit is percent of the + <member scope="com.sun.star.formula">FormulaProperties::BaseFontHeight</member> */ - [property] short RelativeFontHeightLimits ; + [property] short RelativeFontHeightLimits; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightOperators /** contains the relative height of the font for operators. + + The values unit is percent of the + <member scope="com.sun.star.formula">FormulaProperties::BaseFontHeight</member> */ - [property] short RelativeFontHeightOperators ; + [property] short RelativeFontHeightOperators; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFontHeightText /** contains the relative height of the font for text. + + The values unit is percent of the + <member scope="com.sun.star.formula">FormulaProperties::BaseFontHeight</member> */ - [property] short RelativeFontHeightText ; + [property] short RelativeFontHeightText; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeBracketDistance /** contains the relative distance of brackets. */ - [property] short RelativeBracketDistance ; + [property] short RelativeBracketDistance; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeBracketExcessSize /** contains the relative excess size of brackets. */ - [property] short RelativeBracketExcessSize ; + [property] short RelativeBracketExcessSize; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionBarExcessLength /** contains the relative excess length of a fraction bar. */ - [property] short RelativeFractionBarExcessLength ; + [property] short RelativeFractionBarExcessLength; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionBarLineWeight /** contains the relative line weight of a fraction bar. */ - [property] short RelativeFractionBarLineWeight ; + [property] short RelativeFractionBarLineWeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionDenominatorDepth /** contains the relative depth of the denominator of a fraction */ - [property] short RelativeFractionDenominatorDepth ; + [property] short RelativeFractionDenominatorDepth; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeFractionNumeratorHeight /** contains the relative height of the numerator of a fraction. */ - [property] short RelativeFractionNumeratorHeight ; + [property] short RelativeFractionNumeratorHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeIndexSubscript /** contains the relative superscript of indices. */ - [property] short RelativeIndexSubscript ; + [property] short RelativeIndexSubscript; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeIndexSuperscript /** contains the relative subscript of indices. */ - [property] short RelativeIndexSuperscript ; + [property] short RelativeIndexSuperscript; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeLineSpacing /** contains the relative line spacing. */ - [property] short RelativeLineSpacing ; + [property] short RelativeLineSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeLowerLimitDistance /** contains the relative distance of lower limits. */ - [property] short RelativeLowerLimitDistance ; + [property] short RelativeLowerLimitDistance; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeMatrixColumnSpacing /** contains the relative column spacing of matrices. */ - [property] short RelativeMatrixColumnSpacing ; + [property] short RelativeMatrixColumnSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeMatrixLineSpacing /** contains the relative line spacing of matrices. */ - [property] short RelativeMatrixLineSpacing ; + [property] short RelativeMatrixLineSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeOperatorExcessSize /** contains the relative excess of operators. */ - [property] short RelativeOperatorExcessSize ; + [property] short RelativeOperatorExcessSize; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeOperatorSpacing /** contains the relative spacing of operators. */ - [property] short RelativeOperatorSpacing ; + [property] short RelativeOperatorSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeRootSpacing /** contains the relative root spacing */ - [property] short RelativeRootSpacing ; + [property] short RelativeRootSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeScaleBracketExcessSize /** contains the relative scaling of the bracket excess. */ - [property] short RelativeScaleBracketExcessSize ; + [property] short RelativeScaleBracketExcessSize; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSpacing /** contains the relative spacing. */ - [property] short RelativeSpacing ; + [property] short RelativeSpacing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSymbolMinimumHeight /** contains the relative minimum height of the formula. */ - [property] short RelativeSymbolMinimumHeight ; + [property] short RelativeSymbolMinimumHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeSymbolPrimaryHeight /** contains the relative primary height of symbols. */ - [property] short RelativeSymbolPrimaryHeight ; + [property] short RelativeSymbolPrimaryHeight; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RelativeUpperLimitDistance /** contains the relative distance of upper limits */ - [property] short RelativeUpperLimitDistance ; + [property] short RelativeUpperLimitDistance; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::TopMargin /** contains the metric value of the top margin of the formula. */ - [property] short TopMargin ; + [property] short TopMargin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::BottomMargin /** contains the metric value of the bottom margin of the formula. */ - [property] short BottomMargin ; + [property] short BottomMargin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::LeftMargin /** contains the metric value of the left margin of the formula. */ - [property] short LeftMargin ; + [property] short LeftMargin; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::formula::FormulaProperties::RightMargin /** contains the metric value of the right margin of the formula. */ - [property] short RightMargin ; + [property] short RightMargin; }; //============================================================================= @@ -429,6 +381,12 @@ service FormulaProperties /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/04/08 13:02:59 tl + IDL review + + Revision 1.3 2000/11/08 12:43:14 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:20 hjs initial import diff --git a/offapi/com/sun/star/formula/SymbolDescriptor.idl b/offapi/com/sun/star/formula/SymbolDescriptor.idl index f8e717a337d7..28c92ec94682 100644 --- a/offapi/com/sun/star/formula/SymbolDescriptor.idl +++ b/offapi/com/sun/star/formula/SymbolDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SymbolDescriptor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-06-08 16:04:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,7 +66,13 @@ module com { module sun { module star { module formula { //============================================================================= - +/** @deprecated draft + - nWeight should be changed to float as in FontWeight.idl + - nItalic probably needs to have FontItalic extended by the two + extra defines REVERSE_* listed in FontSlant.idl + - nCharSet should have the CharSet.idl extended by the new defines + from rtl/textenc.h +*/ struct SymbolDescriptor { /** The name of the symbol. @@ -77,7 +83,7 @@ struct SymbolDescriptor */ string sExportName; - /** Specifies the symbol set to which this symbol belongs. + /** Specifies the name of the symbol set to which this symbol belongs. */ string sSymbolSet; @@ -90,22 +96,50 @@ struct SymbolDescriptor string sFontName; /** Specifies the character set which is supported by the font. + + @see <type scope="com::sun::star::awt">CharSet</type> */ short nCharSet; /** Specifies the general style of the font. + + @see <type scope="com::sun::star::awt">FontFamily</type> */ short nFamily; /** Specifies the pitch of the font. + + @see <type scope="com::sun::star::awt">FontPitch</type> */ short nPitch; /** Specifies the thickness of the line. + + @see <type scope="com::sun::star::awt">FontWeight</type> + + The allowed integer values correspond as follows: + 0 : <type member="com::sun::star::awt">FontWeight::DONTKNOW</member> + 1 : <type member="com::sun::star::awt">FontWeight::THIN</member> + 2 : <type member="com::sun::star::awt">FontWeight::ULTRALIGHT</member> + 3 : <type member="com::sun::star::awt">FontWeight::LIGHT</member> + 4 : <type member="com::sun::star::awt">FontWeight::SEMILIGHT</member> + 5 : <type member="com::sun::star::awt">FontWeight::NORMAL</member> + 7 : <type member="com::sun::star::awt">FontWeight::SEMIBOLD</member> + 8 : <type member="com::sun::star::awt">FontWeight::BOLD</member> + 9 : <type member="com::sun::star::awt">FontWeight::ULTRABOLD</member> + 10 : <type member="com::sun::star::awt">FontWeight::BLACK</member> + */ short nWeight; /** Specifies if the font is italic. + + @see <type scope="com::sun::star::awt">FontSlant</type> + + The values + <type member="com::sun::star::awt">FontSlant::REVERSE_OBLIQUE</member> and + <type member="com::sun::star::awt">FontSlant::REVERSE_ITALIC</member> + may not be used. */ short nItalic; }; diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl index dabd3faca4dd..a33f78ac8212 100644 --- a/offapi/com/sun/star/frame/Components.idl +++ b/offapi/com/sun/star/frame/Components.idl @@ -2,9 +2,9 @@ * * $RCSfile: Components.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,54 +65,31 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module frame { +module com { module sun { module star { module frame { //============================================================================= +/** specifies a collection of components -// DocMerge from xml: service com::sun::star::frame::Components -/** specifies a collection of components. - + <p> + One important instance of this service is available from the + <type>Desktop</type> object via the <type>XDesktop</type> interface. + </p> - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> - @see com::sun::star::lang::XComponent - @see XDesktop + @see com::sun::star::lang::XComponent + @see XDesktop */ service Components { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + /** use it to get snapshot of current avaliable components as an enumeration + */ interface com::sun::star::container::XEnumerationAccess; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.2 2000/10/09 14:24:56 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/ContentHandler.idl b/offapi/com/sun/star/frame/ContentHandler.idl new file mode 100644 index 000000000000..ba633a3ebaf0 --- /dev/null +++ b/offapi/com/sun/star/frame/ContentHandler.idl @@ -0,0 +1,104 @@ +/************************************************************************* + * + * $RCSfile: ContentHandler.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:14 $ + * + * 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_frame_ContentHandler_idl__ +#define __com_sun_star_frame_ContentHandler_idl__ + +#ifndef __com_sun_star_frame_XNotifyingDispatch_idl__ +#include <com/sun/star/frame/XNotifyingDispatch.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** special dispatcher for non visible contents, e.g. sounds + + <p> + This handler doesn't need any frame as target for loading components. + Content handler are registered for content types. + (See type/filter configuration of <type scope="com::sun::star::document">TypeDetection</type> + for further informations) If generic load mechanism found such documents which + can be handled by a ContentHandler it will create and use it. + </p> + + @see com::sun::star::document::TypeDetection + */ +service ContentHandler +{ + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + interface XNotifyingDispatch; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/ContentHandlerFactory.idl b/offapi/com/sun/star/frame/ContentHandlerFactory.idl new file mode 100644 index 000000000000..64b9573843f6 --- /dev/null +++ b/offapi/com/sun/star/frame/ContentHandlerFactory.idl @@ -0,0 +1,145 @@ +/************************************************************************* + * + * $RCSfile: ContentHandlerFactory.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ + * + * 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_frame_ContentHandlerFactory_idl__ +#define __com_sun_star_frame_ContentHandlerFactory_idl__ + +#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ +#include <com/sun/star/lang/XMultiServiceFactory.idl> +#endif + +#ifndef __com_sun_star_container_XNameAccess_idl__ +#include <com/sun/star/container/XNameAccess.idl> +#endif + +#ifndef __com_sun_star_container_XContainerQuery_idl__ +#include <com/sun/star/container/XContainerQuery.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** factory to create content loader + + <p> + With this factory it's possible to + <ul> + <li>have access on configuration of set of registered content handler objects</li> + <li>create a content handler by his internal name</li> + <li>query for a content handler by using special query or property description.</li> + </ul> + </p> + */ +service ContentHandlerFactory +{ + //------------------------------------------------------------------------- + /** interface to create handler objects by using his internal name + + <p> + Returned objects must support the service specification of a <type>ContentHandler</type>. + They can be created by using of his internal name, which must be unambigous everytime, only. + To get this name use further specified interfaces of this factory for access on + the flat configuration. + </p> + */ + interface com::sun::star::lang::XMultiServiceFactory; + + //------------------------------------------------------------------------- + /** provides access to the whole content handler configuration + + <p> + This interface supports an access to the internal configuration + of all accessible handler objects. The return value of + <member>XNameAccess::getByName()</member> is a property sequence + packed in an any. + </p> + <table border=1> + <tr> + <td><b>Types<b></td> + <td>[string]</td> + <td>file types for which handler is registered</td> + </tr> + <tr> + <td><b>UIName<b></td> + <td>[string]</td> + <td>UI representable and localized name</td> + </tr> + </table> + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + /** supports query mode for configuration access + + <p> + This interface can be used to get sub sets of current configuration entries + which represent given search parameters. + </p> + */ + interface com::sun::star::container::XContainerQuery; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl index 25435626fc73..68dfdd9580b7 100644 --- a/offapi/com/sun/star/frame/Controller.idl +++ b/offapi/com/sun/star/frame/Controller.idl @@ -2,9 +2,9 @@ * * $RCSfile: Controller.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:26:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,34 +73,70 @@ #include <com/sun/star/awt/XWindow.idl> #endif +#ifndef __com_sun_star_ui_XContextMenuInterception_idl__ +#include <com/sun/star/ui/XContextMenuInterception.idl> +#endif + +#ifndef __com_sun_star_view_XSelectionSupplier_idl__ +#include <com/sun/star/view/XSelectionSupplier.idl> +#endif //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::Controller /** is an abstract service for a component which offers a deeper integration of - desktop components than a <type scope="com::sun::star::awt">UnoControl</type> - can offer. - - <!-- Dennis: Are the descriptions of XController and XDispatchProvider missing descriptions? -->*/ + desktop components than a <type scope="com::sun::star::awt">XWindow</type> + can offer + + <p> + Such components can be loaded into a <type>Frame</type> inside a <type>Desktop</type> + environment. A controller is a recher component then a pure window, but full featured + components need a <type>XModel</type> interface too. + <br> + (see service <type scope="com::sun::star::document">OfficeDocument</type> for further information) + <p> + + @see com::sun::star::document::OfficeDocument + */ service Controller { - // DocMerge: empty anyway - interface com::sun::star::frame::XController; + //------------------------------------------------------------------------- + /** with this interface, components viewed in a <type>Frame</type> can serve + events (by supplying dispatches) + */ + interface XController; - // DocMerge: empty anyway - interface com::sun::star::frame::XDispatchProvider; + //------------------------------------------------------------------------- + /** for certain functions which are useful at the UI + <p> + Mostly used by the <type>Frame</type> service, which contains this + controller object. There will be an interception mechanism for dispatches + available too. + </p> - // DocMerge from xml: service com::sun::star::frame::Controller: interface com::sun::star::awt::XWindow - /** Possibly the controller and the main window of the component - are the same object. + @see XDispatch + @see XDispatchProviderInterception */ - interface com::sun::star::awt::XWindow; + interface XDispatchProvider; + //------------------------------------------------------------------------- + /** this interface enables the controller to get interceptors registered that + change context menue or prevent them from beeing executed + + <p> + Don't mix it with <type>XDispatchProviderInterception</type> which + intercept calls of <member>XDispatch::dispatch()</member>. + </p> + */ + [optional] interface com::sun::star::ui::XContextMenuInterception; + + //------------------------------------------------------------------------- + /** makes it possible to access and change the selection in a view + */ + [optional] interface com::sun::star::view::XSelectionSupplier; }; //============================================================================= @@ -110,6 +146,12 @@ service Controller /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.14.1 2002/06/17 08:44:10 as + odk review + + Revision 1.4 2001/04/13 20:26:41 arellano + revised plural and added question + Revision 1.3 2000/11/08 12:43:14 mi moved from api diff --git a/offapi/com/sun/star/frame/Desktop.idl b/offapi/com/sun/star/frame/Desktop.idl index 6062b6fe8819..ac4c56e67abe 100644 --- a/offapi/com/sun/star/frame/Desktop.idl +++ b/offapi/com/sun/star/frame/Desktop.idl @@ -2,9 +2,9 @@ * * $RCSfile: Desktop.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,16 @@ #include <com/sun/star/frame/Frame.idl> #endif -#ifndef __com_sun_star_lang_Locale_idl__ -#include <com/sun/star/lang/Locale.idl> +#ifndef __com_sun_star_frame_XDesktop_idl__ +#include <com/sun/star/frame/XDesktop.idl> +#endif + +#ifndef __com_sun_star_frame_XComponentLoader_idl__ +#include <com/sun/star/frame/XComponentLoader.idl> +#endif + +#ifndef __com_sun_star_document_XEventBroadcaster_idl__ +#include <com/sun/star/document/XEventBroadcaster.idl> #endif #ifndef __com_sun_star_beans_XPropertySet_idl__ @@ -77,64 +85,48 @@ module com { module sun { module star { module frame { -interface XDesktop; -interface XComponentLoader; -interface XTasksSupplier; - //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::Desktop -/** is the environment for components which can instantiate within frames. - - <p>A desktop environment contains tasks with one or more frames - in which components can be loaded.</p> +/** is the environment for components which can instantiate within frames + + <p> + A desktop environment contains tasks with one or more frames + in which components can be loaded. The term "task" or naming a frame as a + "task frame" is not in any way related to any additional implemented + interfaces, it's just because these frames use task windows. + </p> */ service Desktop { + //------------------------------------------------------------------------- + /** make it possible to be the global root of different seperated frame trees + + <p> + It's not a must for a frame (neither a frame tree) to be a part of this + global tree. But such outstanding frames willn't be accessible by the normal + frame api. + </p> + */ service Frame; + //------------------------------------------------------------------------- + /** regulate life time of desktop environment and support high level + access to components of sub frame tree + */ interface XDesktop; + + //------------------------------------------------------------------------- + /** supports simple api for loading components into the frame environment + */ interface XComponentLoader; - interface XTasksSupplier; - interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - /** returns currently active child frame of desktop + /** provides listener support for events on currently loaded documents */ - [property, readonly] com::sun::star::frame::XFrame ActiveFrame; + interface com::sun::star::document::XEventBroadcaster; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/09/26 09:57:05 as - #79395# actualize service description - - Revision 1.4 2001/03/15 08:53:46 as - #80780# remove non supported property - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.3 2000/02/09 15:45:28 mi - #72875# HasDesigner is now HasStylist - - Revision 1.2 2000/02/09 10:39:35 as - #72208# new property ISOLocale - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/DesktopTask.idl b/offapi/com/sun/star/frame/DesktopTask.idl index 6e51369abc99..c16e8fe51837 100644 --- a/offapi/com/sun/star/frame/DesktopTask.idl +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: DesktopTask.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:38:58 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,112 +89,31 @@ #include <com/sun/star/awt/Size.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::DesktopTask -/** specifies a separate task within a desktop environment.@see DesktopTasks +/** @deprecated */ service DesktopTask { - // DocMerge: empty anyway interface com::sun::star::frame::XDesktopTask; - - // DocMerge: empty anyway interface com::sun::star::frame::XFrame; - - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - - // DocMerge: empty anyway interface com::sun::star::frame::XWindowArranger; - - // DocMerge: empty anyway interface com::sun::star::frame::XFramesSupplier; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::Title - /** contains the title of the component which is active within the task. - */ [readonly, property] string Title; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsDesktop - /** determines if the task is the desktop task. - */ [readonly, property] boolean IsDesktop; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsVisible - /** determines if the task is visible or not. - */ [property] boolean IsVisible; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsFloating - /** determines if the task is floating or not. - */ [property] boolean IsFloating; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::IsAlwaysVisible - /** determines if the task is always visible or only when active. - */ [property] boolean IsAlwaysVisible; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::Position - /** contains the position in pixels relative to the desktop window. - */ [property] com::sun::star::awt::Point Position; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::DesktopTask::Size - /** contains the size in pixel. - */ [property] com::sun::star::awt::Size Size; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:01 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/DesktopTasks.idl b/offapi/com/sun/star/frame/DesktopTasks.idl index f4a2685d45a8..719e2298797a 100644 --- a/offapi/com/sun/star/frame/DesktopTasks.idl +++ b/offapi/com/sun/star/frame/DesktopTasks.idl @@ -2,9 +2,9 @@ * * $RCSfile: DesktopTasks.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,50 +65,20 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::DesktopTasks -/** specifies a collection of tasks. - - - - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. - - </p>@see DesktopTask - @see XDesktop +/** @deprecated */ service DesktopTasks { - // DocMerge: empty anyway interface com::sun::star::container::XEnumerationAccess; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/DispatchDescriptor.idl b/offapi/com/sun/star/frame/DispatchDescriptor.idl index 4d295130e4b7..d3d92389da3a 100644 --- a/offapi/com/sun/star/frame/DispatchDescriptor.idl +++ b/offapi/com/sun/star/frame/DispatchDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-04-13 20:42:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,59 +71,57 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: struct com::sun::star::frame::DispatchDescriptor /** describes a feature to be retrieved by a URL that - has to be loaded into a specified frame. + has to be loaded into a specified frame + + <p> + For a normal dispatch calls all needed parameters are seperated. + For optimized remote functionality <member>XDispatch::queryDispatches()</member> + it's neccessary to pack these parameters in a flat structure wich can be used + in a simple manner. + </p> + + @see XDispatchProvider::queryDispatches() */ struct DispatchDescriptor { - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FeatureURL - /** Specifies the URL of the resource/function. + //------------------------------------------------------------------------- + /** specifies the URL of the resource/function + + <p> + Must be a full parsed URL. Use service <type scope="com::sun::star::util">URLTransformer</type> + for that. + </p> + + @see com::sun::star::util::URLTransformer */ com::sun::star::util::URL FeatureURL; //------------------------------------------------------------------------- + /** name of the target frame + + <p> + Special targets (e.g. "_blank", "_self") can be used. + </p> - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::FrameName - /** Name of the target frame. + @see XDispatchProvider::queryDispatch() */ string FrameName; //------------------------------------------------------------------------- + /** describes how the target frame is to be searched - // DocMerge from xml: field com::sun::star::frame::DispatchDescriptor::SearchFlags - /** How the target frame is to be searched. + <p> + This optional parameter is used if <var>FrameName</var> isn't a special target only. + </p> + + @see FrameSearchFlag */ long SearchFlags; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:01 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/DispatchProvider.idl b/offapi/com/sun/star/frame/DispatchProvider.idl new file mode 100644 index 000000000000..a58875b6e274 --- /dev/null +++ b/offapi/com/sun/star/frame/DispatchProvider.idl @@ -0,0 +1,121 @@ +/************************************************************************* + * + * $RCSfile: DispatchProvider.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ + * + * 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_frame_DispatchProvider_idl__ +#define __com_sun_star_frame_DispatchProvider_idl__ + +#ifndef __com_sun_star_frame_XDispatchProvider_idl__ +#include <com/sun/star/frame/XDispatchProvider.idl> +#endif + +#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__ +#include <com/sun/star/frame/XDispatchProviderInterception.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module frame { + +//============================================================================= +/** provides <type>XDispatch</type> objects for certain functions which + are useful at the UI + + <p> + Such dispatch objects must be queried explicitly and used for + queried purposes only. They can handle requests with guaranteed + notifications (<type>XNotifyingDispatch</type>) and with possible + (but not guaranteed) notifications + </p> + + @see XNotifyingDispatch + @see XDispatch + */ +service DispatchProvider +{ + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + interface XDispatchProvider; + + //------------------------------------------------------------------------- + /** provides handling of dispatches with defined result state + + <p> + Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + and can be called for requests if result isn't neccessary for dispatch operation. + </p> + + @see XDispatch + */ + [optional] interface XDispatchProviderInterception; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/frame/DispatchResultEvent.idl b/offapi/com/sun/star/frame/DispatchResultEvent.idl index 174d4f92f554..4595e937cfdd 100644 --- a/offapi/com/sun/star/frame/DispatchResultEvent.idl +++ b/offapi/com/sun/star/frame/DispatchResultEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchResultEvent.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mba $ $Date: 2001-11-21 12:49:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,19 +75,29 @@ module com { module sun { module star { module frame { //============================================================================= +/** contains the result of the dispatch action, if State is set to SUCCESS + <p> + The type of the result is dispatch action dependend. The member State + can be set to one of the values defined in <type>DispatchResultState</type>. + If State is set to <const>DispatchResultState::FAILURE</const>, Result may + specify the reason (or is empty). The type is also dispatch action dependend. + If State is set to <const>DispatchResultState::DONTKNOW</const>, Result is empty. + </p> + + @see DispatchResultState +*/ struct DispatchResultEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - /**Contains the result of the dispatch action, if State is set to SUCCESS. - The type of the result is dispatch action dependend.<BR> - The member State can be set to one of the values defined in <type>DispatchResultState</type>.<BR> - If State is set to FAILURE, Result may specify the reason (or is empty). - The type is also dispatch action dependend.<BR> - If State is set to DONTKNOW, Result is empty.<BR> - */ - short State; - any Result; + /** describes state of dispatch + */ + short State; + + //------------------------------------------------------------------------- + /** describes result for given <var>State</var> + */ + any Result; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/DispatchResultState.idl b/offapi/com/sun/star/frame/DispatchResultState.idl index 79fa017fccd7..2638ad99a9e4 100644 --- a/offapi/com/sun/star/frame/DispatchResultState.idl +++ b/offapi/com/sun/star/frame/DispatchResultState.idl @@ -2,9 +2,9 @@ * * $RCSfile: DispatchResultState.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-21 12:49:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,16 +66,24 @@ module com { module sun { module star { module frame { //============================================================================= -/** +/** possible values for <type>DispatchResultEvent</type> */ - constants DispatchResultState { - const short FAILURE = 0; + //------------------------------------------------------------------------- + /** indicates: dispatch failed + */ + const short FAILURE = 0; - const short SUCCESS = 1; + //------------------------------------------------------------------------- + /** indicates: dispatch was successfully + */ + const short SUCCESS = 1; - const short DONTKNOW = 2; + //------------------------------------------------------------------------- + /** indicates: result isn't defined + */ + const short DONTKNOW = 2; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/DocumentTemplates.idl b/offapi/com/sun/star/frame/DocumentTemplates.idl index a74d19799ae6..2d12d5101b5b 100644 --- a/offapi/com/sun/star/frame/DocumentTemplates.idl +++ b/offapi/com/sun/star/frame/DocumentTemplates.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentTemplates.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,42 +70,20 @@ module com { module sun { module star { module frame { //============================================================================= - /** is an abstract service for accessing the document templates of the office and manipulate them ( add or rename or remove templates ) */ - service DocumentTemplates { - // DocMerge: empty anyway - interface com::sun::star::frame::XDocumentTemplates; + //------------------------------------------------------------------------- + /** implements a high level interface on top of an ucb content provider + which is used for template configuration + */ + interface XDocumentTemplates; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1 2001/07/27 12:34:51 dv - #86311# Added for documentation purposes - - Revision 1.4 2001/04/13 20:26:41 arellano - revised plural and added question - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index 5b617cb5fc80..37dc7d226529 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FeatureStateEvent.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,92 +75,55 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: struct com::sun::star::frame::FeatureStateEvent /** This event is broadcast by a <type>Controller</type> whenever the state of - the feature changes. @see XController - @see XStatusListener + the feature changes + + @see XController + @see XStatusListener */ struct FeatureStateEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureURL /** contains the URL of the feature. */ com::sun::star::util::URL FeatureURL; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureDescriptor /** contains a descriptor of the feature for the user interface. */ string FeatureDescriptor; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::IsEnabled /** specifies whether the feature is currently enabled or disabled. */ boolean IsEnabled; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::Requery /** specifies whether the <type>XDispatch</type> has to be requeried. + + <p> + Interest code should listen for <type>FrameActionEvents</type> + too, to update own feature states and dispatch listener on + <const>FrameAction::CONTEXT_CHANGED</const>. + </p> */ boolean Requery; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::State /** contains the state of the feature in this dispatch. - <p>This can be, for example, simply <TRUE/> for a boolean feature like + <p> + This can be, for example, simply <TRUE/> for a boolean feature like underline on/off. Some simple types like <code>string</code> or <atom>boolean</atom> are useful here for generic UI elements, like - a checkmark in a menu.</p> - - <!-- Dennis: The <true> is appearing on the openoffice Web page. --> + a checkmark in a menu. + </p> */ any State; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/04/13 20:49:34 arellano - corrected tense and added comment - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/Frame.idl b/offapi/com/sun/star/frame/Frame.idl index 3abdde00ce2b..c03cf97bdced 100644 --- a/offapi/com/sun/star/frame/Frame.idl +++ b/offapi/com/sun/star/frame/Frame.idl @@ -2,9 +2,9 @@ * * $RCSfile: Frame.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,14 @@ #include <com/sun/star/frame/XDispatchProvider.idl> #endif +#ifndef __com_sun_star_frame_XDispatchRecorderSupplier_idl__ +#include <com/sun/star/frame/XDispatchRecorderSupplier.idl> +#endif + +#ifndef __com_sun_star_frame_XDispatchProviderInterception_idl__ +#include <com/sun/star/frame/XDispatchProviderInterception.idl> +#endif + #ifndef __com_sun_star_frame_XFramesSupplier_idl__ #include <com/sun/star/frame/XFramesSupplier.idl> #endif @@ -77,94 +85,127 @@ #include <com/sun/star/task/XStatusIndicatorFactory.idl> #endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::Frame -/** represents the environment for a desktop component. +/** represents the environment for a desktop component + + <p> + Frames are the anchors for the office components and they are the components' link + to the outside world. They create a skeleton for the whole office api infrastructure + by building frame hierarchys. These hierarchies contains all currently loaded + documents and make it possible to walk during these trees. + A special service <type>Desktop</type> can(!) combine different of such trees + to a global one which life time will be controlled by it. + </p> + + @see Desktop */ service Frame { - - - // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFrame + //------------------------------------------------------------------------- /** allows the component to be loaded and accessed - within the frame; it is the main connection to the - environment of the component. + within the frame; it is the main connection to the + environment of the component. */ - interface com::sun::star::frame::XFrame; + interface XFrame; + //------------------------------------------------------------------------- /** provides access to dispatchers for the frame. - <p>What kind of URLs a frame accepts in the calls to <method>XDispatchProvider::queryDispatch</method>, + <p> + What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, and how the returned dispatcher handles dispatches is completely implementation dependent - (though of course the restrictions of <type>XDispatchProvider</type> must be met).</p> - - <p>Frame implementations may (optionally) support special targets in the call to - <method>XDispatchProvider::queryDispatch</method>.</p> - - <p>Such special targets are passed as target frame name. They may, in addition, + (though of course the restrictions of <type>XDispatchProvider</type> must be met). + Frame implementations may (optionally) support special targets in the call to + <member>XDispatchProvider::queryDispatch()</member>. + Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see <type>FrameSearchFlag</type>), or, in opposite, limit the set of allowed flags.<br> Common special targets include: <ul> <li><b>_blank</b> is used to create a new frame when dispatching the URL.</li> - <li><b>_self</b> forces the frame to dispatch the URL into itself.</li> + <li><b>_default</b> is used to recycle empty or create a new frame when dispatching the URL.</li> + <li><b>_self</b> forces the frame to dispatch the URL into itself. ("" means the same)</li> <li><b>_parent</b> dispatches the URL into the parent frame.</li> <li><b>_top</b> dispatches the URL into the top level frame, the frame where this is invoked belongs to.</li> - <li><b>_helpagent</b> dispatches the URL into the help agent window belonging to the frame.</li> </ul> </p> @see XDispatch + @see XFrame::findFrame() */ - interface com::sun::star::frame::XDispatchProvider; + interface XDispatchProvider; + //------------------------------------------------------------------------- + /** supports interception mechanism for dispatched URLs - // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::frame::XFramesSupplier - /** This optional interface is used to access sub-frames within this - Frame. + <p> + Registered objects can intercept, supress or deroute dispatched URLs. + If they support another interface too (<type>XInterceptorInfo</type>) + it's possible to perform it by directly calling of right interceptor without + using list of all registered ones. + </p> */ - [optional] interface com::sun::star::frame::XFramesSupplier; + interface XDispatchProviderInterception; + //------------------------------------------------------------------------- + /** provides access to sub frames within this frame + */ + interface XFramesSupplier; - // DocMerge from xml: service com::sun::star::frame::Frame: interface com::sun::star::task::XStatusIndicatorFactory - /** This optional interface supplies access to <type>XStatusIndicator</type>s - for the component within the frame. + //------------------------------------------------------------------------- + /** supplies access to <type scope="com::sun::star::task">XStatusIndicator</type> objects + for the component within the frame to show progresses */ [optional] interface com::sun::star::task::XStatusIndicatorFactory; + //------------------------------------------------------------------------- + /** if possible it sets/gets the UI title on/from the frame container window + + <p> + It depends from the type of the frame container window. If it is a system + task window all will be OK. Otherwise the title can't be set. + Setting/getting of the pure value of this property must be possible in every + case. Only showing on the UI can be fail. + </p> + */ + [property] string Title; + + //------------------------------------------------------------------------- + /** provides access to the dispatch recorder of the frame + + <p> + Such recorder can be used to record dispatch requests. + The supplier contains a dispatch recorder and provide the functionality + to use it for any dispatch object from outside which supports the interface + <type>XDispatch</type>. A supplier is available only, if recording was enabled. + That means: if somewhere whish to enable recoding on a frame he must set + a supplier with a recorder object inside of it. Every user of dispatches + has to check then if such supplier is available at this frame property. + If value of this property is <NULL/> he must call <member>XDispatch::dispatch()</member> + on the original dispatch object. If it's a valid value he must use the supplier + by calling his method <member>XDispatchRecordeSupplier::dispatchAndRecord()</member> + with the original dispatch object as argument. + </p> + + <p> + Note:<br> + It's not recommended to cache an already getted supplier. Because there exist + no possibility to check for enabled/disabled recording then. + </p> + */ + [property] XDispatchRecorderSupplier RecorderSupplier; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/05/11 12:09:47 fs - added a rudimentary documentation to the XDispatchProvider interface (mainlyfor mentioning the _helpagent target) - - Revision 1.4 2001/01/23 10:08:25 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl index 88bb42dc6241..8700905cc5c9 100644 --- a/offapi/com/sun/star/frame/FrameAction.idl +++ b/offapi/com/sun/star/frame/FrameAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,123 +67,119 @@ module com { module sun { module star { module frame { //============================================================================= +/** these are the events which can happen to the components in frames + of the desktop -// DocMerge from xml: enum com::sun::star::frame::FrameAction -/** These are the events which can happen to the components in frames - of the desktop. + <p> + Interest listener can get informations about loaded/realoed or unloaded + components into a <type>Frame</type>. + </p> + + @see XFrame + @see XFrameActionListener + @see FrameActionEvent */ enum FrameAction { //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component is + attached to a frame - // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_ATTACHED - /** An event of this kind is broadcast whenever a component is - attached to a frame. - - <p>This is almost the same as the instantiation of the component + <p> + This is almost the same as the instantiation of the component within that frame. The component is attached to the frame - immediately before this event is broadcast.</p>@see XFrame::activated + immediately before this event is broadcast. + </p> + + @see XFrame::setComponent() */ COMPONENT_ATTACHED, //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component is + detaching from a frame - // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_DETACHING - /** An event of this kind is broadcast whenever a component is - detaching from a frame. - - <p>This is quite the same as the destruction of the component + <p> + This is quite the same as the destruction of the component which was in that frame. At the moment when the event is broadcast the component is still attached to the frame but in the next moment it won't. </p> + + @see XFrame::setComponent() */ COMPONENT_DETACHING, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::COMPONENT_REATTACHED - /** An event of this kind is broadcast whenever a component is + /** an event of this kind is broadcast whenever a component is attached to a new model. - <p>In this case the component remains the same but operates - on a new model component.</p> + <p> + In this case the component remains the same but operates + on a new model component. + </p> */ COMPONENT_REATTACHED, //------------------------------------------------------------------------- + /** an event of this kind is broadcast whenever a component gets + activated - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_ACTIVATED - /** An event of this kind is broadcast whenever a component gets - activated. + <p> + Activations are broacast from the top component which was + not active before, down to the inner most component. + </p> - <p>Activations are broacast from the top component which was - not active before, down to the inner most component.</p>@see XFrame::activated + @see XFrame::activate() */ FRAME_ACTIVATED, //------------------------------------------------------------------------- + /** an event of this kind is broadcasted immediately before the + component is deactivated - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_DEACTIVATING - /** An event of this kind is broadcasted immediately before the - component is deactivated. - - <p>Deactivations are broadcast from the innermost component which + <p> + Deactivations are broadcast from the innermost component which does not stay active up to the outer most component which does not - stay active.</p> - @see XFrame::contextChanged + stay active. + </p> + + @see XFrame::deactivate() */ FRAME_DEACTIVATING, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::CONTEXT_CHANGED - /** An event of this kind is broadcast whenever a component changes + /** an event of this kind is broadcast whenever a component changes its internal context (i.e., the selection). - <p>If the activation status within a frame changes, this counts as + <p> + If the activation status within a frame changes, this counts as a context change too. </p> + + @see XFrame::contexChanged() */ CONTEXT_CHANGED, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_ACTIVATED - /** An event of this kind is broadcast by an active frame when it + /** an event of this kind is broadcast by an active frame when it is getting UI control (tool control). + + @see XFrame::activate() */ FRAME_UI_ACTIVATED, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::frame::FrameAction::FRAME_UI_DEACTIVATING - /** An event of this kind is broadcast by an active frame when it + /** an event of this kind is broadcast by an active frame when it is losing UI control (tool control). + + @see XFrame::deactivate() */ FRAME_UI_DEACTIVATING - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:27 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FrameActionEvent.idl b/offapi/com/sun/star/frame/FrameActionEvent.idl index 30b1480c5587..31e2d8aa68a1 100644 --- a/offapi/com/sun/star/frame/FrameActionEvent.idl +++ b/offapi/com/sun/star/frame/FrameActionEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameActionEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,63 +73,31 @@ #include <com/sun/star/frame/FrameAction.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** this event struct is broadcast for actions which can happen to + components within frames -// DocMerge from xml: struct com::sun::star::frame::FrameActionEvent -/** This event struct is broadcast for actions which can happen to - components within frames. @see XFrameActionListener + @see XFrameActionListener */ struct FrameActionEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FrameActionEvent::Frame - /** contains the frame in which the event occured. + /** contains the frame in which the event occured */ - com::sun::star::frame::XFrame Frame; + XFrame Frame; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::frame::FrameActionEvent::Action - /** specifies the concrete event. + /** specifies the concrete event */ - com::sun::star::frame::FrameAction Action; - + FrameAction Action; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl index f79edfe5a43d..e124fbda2af3 100644 --- a/offapi/com/sun/star/frame/FrameControl.idl +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,77 +69,46 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::FrameControl -/** contains a frame with a desktop component. - - <p>If the control is visible and has a valid (loadable) component URL, - then the <member>FrameControl::Frame</member> property is set.</p> +/** contains a frame with a desktop component + + <p> + If the control is visible and has a valid (loadable) component URL, + then the <member>FrameControl::Frame</member> property is set. + Normaly this control can be used for preview functionality inside + any UI. + </p> */ service FrameControl { - - - // DocMerge from xml: service com::sun::star::frame::FrameControl: service com::sun::star::awt::UnoControl - /** The base service of all controls. + //------------------------------------------------------------------------- + /** the base service of all controls */ service com::sun::star::awt::UnoControl; - - // DocMerge from xml: service com::sun::star::frame::FrameControl: interface com::sun::star::beans::XPropertySet - /** provides access to the properties of this service. - */ - interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::frame::FrameControl::ComponentUrl /** contains the type of the component which is loaded into the frame, - or the document which implicitly specifies the type. + or the document which implicitly specifies the type */ [property] string ComponentUrl; //------------------------------------------------------------------------- + /** the frame held by this control - // DocMerge from xml: property com::sun::star::frame::FrameControl::Frame - /** The frame held by this control. The <type>Frame</type> is created if the control - is shown and the component's URL is set. + <p> + The <type>Frame</type> is created if the control + is shown and the <member>ComponentUrl</member> is set. + </p> */ - [readonly, property] string Frame; - + [property, readonly] string Frame; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:01 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FrameLoader.idl b/offapi/com/sun/star/frame/FrameLoader.idl index 2b895deb6885..cebe39ad361f 100644 --- a/offapi/com/sun/star/frame/FrameLoader.idl +++ b/offapi/com/sun/star/frame/FrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameLoader.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,56 +58,76 @@ * * ************************************************************************/ -#ifndef __com_sun_star_frame_Frame_idl__ -#define __com_sun_star_frame_Frame_idl__ +#ifndef __com_sun_star_frame_FrameLoader_idl__ +#define __com_sun_star_frame_FrameLoader_idl__ #ifndef __com_sun_star_frame_XFrameLoader_idl__ #include <com/sun/star/frame/XFrameLoader.idl> #endif +#ifndef __com_sun_star_lang_XInitialization_idl__ +#include <com/sun/star/lang/XInitialization.idl> +#endif + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** derivations of this abstract service are used to load components + into <type>Frame</type>s of the environment -// DocMerge from xml: service com::sun::star::frame::FrameLoader -/** Derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment. - - <p>Concrete implementations of this service register, for example, + <p> + Concrete implementations of this service register, for example, for file name extensions or MIME types to load appropriate - components. The components loaded are at least <type>Controller</type>.</p> + components. The components loaded are at least <type>Controller</type>. + Instead of <type>SynchronousFrameLoader</type> this one use asynchronous + processes to load the component. + </p> - <!-- Dennis: Please reword the above paragraph -->*/ + @see SynchronousFrameLoader + */ service FrameLoader { - // DocMerge: empty anyway - interface com::sun::star::frame::XFrameLoader; + //------------------------------------------------------------------------- + /** support asynchronous loading of the component + */ + interface XFrameLoader; + + //------------------------------------------------------------------------- + /** support initialization of loader with its own configuration! + + <p> + Concrete implementations should use it to get her own configuration data + directly after creation by the <type>FrameLoaderFactory</type>. + Otherwhise they must use normal configuration api to do so. + </p> + */ + [optional] interface com::sun::star::lang::XInitialization; + + //------------------------------------------------------------------------- + /** provides access to the internal name of this frame loader + + <p> + The internal name is a part of his configuration and will be passed by + the <type>FrameLoaderFactory</type> after creation + if optional interface <type scope="com::sun::star::lang">XInitialization</type> + is supported. Value of function <member>XNamed::getName()</member> can be + used on service <type>FrameLoaderFactory</type> to get further informations about this loader. + Setting of this name by calling <member>XNamed::setName()</member> must be + forwarded to same factory service. He should decide, if it's allowed or not. + The reason: prevent code against name ambigities. + </p> + */ + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/04/24 00:07:05 arellano - added comment - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1 2000/05/25 10:26:18 mi - Doku - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FrameLoaderFactory.idl b/offapi/com/sun/star/frame/FrameLoaderFactory.idl index ea01c93f5e77..8cb95f7e73ae 100644 --- a/offapi/com/sun/star/frame/FrameLoaderFactory.idl +++ b/offapi/com/sun/star/frame/FrameLoaderFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameLoaderFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,44 +69,73 @@ #include <com/sun/star/container/XNameAccess.idl> #endif +#ifndef __com_sun_star_container_XContainerQuery_idl__ +#include <com/sun/star/container/XContainerQuery.idl> +#endif + //============================================================================= module com { module sun { module star { module frame { //============================================================================= - /** factory to create frame loader + + <p> + With this factory it's possible to + <ul> + <li>have access on configuration of set of registered frame laoder objects</li> + <li>create a frame laoder by his internal name</li> + <li>query for a frame laoder by using special query or property description.</li> + </ul> + </p> */ service FrameLoaderFactory { //------------------------------------------------------------------------- - /**interface to create the loader - <p> - After a <type>TypeDetection</type> you can use these interfaces to create the right loader to - load the document into a frame. Give it an internal type name and it creates a suitable - <type>XSynchronousFrameLoader</type> or <type>XFrameLoader</type> and returns it by calling - XMultiServiceFactory::createInstance...() - - casted to XInterface! Please check returned object for his supported interface! + /** interface to create loader objects by using his internal name - @attention Method XMultiServiceFactory::getAvailableServiceNames() isn't supported! - Please use XNameAcces of these service for access on loader configuration. + <p> + Returned objects must support the service specification of a <type>FrameLoader</type> + or <type>SynchronousFrameLoader</type>. (Note: last one will be prefered if both ones + are available) + They can be created by using of his internal name, which must be unambigous everytime, only. + To get this name use further specified interfaces of this factory for access on + the flat configuration. </p> */ interface com::sun::star::lang::XMultiServiceFactory; //------------------------------------------------------------------------- - /**readonly access to loader configuration + /** provides access to the whole frame loader configuration <p> - These interface support a readonly access to our internal configuration of all accessible loader. - The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any!</p> -<pre> -Supported properties are: -<property name value type of property description/> -"Types" [sequence< string > ] loader is registered for these types -"UIName" [string ] localized name of loader to show it at UI -</pre> */ + This interface supports an access to the internal configuration of all accessible loader objects. + The return value of <member>XNameAccess::getByName()</member> is a property sequence packed in an any. + </p> + <table border=1> + <tr> + <td><b>Types<b></td> + <td>[string]</td> + <td>file types which loader is registered for</td> + </tr> + <tr> + <td><b>UIName<b></td> + <td>[string]</td> + <td>UI representable and localized name</td> + </tr> + </table> + */ interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + /** supports query mode for configuration access + + <p> + This interface can be used to get sub sets of current configuration entries + which represent given search parameters. + </p> + */ + interface com::sun::star::container::XContainerQuery; }; //============================================================================= diff --git a/offapi/com/sun/star/frame/FrameSearchFlag.idl b/offapi/com/sun/star/frame/FrameSearchFlag.idl index 826da8b70e22..da5274348d3c 100644 --- a/offapi/com/sun/star/frame/FrameSearchFlag.idl +++ b/offapi/com/sun/star/frame/FrameSearchFlag.idl @@ -2,9 +2,9 @@ * * $RCSfile: FrameSearchFlag.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,99 +67,98 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from idl: constants com::sun::star::frame::FrameSearchFlag -/** These types describe the algorithm to be used to search a frame. +/** these types describe the algorithm to be used to search a frame + + <p> + Such flags will be used on methods <type>XFrame::findFrame()</type>, + <type>XDispatchProvider::queryDispatch()</type> or + <type>XComponentLoader::loadComponentFromURL()</type> if no special target + frame name (e.g. "_blank", "_self") is used. + </p> + + @see XFrame::findFrame() + @see XDispatchProvider::queryDispatch() + @see XComponentLoader::loadComponentFromURL() */ constants FrameSearchFlag { //------------------------------------------------------------------------- + /** no longer supported + + <p> + Using of this flag will do nothing. Use right combination of other flags + instead of this one. + </p> - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::AUTO - /** SELF+CHILDREN + @deprecated */ const long AUTO = 0; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::PARENT - /** includes the parent frame + /** allows search on the parent frames */ const long PARENT = 1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SELF - /** includes the start frame + /** includes the start frame himself */ const long SELF = 2; //------------------------------------------------------------------------- + /** includes all child frames of the start frame - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::CHILDREN - /** includes the child frames of the start frame - */ + <p> + Note: That means all direct children and of course her childrens too. + Search doesn't stop at the next level inside the tree! + </p> + */ const long CHILDREN = 4; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::CREATE /** frame will be created if not found */ const long CREATE = 8; //------------------------------------------------------------------------- + /** includes the direct siblings of the start frame - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::SIBLINGS - /** includes the other child frames of the parent of the start frame + <p> + Normaly it's interpreted as search on the direct childs of the parent + only. But in combination with e.g. the CHILDREN flag it can include all + children of it too. + </p> */ const long SIBLINGS = 16; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::TASKS - /** includes all frames in all tasks in the current frames hierarchy + /** allow the search outside the current sub task tree of the whole possible frame tree + + <p> + If this flag isn't present, any search from bottom to top has to stop, if a top frame + will be reached. It doesn't influence a search from top to bottom. + But it can be used at the root of the frame tree to search on direct childrens of it only. + Because the direct children of the root node are the root's of the task sub trees, which + are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress + a deeper search so. + </p> */ const long TASKS = 32; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::ALL - /** includes all frames except frames in other tasks + /** includes all frames except frames in other tasks sub trees + but doesn't create any new frame */ const long ALL = 23; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::FrameSearchFlag::GLOBAL - /** searches in the whole hierarchy of frames. + /** searches in the whole hierarchy of frames + but doesn't create any new frame */ const long GLOBAL = 55; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/FramesContainer.idl b/offapi/com/sun/star/frame/FramesContainer.idl index fbdae66cd73e..19ef53c83cf4 100644 --- a/offapi/com/sun/star/frame/FramesContainer.idl +++ b/offapi/com/sun/star/frame/FramesContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: FramesContainer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,55 +65,31 @@ #include <com/sun/star/frame/XFrames.idl> #endif -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** this is a special container which can contain frames -// DocMerge from xml: service com::sun::star::frame::FramesContainer -/** This is a special container which can contain frames. + <p> + All elements in this container support the service frame. + Implementations of this service are available by interface + <type>XFramesSupplier</type>. + </p> - <p>All elements in this container support the service frame. - </p>@see Frame + @see XFramesSupplier */ service FramesContainer { - // DocMerge: empty anyway - interface com::sun::star::frame::XFrames; - - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; - + //------------------------------------------------------------------------- + /** access to frame collection by reference + */ + interface XFrames; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl index 44cc2c1652e2..4d6258101410 100644 --- a/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl +++ b/offapi/com/sun/star/frame/MediaTypeDetectionHelper.idl @@ -2,9 +2,9 @@ * * $RCSfile: MediaTypeDetectionHelper.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,19 +70,19 @@ module com { module sun { module star { module frame { //============================================================================= - - -// DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper -/** provides for mapping a given sequence of ContentIdentifierStrings - to a sequence of respective MediaTypes. +/** provides for mapping a given sequence of content identifier strings + to a sequence of respective media (mime) types */ service MediaTypeDetectionHelper { - - // DocMerge from xml: service com::sun::star::frame::MediaTypeDetectionHelper: interface com::sun::star::util::XStringMapping - /** provides a mapping from <atom>string<atom> to <atom>string<atom>. - - This interface is required. + //------------------------------------------------------------------------- + /** provides a mapping from <atom>string<atom> to <atom>string<atom> + + <p> + Order of given and their returned coressponding strings is important. + Don't pack or optimize it. Every item of [in] list must match + to an item of [out] list. + </p> */ interface com::sun::star::util::XStringMapping; }; @@ -91,23 +91,5 @@ service MediaTypeDetectionHelper }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1 2000/07/28 19:21:41 iha - new - - -=============================================================================*/ - #endif diff --git a/offapi/com/sun/star/frame/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl index 641b61ed6b18..ca54a618f3d8 100644 --- a/offapi/com/sun/star/frame/ProtocolHandler.idl +++ b/offapi/com/sun/star/frame/ProtocolHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtocolHandler.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: as $ $Date: 2002-09-05 11:31:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/frame/Settings.idl b/offapi/com/sun/star/frame/Settings.idl index 414b77e99175..61c32ccb996f 100644 --- a/offapi/com/sun/star/frame/Settings.idl +++ b/offapi/com/sun/star/frame/Settings.idl @@ -2,9 +2,9 @@ * * $RCSfile: Settings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,39 +65,20 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: service com::sun::star::frame::Settings /** @deprecated */ service Settings { - // DocMerge: empty anyway interface com::sun::star::container::XNameAccess; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl index c66d72b2a363..b10450dccba0 100644 --- a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: SynchronousFrameLoader.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: jsc $ $Date: 2001-11-09 09:22:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,8 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_frame_SynchronousFrame_idl__ -#define __com_sun_star_frame_SynchronousFrame_idl__ +#ifndef __com_sun_star_frame_SynchronousFrameLoader_idl__ +#define __com_sun_star_frame_SynchronousFrameLoader_idl__ #ifndef __com_sun_star_frame_XSynchronousFrameLoader_idl__ #include <com/sun/star/frame/XSynchronousFrameLoader.idl> @@ -69,8 +69,8 @@ #include <com/sun/star/lang/XInitialization.idl> #endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> #endif //============================================================================= @@ -78,75 +78,56 @@ module com { module sun { module star { module frame { //============================================================================= +/** derivations of this abstract service are used to load components + into <type>Frame</type>s of the environment -// DocMerge from xml: service com::sun::star::frame::SynchronousFrameLoader -/** Derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment. - - <p>Concrete implementations of this service register, for example, + <p> + Concrete implementations of this service register, for example, for file name extensions or MIME types to load appropriate - components. The components loaded are at least <type>Controller</type>.</p> + components. The components loaded are at least <type>Controller</type>. + Instead of service <type>FrameLoader</type> this one use synchronous + processes to load the component. + </p> + + @see FrameLoader */ service SynchronousFrameLoader { //------------------------------------------------------------------------- - /**support synchron loading + /** support synchronous loading of component */ - interface com::sun::star::frame::XSynchronousFrameLoader; + interface XSynchronousFrameLoader; //------------------------------------------------------------------------- /** support initialization of loader with its own configuration! + <p> - A loader can support a readonly access to its own configuration. - But readonly properties couldn't be set ... - That's the reason for these interface! - All Anys of given sequence are from Type <type>PropertyValue</type>. + Concrete implementations should use it to get her own configuration data + directly after creation by the <type>FrameLoaderFactory</type>. + Otherwhise they must use normal configuration api to do so. </p> */ [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- - /**readonly(!) access to loader configuration + /** provides access to the internal name of this frame loader + <p> - These interfaces support readonly access to our internal configuration of THIS loader. - The loader itself gets its configuration about <type>XInitialization</type> at creation by using - the <type>FrameLoaderFactory</type>! - </p> + The internal name is a part of his configuration and will be passed by + the <type>FrameLoaderFactory</type> after creation + if optional interface <type scope="com::sun::star::lang">XInitialization</type> + is supported. Value of function <member>XNamed::getName()</member> can be + used on service <type>FrameLoaderFactory</type> to get further informations about this loader. + Setting of this name by calling <member>XNamed::setName()</member> must be + forwarded to same factory service. He should decide, if it's allowed or not. + The reason: prevent code against name ambigities. + </p> */ - [optional] interface com::sun::star::beans::XPropertySet; - - /// loader is registered for these types - [optional, property, readonly] sequence< string > Types ; - - /// localized name of loader to show it at UI elements - [optional, property, readonly] string UIName ; + [optional] interface com::sun::star::container::XNamed; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/11/01 10:29:29 mi - proofreading and corrections from Richard Holt - - Revision 1.1 2000/11/20 10:06:11 as - new interfaces for filter and type detection - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:20 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1 2000/05/25 10:26:18 mi - Doku - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/TemplateAccess.idl b/offapi/com/sun/star/frame/TemplateAccess.idl index 7647907291a4..8d446d1e3836 100644 --- a/offapi/com/sun/star/frame/TemplateAccess.idl +++ b/offapi/com/sun/star/frame/TemplateAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: TemplateAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,33 +69,37 @@ #include <com/sun/star/frame/XDocumentTemplates.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** provides a high level api to organize document templates -// DocMerge from xml: service com::sun::star::frame::TemplateAccess -/**specifies a collection of TemplateAccess. + <p> + AS_??? + One important instance of this service is available from the + <type>Desktop</type> object via the <type>XDesktop</type> interface. + </p> - <p>One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. </p> - @see com::sun::star::lang::XComponent - @see XDesktop + @see com::sun::star::lang::XComponent + @see XDesktop */ service TemplateAccess { - // DocMerge: empty anyway - interface com::sun::star::lang::XLocalizable; - // DocMerge: empty anyway - interface com::sun::star::frame::XDocumentTemplates; + //------------------------------------------------------------------------- + /** used to organize document templates + */ + interface XDocumentTemplates; + //------------------------------------------------------------------------- + /** + */ + interface com::sun::star::lang::XLocalizable; }; //============================================================================= }; }; }; }; - #endif diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl index a3a3602866b0..26d70d553135 100644 --- a/offapi/com/sun/star/frame/TerminationVetoException.idl +++ b/offapi/com/sun/star/frame/TerminationVetoException.idl @@ -2,9 +2,9 @@ * * $RCSfile: TerminationVetoException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,16 +65,24 @@ #include <com/sun/star/uno/Exception.idl> #endif - //============================================================================= module com { module sun { module star { module frame { //============================================================================= +/** can be thrown by a <type>XTerminateListener</type> to prevent the environment + (e.g., desktop) from terminating + + <p> + If a <type>XTerminateListener</type> use this exception for a veto against + the termination of the office, he will be the new "owner" of it. + After his own operation will be finished, he MUST try to terminate the + office again. Any other veto listener can intercept that again or office + will die realy. + </p> -// DocMerge from xml: exception com::sun::star::frame::TerminationVetoException -/** This exception can be thrown to prevent the environment (e.g., desktop) - from terminating. + @see XDesktop::terminate() + @see XTerminateListener */ exception TerminationVetoException: com::sun::star::uno::Exception { @@ -84,21 +92,4 @@ exception TerminationVetoException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/WindowArrange.idl b/offapi/com/sun/star/frame/WindowArrange.idl index 0a7513df488f..5bf61f90111c 100644 --- a/offapi/com/sun/star/frame/WindowArrange.idl +++ b/offapi/com/sun/star/frame/WindowArrange.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowArrange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,84 +61,48 @@ #ifndef __com_sun_star_frame_WindowArrange_idl__ #define __com_sun_star_frame_WindowArrange_idl__ - //============================================================================= module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from idl: constants com::sun::star::frame::WindowArrange -/** These constants are used to specify a style of window arrangement. +/** these constants are used to specify a style of window arrangement */ constants WindowArrange { //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::TILE - /** arranges the windows in tiles. + /** arranges the windows in tiles */ const short TILE = 1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::VERTICAL - /** arranges the windows vertically. + /** arranges the windows vertically */ const short VERTICAL = 2; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::HORIZONTAL - /** arranges the windows horizontally. + /** arranges the windows horizontally */ const short HORIZONTAL = 3; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::CASCADE - /** cascades the windows. + /** cascades the windows */ const short CASCADE = 4; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::MAXIMIZE - /** maximizes all windows. + /** maximizes all windows */ const short MAXIMIZE = 5; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::frame::WindowArrange::MINIMIZE - /** minimizes all windows. + /** minimizes all windows */ const short MINIMIZE = 6; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl index 44ca44240fa7..1df4306f2df4 100644 --- a/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl +++ b/offapi/com/sun/star/frame/XBrowseHistoryRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBrowseHistoryRegistry.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,51 +75,26 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XBrowseHistoryRegistry /** @deprecated */ interface XBrowseHistoryRegistry: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: empty anyway + /** @deprecated + */ [oneway] void updateViewData( [in] any Value ); //------------------------------------------------------------------------- - - // DocMerge: empty anyway - [oneway] void createNewEntry( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] string aTitle ); - + /** @deprecated + */ + [oneway] void createNewEntry( + [in] string URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments, + [in] string Title); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index 3225d4d0724e..9398a88602e4 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentLoader.idl,v $ * - * $Revision: 1.11 $ + * $Revision: 1.12 $ * - * last change: $Author: as $ $Date: 2001-11-20 14:05:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,98 +87,140 @@ module com { module sun { module star { module frame { //============================================================================= +/** this is a simple interface to load components by an URL into a + frame environment -// DocMerge from xml: interface com::sun::star::frame::XComponentLoader -/** This is a simple interface to load components by an URL into a - frame environment. - @see Desktop - @see Frame - @see XFrame + @see Desktop + @see Frame + @see XFrame */ interface XComponentLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XComponentLoader::loadComponentFromURL /** loads a component specified by an URL into the specified new or existing frame. - @param aURL - specifies the URL of the document to load. To create new documents, - use "private:factory/scalc", "private:factory/swriter", etc. + @param URL + specifies the URL of the document to load + + <p> + To create new documents, use "private:factory/scalc", "private:factory/swriter", etc. + Other special protocols (e.g. "slot:", ".uno") are not allowed and raise + an <type scope="com::sun::star::lang">IllegalArgumentException</type>. + </p> + + @param TargetFrameName + specifies the name of the frame to view the document in + + <p> + If a frame with the specified name already exists, it is used, otherwise it + is created. There exist some special targets which never can be used + as real frame names: + <table border=1> + <tr> + <td><strong>"_blank"</strong></td> + <td>always creates a new frame</td> + </tr> + <tr> + <td><strong>"_default"</strong></td> + <td>recycle empty frame or create new one</td> + </tr> + <tr> + <td><strong>"_self", ""(!)</strong></td> + <td>means frame himself</td> + </tr> + <tr> + <td><strong>"_parent"</strong></td> + <td>address direct parent of frame</td> + </tr> + <tr> + <td><strong>"_top"</strong></td> + <td>indicates top frame of current path in tree</td> + </tr> + <tr> + <td><strong>"_beamer"</strong></td> + <td>means special sub frame</td> + </tr> + </table> + + @param SearchFlags + use the values of <type>FrameSearchFlag</type> to specify + how to find the specified <var>TargetFrameName</var> - @param aTargetFrameName - specifies the name of the frame to view the document in. If a frame - with the specified name already exists, it is used, otherwise it - is created. "_blank" always creates a new frame, "_self" means frame himself, - "_parent" address direct parent of frame, "_top" indicates top frame of - current path in tree. + <p> + Note: These flags are optional ones and will be used for non special + target names only. + </p> - @param nSearchFlags - use the values of <type>FrameSearchFlag</type> to specify - how to find the specified <var>aTargetFrameName</var>. - Normally, simply use <code>0</code>. + @param Arguments + these arguments specify component or filter specific behavior - @param aArgs - these arguments specify component or filter specific behavior. + <p> For example, "ReadOnly" with a boolean value specifies whether the document is opened read-only. "FilterName" specifies the component type to create and the filter to use, for example: - "scalc: Text - csv". For more information see + "Text - CSV". For more information see <type scope="com::sun::star::document">MediaDescriptor</type>. + </p> + + @return + a <type scope="com::sun::star::lang">XComponent</type> for successfully loaded + documents or + <br> + <NULL/>if it failed + + <p> + This interface is a generic one and can be used to start further requests on + loaded document or control the lifetime of it (means dispose() it after using). + The real document service behind this interface can be one of follow three ones: + <ul> + <li> + <type scope="com::sun::star::awt">XWindow</type> for simple components<br/> + Should be used for viewable components only. It is not allowed to dispose + it after use directly, because the frame containing the component is its owner. + Because the frame object is not accessible through the interface too, + only an interacting user can do this by closing the frames' window. + </li> + <li> + <type>XController</type> for richer components<br/> + Should be used for real editable components which doesn't need a model. + It is not allowed to dispose it after use directly, because the frame + containing the component is its owner. Here the object can be disposed + by disposing the frame, that the <member>XController::getFrame()</member> + method of the controller returns. But for visible components the controller + should be asked for permission by calling <member>XController::suspend()</member> before. + </li> + <li> + <type>XModel</type> for full featured components<br/> + A model that in general can be shared between several view/controller pairs, + does not have an explicit owner. Every view and also the component that + loaded the document may consider itself as an owner. + Simply calling <member>XComponent::dispose()</member> on this model may + cause problems, if some members of the "owner community" are currently + busy working on the model. These problems are handled by explicit closing + negotiations through the interface <type scope="com::sun::star::util">XCloseable</type>. + Direct dispose of the model is allowed only, if this special interface doesn't exist. + </li> + </ul> + </p> + + @throws com::sun::star::io::IOException + when <var>URL</var> couldn't be found or was corrupt + + @throws com::sun::star::lang::IllegalArgumentException + when given parameters doesn't perform the specification */ - com::sun::star::lang::XComponent loadComponentFromURL( [in] string aURL, - [in] string aTargetFrameName, - [in] long nSearchFlags, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException, - com::sun::star::lang::IllegalArgumentException ); - + com::sun::star::lang::XComponent loadComponentFromURL( + [in] string URL, + [in] string TargetFrameName, + [in] long SearchFlags, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments) + raises( com::sun::star::io::IOException, + com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.10 2001/11/01 10:29:29 mi - proofreading and corrections from Richard Holt - - Revision 1.9 2001/03/22 17:25:56 mi - #77161# arguments of XComponentLoader::loadComponents - - Revision 1.8 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.7 2000/12/21 15:04:54 mi - typo fixed: FrameSearchFlags now without s at the end - - Revision 1.6 2000/12/21 15:03:56 mi - typo fixed: FrameSearchFlagsy now without y at the end - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/12 12:27:50 mi - documentation for arguments added - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.6 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:56 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XComponentRegistry.idl b/offapi/com/sun/star/frame/XComponentRegistry.idl index 5af553556dc9..108b372d04ff 100644 --- a/offapi/com/sun/star/frame/XComponentRegistry.idl +++ b/offapi/com/sun/star/frame/XComponentRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentRegistry.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,54 +75,20 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XComponentRegistry -/** makes it possible to instantiate desktop components. - - @deprecated - @see XFrame +/** @deprecated */ interface XComponentRegistry: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: empty anyway - com::sun::star::uno::XInterface createObject( [in] string aURL, - [in] com::sun::star::uno::Uik ik ); - + /** @deprecated + */ + com::sun::star::uno::XInterface createObject( + [in] string URL, + [in] com::sun::star::uno::Uik Uik ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/22 17:26:29 mi - Formatting error in documentation fixed - - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XConfigManager.idl b/offapi/com/sun/star/frame/XConfigManager.idl index 7731cc39eb61..716d24e510ba 100644 --- a/offapi/com/sun/star/frame/XConfigManager.idl +++ b/offapi/com/sun/star/frame/XConfigManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConfigManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,47 +77,71 @@ module frame { //============================================================================ - -// DocMerge from xml: interface com::sun::star::frame::XConfigManager /** @deprecated */ interface XConfigManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::frame::XConfigManager::addPropertyChangeListener - /** add a listener to notify changes on "sKeyName" + /** add a listener to notify changes on well known variables + inside the real implementation - <p> If <var>sKeyName</var> specifies a group of keys, the listener gets one notify for each subkey.</p> - */ - [oneway] void addPropertyChangeListener( [in] string sKeyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) ; + <p> + Listener can update his text values by calling <member>XConfigManager::substituteVariables()</member> + again. If <var>KeyName</var> specifies a group of keys, the listener gets one notify for each subkey. + </p> - //------------------------------------------------------------------------- + @param KeyName + specifies variable about listener will be informed on changes + @param Listener + listener which will be informed - // DocMerge from xml: method com::sun::star::frame::XConfigManager::removePropertyChangeListener - /** remove a listener - */ - [oneway] void removePropertyChangeListener( [in] string sKeyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) ; + @see XConfigManager::removePropertyChangeListener() + + @deprecated + */ + [oneway] void addPropertyChangeListener( + [in] string KeyName, + [in] com::sun::star::beans::XPropertyChangeListener Listener ); //------------------------------------------------------------------------- + /** remove a registered listener + @param KeyName + specifies variable on which listener was registered - // DocMerge from xml: method com::sun::star::frame::XConfigManager::substituteVariables - /** substitute variables in "sText" + @param Listener + listener which will be deregistered + @see XConfigManager::addPropertyChangeListener() - <p> - The value of "sText" is NOT changed.</p> + @deprecated */ - string substituteVariables( [in] string sText ) ; + [oneway] void removePropertyChangeListener( + [in] string KeyName, + [in] com::sun::star::beans::XPropertyChangeListener Listener); //------------------------------------------------------------------------- + /** substitute variables (place holder) inside given parameter <var>Text</var> + + <p> + The value of <var>Text</var> is NOT changed. + </p> + @param Text + original value including variables - // DocMerge from xml: method com::sun::star::frame::XConfigManager::flush - /** write data of INI-file to disk + @return + changed copy of <var>Text</var> without any variables + */ + string substituteVariables( [in] string Text ); + + //------------------------------------------------------------------------- + /** was designed for additional functionality for interface <type scope="com::sun::star::registry">XSimpleRegistry</type> + and make no sense without that + @deprecated */ - [oneway] void flush() ; + [oneway] void flush(); }; //XConfigManager }; //frame diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index 54f9e734b2a9..766b5f31b78e 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XController.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,101 +73,87 @@ interface XFrame; interface XModel; //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XController /** With this interface, components viewed in a <type>Frame</type> can serve - events (by supplying dispatches). @see XModel - @see XFrame - @see com::sun::star::awt::XWindow + events (by supplying dispatches). + + @see XFrame + @see com::sun::star::awt::XWindow + @see XModel */ interface XController: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::attachFrame /** is called to attach the controller with its managing frame. + + @param Frame + the new owner frame of this controller */ - void attachFrame( [in] XFrame xFrame ); + void attachFrame( [in] XFrame Frame ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::attachModel /** is called to attach the controller to a new model. + + @param Model + the new model for this controller + + @return + <TRUE/>if attach was successfully + <br> + <FALSE/>otherwise */ - boolean attachModel( [in] XModel xModel ); + boolean attachModel( [in] XModel Model ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::suspend /** is called to prepare the controller for closing the view + + @param Suspend + <TRUE/>force the controller to suspend his work + <FALSE/>try to reactivate the controller + + @return + <TRUE/>if request was accepted and of course successfully finished + <br> + <FALSE/>otherwise */ - boolean suspend( [in] boolean bSuspend ); + boolean suspend( [in] boolean Suspend ); //------------------------------------------------------------------------- + /** provides access to current view status - // DocMerge from idl: method com::sun::star::frame::XController::getViewData - /** @returns - data that can be used to restore the current view status. + @returns + set of data that can be used to restore the current view status + at later time by using <member>XController::restoreViewData()</member> */ any getViewData(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XController::restoreViewData /** restores the view status using the data gotten from a previous call to - <member>XController::getViewData</member>. + <member>XController::getViewData()</member>. + + @param Data + set of data to restore it */ void restoreViewData( [in] any Data ); //------------------------------------------------------------------------- + /** provides access to currently attached model - // DocMerge from idl: method com::sun::star::frame::XController::getModel - /** @returns - the currently attached model. + @returns + the currently attached model. */ XModel getModel(); //------------------------------------------------------------------------- + /** provides access to owner frame of this controller - // DocMerge from idl: method com::sun::star::frame::XController::getFrame - /** @returns - the frame containing this controller. + @returns + the frame containing this controller. */ XFrame getFrame(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.2 2000/10/09 14:24:56 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.6 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:56 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index cb8da4088b2a..8e65b06a6189 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDesktop.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,125 +87,113 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDesktop /** This is the main interface of a desktop service. - <p>A desktop is an environment for components which can be viewed in + <p> + A desktop is an environment for components which can be viewed in frames. Frames are like frames in HTML framesets. This does not imply that a desktop can handle framesets; the frames may be top frames only. + </p> - </p>@see Desktop + @see Desktop */ interface XDesktop: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktop::terminate /** tries to terminate the desktop. - <p>First, a vetoable queryTermination-event is broadcast. If no - TerminationVetoException was thrown, a notifyTermination-event is - broadcast and <TRUE/> will be returned; otherwise an - abortTermination-event is broadcast and <FALSE/> will be returned. - </p>@see com::sun::star::frame::TerminationVetoException - @see XTerminateListener + <p> + First, every terminate listener is called by his <member>XTerminateListener::queryTermination()</member> method. + Throwing of a <type>TerminationVetoException</type> can break the termination process and the listener how has + done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after + his own processes will be finished. + If nobody disagree with the termination request, every listener will be called by his + <member>XTerminateListener::notifyTermination()</member> method. + </p> + + @return + <TRUE/>if all listener agree with this request + <br> + <FALSE/>otherwise + + @see XTerminateListener + @see TerminationVetoException */ boolean terminate(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktop::addTerminateListener /** registers an event listener to the desktop, which is called when the desktop is queried to terminate, and when it really terminates. - */ - [oneway] void addTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); - //------------------------------------------------------------------------- + @param Listener + listener for termination events - // DocMerge from xml: method com::sun::star::frame::XDesktop::removeTerminateListener - /** unregisters an event listener which was registered with - <member>XDesktop::addTerminateListener</member>. + @see XDesktop::removeTerminateListener() */ - [oneway] void removeTerminateListener( [in] com::sun::star::frame::XTerminateListener xListener ); + [oneway] void addTerminateListener( [in] XTerminateListener Listener ); //------------------------------------------------------------------------- + /** unregisters an event listener for termination events. - // DocMerge from idl: method com::sun::star::frame::XDesktop::getComponents - /** @returns - a collection of all components which are loaded into a frame. - - <p>The component is, by definition, the model of the control which - is loaded into a frame, or if no model exists, into the control - itself. + @param Listener + listener which wish to be deregistered - <p>The service, <type>Components</type>, which is available from this - method is a collection of all components of the desktop which are open - within a frame of the desktop. + @see XDesktop::addTerminateListener() + */ + [oneway] void removeTerminateListener( [in] XTerminateListener Listener ); - @see Components + //------------------------------------------------------------------------- + /** provides read access to collection of all currently loaded components + inside the frame tree + + <p> + The component is, by definition, the model of the control which + is loaded into a frame, or if no model exists, into the control + itself. + The service <type>Components</type> which is available from this + method is a collection of all components of the desktop which are open + within a frame of the desktop. + </p> + + @returns + the collection of all components + + @see Components */ com::sun::star::container::XEnumerationAccess getComponents(); //------------------------------------------------------------------------- + /** provides read access to the component inside the tree which has the UI focus + + <p> + Normally, the component is the model part of the + active component. If no model exists it is the active controller + (view) itself. + </p> - // DocMerge from idl: method com::sun::star::frame::XDesktop::getCurrentComponent - /** @returns - the component within the desktop environment which has the UI focus. + @returns + the component within the desktop environment which has the UI focus. - <p>Normally, the component is the model part of the - active component. If no model exists it is the active controller - (view) itself. + @see XDesktop::getCurrentFrame() */ com::sun::star::lang::XComponent getCurrentComponent(); //------------------------------------------------------------------------- + /** provides read access to the frame wich contains the current component - // DocMerge from idl: method com::sun::star::frame::XDesktop::getCurrentFrame - /** @returns - the frame of the component which has the - UI focus within this desktop enviroment. - */ - com::sun::star::frame::XFrame getCurrentFrame(); + @returns + the frame of the component which has the + UI focus within this desktop enviroment + @see XDesktop::getCurrentComponent() + */ + XFrame getCurrentFrame(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.2 2000/10/09 14:24:56 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.6 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:56 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDesktopTask.idl b/offapi/com/sun/star/frame/XDesktopTask.idl index 1721b2094541..f7cac5ae4461 100644 --- a/offapi/com/sun/star/frame/XDesktopTask.idl +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDesktopTask.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,53 +75,28 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDesktopTask -/** is used to initialize and close a desktop task. +/** use <type>XFrame</type> instead of this + @deprecated */ interface XDesktopTask: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktopTask::initialize - /** attaches a window to the task. + /** use <type scope="com::sun::star::lang">XInitialization</type> instead of this + @deprecated */ - void initialize( [in] com::sun::star::awt::XWindow xTaskWindow ); + void initialize( [in] com::sun::star::awt::XWindow TaskWindow ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDesktopTask::close - /** tries to close all windows within the task and the task by itself. + /** use <type scope="com::sun::star::util">XClosable</type> + or <member scope="com::sun::star::lang">XComponent::dispose()</member> + instead of this + @deprecated */ boolean close(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 1999/11/25 16:03:32 mi - welforming HTML for XML - - Revision 1.2 1999/11/18 11:49:57 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index 305145eaae63..2dc0866cadc1 100644 --- a/offapi/com/sun/star/frame/XDispatch.idl +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatch.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,109 +83,114 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatch /** serves state information of objects which can be connected to controllers (e.g., toolbox controllers). - <p>Each state change is to be broadcast to all registered + <p> + Each state change is to be broadcast to all registered status listeners. The first notification should be performed - synchronously from <member>XDispatch::addStatusListener</member>; + synchronously from <member>XDispatch::addStatusListener()</member>; if not, controllers may flicker. State listener must be aware of this - synchronous notification.</p> + synchronous notification. + </p> - <p>The state consists of enabled/disabled and a short descriptive text + <p> + The state consists of enabled/disabled and a short descriptive text of the function (e.g., "undo insert character"). It is to be broadcast whenever this state changes or the controller should re-get the value for the URL to which it is connected. Additionally, a context-switch-event is to be broadcast whenever the object may be out of scope, - to force the state listener to requery the <type>XDispatch</type>.</p> + to force the state listener to requery the <type>XDispatch</type>. + </p> - @see StatusEvent - @see Frame - @see View + @see Frame + @see FeatureStateEvent */ interface XDispatch: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatch::dispatch /** dispatches (executes) an URL asynchronously. - <p>It is only allowed to dispatch URLs for which this <type>XDispatch</type> - was explicitely queried. Additional arguments "'#..." or "?...") are allowed.</p> + <p> + It is only allowed to dispatch URLs for which this <type>XDispatch</type> + was explicitely queried. Additional arguments "'#..." or "?...") are allowed. + </p> + + @param URL + full parsed URL wich describe the feature which should be dispatched (executed) + + @param Arguments + optional arguments for this request + They depends from the real implementation of the dipsatch object. @example - <listing> - // some code for a click-handler of a hyperlink in a view - XFrame xTargetFrame = m_xFrame-&gt;findFrame( - m_aHyperlink-&gt;getTargetFrameName(), FRAME_SEARCH_STANDARD ); - URL aURL; - aURL.Original = m_aHyperlink-&gt;getURL(); - XDispatch m_xFrame-&gt;queryDispatch( aURL, sequence&lt;PropertyValue&gt;() ); - xDispatch-&gt;dispatch( aURL ); - </listing> + <listing> + // some code for a click-handler + void <strong>myOnClick</strong>(<em>String</em> sURL,<em>String</em> sTargetFrame,<em>com.sun.star.beans.PropertyValue[]</em> lArguments) + { + com.sun.star.util.URL[] aURL = new com.sun.star.util.URL[1]; + aURL[0] = new com.sun.star.util.URL(); + aURL[0].Complete = sURL; + + com.sun.star.util.XURLTransformer xParser = (com.sun.star.util.XURLTransformer)UnoRuntime.queryInterface(com.sun.star.util.XURLTransformer.class, mxServiceManager.createInstance("com.sun.star.util.URLTransformer")); + + xParser->parseStrict(aURL); + + com.sun.star.frame.XDispatch xDispatcher = mxFrame.queryDispatch(aURL[0], sTargetFrame, com.sun.star.frame.FrameSearchFlag.GLOBAL); + + if(xDispatcher!=null) + xDispatcher.dispatch(aURL[0], lArguments); + } + </listing> */ - [oneway] void dispatch( [in] com::sun::star::util::URL aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + [oneway] void dispatch( + [in] com::sun::star::util::URL URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatch::addStatusListener /** registers a listener of a controller for a specific URL to this object to receive status events. - <p>It is only allowed to register for URLs for which this <type>XDispatch</type> - was explicitely queried. Additional arguments ("#..." or "?...") will be ignored.</p> + <p> + It is only allowed to register for URLs for which this <type>XDispatch</type> + was explicitely queried. Additional arguments ("#..." or "?...") will be ignored. + Note: Notifications can't be guranteed! This will be a part of interface <type>XNotifyingDispatch</type>. + </p> + + @param Control + listener which wish to be informed - @see XDispatch::removeStatusListener + @param URL + the URL (without additional arguments) for which the listener wish to be registered + So a listener can be registered for more then one URLs at the same time. + + @see XStatusListener + @see XDispatch::removeStatusListener() */ - [oneway] void addStatusListener( [in] com::sun::star::frame::XStatusListener xControl, - [in] com::sun::star::util::URL aURL ); + [oneway] void addStatusListener( + [in] XStatusListener Control, + [in] com::sun::star::util::URL URL); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatch::removeStatusListener /** unregisters a listener of a controller. - @see Dispatch::addStatusListener - */ - [oneway] void removeStatusListener( [in] com::sun::star::frame::XStatusListener xControl, - [in] com::sun::star::util::URL aURL ); + @param Control + listener which wish to be unregistered + @param URL + the URL for which the listener was registered + Additional arguments ("#..." or "?...") will be ignored. + + @see XStatusListener + @see XDispatch::addStatusListener() + */ + [oneway] void removeStatusListener( + [in] XStatusListener Control, + [in] com::sun::star::util::URL URL); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.4 2000/12/19 13:37:15 mi - syntax errors in documentation fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.6 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:32 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index 5f1bee3d1a73..badcaee4d81c 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProvider.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,70 +83,61 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProvider /** provides <type>XDispatch</type> interfaces for certain functions which are useful at the UI. + + @see XDispatch */ interface XDispatchProvider: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProvider::queryDispatch /** searches for an <type>XDispatch</type> for the specified URL within - the specified target frame.@see XFrame::findFrame - @see queryDispatches - */ - com::sun::star::frame::XDispatch queryDispatch( [in] com::sun::star::util::URL aURL, - [in] string aTargetFrameName, - [in] long nSearchFlags ); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XDispatchProvider::queryDispatches - /** @returns - multiple dispatch interfaces for the specified descriptors at once. - - <p>Actually this method is redundant to - <member>XDispatchProvider::queryDispatch</member> to avoid multiple - remote calls. - */ - sequence<com::sun::star::frame::XDispatch> queryDispatches( - [in] sequence<com::sun::star::frame::DispatchDescriptor> aDescripts ); - -}; + the specified target frame. -//============================================================================= + @param URL + describe the feature which should be supported by returned dispatch object -}; }; }; }; + @param TargetFrameName + specify the frame which should be the target for this request -/*============================================================================= + @param SearchFlags + optional search parameter for finding the frame if no special + <var>TargetFrameName</var> was used - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions + @return + the dispatch object which provides queried functionality + <br> + or <NULL/> if no dispatch object is available - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api + @see XFrame::findFrame() + @see XDispatchProvider::queryDispatches() + */ + XDispatch queryDispatch( + [in] com::sun::star::util::URL URL, + [in] string TargetFrameName, + [in] long SearchFlags ); - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import + //------------------------------------------------------------------------- + /** actually this method is redundant to <member>XDispatchProvider::queryDispatch()</member> + to avoid multiple remote calls. - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML + @param Requests + list of dispatch requests - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations + @returns + multiple dispatch interfaces for the specified descriptors at once - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation + <p> + It's not allowed to pack it - because every request must match + to his real result. Means: don't delete <NULL/> entries inside this list. + </p> + */ + sequence< XDispatch > queryDispatches( + [in] sequence<DispatchDescriptor> Requests); +}; - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl index 814159b21a27..bf6a7e4ee213 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProviderInterception.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,56 +75,50 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterception /** makes it possible to register an <type>XDispatchProvider</type> which intercepts all requests of <type>XDispatch</type> to this instance. + + <p> + Note: Nobody can guarantee order of used interceptor objects if more then ones exist. + Later registered ones will be used at first. But it's possible to increase the chance + for that by providing the optional interface <type>XInterceptorInfo</type>. + </p> + + @see XDispatchProvider + @see XDispatch + @see XInterceptorInfo */ interface XDispatchProviderInterception: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::registerDispatchProviderInterceptor /** registers an <type>XDispatchProviderInterceptor</type>, which will become the first interceptor in the chain of registered interceptors. + + @param Interceptor + the interceptor which whish to be registered + + @see XDispatchProviderInterception::releaseDispatchProviderInterceptor() */ - void registerDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterception::releaseDispatchProviderInterceptor /** removes an <type>XDispatchProviderInterceptor</type> which was previously registered - using <member>XDispatchProviderInterception::registerDispatchProviderInterceptor</member>. - <p>The order of removals is arbitrary. It is not necessary to remove the last - registered interceptor first.</p> - */ - void releaseDispatchProviderInterceptor( [in] com::sun::star::frame::XDispatchProviderInterceptor xInterceptor ); + <p> + The order of removals is arbitrary. It is not necessary to remove the last + registered interceptor first. + </p> + + @param Interceptor + the interceptor which whish to be unregistered + @see XDispatchProviderInterception::registerDispatchProviderInterceptor() + */ + void releaseDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/11 17:11:00 mi - broken member-link fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 6341d1c43ef3..524dd8b77128 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchProviderInterceptor.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,49 +71,59 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDispatchProviderInterceptor /** makes it possible to intercept request of <type>XDispatch</type>. + + <p> + Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>. + </p> + + @see XDispatchProviderInterception */ -interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider +interface XDispatchProviderInterceptor: XDispatchProvider { //------------------------------------------------------------------------- + /** access to the slave <type>XDispatchProvider</type> of this interceptor - // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getSlaveDispatchProvider - /** @returns - the slave <type>XDispatchProvider</type> to which calls to - <member>XDispatchProvider::queryDispatch</member> can be forwarded - under control of this dispatch provider. + @returns + the slave of this interceptor + + @see XDispatchProviderInterceptor::setSlaveDispatchProvider() */ - com::sun::star::frame::XDispatchProvider getSlaveDispatchProvider(); + XDispatchProvider getSlaveDispatchProvider(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setSlaveDispatchProvider /** sets the slave <type>XDispatchProvider</type> to which calls to - <member>XDispatchProvider::queryDispatch</member> can be forwarded + <member>XDispatchProvider::queryDispatch()</member> can be forwarded under control of this dispatch provider. + + @param xNewDispatchProvider + the new slave of this interceptor + + @see XDispatchProviderInterceptor::getSlaveDispatchProvider() */ - void setSlaveDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewDispatchProvider ); + void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider ); //------------------------------------------------------------------------- + /** access to the master <type>XDispatchProvider</type> of this interceptor + + @returns + the master of this interceptor - // DocMerge from idl: method com::sun::star::frame::XDispatchProviderInterceptor::getMasterDispatchProvider - /** @returns - the master <type>XDispatchProvider</type>, which may forward - calls to its <member>XDispatchProvider::queryDispatch</member> - to this dispatch provider. + @see XDispatchProviderInterceptor::setMasterDispatchProvider() */ - com::sun::star::frame::XDispatchProvider getMasterDispatchProvider(); + XDispatchProvider getMasterDispatchProvider(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XDispatchProviderInterceptor::setMasterDispatchProvider /** sets the master <type>XDispatchProvider</type>, which may forward - calls to its <member>XDispatchProvider::queryDispatch</member> + calls to its <member>XDispatchProvider::queryDispatch()</member> to this dispatch provider. + + @param NewSupplier + the master of this interceptor + + @see XDispatchProviderInterceptor::getMasterDispatchProvider() */ - void setMasterDispatchProvider( [in] com::sun::star::frame::XDispatchProvider xNewSupplier ); + void setMasterDispatchProvider( [in] XDispatchProvider NewSupplier ); }; @@ -121,27 +131,4 @@ interface XDispatchProviderInterceptor: com::sun::star::frame::XDispatchProvider }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XDispatchResultListener.idl b/offapi/com/sun/star/frame/XDispatchResultListener.idl index e4ad8efc321f..be579193136a 100644 --- a/offapi/com/sun/star/frame/XDispatchResultListener.idl +++ b/offapi/com/sun/star/frame/XDispatchResultListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDispatchResultListener.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-09 16:20:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,10 +74,21 @@ module com { module sun { module star { module frame { //============================================================================= +/** listener for results of <member>XNotifyingDispatch::dispatchWithNotification()</member> + @see XNotifyingDispatch + */ interface XDispatchResultListener: com::sun::star::lang::XEventListener { - void dispatchFinished( [in] com::sun::star::frame::DispatchResultEvent Evt ); + //------------------------------------------------------------------------- + /** indicates finished dispatch + + @param Result + contains the result of the dispatch action + + @see DispatchResultEvent + */ + void dispatchFinished( [in] DispatchResultEvent Result ); }; //============================================================================= diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 147a79bf505e..40c23f0bbc1f 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentTemplates.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,76 +74,176 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XDocumentTemplates -/** makes it possible to receive events when the state of a feature changes. +/** provides a high level api to organize document templates + + <p> + Template informations are saved as links to the original content + and organized in groups. This data should be persistent and can be + updated by calling special method <member>XDocumentTemplates::update()</member>. + A real implementation of this interface can do that on top of + an ucb content provider. Method <member>XDocumentTemplates::getContent()</member> + force that. + </p> */ interface XDocumentTemplates: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- -// [attribute] sequence<string> Directories; + /** privides access to the root of internal used hierarchy + + <p> + This content can be used for accessing the groups directly. + </p> - /** returns a content, which can be used for accessing the groups. + @return + the ucb content for template configuration */ - com::sun::star::ucb::XContent getContent(); + com::sun::star::ucb::XContent getContent(); + //------------------------------------------------------------------------- /** creates the template with the given name in the given group using the - data from the storable. + data from the storable + + @param GroupName + specifies the group + + @param TemplateName + specifies the template + + @param Storable + specifies the target + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + + @see XDocumentTemplates::addTemplate() */ - boolean storeTemplate( [in] string GroupName, [in] string TemplateName, - [in] com::sun::star::frame::XStorable Storable ); -// raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); - /** is called when the status of the feature changes. + boolean storeTemplate( + [in] string GroupName, + [in] string TemplateName, + [in] XStorable Storable); + + //------------------------------------------------------------------------- + /** creates the template with the given name in the given group using the + given URL + + @param GroupName + specifies the group + + @param TemplateName + specifies the template + + @param SourceURL + specifies the position of template + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + + @see XDocumentTemplates::storeTemplate() */ - boolean addTemplate( [in] string GroupName, [in] string TemplateName, - [in] string SourceURL ); - /** is called when the status of the feature changes. + boolean addTemplate( + [in] string GroupName, + [in] string TemplateName, + [in] string SourceURL); + + //------------------------------------------------------------------------- + /** remove a template from specified group + + @param GroupName + specifies the group which include the template + + @param TemplateName + specifies the template for delete + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean removeTemplate( [in] string GroupName, [in] string TemplateName ); + boolean removeTemplate( + [in] string GroupName, + [in] string TemplateName); + + //------------------------------------------------------------------------- + /** rename a template inside specified group - /** is called when the status of the feature changes. + @param GroupName + specifies the group which include the template + + @param TemplateName + specifies the template for renaming + + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean renameTemplate( [in] string GroupName, [in] string OldTemplateName, - [in] string NewTemplateName ); + boolean renameTemplate( + [in] string GroupName, + [in] string OldTemplateName, + [in] string NewTemplateName); - /** Creates a new Group + //------------------------------------------------------------------------- + /** creates a new group @param GroupName - the name of the group to be created + the name of the group to be created @return - true, if the group could be created, false otherwise + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - boolean addGroup( [in] string GroupName ); - /** is called when the status of the feature changes. - */ - boolean removeGroup( [in] string GroupName ); + boolean addGroup( [in] string GroupName ); - /** is called when the status of the feature changes. - */ - boolean renameGroup( [in] string OldGroupName, [in] string NewGroupName ); + //------------------------------------------------------------------------- + /** remove an existing group + + @param GroupName + the name of the group to be removed - /** is called when the status of the feature changes. + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise */ - [oneway] void update(); -}; + boolean removeGroup( [in] string GroupName ); -//============================================================================= + //------------------------------------------------------------------------- + /** rename an existing group -}; }; }; }; + @param OldGroupName + the old name of the group -/*============================================================================= + @param NewGroupName + the new name of the group - $Log: not supported by cvs2svn $ - Revision 1.3 2001/03/23 14:45:09 dv - added renameTemplate and renameGroup + @return + <TRUE/> if operation was sucessfully + <br> + <FALSE/> otherwise + */ + boolean renameGroup( + [in] string OldGroupName, + [in] string NewGroupName); - Revision 1.2 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions + //------------------------------------------------------------------------- + /** force an update for internal structures + + <p> + Because the templates are well known by links and not as direct content + they can be outdated. An update force actualization of that to find + wrong links. + </p> + */ + [oneway] void update(); +}; - Revision 1.1 2001/03/09 15:06:21 dv - First checkin +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl index 86d2873075ff..c415551ec31c 100644 --- a/offapi/com/sun/star/frame/XExtendedFilterDetection.idl +++ b/offapi/com/sun/star/frame/XExtendedFilterDetection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExtendedFilterDetection.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,30 +77,18 @@ module frame { //============================================================================ - -// DocMerge from xml: interface com::sun::star::frame::XExtendedFilterDetection -/** extended filter detection for frame loader factories. - - - - - +/** use <type scope="com::sun::star::document">XExtendedFilterDetection</type> instead of this @deprecated */ interface XExtendedFilterDetection: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - - // DocMerge from xml: method com::sun::star::frame::XExtendedFilterDetection::detect - /** control agreement of a frameloader with given URL or arguments - - <p> - Implement it as an extra service for your frameloader to give information about - your responsibility for a given URL. If you can handle these documents return - a valid name for a filter or an empty string otherwise.</p> + /** use <member scope="com::sun::star::document">XExtendedFilterDetection::detect()</member> instead of this + @deprecated */ - string detect( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > aArgumentlist ); + string detect( + [in] string URL, + [in] sequence< com::sun::star::beans::PropertyValue > Argumentlist); }; // XExtendedFilterDetection }; // frame diff --git a/offapi/com/sun/star/frame/XFilterDetect.idl b/offapi/com/sun/star/frame/XFilterDetect.idl index 52d51d97b26a..d82f80c92128 100644 --- a/offapi/com/sun/star/frame/XFilterDetect.idl +++ b/offapi/com/sun/star/frame/XFilterDetect.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilterDetect.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,61 +71,20 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XFilterDetect -/** makes it possible to determine the content type. - - - - - - - - - - - +/** use <type scope="com::sun::star::document">XExtendedFilterDetection</type> instead of this @deprecated */ interface XFilterDetect: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: empty anyway string getContentType( [in] string URL ); //------------------------------------------------------------------------- - - // DocMerge: empty anyway boolean useExternBrowser( [in] string URL ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:28 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:58 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index f72ff693bc5d..3ff59362fb58 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrame.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,282 +78,331 @@ interface XController; interface XFramesSupplier; //============================================================================= +/** a frame object can be considered to be an "anchor" object where a component + can be attached to. -// DocMerge from xml: interface com::sun::star::frame::XFrame -/** makes it possible to control a <type>Frame</type> + <p> + A frame can be (it's not a must!) a part of a frame tree. If not this frame willn't be + accessible by using the api. This mode make sense for previews. + The root node of the tree can be a <type>Desktop</type> implementation. + </p> + + @see Desktop */ interface XFrame: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- + /** is called to initialize the frame within a window - the container window. + + <p> + This window will be used as parent for the component window and to support + some UI relevant features of the frame service. + Note: Re-parenting mustn't supported by a real frame implementation! + It's designed for initializing - not for setting. + </p> - // DocMerge from xml: method com::sun::star::frame::XFrame::initialize - /** is called to initialize the frame within a window. + @param Window + the new container window - @see XFrame::getContainerWindow + @see XFrame::getContainerWindow() */ - void initialize( [in] com::sun::star::awt::XWindow xWindow ); + void initialize( [in] com::sun::star::awt::XWindow Window ); //------------------------------------------------------------------------- + /** provides access to the container window of the frame. - // DocMerge from xml: method com::sun::star::frame::XFrame::getContainerWindow - /** provides access to the window of the frame. + <p> + Normally this is used as the parent window of the + component window. + </p> - <p>Normally this is used as the parent window of the - controller window. </p> + @return + the container window of this frame - @see XFrame::initialize + @see XFrame::initialize() */ com::sun::star::awt::XWindow getContainerWindow(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::setCreator /** sets the frame container that created this frame. + <p> + Only the creator is allowed to call this method. + But creator doesn't mean the implementation which creates this instance ... + it means the parent frame of the frame hierarchy. + Because; normaly a frame should be created by using the api + and is neccessary for searches inside the tree (e.g. <member>XFrame::findFrame()</member>) + </p> + @param Creator + the creator (parent) of this frame - <p>Only the creator is allowed to call this method.</p> + @see XFrame::getCreator() */ - [oneway] void setCreator( [in] XFramesSupplier xCreator ); + [oneway] void setCreator( [in] XFramesSupplier Creator ); //------------------------------------------------------------------------- + /** provides access to the creator (parent) of this frame + + @returns + the frame container that created and contains this frame. - // DocMerge from idl: method com::sun::star::frame::XFrame::getCreator - /** @returns - the frame container that created this frame. + @see XFrame::setCreator() */ XFramesSupplier getCreator(); //------------------------------------------------------------------------- + /** access to the name property of this frame - // DocMerge from idl: method com::sun::star::frame::XFrame::getName - /** @returns - the programmatic name of this frame. + @returns + the programmatic name of this frame. - <p>See specification of HTML framesets for reference. + @see XFrame::setName() */ string getName(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::setName /** sets the name of the frame. + <p> + Normally the name of the frame is set initially (e.g. by the creator). + The name of a frame will be used for identifying it if a frame search was started. + These searches can be forced by: + <ul> + <li><member>XFrame::findFrame()</member> + <li><member>XDispatchProvider::queryDispatch()</member> + <li><member>XComponentLoader::loadComponentFromURL()</member> + </ul> + Note: Special targets like "_blank", "_self" etc. are not allowed. + That's why frame names shouldn't start with a sign "_". + </p> + @param Name + the new programmatic name of this frame - <p>Normally the name of the frame is set initially.</p> + @see XFrame::findFrame() + @see XFrame::getName() + @see XDispatchProvider + @see XComponentLoader */ - [oneway] void setName( [in] string aName ); + [oneway] void setName( [in] string Name ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::findFrame /** searches for a frame with the specified name. - <p>Frames may contain other frames (e.g., a frameset) and may + <p> + Frames may contain other frames (e.g., a frameset) and may be contained in other frames. This hierarchy is searched with - this method.</p> + this method. + </p> - <p>First some special names are taken into account, i.e. "", - "_self", "_top", "_active" etc. <var>nSearchFlags</var> is ignored when - comparing these names with <var>aTargetFrameName</var>; further steps are - controlled by <var>nSearchFlags</var>. If allowed, the name of the frame + <p> + First some special names are taken into account, i.e. "", + "_self", "_top", "_blank" etc. <var>SearchFlags</var> is ignored when + comparing these names with <var>TargetFrameName</var>; further steps are + controlled by <var>SearchFlags</var>. If allowed, the name of the frame itself is compared with the desired one, and then ( again if allowed ) - the method - - - - - - is called for all children - of the frame. Finally - - + the method is called for all children of the frame. Finally may be called + for the siblings and then for parent frame (if allowed). + </p> + <p> + If no frame with the given name is found, a new top frame is + created; if this is allowed by a special flag <const>FrameSearchFlag::CREATE</const>. + The new frame also gets the desired name. + </p> - may be called - for the parent frame (if allowed).</p> + @param TargetFrameName + identify (a) a special target ("_blank","_self" ...) + or (b) any well known frame + to search it inside the current hierarchy - <p>If no frame with the given name is found, a new top frame is - created; if this is not suppressed by a special <type>FrameSearchFlag</type>. - The new frame also gets the desired name.</p> + @param SearchFlags + optional parameter to regulate search if no special target was used for <var>TargetFrameName</var> */ - com::sun::star::frame::XFrame findFrame( [in] string aTargetFrameName, - [in] long nSearchFlags ); + XFrame findFrame( + [in] string TargetFrameName, + [in] long SearchFlags); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::isTop /** determines if the frame is a top frame. - <p>In general a top frame is the frame which is a direct child of - a task frame or which does not have a parent. If a frame returns - <TRUE/> for this method, all calls to <member>XDispatchProvider::queryDispatch</member> - have to stop the search at such a frame unless the flag - <const>FrameSearchFlag::TASKS</const> is set.</p> + <p> + In general a top frame is the frame which is a direct child of + a task frame or which does not have a parent. Possible frame searches must + stop the search at such a frame unless the flag <const>FrameSearchFlag::TASKS</const> + is set. + </p> + + @return + <TRUE/> if frame supports top frame specification + <br> + <FALSE/> otherwise */ boolean isTop(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::activate /** activates this frame and thus the component within. - <p>At first the frame sets itself as the active frame of its - creator by calling - -<!-- JRH: Something seems to be missing from here? --> - - - , - then it broadcasts a <type>FrameActionEvent</type> with + <p> + At first the frame sets itself as the active frame of its + creator by calling <member>XFramesSupplier::setActiveFrame()</member>, + then it broadcasts an <type>FrameActionEvent</type> with <const>FrameAction::FRAME_ACTIVATED</const>. The component within - this frame may listen to this event to grab the focus on activation. - For simple components this can be done by the <type>FrameLoader</type>. + this frame may listen to this event to grab the focus on activation; + for simple components this can be done by the <type>FrameLoader</type>. + </p> + <p> + Finally, most frames may grab the focus to one of its windows + or forward the activation to a sub-frame. </p> - <p>Finally, most frames may grab the focus to one of its windows - or forward the activation to a sub-frame.</p> -*/ + + @see XFrame::deactivate() + @see XFrame::isActive() + */ [oneway] void activate(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::deactivate /** is called by the creator frame when another sub-frame gets activated. - - - <p>At first the frame deactivates its active sub-frame, if any. + <p> + At first the frame deactivates its active sub-frame, if any. Then broadcasts a <type>FrameActionEvent</type> with - <const>FrameAction::FRAME_DEACTIVATING</const>.</p> + <const>FrameAction::FRAME_DEACTIVATING</const>. + </p> + + @see XFrame::activate() + @see XFrame::isActive() */ [oneway] void deactivate(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::isActive /** determines if the frame is active. + + @return + <TRUE/> for active or UI active frames + <br> + <FALSE/> otherwise + + @see XFrame::activate() + @see XFrame::deactivate() */ boolean isActive(); //------------------------------------------------------------------------- + /** sets a new component into the frame or release an existing one from a frame. - // DocMerge from xml: method com::sun::star::frame::XFrame::setComponent - /** sets a new component into the frame. + @param ComponentWindow + the window of the new component or <NULL/> for release + + <p> + A valid component window should be a child of the frame container window. + </p> + + @param Controller + the controller of the new component or <NULL/> for release + + <p> + Simple components may implement a <type scope="com::sun::star::awt">XWindow</type> only. + In this case no controller must be given here. + </p> + + @return + <TRUE/>if setting of new component or release of an existing one was successfully + <br> + <FALSE/> otherwise (especialy, if an existing controller disagree within his + <member>XController::suspend()</member> call) + + @see XFrame::getComponentWindow() + @see XFrame::getContainerWindow() + @see XFrame::getController() */ - boolean setComponent( [in] com::sun::star::awt::XWindow xComponentWindow, - [in] com::sun::star::frame::XController xController ); + boolean setComponent( + [in] com::sun::star::awt::XWindow ComponentWindow, + [in] XController Controller); //------------------------------------------------------------------------- + /** provides access to the component window - // DocMerge from idl: method com::sun::star::frame::XFrame::getComponentWindow - /** @returns - the current visible component in this frame. + <p> + Note: Don't dispose this window - the frame is the owner of it. + </p> + + @returns + the current visible component in this frame + <br> + or <NULL/> if no one currently exist - <p>The frame is the owner of the window. + @see XFrame::setComponent() */ com::sun::star::awt::XWindow getComponentWindow(); //------------------------------------------------------------------------- + /** provides access to the controller - // DocMerge from idl: method com::sun::star::frame::XFrame::getController - /** @returns - the current controller within this frame. + <p> + Note: Don't dispose it - the frame is the owner of it. + Use <member>XController::getFrame()</member> to dispose + the frame after you the controller agreed with a + <member>XController::suspend()</member> call. + </p> - <p>Normally it is set by a frame loader. + @returns + the current controller within this frame + <br> + or <NULL/> if no one currently exist + + @see XFrame::setComponent() */ XController getController(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::contextChanged /** notifies the frame that the context of the controller within this - frame changed (i.e., the selection). + frame changed (i.e. the selection). - - - <p>According to a call to this interface, the frame calls - -<!-- JRH: Something seems to be missing from here? --> - - - - with + <p> + According to a call to this interface, the frame calls + <member>XFrameEventListener::frameAction()</member> with <const>FrameAction::CONTEXT_CHANGED</const> to all listeners which - are registered using - - - + are registered using <member>XFrame::addFrameActionListener</member>. + For external controllers this event can be used to requery dispatches. - . - For external controllers this event can be used to requery dispatches.</p> - */ + @see XFrameEventListener + @see FrameAction + @see XFrame::addFrameActionListener() + */ void contextChanged(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrame::addFrameActionListener /** registers an event listener, which will be called when certain things happen to the components within this frame or within sub-frames of this frame. + <p> + E.g., it is possible to determine instantiation/destruction and + activation/deactivation of components. + </p> + @param Listener + specifies the listener which will be informed - <p>E.g., it is possible to determine instantiation/destruction and - activation/deactivation of components.</p> + @see XFrame::removeFrameActionListener() */ - [oneway] void addFrameActionListener( [in]XFrameActionListener xListener ); + [oneway] void addFrameActionListener( [in]XFrameActionListener Listener ); //------------------------------------------------------------------------- + /** unregisters an event listener - // DocMerge from xml: method com::sun::star::frame::XFrame::removeFrameActionListener - /** unregisters an event listener which was registered with - <member>XFrame::addFrameActionListener()</member>. - */ - [oneway] void removeFrameActionListener( [in] XFrameActionListener xListener ); + @param Listener + specifies the listener which willn't be informed any longer + @see XFrame::addFrameActionListener() + */ + [oneway] void removeFrameActionListener( [in] XFrameActionListener Listener ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.4 2000/12/14 12:53:37 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.9 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.5 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.4 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.3 1999/12/06 13:21:14 mba - #67620#: isActive - - Revision 1.2 1999/11/18 11:49:57 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFrameActionListener.idl b/offapi/com/sun/star/frame/XFrameActionListener.idl index 9713bf30edb2..5bd83d03575a 100644 --- a/offapi/com/sun/star/frame/XFrameActionListener.idl +++ b/offapi/com/sun/star/frame/XFrameActionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameActionListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,50 +75,30 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from idl: interface com::sun::star::frame::XFrameActionListener /** has to be provided if an object wants to receive events - when several things happen to components within frames of the desktop. + when several things happen to components within frames of the desktop frame tree. - <p>E.g., you can receive events of instantiation/destruction and - activation/deactivation of components. + <p> + E.g., you can receive events of instantiation/destruction and + activation/deactivation of components. + </p> - @see XDesktop::addFrameActionListener - @see XDesktop::removeFrameActionListener + @see XFrame::addFrameActionListener() + @see XFrame::removeFrameActionListener() */ interface XFrameActionListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrameActionListener::frameAction /** is called whenever any action occurs to a component within a frame. - */ - [oneway] void frameAction( [in] com::sun::star::frame::FrameActionEvent aEvent ); + @param Action + describes the detected frame action for which the listener can react + */ + [oneway] void frameAction( [in] FrameActionEvent Action ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFrameLoader.idl b/offapi/com/sun/star/frame/XFrameLoader.idl index d7dfdbfe10ed..f01c8865b664 100644 --- a/offapi/com/sun/star/frame/XFrameLoader.idl +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameLoader.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,53 +83,61 @@ module com { module sun { module star { module frame { //============================================================================= +/** load components into a frame -// DocMerge: empty anyway + <p> + It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type> + instead of this one. The generic load algorithm of the office supports both ones - but prefered + the synchronous interface. + </p> + + @see XFrame + */ interface XFrameLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrameLoader::load /** starts the loading of the specified resource into the specified <type>Frame</type>. - */ - [oneway] void load( [in] com::sun::star::frame::XFrame aFrame, - [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] com::sun::star::frame::XLoadEventListener xListener ); - //------------------------------------------------------------------------- + @param Frame + specifies the loading target - // DocMerge from xml: method com::sun::star::frame::XFrameLoader::cancel - /** cancels the loading process. + @param URL + describes the ressource of loading component + Support of special protocols are implementation details + and depends from the environment. + @param Arguments + optional arguments for loading + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further informations) + @param Listener + this listener will be informed about success - <p>After returning from this call, neither the frame nor the - load-event-listener specified in "load" may be called back.</p> + @see XLoadEventListener */ - [oneway] void cancel(); + [oneway] void load( + [in] XFrame Frame, + [in] string URL, + [in] sequence< com::sun::star::beans::PropertyValue > Arguments, + [in] XLoadEventListener Listener); + + //------------------------------------------------------------------------- + /** cancels the loading process. + <p> + After returning from this call, neither the frame nor the + load-event-listener specified in <member>XFrameLoader::load()</member> may be called back. + Because only the owner of this process who called load method + before can cancel this process. And he doesn't need any notification about that. + On the other hand - nobody then this owner himself can be registered as an + <type>XLoadEventListener</type> here. + </p> + */ + [oneway] void cancel(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl index e8b1156638f5..c3536f8a2b22 100644 --- a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl +++ b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameLoaderQuery.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,59 +81,29 @@ module frame { //============================================================================ - - -// DocMerge from xml: interface com::sun::star::frame::XFrameLoaderQuery -/** Use this interface together with a XMultiServiceFactory to implement a frame - loader. You can support detailed information about supported properties with XFrameLoaderQuery - and create matching loader with XMultiServiceFactory. - - - - - +/** use service <type>FrameLoaderFactory</type> instead of this @deprecated */ interface XFrameLoaderQuery: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - - // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getAvailableFilterNames - /** return filter names of all available frame loader - <P> - You can use a name of returned list to create a new frame loader - at a XMultiServiceFactory implementation. If you wish to get further - informations about loader properties use method getLoaderProperties() - of this interface. + /** use member <member scope="com::sun::star::container">XNameAccess::getElementNames()</member> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ sequence< string > getAvailableFilterNames(); //------------------------------------------------------------------------- - - - // DocMerge from idl: method com::sun::star::frame::XFrameLoaderQuery::getLoaderProperties - /** return extended information about all supported properties of an frame loader - <P> - If you know a name of a loader call these method to get a set of all - supported properties. Use these values to create a new loader with special - arguments. + /** use member <member scope="com::sun::star::container">XNameAccess::getByName()</member> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ sequence< ::com::sun::star::beans::PropertyValue > getLoaderProperties( [in] string sFilterName ); //------------------------------------------------------------------------- - - - // DocMerge from xml: method com::sun::star::frame::XFrameLoaderQuery::searchFilter - /** search a filter for given parameter - - <p> - If you don't know a filter name of a loader, call these method to search for anyone - who supports a given parameter. Use returned name to get further information - by means of getLoaderProperties() or create a new frame loader at a - XMultiServiceFactory. Don't forget to add returned filter name to argument list - for faster creation! Otherwise, we must search for right loader again. - (We look for FilterName first!)</p> + /** use member <type scope="com::sun::star::container">XContainerQuery</type> + provided by service <type>FrameLoaderFactory</type> instead of this + @deprecated */ string searchFilter( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > seqArguments ); diff --git a/offapi/com/sun/star/frame/XFrameSetModel.idl b/offapi/com/sun/star/frame/XFrameSetModel.idl index 2703086ba0b8..ce423efbeaf5 100644 --- a/offapi/com/sun/star/frame/XFrameSetModel.idl +++ b/offapi/com/sun/star/frame/XFrameSetModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrameSetModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,63 +71,20 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XFrameSetModel -/** This is the main interface for model objects. - - - - - - - - - - - - - +/** use <type>XModel</type> instead of this @deprecated */ interface XFrameSetModel: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge: empty anyway string getSource(); //------------------------------------------------------------------------- - - // DocMerge: empty anyway void setSource( [in] string Source ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.7 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFrames.idl b/offapi/com/sun/star/frame/XFrames.idl index 86928acc9464..5d58f2043377 100644 --- a/offapi/com/sun/star/frame/XFrames.idl +++ b/offapi/com/sun/star/frame/XFrames.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFrames.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,59 +75,57 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XFrames /** manages and creates frames. - - - <p>Frames may contain other frames (by implementing an <type>XFrames</type> + <p> + Frames may contain other frames (by implementing an <type>XFrames</type> interface) and may be contained in other frames. + </p> - </p>@see XFrame - @see Frame + @see XFrame + @see Frame */ interface XFrames: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrames::append /** appends the specified <type>Frame</type> to the list of sub-frames. + + @param xFrame + new frame for inserting into this container */ - void append( [in] com::sun::star::frame::XFrame xFrame ); + void append( [in] XFrame xFrame ); //------------------------------------------------------------------------- + /** provides access to the list of all currently existing + frames inside this container and her sub frames - // DocMerge from idl: method com::sun::star::frame::XFrames::queryFrames - /** @returns - all child frames of the container which are intended to be visible - to other objects. + @param nSearchFlags + use combinations of <type>FrameSearchFlag</type> to specify which + frames should be found - <P>The content of the sequence may be limited by the caller through - the <type>FrameSearchFlags</type>.</P> + @return + all frames of this container and all available frames of the whole frame tree + which match search parameter <var>SearchFlags</var> */ - sequence<com::sun::star::frame::XFrame> queryFrames( [in] long nSearchFlags ); + sequence< XFrame > queryFrames( [in] long nSearchFlags ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFrames::remove /** removes the frame from its container. - - - <p>The method - - - - - is not called implicitly - by this method. - + <p> + Note: + <ul> + <li>The method <method>XComponent::dispose()</method> is not called implicitly + by this method.</li> + <li>The creator attribute of the frame must be reset by the caller of + this method.</li> + </ul> </p> - <p>The creator attribute of the frame must be reset by the caller of - this method.</p> - */ - void remove( [in] com::sun::star::frame::XFrame xFrame ); + + @param xFrame + frame which should be removed from this container + */ + void remove( [in] XFrame xFrame ); }; @@ -135,30 +133,4 @@ interface XFrames: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.7 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl index 2fdeb64e8d87..fc18cda59aed 100644 --- a/offapi/com/sun/star/frame/XFramesSupplier.idl +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFramesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,100 +72,69 @@ interface XFrames; //============================================================================= +/** provides access to sub frames of current one -// DocMerge: empty anyway + @see XFrames + */ interface XFramesSupplier: XFrame { //------------------------------------------------------------------------- + /** provides access to this container and to all other <type>XFramesSupplier</type> + which are available from this node of frame tree - // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getFrames - /** @returns - the collection of (sub-) frames which is represented by - a <type>FramesContainer</type>. + @returns + the collection of frames which is represented by + a <type>FramesContainer</type>. */ XFrames getFrames(); //------------------------------------------------------------------------- + /** gets the current active frame of this container + (not of any other available supplier) + + <p> + This may be the frame itself. The active frame is defined as + the frame which contains (recursively) the window with the focus. + If no window within the frame contains the focus, this method + returns the last frame which had the focus. If no containing + window ever had the focus, the first frame within this frame is + returned. + </p> - // DocMerge from idl: method com::sun::star::frame::XFramesSupplier::getActiveFrame - /** @returns - the sub-<type>Frame</type> which is active within this frame. - - <p>This may be the frame itself. The active frame is defined as - the frame which contains (recursively) the window with the focus. - If no window within the frame contains the focus, this method - returns the last frame which had the focus. If no containing - window ever had the focus, the first frame within this frame is - returned. + @returns + the <type>Frame</type> which is active within this frame. */ XFrame getActiveFrame(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XFramesSupplier::setActiveFrame /** is called on activation of a direct sub-frame. - - - <p>This method is only allowed to be called by a sub-frame according to - - - - - - or - - - - - - . After this call - - - - - - will return the - frame specified by <var>xFrame</var>. - + <p> + This method is only allowed to be called by a sub-frame according to + <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>. + After this call <member>XFramesSupplier::getActiveFrame()</member> will return the + frame specified by <var>Frame</var>. </p> - <p>In general this method first calls the method - + <p> + In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member> + at the creator frame with <var>this</var> as the current argument. Then it broadcasts + the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>. + </p> + <p> + Note: Given parameter <var>Frame</var> must already exist inside the container + (e.g., inserted by using <member>XFrames::append()</member>) + </p> - - at the creator frame - with <var>this</var> as the current argument. Then it broadcasts - the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>.</p> - -<!-- JRH: Something seems to be missing from here? Or maybe there are pictures? --> */ - void setActiveFrame( [in] XFrame xFrame ); - + @param Frame + the new active child frame inside this container + */ + void setActiveFrame( [in] XFrame Frame ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XInterceptorInfo.idl b/offapi/com/sun/star/frame/XInterceptorInfo.idl index 8391e062239b..3d5d6cceff32 100644 --- a/offapi/com/sun/star/frame/XInterceptorInfo.idl +++ b/offapi/com/sun/star/frame/XInterceptorInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterceptorInfo.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,44 +71,37 @@ //============================================================================= -/** Makes it possible to get information about registered interceptor. - zB. get URL lists for interception +/** makes it possible to get information about a registered interceptor and is used by + frame interceptor mechanism to perform interception. + + <p> + Frame can call right interceptor directly without calling all of registered ones. Use it as an additional interface to <type>XDispatchProviderInterceptor</type>. + If any interceptor in list doesn't support this interface - these mechanism will be broken + and normal list of master-slave interceptor objects will be used from top to the bottom. + </p> - <!-- Dennis: What is the "zB"? --> - <!-- Dennis: What "gets" the URL lists? --> -<!-- JRH: Something still seems to be missing from here? -->*/ + @see XDispatchProviderInterception + @see XDispatchProviderInterceptor + */ interface XInterceptorInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** returns the URL list for interception. + + <p> + Wildcards inside the URL's are allowed to register the interceptor for + URL's too, which can have optional arguments (e.g. "..#.." or "..?.."). + </p> + + @return + a list of URL's wich are handled by this interceptor */ sequence< string > getInterceptedURLs(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/04/24 00:10:37 arellano - modified grammatical number, spelling - - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1 2000/10/18 12:09:31 as - #79050# new interface support interception of selected URLs - - Revision 1.1.1.1 2000/09/18 23:35:21 hjs - initial import - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XLoadEventListener.idl b/offapi/com/sun/star/frame/XLoadEventListener.idl index 8961f19879bc..3356c82675b4 100644 --- a/offapi/com/sun/star/frame/XLoadEventListener.idl +++ b/offapi/com/sun/star/frame/XLoadEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLoadEventListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,47 +72,31 @@ interface XFrameLoader; //============================================================================= +/** is used to receive callbacks from an asynchronous frame loader. -// DocMerge from xml: interface com::sun::star::frame::XLoadEventListener -/** is used to receive callbacks from a frame loader. + @see XFrameLoader */ interface XLoadEventListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- + /** is called when a new component is loaded into a frame successfully. - // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadFinished - /** is called when a new control is loaded into a frame. + @param Loader + the source of this event */ - [oneway] void loadFinished( [in] XFrameLoader aLoader ); + [oneway] void loadFinished( [in] XFrameLoader Loader ); //------------------------------------------------------------------------- + /** is called when a frame load is cancelled or failed. - // DocMerge from xml: method com::sun::star::frame::XLoadEventListener::loadCancelled - /** is called when a frame load is cancelled. + @param Loader + the source of this event */ - [oneway] void loadCancelled( [in] XFrameLoader aLoader ); - + [oneway] void loadCancelled( [in] XFrameLoader Loader ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl index 6642308f4c80..eb20bb2116ad 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,210 +87,184 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from idl: interface com::sun::star::frame::XModel /** represents a component which is created from an URL and arguments. - <p>It is a representation of a resource in the sense that it was - created/loaded from the resource. The arguments are passed to the loader - to modify its behavior. An example for such an argument is "AsTemplate", - which loads the resource as a template for a new document. - - <p>Models can be controlled by controller components, which are usually - views of the model. - - <p>If there is at least one controller, there is by definition a - current controller. And if that controller supports the interface - <type>XSelectionSupplier</type>, it has a current selection too. + <p> + It is a representation of a resource in the sense that it was + created/loaded from the resource. The arguments are passed to the loader + to modify its behavior. An example for such an argument is "AsTemplate", + which loads the resource as a template for a new document. + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details) + </p> + + <p> + Models can be controlled by controller components, which are usually + views of the model. + (see <type>Controller</type> for further details) + </p> + + <p> + If there is at least one controller, there is by definition a + current controller. And if that controller supports the interface + <type>XSelectionSupplier</type>, it has a current selection too. + </p> + + @see MediaDescriptor + @see Controller + @see XSelectionSupplier */ interface XModel: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::attachResource /** informs a model about its resource description. + + @param URL + specifies the ressource + + @param Arguments + are optional arguments for that ressource + (see <type scope="com::sun::star::document">MediaDescriptor</type>) + + @return + <TRUE/> for success + <br> + <FALSE/> otherwise */ - boolean attachResource( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); + boolean attachResource( + [in] string URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments); //------------------------------------------------------------------------- + /** provides information about the location of this model - // DocMerge from idl: method com::sun::star::frame::XModel::getURL - /** @returns - the URL of the resource which is represented by this model. + @returns + the URL of the resource which is represented by this model. - @see XStorable::getLocation + @see XStorable::getLocation() */ string getURL(); //------------------------------------------------------------------------- + /** provides read acces on currently representation of the + <type scope="com::sun::star::document">MediaDescriptor</type> + of this model which describes the model and his state - // DocMerge from idl: method com::sun::star::frame::XModel::getArgs - /** @returns - the arguments with which the model was originally created or - stored the last time. + @returns + the arguments with which the model was originally created or + stored the last time. */ - sequence<com::sun::star::beans::PropertyValue> getArgs(); + sequence< com::sun::star::beans::PropertyValue > getArgs(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::connectController /** is called whenever a new controller is created for this model. + <p> + The <type scope="com::sun::star::lang">XComponent</type> interface + of the controller must be used to recognize when it is deleted. + </p> + @param Controller + a new controller for this model - <p>The <type scope="com::sun::star::lang">XComponent</type> interface of the controller must be used to - recognize when it is deleted. - - </p>@see releaseController + @see XModel::disconnectController() */ - [oneway] void connectController( [in] com::sun::star::frame::XController xController ); + [oneway] void connectController( [in] XController Controller ); //------------------------------------------------------------------------- + /** is called whenever an existing controller should be deregistered at this model. - // DocMerge from xml: method com::sun::star::frame::XModel::disconnectController - /** is called whenever a new controller is created for this model. - - + <p> + The <type scope="com::sun::star::lang">XComponent</type> interface + of the controller must be used to recognize when it is deleted. + </p> - <p>The <type scope="com::sun::star::lang">XComponent</type> interface of the controller must be - used to recognize when it is deleted. + @param Controller + the existing controller which should be deregistered - </p>@see registerController + @see XModel::connectController() */ - [oneway] void disconnectController( [in] com::sun::star::frame::XController xController ); + [oneway] void disconnectController( [in] XController Controller ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::lockControllers /** suspends some notifications to the controllers which are used for display updates. - - - <p>The calls to - - - - - and - - - - - - may be + <p> + The calls to <member>XModel::lockControllers()</member> and + <member>XModel::unlockControllers()</member> may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications - for display updates are not broadcasted.</p> + for display updates are not broadcasted. + </p> */ [oneway] void lockControllers(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::unlockControllers /** resumes the notifications which were suspended by + <member>XModel::lockControllers()</member>. - - - - - . - - - - <p>The calls to - - - - - and - - - - - - may be + <p> + The calls to <member>XModel::lockControllers()</member> and + <member>XModel::unlockControllers()</member> may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for - display updates are not broadcasted.</p> - */ + display updates are not broadcasted. + </p> + */ [oneway] void unlockControllers(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::hasControllersLocked /** determines if there is at least one lock remaining. + <p> + While there is at least one lock remaining, some notifications + for display updates are not broadcasted to the controllers. + </p> - - <p>While there is at least one lock remaining, some notifications - for display updates are not broadcasted to the controllers.</p> + @return + <TRUE/> if any lock exist + <br> + <FALSE/> otherwise */ boolean hasControllersLocked(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentController - /** @returns - the controller which currently controls this model. - - <p>If the controller which is active is a controller of this model, - it will be returned. If not, the controller which was the last - active of this model is returned. If no controller of this model - ever was active, the controller first registered is returned. If no - controller is registered for this model, NULL is returned. + /** provides access to the controller which currently controls this model + + @returns + If the controller which is active is a controller of this model, + it will be returned. If not, the controller which was the last + active of this model is returned. If no controller of this model + ever was active, the controller first registered is returned. If no + controller is registered for this model, <NULL/> is returned. */ - com::sun::star::frame::XController getCurrentController(); + XController getCurrentController(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XModel::setCurrentController /** sets a registered controller as the current controller. + + @param Controller + reference to an already existing connected controller, which should be + the new active one + + @throws com::sun::star::container::NoSuchElementException + if <var>xController</var> isn't an already connected controller on this model */ - void setCurrentController( [in] com::sun::star::frame::XController xController ) + void setCurrentController( [in] XController Controller ) raises( com::sun::star::container::NoSuchElementException ); //------------------------------------------------------------------------- + /** provides read access on current selection on controller - // DocMerge from idl: method com::sun::star::frame::XModel::getCurrentSelection - /** @returns - the current selection in the current controller. - - <p>If there is no current controller, it returns NULL. + @returns + the current selection in the current controller. + If there is no current controller, it returns <NULL/>. */ com::sun::star::uno::XInterface getCurrentSelection(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.8 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.4 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.3 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.2 1999/11/18 11:49:57 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XNotifyingDispatch.idl b/offapi/com/sun/star/frame/XNotifyingDispatch.idl index 372169806b01..8b0f160531d4 100644 --- a/offapi/com/sun/star/frame/XNotifyingDispatch.idl +++ b/offapi/com/sun/star/frame/XNotifyingDispatch.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNotifyingDispatch.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mba $ $Date: 2001-11-09 16:20:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,31 @@ module com { module sun { module star { module frame { //============================================================================= +/** dispatch with guaranteed notify (instead of <type>XDispatch</type>) -interface XNotifyingDispatch: com::sun::star::frame::XDispatch + @see XDispatch + @see XStatusListener + */ +interface XNotifyingDispatch: XDispatch { - [oneway] void dispatchWithNotification( [in] com::sun::star::util::URL aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs, - [in] com::sun::star::frame::XDispatchResultListener Listener ); + //------------------------------------------------------------------------- + /** Do the same like <member>XDispatch::dispatch()</member> but notifies + listener in every case. Should be used if result must be known. + + @param URL + full parsed URL describes the feature which should be dispatched (executed) + + @param Arguments + optional arguments for this request + (see <type scope="com::sun::star::document">MediaDescriptor</type>) + + @param Listener + optional listener for guaranteed notifications of this request + */ + [oneway] void dispatchWithNotification( + [in] com::sun::star::util::URL URL, + [in] sequence<com::sun::star::beans::PropertyValue> Arguments, + [in] XDispatchResultListener Listener); }; //============================================================================= diff --git a/offapi/com/sun/star/frame/XStatusListener.idl b/offapi/com/sun/star/frame/XStatusListener.idl index 4a940d627888..13d20837e336 100644 --- a/offapi/com/sun/star/frame/XStatusListener.idl +++ b/offapi/com/sun/star/frame/XStatusListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,46 +75,30 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XStatusListener /** makes it possible to receive events when the state of a feature changes. + + <p> + Nobody guarantee any notification. Use combination of <type>XNotifyingDispatch</type> + and <type>XDispatchResultListener</type> for that. + </p> + + @see XDispatch + @see XNotifyingDispatch + @see XDispatchResultListener */ interface XStatusListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XStatusListener::statusChanged /** is called when the status of the feature changes. - */ - [oneway] void statusChanged( [in] com::sun::star::frame::FeatureStateEvent Event ); + @param State + provides information about changes of the requested feature + */ + [oneway] void statusChanged( [in] FeatureStateEvent State ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.7 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XStorable.idl b/offapi/com/sun/star/frame/XStorable.idl index d9fccb1a5751..fc17f09f1a27 100644 --- a/offapi/com/sun/star/frame/XStorable.idl +++ b/offapi/com/sun/star/frame/XStorable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStorable.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,174 +79,117 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XStorable /** offers a simple way to store a component to an URL. - - - <p>It is usually only useful for two cases: - + <p> + It is usually only useful for two cases: </p> <ol> - <li>Large components which are wrapped with <em>StarOne</em> interfaces - and for which distinct filters are not available separately as - components. - - </li> - <li>Very small components for which only one or very few hard - coded file format filters make sense or even exist. - </li> + <li> + Large components which are wrapped with <em>StarOne</em> interfaces + and for which distinct filters are not available separately as + components. + </li> + <li> + Very small components for which only one or very few hard + coded file format filters make sense or even exist. + </li> </ol> */ interface XStorable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** The object may know the location because it was loaded from there, + or because it is stored there. - // DocMerge from idl: method com::sun::star::frame::XStorable::hasLocation - /** @returns - <TRUE/> if the object knows a location where it is persistent. - - <p>The object may know the location because it was loaded from there, - or because it is stored there. + @returns + <TRUE/> if the object knows a location where it is persistent + <FALSE/> otherwise */ boolean hasLocation(); //------------------------------------------------------------------------- + /** After <member>XStorable::storeAsURL()</member> it returns the + URL the object was stored to. - // DocMerge from idl: method com::sun::star::frame::XStorable::getLocation - /** @returns - the URL of the resource which is represented by this object. - - <p>After <member>XStorable::storeAsURL</member> it returns the - URL the object was stored to. + @returns + the URL of the resource which is represented by this object. */ string getLocation(); //------------------------------------------------------------------------- + /** It is not possible to call <member>XStorable::store()</member> successfully + when the data store is read-only. - // DocMerge from idl: method com::sun::star::frame::XStorable::isReadonly - /** @returns - <TRUE/> if the data store is readonly or opened readonly. - - <p>It is not possible to call store() successfully when the data - store is read-only. + @returns + <TRUE/> if the data store is readonly or opened readonly + <FALSE/> otherwise */ boolean isReadonly(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XStorable::store /** stores the data to the URL from which it was loaded. + <p>Only objects which know their locations can be stored.</p> + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) - <p>Only objects which know their locations can be stored.</p> + @see XStorable::storeAsURL + @see XStorable::storeToURL */ void store() raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XStorable::storeAsURL /** stores the object's persistent data to a URL and lets the object become the representation of this new URL. + <p>This is the normal behavior for UI's "save-as" feature.</p> + @param sURL + specifies the new location of this component - <p>This is the normal behavior for UI's "save-as" feature. - - </p> - <p>The arguments depend on the object itself. Commonly used are: - <dl> - <dt>string FilterName - </dt> - <dd> The programmatic name of the file format filter to be used. + @param lArguments + optional parameters for saving + (see <type scope="com::sun::star::document">MediaDescriptor</type> for further details) - </dd> - <dt>string FilterFlags - </dt> - <dd> This string contains flags which depend on the filter. - They describe how the data is to be stored. (E.g., the - field delimitors for text database formats or the - character set.) + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) - </dd> - <dt>boolean Overwrite - </dt> - <dd> Overwrites the target file if it exists. Otherwise the - call would result in an exception if the file exists. - - </dd> - <dt>string Password - </dt> - <dd> This argument specifies the password to be used to - encrypt the document. - </dd> - </dl> - - </p> - - @see storeTo - @see com::sun::star::document::MediaDescriptor - for more information on values for <var>aArgs</var>. + @see XStorable::store + @see XStorable::storeToURL + @see MediaDescriptor */ - void storeAsURL( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException ); + void storeAsURL( + [in] string sURL, + [in] sequence<com::sun::star::beans::PropertyValue> lArguments ) + raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XStorable::storeToURL /** stores the object's persistent data to a URL and continues to be a representation of the old URL. - <p>This is the normal behavior for UI's export feature. </p> + <p>This is the normal behavior for UI's export feature.</p> - @see storeAs - @see com::sun::star::document::MediaDescriptor - for more information on values for <var>aArgs</var>. - */ - void storeToURL( [in] string aURL, - [in] sequence<com::sun::star::beans::PropertyValue> aArgs ) - raises( com::sun::star::io::IOException ); + @throws com::sun::star::io::IOException + if an IO error occured during save operation + (may the location is unknown) + @see XStorable::store + @see XStorable::storeAsURL + @see MediaDescriptor + */ + void storeToURL( + [in] string sURL, + [in] sequence<com::sun::star::beans::PropertyValue> lArguments ) + raises( com::sun::star::io::IOException ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/22 17:27:25 mi - #77161# arguments of XStorable::storeAs/To - - Revision 1.5 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/19 16:03:30 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.7 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:56 mi - missing documentations - - Revision 1.2 2000/01/31 09:44:59 mi - XML syntax for documentation - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index a80599a369a8..98051838c92b 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSynchronousFrameLoader.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-04-24 00:16:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,31 +78,46 @@ module com { module sun { module star { module frame { //============================================================================= - /** loads a resource into a <type>Frame</type>. <p> Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous. </p> - */ + @see XFrameLoader + */ interface XSynchronousFrameLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** starts the loading of the specified resource into the specified <type>Frame</type>. - <p> - Use a <type>MediaDescriptor</type> to describe the document for loading. - <TRUE/> is returned if loading is successful, otherwise <FALSE/>. - </p> + @param Descriptor + describes the ressource which should be loaded + It use a <type scope="com::sun::star::document">MediaDescriptor</type> for that. + + @param Frame + the target frame which should contain the new loaded component + + @return + <TRUE/> if loading is successfully + <br> + <FALSE/> otherwise */ - boolean load( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor , - [in] com::sun::star::frame::XFrame xFrame ); + boolean load( + [in] sequence< com::sun::star::beans::PropertyValue > Descriptor, + [in] XFrame Frame ); //------------------------------------------------------------------------- - /** cancels the loading process. + + <p> + No notifications (neither to the frame or the caller) must be notified. + Because it's a synchronous process this cancel call can be forced by + another thread the the loader thread only. Method + <member>XSynchronousFrameLoader::load()</member> must return <FALSE/> + then and caller of this method <member>XSynchronousFrameLoader::cancel()</member> + already knows the state ... + </p> */ void cancel(); }; diff --git a/offapi/com/sun/star/frame/XTask.idl b/offapi/com/sun/star/frame/XTask.idl index 84015bf1a25c..7272939a7fa8 100644 --- a/offapi/com/sun/star/frame/XTask.idl +++ b/offapi/com/sun/star/frame/XTask.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTask.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,76 +71,37 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XTask -/** This is the main interface of a task within the desktop. - - - - - - - - @deprecated@see XDesktopTask - for substitute. - - @see XWindowArranger - for substitute. +/** use <type>XFrame</type> instead of this one + @deprecated */ -interface XTask: com::sun::star::frame::XFrame +interface XTask: XFrame { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::close - /** tries to close all windows within the task and the task by itself. + /** use <type scope="com::sun::star::util">XClosable</type> or + <member scope="com::sun::star::lang">XComponent::dispose()</member> + at a <type>Frame</type> instead of this one + @deprecated */ boolean close(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::tileWindows - /** arranges the windows within the task in tiles. + /** @deprecated */ [oneway] void tileWindows(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsVertical - /** arranges the windows within the task vertically. + /** @deprecated */ [oneway] void arrangeWindowsVertical(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTask::arrangeWindowsHorizontal - /** arranges the windows within the task horizontally. + /** @deprecated */ [oneway] void arrangeWindowsHorizontal(); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.6 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:32 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XTasksSupplier.idl b/offapi/com/sun/star/frame/XTasksSupplier.idl index 5ce57c631c67..9ed7ab25857c 100644 --- a/offapi/com/sun/star/frame/XTasksSupplier.idl +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTasksSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,65 +79,26 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XTasksSupplier -/** provides access to the tasks of a desktop environment. - - - - <p>Note: Not all desktop environments support tasks at all. - - </p>@see Desktop +/** use <type>XFramesSupplier</type> instead of that + @deprecated */ interface XTasksSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XTasksSupplier::getTasks - /** @returns - a collection of all tasks currently running in the desktop. - - <p>The service <type>Tasks</type> contained in this attribute is - a collection object of all tasks of the desktop. - - @see Tasks + /** use <member>XFramesSupplier::getFrames()</member> instead of this one + @depreacted */ com::sun::star::container::XEnumerationAccess getTasks(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XTasksSupplier::getActiveTask - /** @returns - the task of the currently active component within this desktop enviroment. - - <p>Even if an active component exists, there may be no active task. + /** use <member>XFramesSupplier::getActiveFrame()</member> instead of this one + @depreacted */ - com::sun::star::frame::XTask getActiveTask(); - + XTask getActiveTask(); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl index 0e8855e7059d..3dfdee864af6 100644 --- a/offapi/com/sun/star/frame/XTerminateListener.idl +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTerminateListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,53 +79,45 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XTerminateListener /** has to be provided if an object wants to receive an event - when the master environment (e.g., desktop) is terminated.@see XDesktop::addTerminateListener - @see XDesktop::removeTerminateListener + when the master environment (e.g., desktop) is terminated. + + @see XDesktop::terminate() + @see XDesktop::addTerminateListener() + @see XDesktop::removeTerminateListener() */ interface XTerminateListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTerminateListener::queryTermination /** is called when the master environment (e.g., desktop) is about to terminate. + + <p> + Termination can be intercepted by throwing <type>TerminationVetoException</type>. + Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member> + after finishing his own operations. + </p> + + @param Event + describe the source of the event (e.g., the desktop) + + @throws TerminationVetoException + listener can disagree with this query by throwing this veto exception */ - void queryTermination( [in] com::sun::star::lang::EventObject aEvent ) - raises( com::sun::star::frame::TerminationVetoException ); + void queryTermination( [in] com::sun::star::lang::EventObject Event ) + raises( TerminationVetoException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XTerminateListener::notifyTermination /** is called when the master environment is finally terminated. - */ - void notifyTermination( [in] com::sun::star::lang::EventObject aEvent ); + Not veto will be accepted then. + @param Event + describe the source of the event (e.g., the desktop) + */ + void notifyTermination( [in] com::sun::star::lang::EventObject Event ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:25 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/frame/XUrlList.idl b/offapi/com/sun/star/frame/XUrlList.idl index f6e88454776e..203379b2b8c1 100644 --- a/offapi/com/sun/star/frame/XUrlList.idl +++ b/offapi/com/sun/star/frame/XUrlList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUrlList.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 10:29:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,9 +71,7 @@ module com { module sun { module star { module frame { //============================================================================= -/** provides a list of URLs (i.e., to represent a selection). - - @deprecated +/** @deprecated */ interface XUrlList: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/frame/XWindowArranger.idl b/offapi/com/sun/star/frame/XWindowArranger.idl index 00659f4652a0..aa88b2a58d90 100644 --- a/offapi/com/sun/star/frame/XWindowArranger.idl +++ b/offapi/com/sun/star/frame/XWindowArranger.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWindowArranger.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,53 +71,23 @@ module com { module sun { module star { module frame { //============================================================================= - -// DocMerge from xml: interface com::sun::star::frame::XWindowArranger -/** makes it possible to arrange the sub-windows within this component. +/** @deprecated */ interface XWindowArranger: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::frame::XWindowArranger::hasArrangeCommand - /** @returns - <TRUE/> if the specified arrangement style is supported. - - @see WindowArrange + /** @deprecated */ boolean hasArrangeCommand( [in] short nCommand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::frame::XWindowArranger::arrange - /** arranges the window according to the specified style.@see WindowArrange + /** @deprecated */ [oneway] void arrange( [in] short nCommand ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:10 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:14 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:22 hjs - initial import - - Revision 1.5 2000/09/11 11:52:29 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/i18n/AmPmValue.idl b/offapi/com/sun/star/i18n/AmPmValue.idl index 0219f5fb68b8..f5147ba46e59 100644 --- a/offapi/com/sun/star/i18n/AmPmValue.idl +++ b/offapi/com/sun/star/i18n/AmPmValue.idl @@ -2,9 +2,9 @@ * * $RCSfile: AmPmValue.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,10 +68,13 @@ module com { module sun { module star { module i18n { //============================================================================= -/// constants used in calls to <member>XCalendar::getDisplayName()</member> +/** Constants for AM/PM used in calls to <member>XCalendar::getDisplayName()</member>. + */ constants AmPmValue { + /// get display name string for AM const short AM = 0; + /// get display name string for PM const short PM = 1; }; diff --git a/offapi/com/sun/star/i18n/Boundary.idl b/offapi/com/sun/star/i18n/Boundary.idl new file mode 100644 index 000000000000..440b37389e69 --- /dev/null +++ b/offapi/com/sun/star/i18n/Boundary.idl @@ -0,0 +1,84 @@ +/************************************************************************* + * + * $RCSfile: Boundary.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:36 $ + * + * 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_i18n_Boundary_idl__ +#define __com_sun_star_i18n_Boundary_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Start and end position of a word. + */ +struct Boundary +{ + /// Start position of a word, <b>inclusive</b> + long startPos ; + + /// End position of a word, <b>exclusive</b> + long endPos; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/BreakIterator.idl b/offapi/com/sun/star/i18n/BreakIterator.idl index a64939288577..b0464a0b305d 100644 --- a/offapi/com/sun/star/i18n/BreakIterator.idl +++ b/offapi/com/sun/star/i18n/BreakIterator.idl @@ -2,9 +2,9 @@ * * $RCSfile: BreakIterator.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,13 +75,15 @@ //-------------------------------------------------------------------------- /** contains the base routines for iteration in Unicode string. Iterates over - Characters, Words, Sentences and Linebreaks. - <P>It also contains a BreakIterator service for asian languages + characters, words, sentences and line breaks. + + <p> It also contains a BreakIterator service for asian languages. + </p> */ service BreakIterator { interface com::sun::star::i18n::XBreakIterator; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; //============================================================================= diff --git a/offapi/com/sun/star/i18n/BreakType.idl b/offapi/com/sun/star/i18n/BreakType.idl new file mode 100644 index 000000000000..7c8fa29d1446 --- /dev/null +++ b/offapi/com/sun/star/i18n/BreakType.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * $RCSfile: BreakType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:37 $ + * + * 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_i18n_BreakType_idl__ +#define __com_sun_star_i18n_BreakType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Constants to specify the type of a line break, used with + <member>LineBreakResults::breakType</member>. + */ + +constants BreakType +{ + /// Line break is a word break. + const short WORDBOUNDARY = 1; + + /// Line break is a result of hyphenation. + const short HYPHENATION = 2; + + /// Line break - hanging punctuation recognized. + const short HANGINGPUNCTUATION = 3; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/Calendar.idl b/offapi/com/sun/star/i18n/Calendar.idl index 5ebb8322bc4a..c75dcc760ecb 100644 --- a/offapi/com/sun/star/i18n/Calendar.idl +++ b/offapi/com/sun/star/i18n/Calendar.idl @@ -2,9 +2,9 @@ * * $RCSfile: Calendar.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-05-21 20:50:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,13 @@ module com { module sun { module star { module i18n { //============================================================================= /** - A calendar as loaded from locale data. + A calendar as returned in a sequence by + <member>XLocaleData::getAllCalendars()</member>. - <p>A sequence of Calendars is returned by calls to - <member>XLocaleData::getAllCalendars()</member>. + @see XLocaleData + for links to DTD of XML locale data files. */ + struct Calendar { /// the days of the week, see also <type>CalendarItem</type>. @@ -90,7 +92,7 @@ struct Calendar short MinimumNumberOfDaysForFirstWeek; /// if this is the default calendar for a given locale. boolean Default; - /// the name of the calendar, for example, <bold>gregorian</bold>. + /// the name of the calendar, for example, <b>gregorian</b>. string Name; }; diff --git a/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl b/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl index d8a46b0f0177..c8eaec310ac7 100644 --- a/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl +++ b/offapi/com/sun/star/i18n/CalendarDisplayIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: CalendarDisplayIndex.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-05-21 20:51:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,10 +74,15 @@ module com { module sun { module star { module i18n { */ constants CalendarDisplayIndex { + /// name of an AM/PM value const short AM_PM = 0; + /// name of a day of week const short DAY = 1; + /// name of a month const short MONTH = 2; + /// name of a year (if used for a specific calendar) const short YEAR = 3; + /// name of an era, like BC/AD const short ERA = 4; }; diff --git a/offapi/com/sun/star/i18n/CalendarFieldIndex.idl b/offapi/com/sun/star/i18n/CalendarFieldIndex.idl index 820940a3581f..297931d1575d 100644 --- a/offapi/com/sun/star/i18n/CalendarFieldIndex.idl +++ b/offapi/com/sun/star/i18n/CalendarFieldIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: CalendarFieldIndex.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: er $ $Date: 2002-05-02 17:10:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,7 @@ module com { module sun { module star { module i18n { /** - Field indexes to be passed to various <type>XCalendar</type> methods. + Field indices to be passed to various <type>XCalendar</type> methods. <p> Field is writable only if marked both Get/Set. </p> @@ -81,38 +81,43 @@ module com { module sun { module star { module i18n { */ constants CalendarFieldIndex { + /// Get/Set time zone offset in minutes [-12*60..12*60] + const short ZONE_OFFSET = 14; + /// Total number of fields + const short FIELD_COUNT = 15; + /// Get <type>AmPmValue</type>. const short AM_PM = 0; - /// Get/Set [1-31] + /// Get/Set day of month [1-31]. const short DAY_OF_MONTH = 1; - /// Get [0-6] + /// Get day of week [0-6]. const short DAY_OF_WEEK = 2; - /// Get + /// Get day of year. const short DAY_OF_YEAR = 3; - /// Get/Set daylight saving time offset in minutes [0*60..1*60] + /** Get/Set daylight saving time offset in minutes [0*60..1*60] + <p> Note that there is a bug in OpenOffice.org 1.0 / StarOffice 6.0 + that prevents interpreting this value correctly. </p> */ const short DST_OFFSET = 4; - /// Get/Set [0-23] + /// Get/Set hour [0-23]. const short HOUR = 5; - /// Get/Set [0-59] + /// Get/Set minute [0-59]. const short MINUTE = 6; - /// Get/Set [0-59] + /// Get/Set second [0-59]. const short SECOND = 7; - /// Get/Set [0-999] + /// Get/Set milliseconds [0-999]. const short MILLISECOND = 8; - /// Get + /// Get week of month. const short WEEK_OF_MONTH = 9; - /// Get + /// Get week of year. const short WEEK_OF_YEAR = 10; - /// Get/Set + /// Get/Set year. const short YEAR = 11; - /// Get/Set [0-...] + /** Get/Set month [0-...]. + <p> Note that the maximum value is <b>not</b> necessarily 12 but + depends on the calendar used instead. </p> */ const short MONTH = 12; - /// Get/Set + /// Get/Set era, for example, 0:= Before Christ, 1:= After Christ. const short ERA = 13; - /// Get/Set time zone offset in minutes [-12*60..12*60] - const short ZONE_OFFSET = 14; - /// Total number of fields - const short FIELD_COUNT = 15; }; //============================================================================= diff --git a/offapi/com/sun/star/i18n/CalendarItem.idl b/offapi/com/sun/star/i18n/CalendarItem.idl index 426e6e9e29e3..3b7f368b23c9 100644 --- a/offapi/com/sun/star/i18n/CalendarItem.idl +++ b/offapi/com/sun/star/i18n/CalendarItem.idl @@ -2,9 +2,9 @@ * * $RCSfile: CalendarItem.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-05-21 20:57:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,20 +70,23 @@ module com { module sun { module star { module i18n { /** - One entry in a calendar, for example, a day of week or a month or an era. + One entry in a calendar, for example, a day of week or a month or an + era. - <p>A sequence of CalendarItems is contained in the <type>Calendar</type> - fields <emp>Days</emp>, <emp>Months</emp> and <emp>Eras</emp>. + <p> A sequence of CalendarItems is contained in + <member>Calendar::Days</member>, <member>Calendar::Months</member>, + <member>Calendar::Eras</member> </p> */ + struct CalendarItem { - /// a unique ID for an entry of this type, usually the abbreviated English name. + /** A unique ID for an entry of this type, usually the lower case + abbreviated English name, for example, <b>"sun"</b> for Sunday. */ string ID; - /// the abbreviated name. + /// The abbreviated name, for example, <b>"Sun"</b>. string AbbrevName; - /// the full name. - string FullName; -}; + /// The full name, for example, <b>"Sunday"</b>. + string FullName; }; //============================================================================= }; }; }; }; diff --git a/offapi/com/sun/star/i18n/ChapterCollator.idl b/offapi/com/sun/star/i18n/ChapterCollator.idl index a51c1978be3f..eebd7b6a9545 100644 --- a/offapi/com/sun/star/i18n/ChapterCollator.idl +++ b/offapi/com/sun/star/i18n/ChapterCollator.idl @@ -1,27 +1,83 @@ +/************************************************************************* + * + * $RCSfile: ChapterCollator.idl,v $ + * + * $Revision: 1.3 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:38 $ + * + * 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_i18n_ChapterCollator_idl__ #define __com_sun_star_i18n_ChapterCollator_idl__ #include <com/sun/star/lang/XServiceInfo.idl> - -#ifndef __com_sun_star_i18n_XCollator_idl__ #include <com/sun/star/i18n/XCollator.idl> -#endif -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= +//============================================================================ -/// specific Collator +/// Specific collator to sort chapter numbering. service ChapterCollator { interface com::sun::star::i18n::XCollator; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; -//============================================================================= - +//============================================================================ }; }; }; }; - +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/CharType.idl b/offapi/com/sun/star/i18n/CharType.idl new file mode 100644 index 000000000000..2d5c3682b0c6 --- /dev/null +++ b/offapi/com/sun/star/i18n/CharType.idl @@ -0,0 +1,117 @@ +/************************************************************************* + * + * $RCSfile: CharType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:38 $ + * + * 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_i18n_CharType_idl__ +#define __com_sun_star_i18n_CharType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Constants to specify the character type that starts a character block. + + <p> Used with <member>XBreakIterator::beginOfCharBlock()</member>, + <member>XBreakIterator::endOfCharBlock()</member>, + <member>XBreakIterator::nextCharBlock()</member>, + <member>XBreakIterator::previousCharBlock()</member> </p> + */ +constants CharType +{ + /// all alpha characters allowed + const short ANY_CHAR = 0; + + const short UPPERCASE_LETTER = 1; + const short LOWERCASE_LETTER = 2; + const short TITLECASE_LETTER = 3; + const short MODIFIER_LETTER = 4; + const short OTHER_LETTER = 5; + const short NON_SPACING_MARK = 6; + const short ENCLOSING_MARK = 7; + const short COMBINING_SPACING_MARK = 8; + const short DECIMAL_DIGIT_NUMBER = 9; + const short LETTER_NUMBER = 10; + const short OTHER_NUMBER = 11; + const short SPACE_SEPARATOR = 12; + const short LINE_SEPARATOR = 13; + const short PARAGRAPH_SEPARATOR = 14; + const short CONTROL = 15; + const short FORMAT = 16; + const short PRIVATE_USE = 17; + const short SURROGATE = 18; + const short DASH_PUNCTUATION = 19; + const short START_PUNCTUATION = 20; + const short END_PUNCTUATION = 21; + const short CONNECTOR_PUNCTUATION = 22; + const short OTHER_PUNCTUATION = 23; + const short MATH_SYMBOL = 24; + const short CURRENCY_SYMBOL = 25; + const short MODIFIER_SYMBOL = 26; + const short OTHER_SYMBOL = 27; + const short INITIAL_PUNCTUATION = 28; + const short FINAL_PUNCTUATION = 29; + const short GENERAL_TYPES_COUNT = 30; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/CharacterClassification.idl b/offapi/com/sun/star/i18n/CharacterClassification.idl index 7717c1293156..0db0e0ec3038 100644 --- a/offapi/com/sun/star/i18n/CharacterClassification.idl +++ b/offapi/com/sun/star/i18n/CharacterClassification.idl @@ -2,9 +2,9 @@ * * $RCSfile: CharacterClassification.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ module com { module sun { module star { module i18n { service CharacterClassification { interface com::sun::star::i18n::XCharacterClassification; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; //============================================================================= diff --git a/offapi/com/sun/star/i18n/CharacterIteratorMode.idl b/offapi/com/sun/star/i18n/CharacterIteratorMode.idl new file mode 100644 index 000000000000..2f3a0d4b4e3b --- /dev/null +++ b/offapi/com/sun/star/i18n/CharacterIteratorMode.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * $RCSfile: CharacterIteratorMode.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:39 $ + * + * 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_i18n_CharacterIteratorMode_idl__ +#define __com_sun_star_i18n_CharacterIteratorMode_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Constants to specify the type of character iteration. + + <p> Used with <member>XBreakIterator::nextCharacters()</type> and + <member>XBreakIterator::previousCharacters()</type> </p> + */ +constants CharacterIteratorMode +{ + /// skip characters + const short SKIPCHARACTER = 0; + + /// skip cells + const short SKIPCELL = 1; + + /// skip control characters + const short SKIPCONTROLCHARACTER = 2; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/i18n/Collator.idl b/offapi/com/sun/star/i18n/Collator.idl index 9a7c1c53869a..aa01c05c11ed 100644 --- a/offapi/com/sun/star/i18n/Collator.idl +++ b/offapi/com/sun/star/i18n/Collator.idl @@ -1,3 +1,63 @@ +/************************************************************************* + * + * $RCSfile: Collator.idl,v $ + * + * $Revision: 1.3 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:39 $ + * + * 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_i18n_Collator_idl__ #define __com_sun_star_i18n_Collator_idl__ @@ -7,21 +67,23 @@ #include <com/sun/star/i18n/XCollator.idl> #endif -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= +//============================================================================ + +/** + Access collation algorithms of different locales. + */ -/// specific Collator service Collator { interface com::sun::star::i18n::XCollator; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; -//============================================================================= - +//============================================================================ }; }; }; }; - +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/CollatorOptions.idl b/offapi/com/sun/star/i18n/CollatorOptions.idl new file mode 100644 index 000000000000..0733425006e2 --- /dev/null +++ b/offapi/com/sun/star/i18n/CollatorOptions.idl @@ -0,0 +1,85 @@ +/************************************************************************* + * + * $RCSfile: CollatorOptions.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:39 $ + * + * 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_i18n_CollatorOptions_idl__ +#define __com_sun_star_i18n_CollatorOptions_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Options to be used with <type>XCollator</type> methods. + */ +constants CollatorOptions +{ + /// Ignore case. + const short CollatorOptions_IGNORE_CASE = 1; + /// Ignore Kana. + const short CollatorOptions_IGNORE_KANA = 2; + /// Ignore width. + const short CollatorOptions_IGNORE_WIDTH = 4; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/Currency.idl b/offapi/com/sun/star/i18n/Currency.idl index b4bb0a758379..ad6975599de0 100644 --- a/offapi/com/sun/star/i18n/Currency.idl +++ b/offapi/com/sun/star/i18n/Currency.idl @@ -2,9 +2,9 @@ * * $RCSfile: Currency.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,42 +62,53 @@ #ifndef __com_sun_star_i18n_Currency_idl__ #define __com_sun_star_i18n_Currency_idl__ -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= +//============================================================================ /** - Symbols and names of a specific currency. + Symbols, names, and attributes of a specific currency, returned in a + sequence by <member>XLocaleData::getAllCurrencies()</member>. - <p> Returned by <member>XLocaleData::getAllCurrencies()</member>. + @see XLocaleData + for links to DTD of XML locale data files. */ -struct Currency { - /// identifier, for example, <b>dollar</b>. + +struct Currency +{ + /** Identifier, for example, <b>dollar</b>. */ string ID; - /// currency symbol, for example, <b>$</b>. + + /** Currency symbol, for example, <b>$</b>. */ string Symbol; - /// currency abbreviation used by banks and in money exchange, for example, <b>USD</b>. + + /** Currency abbreviation used by banks and in money exchange, for + example, <b>USD</b>. */ string BankSymbol; - /// name of the currency, for example, <b>US Dollar</b>. + + /** Name of the currency, for example, <b>US Dollar</b>. */ string Name; - /// if this currency is the default currency for a given locale. + + /** If this currency is the default currency for a given locale. */ boolean Default; - /** if this currency is the one used in compatible number format codes with + + /** If this currency is the one used in compatible number format codes with <member>FormatElement::formatIndex</member> values in the range 12..17. Those format codes are used to generate some old style currency format codes for compatibility with StarOffice5 and StarOffice4. + + @see com::sun::star::i18n::NumberFormatIndex */ boolean UsedInCompatibleFormatCodes; - /** the number of decimal places, for example, <bold>2</bold> for US Dollar - or <bold>0</bold> for Italian Lira. - */ + + /** The number of decimal places, for example, <b>2</b> for US Dollar + or <b>0</b> for Italian Lira. */ short DecimalPlaces; }; -//============================================================================= - +//============================================================================ }; }; }; }; - +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/DirectionProperty.idl b/offapi/com/sun/star/i18n/DirectionProperty.idl new file mode 100644 index 000000000000..a803aa1d2119 --- /dev/null +++ b/offapi/com/sun/star/i18n/DirectionProperty.idl @@ -0,0 +1,101 @@ +/************************************************************************* + * + * $RCSfile: DirectionProperty.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05: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_i18n_DirectionProperty_idl__ +#define __com_sun_star_i18n_DirectionProperty_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Direction properties returned by + <member>XCahracterClassification::getCharacterDirection()</member>. + */ + +enum DirectionProperty +{ + LEFT_TO_RIGHT = 0, + RIGHT_TO_LEFT = 1, + EUROPEAN_NUMBER = 2, + EUROPEAN_NUMBER_SEPARATOR = 3, + EUROPEAN_NUMBER_TERMINATOR = 4, + ARABIC_NUMBER = 5, + COMMON_NUMBER_SEPARATOR = 6, + BLOCK_SEPARATOR = 7, + SEGMENT_SEPARATOR = 8, + WHITE_SPACE_NEUTRAL = 9, + OTHER_NEUTRAL = 10, + LEFT_TO_RIGHT_EMBEDDING = 11, + LEFT_TO_RIGHT_OVERRIDE = 12, + RIGHT_TO_LEFT_ARABIC = 13, + RIGHT_TO_LEFT_EMBEDDING = 14, + RIGHT_TO_LEFT_OVERRIDE = 15, + POP_DIRECTIONAL_FORMAT = 16, + DIR_NON_SPACING_MARK = 17, + BOUNDARY_NEUTRAL = 18 +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/ForbiddenCharacters.idl b/offapi/com/sun/star/i18n/ForbiddenCharacters.idl new file mode 100644 index 000000000000..08b5e01951d2 --- /dev/null +++ b/offapi/com/sun/star/i18n/ForbiddenCharacters.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * $RCSfile: ForbiddenCharacters.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05: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_i18n_ForbiddenCharacters_idl__ +#define __com_sun_star_i18n_ForbiddenCharacters_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Locale (mostly CJK) dependent characters that are forbidden at the + start or end of a line. + + <p> Returned by + <member>XLocaleData::getForbiddenCharacters()</member> and used with + <type>XForbiddenCharacters</type> methods. + */ + +struct ForbiddenCharacters +{ + /// Characters forbidden at the start of a line + string beginLine; + + /// Characters forbidden at the end of a line. + string endLine; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/FormatElement.idl b/offapi/com/sun/star/i18n/FormatElement.idl new file mode 100644 index 000000000000..a8902ac21aff --- /dev/null +++ b/offapi/com/sun/star/i18n/FormatElement.idl @@ -0,0 +1,111 @@ +/************************************************************************* + * + * $RCSfile: FormatElement.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05: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_i18n_FormatElement_idl__ +#define __com_sun_star_i18n_FormatElement_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + One number format code and its attributes, returned in a sequence by + <member>XLocaleData::getAllFormats()</member>. + + <p> Contains raw data defined in the XML locale data files. </p> + + @see XLocaleData + for links to DTD of XML locale data files. + */ + +struct FormatElement +{ + /** The format code, for example, "YYYY-MM-DD". */ + string formatCode; + + /** A name or description that is displayed in the number formatter + dialog. */ + string formatName; + + /** A unique (within one locale) identifier. */ + string formatKey; + + /** Type may be one of "short", "medium", "long". */ + string formatType; + + /** Usage category, for example, "DATE" or "FIXED_NUMBER", + corresponding with <type>KNumberFormatUsage</type> values. */ + string formatUsage; + + /** The index used by the number formatter, predefined values + corresponding with <type>NumberFormatIndex</type> values. */ + short formatIndex; + + /** If a format code is the default code of a <em>formatType</em> + group. */ + boolean isDefault; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/Implementation.idl b/offapi/com/sun/star/i18n/Implementation.idl new file mode 100644 index 000000000000..8f954f95c2ef --- /dev/null +++ b/offapi/com/sun/star/i18n/Implementation.idl @@ -0,0 +1,89 @@ +/************************************************************************* + * + * $RCSfile: Implementation.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05: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_i18n_Implementation_idl__ +#define __com_sun_star_i18n_Implementation_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Implementation name details returned in a sequence by + <member>XLocaleData::getCollatorImplementations()</member>. + + @see XLocaleData + for links to DTD of XML locale data files. + */ + +struct Implementation +{ + /// The implementation name. + string unoID; + /// If this is the default implementation. + boolean isDefault; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/IndexEntrySupplier.idl b/offapi/com/sun/star/i18n/IndexEntrySupplier.idl index 981489a6dc02..0fbb60571739 100644 --- a/offapi/com/sun/star/i18n/IndexEntrySupplier.idl +++ b/offapi/com/sun/star/i18n/IndexEntrySupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexEntrySupplier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: bustamam $ $Date: 2001-10-12 21:22:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,9 +75,10 @@ module com { module sun { module star { module i18n { service IndexEntrySupplier { interface com::sun::star::i18n::XIndexEntrySupplier; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; //============================================================================= }; }; }; }; +//============================================================================= #endif diff --git a/offapi/com/sun/star/i18n/KCharacterType.idl b/offapi/com/sun/star/i18n/KCharacterType.idl new file mode 100644 index 000000000000..032494619bf2 --- /dev/null +++ b/offapi/com/sun/star/i18n/KCharacterType.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: KCharacterType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:42 $ + * + * 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_i18n_KCharacterType_idl__ +#define __com_sun_star_i18n_KCharacterType_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Constants to identify the character type. + + <p> Returned by + <member>XCharacterClassification::getCharacterType()</member> and + <member>XCharacterClassification::getStringType()</member> </p> + */ + +constants KCharacterType +{ + /// digit + const long DIGIT = 0x00000001; + + /// upper case alpha letter + const long UPPER = 0x00000002; + + /// lower case alpha letter + const long LOWER = 0x00000004; + + /// title case alpha letter + const long TITLE_CASE = 0x00000008; + + /// any alpha, ALPHA = UPPER | LOWER | TITLE_CASE + const long ALPHA = 0x0000000E; + + /// control character + const long CONTROL = 0x00000010; + + /// printable character + const long PRINTABLE = 0x00000020; + + /// base form + const long BASE_FORM = 0x00000040; + + /** any <type>UnicodeType</type>::..._LETTER. + Note that a LETTER must not necessarily be ALPHA */ + const long LETTER = 0x00000080; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/KNumberFormatType.idl b/offapi/com/sun/star/i18n/KNumberFormatType.idl new file mode 100644 index 000000000000..694d942111b8 --- /dev/null +++ b/offapi/com/sun/star/i18n/KNumberFormatType.idl @@ -0,0 +1,88 @@ +/************************************************************************* + * + * $RCSfile: KNumberFormatType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:42 $ + * + * 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_i18n_KNumberFormatType_idl__ +#define __com_sun_star_i18n_KNumberFormatType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Attribute of number format, classifies the length of the formatted + display string. + */ + +constants KNumberFormatType +{ + /// Short display string + const short SHORT = 1; + /// Medium length display string + const short MEDIUM = 2; + /// Long display string + const short LONG = 3; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/KNumberFormatUsage.idl b/offapi/com/sun/star/i18n/KNumberFormatUsage.idl new file mode 100644 index 000000000000..debf621d3d87 --- /dev/null +++ b/offapi/com/sun/star/i18n/KNumberFormatUsage.idl @@ -0,0 +1,97 @@ +/************************************************************************* + * + * $RCSfile: KNumberFormatUsage.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:42 $ + * + * 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_i18n_KNumberFormatUsage_idl__ +#define __com_sun_star_i18n_KNumberFormatUsage_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Category of number format code. + */ + +constants KNumberFormatUsage +{ + /// Date format, for example, "YYYY-MM-DD". + const short DATE = 1; + /// Time format, for example, "HH:MM:SS". + const short TIME = 2; + /// Mixed date/time format, for example, "YYYY-MM-DD HH:MM:SS". + const short DATE_TIME = 3; + /// Numeric format, for example, "#,##0.00". + const short FIXED_NUMBER = 4; + /// Fractional format, for example, "# ??/??". + const short FRACTION_NUMBER = 5; + /// Percent format, for example, "0.00%". + const short PERCENT_NUMBER = 6; + /// Scientific format, for example, "0.00E+00". + const short SCIENTIFIC_NUMBER = 7; + /// Currency format, for example, "#,##0.00 [$EUR]" + const short CURRENCY = 8; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/KParseTokens.idl b/offapi/com/sun/star/i18n/KParseTokens.idl new file mode 100644 index 000000000000..02c72c78d2e9 --- /dev/null +++ b/offapi/com/sun/star/i18n/KParseTokens.idl @@ -0,0 +1,212 @@ +/************************************************************************* + * + * $RCSfile: KParseTokens.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:43 $ + * + * 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_i18n_KParseTokens_idl__ +#define __com_sun_star_i18n_KParseTokens_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + These constants specify the characters a name or identifier token to + be parsed can have. + + <p> They are passed to + <member>XCharacterClassification::parseAnyToken()</member> and + <member>XCharacterClassification::parsePredefinedToken()</member>. + They are also set in the <member>ParseResult::StartFlags</member> + and <member>ParseResult::ContFlags</member>. </p> + */ + +constants KParseTokens +{ + /// ASCII A-Z upper alpha + const long ASC_UPALPHA = 0x00000001; + + /// ASCII a-z lower alpha + const long ASC_LOALPHA = 0x00000002; + + /// ASCII 0-9 digit + const long ASC_DIGIT = 0x00000004; + + /// ASCII '_' underscore + const long ASC_UNDERSCORE = 0x00000008; + + /// ASCII '$' dollar + const long ASC_DOLLAR = 0x00000010; + + /// ASCII '.' dot/point + const long ASC_DOT = 0x00000020; + + /// ASCII ':' colon + const long ASC_COLON = 0x00000040; + + /// Special value to allow control characters (0x00 < char < 0x20) + const long ASC_CONTROL = 0x00000200; + + /** Special value to allow anything below 128 except control + characters. <strong>Not</strong> set in + <type>ParseResult</type>. */ + const long ASC_ANY_BUT_CONTROL = 0x00000400; + + /** Additional flag set in <member>ParseResult::StartFlags</member> + or <member>ParseResult::ContFlags</member>. Set if none of the + above ASC_... (except ASC_ANY_...) single values match an ASCII + character parsed. */ + const long ASC_OTHER = 0x00000800; + + /// Unicode (above 127) upper case letter + const long UNI_UPALPHA = 0x00001000; + + /// Unicode (above 127) lower case letter + const long UNI_LOALPHA = 0x00002000; + + /// Unicode (above 127) decimal digit number + const long UNI_DIGIT = 0x00004000; + + /// Unicode (above 127) title case letter + const long UNI_TITLE_ALPHA = 0x00008000; + + /// Unicode (above 127) modifier letter + const long UNI_MODIFIER_LETTER = 0x00010000; + + /// Unicode (above 127) other letter + const long UNI_OTHER_LETTER = 0x00020000; + + /// Unicode (above 127) letter number + const long UNI_LETTER_NUMBER = 0x00040000; + + /// Unicode (above 127) other number + const long UNI_OTHER_NUMBER = 0x00080000; + + /** If this bit is set in <em>nContCharFlags</em> parameters and a + string enclosed in double quotes is parsed and two consecutive + double quotes are encountered, the string is ended. If this bit + is not set, the two double quotes are parsed as one escaped + double quote and string parsing continues. The bit is ignored in + <em>nStartCharFlags</em> parameters. + + <p> Example: <br/> + "abc""def" --> bit not set => abc"def <br/> + "abc""def" --> bit set => abc </p> + */ + const long TWO_DOUBLE_QUOTES_BREAK_STRING = 0x10000000; + + /** Additional flag set in <member>ParseResult::StartFlags</member> + or <member>ParseResult::ContFlags</member>. Set if none of the + above UNI_... single values match a Unicode character parsed. */ + const long UNI_OTHER = 0x20000000; + + /** Only valid for <em>nStartCharFlags</em> parameter to + <member>ChararacterClassification::parseAnyToken()</member> and + <member>ChararacterClassification::parsePredefinedToken()</member>, + ignored on <em>nContCharFlags</em> parameter. + <strong>Not</strong> set in <type>ParseResult</type>. */ + const long IGNORE_LEADING_WS = 0x40000000; + + + // useful combinations + + /// ASCII a-zA-Z lower or upper alpha + const long ASC_ALPHA = ASC_UPALPHA | ASC_LOALPHA; + + /// ASCII a-zA-Z0-9 alphanumeric + const long ASC_ALNUM = ASC_ALPHA | ASC_DIGIT; + + /// Unicode (above 127) lower or upper or title case alpha + const long UNI_ALPHA = UNI_UPALPHA | UNI_LOALPHA | UNI_TITLE_ALPHA; + + /// Unicode (above 127) alphanumeric + const long UNI_ALNUM = UNI_ALPHA | UNI_DIGIT; + + /// Unicode (above 127) alpha or letter + const long UNI_LETTER = UNI_ALPHA | UNI_MODIFIER_LETTER | + UNI_OTHER_LETTER; + + /// Unicode (above 127) number + const long UNI_NUMBER = UNI_DIGIT | UNI_LETTER_NUMBER | + UNI_OTHER_NUMBER; + + /// any (ASCII or Unicode) alpha + const long ANY_ALPHA = ASC_ALPHA | UNI_ALPHA; + + /// any (ASCII or Unicode) digit + const long ANY_DIGIT = ASC_DIGIT | UNI_DIGIT; + + /// any (ASCII or Unicode) alphanumeric + const long ANY_ALNUM = ASC_ALNUM | UNI_ALNUM; + + /// any (ASCII or Unicode) letter + const long ANY_LETTER = ASC_ALPHA | UNI_LETTER; + + /// any (ASCII or Unicode) number + const long ANY_NUMBER = ASC_DIGIT | UNI_NUMBER; + + /// any (ASCII or Unicode) letter or number + const long ANY_LETTER_OR_NUMBER = ANY_LETTER | ANY_NUMBER; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/KParseType.idl b/offapi/com/sun/star/i18n/KParseType.idl new file mode 100644 index 000000000000..88600e304c94 --- /dev/null +++ b/offapi/com/sun/star/i18n/KParseType.idl @@ -0,0 +1,126 @@ +/************************************************************************* + * + * $RCSfile: KParseType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:43 $ + * + * 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_i18n_KParseType_idl__ +#define __com_sun_star_i18n_KParseType_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Constants to specify the type of a parsed token. + + <p> Set by + <member>XCharacterClassification::parseAnyToken()</member> and + <member>XCharacterClassification::parsePredefinedToken()</member> in + <member>ParseResult::TokenType</member>. </p> + */ + +constants KParseType +{ + /// One single character like ! # ; : $ et al. + const long ONE_SINGLE_CHAR = 0x00000001; + + // For human .idl readers: <, >, <>, =, <=, >= + /// A Boolean operator like <, >, <>, =, <=, >= + const long BOOLEAN = 0x00000002; + + /// A name matching the conditions passed. + const long IDENTNAME = 0x00000004; + + + // Hint for human .idl readers: do not get confused about the double + // quotation marks, they are needed for the unoidl compiler which otherwise + // gets confused about the single quotation marks. + /** "A single-quoted name matching the conditions passed ( 'na\'me' )." + "Dequoted name in <member>ParseResult::DequotedNameOrString</member> ( na'me )." */ + const long SINGLE_QUOTE_NAME = 0x00000008; + + /** A double-quoted string ( "str\"i""ng" ). Dequoted string in + <member>ParseResult::DequotedNameOrString</member> ( str"i"ng ). */ + const long DOUBLE_QUOTE_STRING = 0x00000010; + + /** A number where all digits are ASCII characters. + Numerical value in <member>ParseResult::Value</member>. */ + const long ASC_NUMBER = 0x00000020; + + /** A number where at least some digits are Unicode (and maybe + ASCII) characters. Numerical value inKParseType + <member>ParseResult::Value</member>. */ + const long UNI_NUMBER = 0x00000040; + + /** Set (ored) if SINGLE_QUOTE_NAME or DOUBLE_QUOTE_STRING has no + closing quote. */ + const long MISSING_QUOTE = 0x40000000; + + + // useful combinations + + /// Any ASCII or Unicode number + const long ANY_NUMBER = ASC_NUMBER | UNI_NUMBER; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/LanguageCountryInfo.idl b/offapi/com/sun/star/i18n/LanguageCountryInfo.idl index 5eb7e696b0ec..69530448c97a 100644 --- a/offapi/com/sun/star/i18n/LanguageCountryInfo.idl +++ b/offapi/com/sun/star/i18n/LanguageCountryInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: LanguageCountryInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-05-21 21:03:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,32 +62,36 @@ #ifndef __com_sun_star_i18n_LanguageCountryInfo_idl__ #define __com_sun_star_i18n_LanguageCountryInfo_idl__ -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= - +//============================================================================ /** - The language and country identifiers and descriptive names of the loaded - locale data. + The language and country identifiers and descriptive names of the + loaded locale data returned by + <member>XLocaleData::getLanguageCountryInfo()</member>. - <p> Returned by <member>XLocaleData::getLanguageCountryInfo()</member>. + @see XLocaleData + for links to DTD of XML locale data files. */ -struct LanguageCountryInfo { + +struct LanguageCountryInfo +{ + /// ISO-639 language code, for example, "en" or "de" string Language; + /// Descriptive language name, for example, "English" or "German" string LanguageDefaultName; + /// ISO-3166 country code, for example, "US" or "DE" string Country; + /// Descriptive country name, for example, "United States" or "Germany" string CountryDefaultName; + /// A variant name string Variant; }; - -//============================================================================= - +//============================================================================ }; }; }; }; - -//============================================================================= - +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl b/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl new file mode 100644 index 000000000000..9725b50c388f --- /dev/null +++ b/offapi/com/sun/star/i18n/LineBreakHyphenationOptions.idl @@ -0,0 +1,93 @@ +/************************************************************************* + * + * $RCSfile: LineBreakHyphenationOptions.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_LineBreakHyphenationOptions_idl__ +#define __com_sun_star_i18n_LineBreakHyphenationOptions_idl__ + +#ifndef __com_sun_star_linguistic2_XHyphenator_idl__ +#include <com/sun/star/linguistic2/XHyphenator.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Hyphenation options passed in calls to <member>XBreakIterator::getLineBreak()</member>. + */ +struct LineBreakHyphenationOptions +{ + /// Reference to the specific hyphenator - can be zero. + ::com::sun::star::linguistic2::XHyphenator rHyphenator; + + /** Sequence of property values to be used by the hyphenator - can be + empty if the default values (from the property set) should be used. */ + ::com::sun::star::beans::PropertyValues aHyphenationOptions; + + /** The first character not fitting to the current line, + considering an additional "-" for hyphenation */ + long hyphenIndex; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/LineBreakResults.idl b/offapi/com/sun/star/i18n/LineBreakResults.idl new file mode 100644 index 000000000000..21adf9226d5f --- /dev/null +++ b/offapi/com/sun/star/i18n/LineBreakResults.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * $RCSfile: LineBreakResults.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_LineBreakResults_idl__ +#define __com_sun_star_i18n_LineBreakResults_idl__ + +#ifndef __com_sun_star_linguistic2_XHyphenatedWord_idl__ +#include <com/sun/star/linguistic2/XHyphenatedWord.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Results of method <member>XBreakIterator::getLineBreak()</member>. + */ +struct LineBreakResults +{ + /// Type of line break, see <type>BreakType</type>. + short breakType; + + /// Position of the calculated line break. + long breakIndex; + + /// Return value of the hyphenator. + ::com::sun::star::linguistic2::XHyphenatedWord rHyphenatedWord; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/LineBreakUserOptions.idl b/offapi/com/sun/star/i18n/LineBreakUserOptions.idl new file mode 100644 index 000000000000..1209a4816569 --- /dev/null +++ b/offapi/com/sun/star/i18n/LineBreakUserOptions.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: LineBreakUserOptions.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:45 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_LineBreakUserOptions_idl__ +#define __com_sun_star_i18n_LineBreakUserOptions_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Line break options passed in calls to <member>XBreakIterator::getLineBreak()</member>. + */ +struct LineBreakUserOptions +{ + /// Characters not allowed at the beginning of a line. + string forbiddenBeginCharacters; + + /// Characters not allowed at the end of a line. + string forbiddenEndCharacters; + + /// If the forbidden characters rules are to be applied or not. + boolean applyForbiddenRules; + + /** If punctuation characters are allowed at the end of the line if + outside of the margins, resulting in a line not being wrapped if only + the punctuation would wrap. */ + boolean allowPunctuationOutsideMargin; + + /// Allow English hyphenation. + boolean allowHyphenateEnglish; + +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/LocaleData.idl b/offapi/com/sun/star/i18n/LocaleData.idl index e8cd66c0c3dd..74d2adeaa33b 100644 --- a/offapi/com/sun/star/i18n/LocaleData.idl +++ b/offapi/com/sun/star/i18n/LocaleData.idl @@ -2,9 +2,9 @@ * * $RCSfile: LocaleData.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: bustamam $ $Date: 2001-10-12 21:22:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,19 +65,20 @@ #include <com/sun/star/lang/XServiceInfo.idl> #include <com/sun/star/i18n/XLocaleData.idl> -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= +//============================================================================ -/// Access locale data +/// Access locale specific data. service LocaleData { interface com::sun::star::i18n::XLocaleData; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; -//============================================================================= +//============================================================================ }; }; }; }; +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/LocaleDataItem.idl b/offapi/com/sun/star/i18n/LocaleDataItem.idl new file mode 100644 index 000000000000..72b6542518c8 --- /dev/null +++ b/offapi/com/sun/star/i18n/LocaleDataItem.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: LocaleDataItem.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:45 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_LocaleDataItem_idl__ +#define __com_sun_star_i18n_LocaleDataItem_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Locale specific data, for example, separators, quotation marks. + + @see XLocaleData + for links to DTD of XML locale data files. + */ + +struct LocaleDataItem +{ + /// internal ID string, not unique, not meaningful to the outer world + string unoID; + /// date separator, for example, <b>"/"</b> or <b>"."</b> or <b>"-"</b> + string dateSeparator; + /// group and thousand separator, for example, <b>","</b> or <b>"."</b> + string thousandSeparator; + /// decimal separator, for example, <b>"."</b> or <b>","</b> + string decimalSeparator; + /// time separator, for example, <b>":"</b> + string timeSeparator; + /// time 100th seconds separator, for example, <b>","</b> + string time100SecSeparator; + /// list separator, for example, <b>";"</b> + string listSeparator; + /// single quotation mark start + string quotationStart; + /// single quotation mark end + string quotationEnd; + /// double quotation mark start + string doubleQuotationStart; + /// double quotation mark end + string doubleQuotationEnd; + /// measurement system, <b>"metric"</b> or <b>"us"</b> + string timeAM; + /// time AM symbol, for example, <b>"AM"</b> or <b>"am"</b> + string timePM; + /// time PM symbol, for example, <b>"PM"</b> or <b>"pm"</b> + string measurementSystem; + /// long date day of week separator, for example, <b>", "</b> + string LongDateDayOfWeekSeparator; + /// long date day separator, for example, <b>", "</b> + string LongDateDaySeparator; + /// long date month separator, for example, <b>" "</b> + string LongDateMonthSeparator; + /// long date year separator, for example, <b>" "</b> + string LongDateYearSeparator; +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/i18n/LocaleItem.idl b/offapi/com/sun/star/i18n/LocaleItem.idl index dd48fa16d7d6..dfa9d125e4f5 100644 --- a/offapi/com/sun/star/i18n/LocaleItem.idl +++ b/offapi/com/sun/star/i18n/LocaleItem.idl @@ -2,9 +2,9 @@ * * $RCSfile: LocaleItem.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,49 +69,59 @@ module com { module sun { module star { module i18n { //============================================================================= /** + @deprecated internal Constant values identifying specific locale data items. + + <p> These are not used with the API but with an OOo internal wrapper class + that caches the contents of an instance of <type>LocaleDataItem</type> and + uses these values to access it's members for faster access. </p> + + <p> Whenever locale data items were added these values and the wrapper + class would have to be adjusted to give the application an easier access. + </p> */ + constants LocaleItem { - /// date separator, <b> / </b> + /// @see ::com::sun::star::i18n::LocaleDataItem::dateSeparator const short DATE_SEPARATOR = 0; - /// group and thousand separator, <b>","</b>. + /// @see com::sun::star::i18n::LocaleDataItem::thousandSeparator const short THOUSAND_SEPARATOR = 1; - /// decimal separator, <b>"."</b> . + /// @see com::sun::star::i18n::LocaleDataItem::decimalSeparator const short DECIMAL_SEPARATOR = 2; - /// time separator, <b>":"</b> . + /// @see com::sun::star::i18n::LocaleDataItem::timeSeparator const short TIME_SEPARATOR = 3; - /// time 100th seconds separator, <b>","</b> . + /// @see com::sun::star::i18n::LocaleDataItem::time100SecSeparator const short TIME_100SEC_SEPARATOR = 4; - /// list separator, <b>";"</b> . + /// @see com::sun::star::i18n::LocaleDataItem::listSeparator const short LIST_SEPARATOR = 5; - /// single quotation mark start. + /// @see com::sun::star::i18n::LocaleDataItem::quotationStart const short SINGLE_QUOTATION_START = 6; - /// single quotation mark end. + /// @see com::sun::star::i18n::LocaleDataItem::quotationEnd const short SINGLE_QUOTATION_END = 7; - /// double quotation mark start. + /// @see com::sun::star::i18n::LocaleDataItem::doubleQuotationStart const short DOUBLE_QUOTATION_START = 8; - /// double quotation mark end. + /// @see com::sun::star::i18n::LocaleDataItem::doubleQuotationEnd const short DOUBLE_QUOTATION_END = 9; - /// measurement system, for example, <b>"metric"</b> or <b>"us"</b>. + /// @see com::sun::star::i18n::LocaleDataItem::timeAM const short MEASUREMENT_SYSTEM = 10; - /// time AM symbol, for example, <b>"AM"</b> or <b>"am"</b>. + /// @see com::sun::star::i18n::LocaleDataItem::timePM const short TIME_AM = 11; - /// time PM symbol, for example, <b>"PM"</b> or <b>"pm"</b>. + /// @see com::sun::star::i18n::LocaleDataItem::measurementSystem const short TIME_PM = 12; - /// long date day of week separator, <b>", "</b> + /// @see com::sun::star::i18n::LocaleDataItem::LongDateDayOfWeekSeparator const short LONG_DATE_DAY_OF_WEEK_SEPARATOR = 13; - /// long date day separator, <b>", "</b> + /// @see com::sun::star::i18n::LocaleDataItem::LongDateDaySeparator const short LONG_DATE_DAY_SEPARATOR = 14; - /// long date month separator, <b>" "</b> + /// @see com::sun::star::i18n::LocaleDataItem::LongDateMonthSeparator const short LONG_DATE_MONTH_SEPARATOR = 15; - /// long date year separator, <b>" "</b> + /// @see com::sun::star::i18n::LocaleDataItem::LongDateYearSeparator const short LONG_DATE_YEAR_SEPARATOR = 16; //! New values may be inserted here if locale data provides them. //! Do not forget to adjust the COUNT value. - /// count of items available. + /// count of items available const short COUNT = 17; }; diff --git a/offapi/com/sun/star/i18n/Months.idl b/offapi/com/sun/star/i18n/Months.idl index 9e4ad111cd27..4e3d8b3a00cd 100644 --- a/offapi/com/sun/star/i18n/Months.idl +++ b/offapi/com/sun/star/i18n/Months.idl @@ -2,9 +2,9 @@ * * $RCSfile: Months.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-05-21 21:52:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,20 +68,35 @@ module com { module sun { module star { module i18n { //============================================================================= -/// constants for months. +/** + Constants for month names used in calls to <member>XCalendar::getDisplayName()</member>. + */ + constants Months { + /// January const short JANUARY = 0; + /// February const short FEBURARY = 1; + /// March const short MARCH = 2; + /// April const short APRIL = 3; + /// May const short MAY = 4; + /// June const short JUNE = 5; + /// July const short JULY = 6; + /// August const short AUGUST = 7; + /// September const short SEPTEMBER = 8; + /// October const short OCTOBER = 9; + /// November const short NOVEMBER = 10; + /// December const short DECEMBER = 11; }; diff --git a/offapi/com/sun/star/i18n/NumberFormatCode.idl b/offapi/com/sun/star/i18n/NumberFormatCode.idl new file mode 100644 index 000000000000..4e36a1785cba --- /dev/null +++ b/offapi/com/sun/star/i18n/NumberFormatCode.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: NumberFormatCode.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:46 $ + * + * 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_i18n_NumberFormatCode_idl__ +#define __com_sun_star_i18n_NumberFormatCode_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Number format code information returned by various + <type>XNumberFormatCode</type> methods. + */ + +struct NumberFormatCode +{ + /// One of <type>KNumberFormatType</type> values. + short Type; + /// One of <type>KNumberFormatUsage</type> values. + short Usage; + /// Format code, for example, "YYYY-MM-DD". + string Code; + /// Descriptive name of the format for this locale. + string DefaultName; + /// Message identifier to be used if the name of the format is localized. + string NameID; + /// Index of the code as defined in <type>NumberFormatIndex</type>. + short Index; + /// If this format is the default format of the <em>Usage</em> group. + boolean Default; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/NumberFormatIndex.idl b/offapi/com/sun/star/i18n/NumberFormatIndex.idl index 982a7a70fe36..bbc607b2c432 100644 --- a/offapi/com/sun/star/i18n/NumberFormatIndex.idl +++ b/offapi/com/sun/star/i18n/NumberFormatIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormatIndex.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-10-31 15:28:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,29 +73,69 @@ module com { module sun { module star { module i18n { //! Number formatter internals must match these values! /** - Number format indexes to be passed as the index argument to - -<member>XNumberFormatCode::getFormatCode()</member> or - -<member scope="com::sun::star::util">XNumberFormatTypes::getFormatIndex()</member>. - - <p> Format codes supported by each locale can be of any number. But for - backward compatiblity reasons, each locale must support some predefined - format codes. These predefined format codes are accessed through indexes - as the following. The values are also used to define the - <code>enum NfIndexTableOffset</code> in file svtools/inc/zforlist.hxx </p> - - <!-- Dennis: What is meant by "Format codes can be of any number"? --> - <!-- Dennis: What is "through indexes are the following" referring to? --> - - <p> Note: This index has <bold>nothing</bold> to do with the index key - used internally by the number formatter. </p> -*/ + Number format indices to be passed as the index argument to + <member>XNumberFormatCode::getFormatCode()</member> + or + <member scope="::com::sun::star::util">XNumberFormatTypes::getFormatIndex()</member>. + + <p> Each locale can support up to about 5000 arbitrary format + codes. But for backward compatiblity reasons, each locale + <b>MUST</b> support some predefined format codes. These predefined + format codes are accessed through indices as the following, and + the locale data format code definitions in + i18npool/source/localedata/data/*.xml <b>MUST</b> have matching + entries in the form <br/> + + <code><FormatElement formatindex="0"></code> <br/> + + (see also <member>FormatElement::formatIndex</member>). + + The index values are also used to define the <code>enum + NfIndexTableOffset</code> in file svtools/inc/zforlist.hxx </p> + + <p> Note: This index has <b>nothing</b> to do with the index key + used internally by the number formatter. </p> <br/> + + <p> Date formats may have a comment of DIN/EN/ISO, meaning + <ul> + <li> DIN 5008 (Deutsche Industrie Norm) </li> + <li> EN 28601 (European Norm) </li> + <li> ISO 8601 (International Standards Organisation) </li> + </ul> + </p> + + <p> Some names of date format constants indicate a special + behavior of those formats in StarOffice 5.2 or older. Those are: + + <dl> + <dt> <a name="SYSTEM"> DATE_SYSTEM_... </a> </dt> + <dd> On Windows platforms these formats were entirely + retrieved from the system's Regional Settings. OpenOffice.org + / StarOffice 6 don't use those Windows settings anymore in + order to provide the same functionality and document layout on + every platform. Like all other formats these formats are now + defined in the i18n framework locale data files under + i18npool/source/localedata/data/*.xml </dd> + + <dt> <a name="SYS"> DATE_SYS_... </a> </dt> + <dd> On Windows platforms these formats used separators and + YMD order retrieved from the Regional Settings, but appearance + of short/long days/months/years was defined by the + application. </dd> + + <dt> <a name="DEF"> DATE_DEF_... </a> </dt> + <dd> The format code was hard defined, only the date separator + was taken from the Windows Regional Settings, but not the YMD + order. </dd> + + </dl> + </p> + */ constants NumberFormatIndex { - /// Number formats. + /// Start of simple numerical formats (first format) const short NUMBER_START = 0; - /// General + /// The "General" format const short NUMBER_STANDARD = NUMBER_START; /// 0 const short NUMBER_INT = NUMBER_START+1; @@ -105,39 +145,43 @@ constants NumberFormatIndex const short NUMBER_1000INT = NUMBER_START+3; /// #,##0.00 const short NUMBER_1000DEC2 = NUMBER_START+4; - /// #,##0.00 or whatever is the locale default. + /// #,##0.00 <br/> In SO5/Win this format was retrieved from the Regional Settings const short NUMBER_SYSTEM = NUMBER_START+5; + /// End of simple numerical formats (last format) const short NUMBER_END = NUMBER_SYSTEM ; - /// Scientific formats. + /// Start of Scientific formats (first format) const short SCIENTIFIC_START = NUMBER_END+1; /// 0.00E+000 const short SCIENTIFIC_000E000 = SCIENTIFIC_START; /// 0.00E+00 const short SCIENTIFIC_000E00 = SCIENTIFIC_START+1; + /// End of Scientific formats (last format) const short SCIENTIFIC_END = SCIENTIFIC_000E00; - /// Percent formats. + /// Start of Percent formats (first format) const short PERCENT_START = SCIENTIFIC_END+1; /// 0% const short PERCENT_INT = PERCENT_START; /// 0.00% const short PERCENT_DEC2 = PERCENT_START+1; + /// End of Percent formats (last format) const short PERCENT_END = PERCENT_DEC2; - /// Fraction formats. + /// Start of Fraction formats (first format) const short FRACTION_START = PERCENT_END+1; /// # ?/? const short FRACTION_1 = FRACTION_START; /// # ??/?? const short FRACTION_2 = FRACTION_START+1; + /// End of Fraction formats (last format) const short FRACTION_END = FRACTION_2; - /// Currency formats. + /// Start of Currency formats (first format) const short CURRENCY_START = FRACTION_END+1; /// #,##0 DM const short CURRENCY_1000INT = CURRENCY_START; @@ -151,57 +195,61 @@ constants NumberFormatIndex const short CURRENCY_1000DEC2_CCC = CURRENCY_START+4; /// #,##0.-- DM const short CURRENCY_1000DEC2_DASHED = CURRENCY_START+5; + /// End of Currency formats (last format) const short CURRENCY_END = CURRENCY_1000DEC2_DASHED; - /// Date formats + /// Start of Date formats (first format) const short DATE_START = CURRENCY_END+1; - /// 08.10.97 short as default for locale. + /// 08.10.97 <br/> see also DATE_SYSTEM_... <a href="#SYSTEM">explanation</a> const short DATE_SYSTEM_SHORT = DATE_START; - /// Wednesday, 8. October 1997 long as default for locale. + /// Wednesday, 8. October 1997 <br/> see also DATE_SYSTEM_... <a href="#SYSTEM">explanation</a> const short DATE_SYSTEM_LONG = DATE_START+1; - /// 08.10.97 defined + /// 08.10.97 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_DDMMYY = DATE_START+2; - /// 08.10.1997 + /** 08.10.1997 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> + <br/><b>Note:</b> When editing already existing date data this + format is forced in order to always edit the full century. */ const short DATE_SYS_DDMMYYYY = DATE_START+3; - /// 8. Oct 97 + /// 8. Oct 97 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_DMMMYY = DATE_START+4; - /// 8. Oct 1997 + /// 8. Oct 1997 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_DMMMYYYY = DATE_START+5; - /// 8. Oct. 1997 DIN (Deutsche Industrie Norm) and EN (European Norm) + /// 8. Oct. 1997 <br/> DIN/EN const short DATE_DIN_DMMMYYYY = DATE_START+6; - /// 8. October 1997 + /// 8. October 1997 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_DMMMMYYYY = DATE_START+7; - /// 8. October 1997 DIN/EN + /// 8. October 1997 <br/> DIN/EN const short DATE_DIN_DMMMMYYYY = DATE_START+8; - /// Wed, 8. Oct 97 + /// Wed, 8. Oct 97 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_NNDMMMYY = DATE_START+9; - /// Wed 08.Oct 97 + /// Wed 08.Oct 97 <br/> see also DATE_DEF_... <a href="#DEF">explanation</a> const short DATE_DEF_NNDDMMMYY = DATE_START+10; - /// Wed, 8. October 1997 + /// Wed, 8. October 1997 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_NNDMMMMYYYY = DATE_START+11; /// Wednesday, 8. October 1997 const short DATE_SYS_NNNNDMMMMYYYY = DATE_START+12; - /// 10-08 DIN/EN + /// 10-08 <br/> DIN/EN const short DATE_DIN_MMDD = DATE_START+13; - /// 97-10-08 DIN/EN + /// 97-10-08 <br/> DIN/EN/ISO const short DATE_DIN_YYMMDD = DATE_START+14; - /// 1997-10-08 DIN/EN + /// 1997-10-08 <br/> DIN/EN/ISO const short DATE_DIN_YYYYMMDD = DATE_START+15; - /// 10.97 + /// 10.97 <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_MMYY = DATE_START+16; - /// 08.Oct + /// 08.Oct <br/> see also DATE_SYS_... <a href="#SYS">explanation</a> const short DATE_SYS_DDMMM = DATE_START+17; /// October const short DATE_MMMM = DATE_START+18; - /// 4. Quarer 97 + /// 4th quarter 97 const short DATE_QQJJ = DATE_START+19; /// week of year const short DATE_WW = DATE_START+20; + /// End of Date formats (last format) const short DATE_END = DATE_WW; - /// Time formats + /// Start of Time formats (first format) const short TIME_START = DATE_END+1; /// HH:MM const short TIME_HHMM = TIME_START; @@ -217,15 +265,19 @@ constants NumberFormatIndex const short TIME_MMSS00 = TIME_START+5; /// [HH]:MM:SS,00 const short TIME_HH_MMSS00 = TIME_START+6; + /// End of Time formats (last format) const short TIME_END = TIME_HH_MMSS00; - /// DateTime formats + /// Start of DateTime formats (first format) const short DATETIME_START = TIME_END + 1; /// 08.10.97 01:23 const short DATETIME_SYSTEM_SHORT_HHMM = DATETIME_START; - /// 08.10.1997 01:23:45 + /** 08.10.1997 01:23:45 + <br/><b>Note:</b> When editing already existing date/time data this + format is forced in order to always edit the full century. */ const short DATETIME_SYS_DDMMYYYY_HHMMSS= DATETIME_START+1; + /// End of DateTime formats (last format) const short DATETIME_END = DATETIME_SYS_DDMMYYYY_HHMMSS; diff --git a/offapi/com/sun/star/i18n/NumberFormatMapper.idl b/offapi/com/sun/star/i18n/NumberFormatMapper.idl index 28e3481a48ae..f3f89be97cba 100644 --- a/offapi/com/sun/star/i18n/NumberFormatMapper.idl +++ b/offapi/com/sun/star/i18n/NumberFormatMapper.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormatMapper.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: bustamam $ $Date: 2001-04-30 19:54:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,14 @@ module com { module sun { module star { module i18n { //============================================================================= -/// Map locale data number format codes to index values used by the number formatter +/** Access locale data number format codes to use with the + number formatter +*/ + service NumberFormatMapper { interface com::sun::star::i18n::XNumberFormatCode; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; //============================================================================= diff --git a/offapi/com/sun/star/i18n/ParseResult.idl b/offapi/com/sun/star/i18n/ParseResult.idl new file mode 100644 index 000000000000..74f529d027a1 --- /dev/null +++ b/offapi/com/sun/star/i18n/ParseResult.idl @@ -0,0 +1,117 @@ +/************************************************************************* + * + * $RCSfile: ParseResult.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:47 $ + * + * 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_i18n_ParseResult_idl__ +#define __com_sun_star_i18n_ParseResult_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Parser results returned by + <member>XCharacterClassification::parseAnyToken()</member> and + <member>XCharacterClassification::parsePredefinedToken()</member>. + */ + +struct ParseResult +{ + /** Count of ignored leading whitespace, in code points, not + characters. */ + long LeadingWhiteSpace; + + /** Code point index of first unprocessed character. */ + long EndPos; + + /** Number of characters (not code points) of the parsed token, not + including leading whitespace. */ + long CharLen; + + /** Value of token in case of numeric. */ + double Value; + + /** <type>KParseType</type> token type like + <const>KParseType::IDENTNAME</const>. */ + long TokenType; + + /** <type>KParseTokens</type> flags of first character of actual + token matched. If <em>TokenType</em> is a + <const>KParseType::SINGLE_QUOTE_NAME</const> or a + <const>KParseType::DOUBLE_QUOTE_STRING</const> the first + character is the first character inside the quotes, not the + quote itself. */ + long StartFlags; + + /** <type>KParseTokens</type> flags of remaining characters of + actual token matched. */ + long ContFlags; + + /** If a quoted name or string is encountered the dequoted result + goes here. */ + string DequotedNameOrString; + +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/ScriptType.idl b/offapi/com/sun/star/i18n/ScriptType.idl new file mode 100644 index 000000000000..d6d375958e2d --- /dev/null +++ b/offapi/com/sun/star/i18n/ScriptType.idl @@ -0,0 +1,95 @@ +/************************************************************************* + * + * $RCSfile: ScriptType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:47 $ + * + * 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_i18n_ScriptType_idl__ +#define __com_sun_star_i18n_ScriptType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Constants to specify the script type. + + <p> Used with <member>XBreakIterator::beginOfScript()</member>, + <member>XBreakIterator::endOfScript()</member>, + <member>XBreakIterator::nextScript()</member>, + <member>XBreakIterator::previousScript()</member> </p> + */ +constants ScriptType +{ + /// Latin characters (English, ...) + const short LATIN = 1; + + /// Asian characters (Japanese, ...) + const short ASIAN = 2; + + /// Complex characters (Arabic, ...) + const short COMPLEX = 3; + + /// undefined characters (punctuation, ...) + const short WEAK = 4; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/Transliteration.idl b/offapi/com/sun/star/i18n/Transliteration.idl index b629012f52c4..34403b36c871 100644 --- a/offapi/com/sun/star/i18n/Transliteration.idl +++ b/offapi/com/sun/star/i18n/Transliteration.idl @@ -2,9 +2,9 @@ * * $RCSfile: Transliteration.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: bustamam $ $Date: 2001-10-12 21:22:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,9 +75,10 @@ module com { module sun { module star { module i18n { service Transliteration { interface com::sun::star::i18n::XTransliteration; - interface com::sun::star::lang::XServiceInfo; + interface com::sun::star::lang::XServiceInfo; }; //============================================================================= }; }; }; }; +//============================================================================= #endif diff --git a/offapi/com/sun/star/i18n/TransliterationModules.idl b/offapi/com/sun/star/i18n/TransliterationModules.idl new file mode 100644 index 000000000000..c7397b745077 --- /dev/null +++ b/offapi/com/sun/star/i18n/TransliterationModules.idl @@ -0,0 +1,119 @@ +/************************************************************************* + * + * $RCSfile: TransliterationModules.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_TransliterationModules_idl__ +#define __com_sun_star_i18n_TransliterationModules_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Old transliteration module enumeration to use with + <member>XTransliteration::loadModule()</member> + */ + +enum TransliterationModules +{ + UPPERCASE_LOWERCASE = 1, + LOWERCASE_UPPERCASE = 2, + HALFWIDTH_FULLWIDTH = 3, + FULLWIDTH_HALFWIDTH = 4, + KATAKANA_HIRAGANA = 5, + HIRAGANA_KATAKANA = 6, + NumToTextLower_zh_CN = 7, + NumToTextUpper_zh_CN = 8, + NumToTextLower_zh_TW = 9, + NumToTextUpper_zh_TW = 10, + NumToTextFormalHangul_ko = 11, + NumToTextFormalLower_ko = 12, + NumToTextFormalUpper_ko = 13, + NON_IGNORE_MASK = 0x000000ff, + IGNORE_MASK = 0xffffff00, + IGNORE_CASE = 0x00000100, + IGNORE_KANA = 0x00000200, // ja_JP + IGNORE_WIDTH = 0x00000400, // ja_JP + // not used yet = 0x00000800, + ignoreTraditionalKanji_ja_JP = 0x00001000, + ignoreTraditionalKana_ja_JP = 0x00002000, + ignoreMinusSign_ja_JP = 0x00004000, + ignoreIterationMark_ja_JP = 0x00008000, + ignoreSeparator_ja_JP = 0x00010000, + ignoreZiZu_ja_JP = 0x00020000, + ignoreBaFa_ja_JP = 0x00040000, + ignoreTiJi_ja_JP = 0x00080000, + ignoreHyuByu_ja_JP = 0x00100000, + ignoreSeZe_ja_JP = 0x00200000, + ignoreIandEfollowedByYa_ja_JP = 0x00400000, + ignoreKiKuFollowedBySa_ja_JP = 0x00800000, + ignoreSize_ja_JP = 0x01000000, + ignoreProlongedSoundMark_ja_JP = 0x02000000, + ignoreMiddleDot_ja_JP = 0x04000000, + ignoreSpace_ja_JP = 0x08000000, + smallToLarge_ja_JP = 0x10000000, + largeToSmall_ja_JP = 0x20000000, + END_OF_MODULE = 0 +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/TransliterationModulesNew.idl b/offapi/com/sun/star/i18n/TransliterationModulesNew.idl new file mode 100644 index 000000000000..3aaa6897a929 --- /dev/null +++ b/offapi/com/sun/star/i18n/TransliterationModulesNew.idl @@ -0,0 +1,146 @@ +/************************************************************************* + * + * $RCSfile: TransliterationModulesNew.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_TransliterationModulesNew_idl__ +#define __com_sun_star_i18n_TransliterationModulesNew_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** New transliteration module enumeration to use with + <member>XTransliteration::loadModuleNew()</member> + */ + +enum TransliterationModulesNew +{ + UPPERCASE_LOWERCASE = 1, + LOWERCASE_UPPERCASE = 2, + HALFWIDTH_FULLWIDTH = 3, + FULLWIDTH_HALFWIDTH = 4, + KATAKANA_HIRAGANA = 5, + HIRAGANA_KATAKANA = 6, + IGNORE_CASE = 7, + IGNORE_KANA = 8, // ja_JP + IGNORE_WIDTH = 9, // ja_JP + ignoreTraditionalKanji_ja_JP = 10, + ignoreTraditionalKana_ja_JP = 11, + ignoreMinusSign_ja_JP = 12, + ignoreIterationMark_ja_JP = 13, + ignoreSeparator_ja_JP = 14, + ignoreZiZu_ja_JP = 15, + ignoreBaFa_ja_JP = 16, + ignoreTiJi_ja_JP = 17, + ignoreHyuByu_ja_JP = 18, + ignoreSeZe_ja_JP = 19, + ignoreIandEfollowedByYa_ja_JP = 20, + ignoreKiKuFollowedBySa_ja_JP = 21, + ignoreSize_ja_JP = 22, + ignoreProlongedSoundMark_ja_JP = 23, + ignoreMiddleDot_ja_JP = 24, + ignoreSpace_ja_JP = 25, + smallToLarge_ja_JP = 26, + largeToSmall_ja_JP = 27, + NumToTextLower_zh_CN = 28, + NumToTextUpper_zh_CN = 29, + NumToTextLower_zh_TW = 30, + NumToTextUpper_zh_TW = 31, + NumToTextFormalHangul_ko = 32, + NumToTextFormalLower_ko = 33, + NumToTextFormalUpper_ko = 34, + NumToTextInformalHangul_ko = 35, + NumToTextInformalLower_ko = 36, + NumToTextInformalUpper_ko = 37, + NumToCharLower_zh_CN = 38, + NumToCharUpper_zh_CN = 39, + NumToCharLower_zh_TW = 40, + NumToCharUpper_zh_TW = 41, + NumToCharHangul_ko = 42, + NumToCharLower_ko = 43, + NumToCharUpper_ko = 44, + NumToCharFullwidth = 45, + NumToCharKanjiShort_ja_JP = 46, + TextToNumLower_zh_CN = 47, + TextToNumUpper_zh_CN = 48, + TextToNumLower_zh_TW = 49, + TextToNumUpper_zh_TW = 50, + TextToNumFormalHangul_ko = 51, + TextToNumFormalLower_ko = 52, + TextToNumFormalUpper_ko = 53, + TextToNumInformalHangul_ko = 54, + TextToNumInformalLower_ko = 55, + TextToNumInformalUpper_ko = 56, + // 2 Spaces for Japanese TextToNum + CharToNumLower_zh_CN = 59, + CharToNumUpper_zh_CN = 60, + CharToNumLower_zh_TW = 61, + CharToNumUpper_zh_TW = 62, + CharToNumHangul_ko = 63, + CharToNumLower_ko = 64, + CharToNumUpper_ko = 65, + END_OF_MODULE = 0 +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/TransliterationType.idl b/offapi/com/sun/star/i18n/TransliterationType.idl new file mode 100644 index 000000000000..6bc9c14e6166 --- /dev/null +++ b/offapi/com/sun/star/i18n/TransliterationType.idl @@ -0,0 +1,115 @@ +/************************************************************************* + * + * $RCSfile: TransliterationType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_TransliterationType_idl__ +#define __com_sun_star_i18n_TransliterationType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** + Bitmask transliteration types used with + <member>XTransliteration::getType()</member> and + <member>XTransliteration::getAvailableModules()</member> methods. + + <p> Non-IGNORE type modules provide + <member>XTransliteration::transliterate()</member>. <br/> + IGNORE type modules provide + <member>XTransliteration::equals()</member> and + <member>XTransliteration::transliterateRange()</member>. </p> + */ + +constants TransliterationType +{ + const short NONE = 0; + + /** A transliteration module is ONE_TO_ONE if and only if it's + mapping between characters is one to one like a-z to A-Z. + Transliteration modules of this type can be used as choice in + regular expressions based search/replace. */ + const short ONE_TO_ONE = 1; + + /** A transliteration module can have attribute NUMERIC if it + tranliterates numbers in different languages like chinese + numbers to arabic numbers and vice versa. This mapping need not + be one to one, it should be primarily used by number formatting + and parsing methods. */ + const short NUMERIC = 2; + + /** A transliteration module is ONE_TO_ONE_NUMERIC if it offers + both one to one mapping and handles number also. */ + const short ONE_TO_ONE_NUMERIC = 3; + + /** With a transliterator IGNORE case, the regular + expression A-Z can be transformed to a-z, for example. */ + const short IGNORE = 4; + + /** If the transliteration is cascaded (uses more than one + algorithm). */ + const short CASCADE = 8; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/UnicodeScript.idl b/offapi/com/sun/star/i18n/UnicodeScript.idl new file mode 100644 index 000000000000..86f13717773f --- /dev/null +++ b/offapi/com/sun/star/i18n/UnicodeScript.idl @@ -0,0 +1,170 @@ +/************************************************************************* + * + * $RCSfile: UnicodeScript.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:49 $ + * + * 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_i18n_UnicodeScript_idl__ +#define __com_sun_star_i18n_UnicodeScript_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Unicode script types, returned by + <member>XCharacterClassification::getScript()</member> + */ + +enum UnicodeScript +{ + kBasicLatin, + kLatin1Supplement, + kLatinExtendedA, + kLatinExtendedB, + kIPAExtension, + kSpacingModifier, + kCombiningDiacritical, + kGreek, + kCyrillic, + kArmenian, + kHebrew, + kArabic, + kSyriac, + kThaana, + kDevanagari, + kBengali, + kGurmukhi, + kGujarati, + kOriya, + kTamil, + kTelugu, + kKannada, + kMalayalam, + kSinhala, + kThai, + kLao, + kTibetan, + kMyanmar, + kGeorgian, + kHangulJamo, + kEthiopic, + kCherokee, + kUnifiedCanadianAboriginalSyllabics, + kOgham, + kRunic, + kKhmer, + kMongolian, + kLatinExtendedAdditional, + kGreekExtended, + kGeneralPunctuation, + kSuperSubScript, + kCurrencySymbolScript, + kSymbolCombiningMark, + kLetterlikeSymbol, + kNumberForm, + kArrow, + kMathOperator, + kMiscTechnical, + kControlPicture, + kOpticalCharacter, + kEnclosedAlphanumeric, + kBoxDrawing, + kBlockElement, + kGeometricShape, + kMiscSymbol, + kDingbat, + kBraillePatterns, + kCJKRadicalsSupplement, + kKangxiRadicals, + kIdeographicDescriptionCharacters, + kCJKSymbolPunctuation, + kHiragana, + kKatakana, + kBopomofo, + kHangulCompatibilityJamo, + kKanbun, + kBopomofoExtended, + kEnclosedCJKLetterMonth, + kCJKCompatibility, + k_CJKUnifiedIdeographsExtensionA, + kCJKUnifiedIdeograph, + kYiSyllables, + kYiRadicals, + kHangulSyllable, + kHighSurrogate, + kHighPrivateUseSurrogate, + kLowSurrogate, + kPrivateUse, + kCJKCompatibilityIdeograph, + kAlphabeticPresentation, + kArabicPresentationA, + kCombiningHalfMark, + kCJKCompatibilityForm, + kSmallFormVariant, + kArabicPresentationB, + kNoScript, + kHalfwidthFullwidthForm, + kScriptCount +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/UnicodeType.idl b/offapi/com/sun/star/i18n/UnicodeType.idl new file mode 100644 index 000000000000..324d327766c8 --- /dev/null +++ b/offapi/com/sun/star/i18n/UnicodeType.idl @@ -0,0 +1,113 @@ +/************************************************************************* + * + * $RCSfile: UnicodeType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:49 $ + * + * 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_i18n_UnicodeType_idl__ +#define __com_sun_star_i18n_UnicodeType_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Constants to classify Unicode characters, returned by + <member>XCharacterClassification::getType()</member> + */ + +constants UnicodeType +{ + const short UNASSIGNED = 0; + const short UPPERCASE_LETTER = 1; + const short LOWERCASE_LETTER = 2; + const short TITLECASE_LETTER = 3; + const short MODIFIER_LETTER = 4; + const short OTHER_LETTER = 5; + const short NON_SPACING_MARK = 6; + const short ENCLOSING_MARK = 7; + const short COMBINING_SPACING_MARK = 8; + const short DECIMAL_DIGIT_NUMBER = 9; + const short LETTER_NUMBER = 10; + const short OTHER_NUMBER = 11; + const short SPACE_SEPARATOR = 12; + const short LINE_SEPARATOR = 13; + const short PARAGRAPH_SEPARATOR = 14; + const short CONTROL = 15; + const short FORMAT = 16; + const short PRIVATE_USE = 17; + const short SURROGATE = 18; + const short DASH_PUNCTUATION = 19; + const short INITIAL_PUNCTUATION = 20; + const short FINAL_PUNCTUATION = 21; + const short CONNECTOR_PUNCTUATION = 22; + const short OTHER_PUNCTUATION = 23; + const short MATH_SYMBOL = 24; + const short CURRENCY_SYMBOL = 25; + const short MODIFIER_SYMBOL = 26; + const short OTHER_SYMBOL = 27; + const short START_PUNCTUATION = 28; + const short END_PUNCTUATION = 29; + const short GENERAL_TYPES_COUNT = 30; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/i18n/Weekdays.idl b/offapi/com/sun/star/i18n/Weekdays.idl index 0064fcbf4a0c..95d43260f3a4 100644 --- a/offapi/com/sun/star/i18n/Weekdays.idl +++ b/offapi/com/sun/star/i18n/Weekdays.idl @@ -2,9 +2,9 @@ * * $RCSfile: Weekdays.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-05-22 23:31:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,15 +69,27 @@ module com { module sun { module star { module i18n { //============================================================================= -/// constants for days of a week. +/** Constants for days of a week. + + <p> used with <member>XCalendar::getFirstDayOfWeek()</member>, + <member>XCalendar::setFirstDayOfWeek()</member> and + <member>XCalendar::getDisplayName()</member> </p> + */ constants Weekdays { + /// Sunday const short SUNDAY = 0; + /// Monday const short MONDAY = 1; + /// Tuesday const short TUESDAY = 2; + /// Wednesday const short WEDNESDAY = 3; + /// Thursday const short THURSDAY = 4; + /// Friday const short FRIDAY = 5; + /// Saturday const short SATURDAY = 6; }; diff --git a/offapi/com/sun/star/i18n/WordType.idl b/offapi/com/sun/star/i18n/WordType.idl new file mode 100644 index 000000000000..6c20d90fb7f0 --- /dev/null +++ b/offapi/com/sun/star/i18n/WordType.idl @@ -0,0 +1,102 @@ +/************************************************************************* + * + * $RCSfile: WordType.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:50 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_WordType_idl__ +#define __com_sun_star_i18n_WordType_idl__ + +//============================================================================= + +module com { module sun { module star { module i18n { + +//============================================================================= + +/** Constants to specify the type of words. + + <p> Used with <member>XBreakIterator::nextWord()</member>, + <member>XBreakIterator::previousWord()</member>, + <member>XBreakIterator::getWordBoundary()</member>, + <member>XBreakIterator::getWordType()</member>, + <member>XBreakIterator::isBeginWord()</member>, + <member>XBreakIterator::isEndWord()</member> </p> +*/ +constants WordType +{ + /** Any "words" - words in the meaning of same character types, + collection of alphanumeric characters, or collection of + non-alphanumeric characters. + */ + const short ANY_WORD = 0; + + /** Any "words" - words in the meaning of same character types, + collection of alphanumeric characters, or collection of + non-alphanumeric characters except blanks. + */ + const short ANYWORD_IGNOREWHITESPACES= 1; + + /** "words" - in the meaning of a collection of alphanumeric + characters. + */ + const short DICTIONARY_WORD = 2; +}; + +//============================================================================= +}; }; }; }; +//============================================================================= +#endif diff --git a/offapi/com/sun/star/i18n/XCalendar.idl b/offapi/com/sun/star/i18n/XCalendar.idl index c20a49f33bf6..df236c7ba196 100644 --- a/offapi/com/sun/star/i18n/XCalendar.idl +++ b/offapi/com/sun/star/i18n/XCalendar.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCalendar.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,137 +66,197 @@ #include <com/sun/star/i18n/Calendar.idl> #include <com/sun/star/i18n/CalendarItem.idl> -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= - +//============================================================================ /** - This interface provides access to locale specific calendar systems. + Access to locale specific calendar systems. */ + interface XCalendar : com::sun::star::uno::XInterface { - /// load the default calendar for the given locale + //------------------------------------------------------------------------ + /// Load the default calendar for the given locale. void loadDefaultCalendar( [in] ::com::sun::star::lang::Locale rLocale ); - /// load a specific calendar for the given locale - void loadCalendar( [in] string uniqueID, [in] ::com::sun::star::lang::Locale rLocale ); + //------------------------------------------------------------------------ + /// Load a specific calendar for the given locale. + void loadCalendar( [in] string uniqueID, + [in] ::com::sun::star::lang::Locale rLocale ); - /// get the current loaded <type>Calendar</type> + //------------------------------------------------------------------------ + /// Get the currently loaded <type>Calendar</type>. Calendar getLoadedCalendar(); - /// returns all available calendars for the given locale + //------------------------------------------------------------------------ + /// Returns all available calendars for the given locale. sequence< string > getAllCalendars( [in] ::com::sun::star::lang::Locale rLocale ); - /// returns the ID string of the loaded calendar, e.g. <b>gregorian</b> + //------------------------------------------------------------------------ + /** Returns the ID string of the loaded calendar, for example, + <b>"gregorian"</b> + */ string getUniqueID(); + //------------------------------------------------------------------------ /** - Set the date/time as an offset to the start of the calendar at 1-Jan-1970 00:00 - The integer part represents the number of days passed since start date. - The fractional part represents fractions of a day, thus 0.5 means 12 hours. + Set the date/time as an offset to the start of the calendar at + 1-Jan-1970 00:00. The integer part represents the number of days + passed since start date. The fractional part represents + fractions of a day, thus 0.5 means 12 hours. */ void setDateTime( [in] double nTimeInDays ); + //------------------------------------------------------------------------ /** - Get the date/time as an offset to the start of the calendar at 1-Jan-1970 00:00 - The integer part represents the number of days passed since start date. - The fractional part represents fractions of a day, thus 0.5 means 12 hours. + Get the date/time as an offset to the start of the calendar at + 1-Jan-1970 00:00. The integer part represents the number of days + passed since start date. The fractional part represents + fractions of a day, thus 0.5 means 12 hours. */ double getDateTime(); + //------------------------------------------------------------------------ /** Set the value of a field. @param nCalendarFieldIndex - one of <type>CalendarFieldIndex</type> values + One of <type>CalendarFieldIndex</type> values. @param nValue - a value of the allowed range for the field index + A value of the allowed range for the field index. */ void setValue( [in] short nCalendarFieldIndex, [in] short nValue ); + //------------------------------------------------------------------------ /** Get the value of a field. @param nCalendarFieldIndex - one of <type>CalendarFieldIndex</type> values + One of <type>CalendarFieldIndex</type> values. */ short getValue( [in] short nCalendarFieldIndex ); + //------------------------------------------------------------------------ /** - Verify if the date fields set by "setValue()" is valid. - It has a side-effect because it will internally calculate - the final value for the date fields + Verify if the date fields set by a combination of + <member>XCalendar::setValue()</member> calls is valid. It has a + side-effect because it will internally calculate the final value + for the date fields */ boolean isValid(); + //------------------------------------------------------------------------ /** Add an amount to a field. @param nCalendarFieldIndex - one of <type>CalendarFieldIndex</type> values + One of <type>CalendarFieldIndex</type> values. @param nAmount - the amount to add + The amount to add. */ void addValue( [in] short nCalendarFieldIndex, [in] long nAmount ); - /// returns the first day of a week, one of <type>Weekdays</type> values + //------------------------------------------------------------------------ + /** returns the first day of a week, one of <type>Weekdays</type> + values. + */ short getFirstDayOfWeek(); - /// set the first day of a week, one of <type>Weekdays</type> values + //------------------------------------------------------------------------ + /** Set the first day of a week, one of <type>Weekdays</type> + values. + */ void setFirstDayOfWeek( [in] short nDay ); - /// set how many days of a week must reside in the first week of a year + //------------------------------------------------------------------------ + /** Set how many days of a week must reside in the first week of a + year. + */ void setMinimumNumberOfDaysForFirstWeek( [in] short nDays ); - /// returns how many days of a week must reside in the first week of a year + //------------------------------------------------------------------------ + /** returns how many days of a week must reside in the first week of + a year. + */ short getMinimumNumberOfDaysForFirstWeek(); - /// returns the number of months in a year, e.g., <b>12</b> + //------------------------------------------------------------------------ + /// returns the number of months in a year, e.g. <b>12</b> short getNumberOfMonthsInYear(); - /// returns the number of days in a week, e.g., <b>7</b> + //------------------------------------------------------------------------ + /// returns the number of days in a week, e.g. <b>7</b> short getNumberOfDaysInWeek(); - /// returns a sequence of <type>CalendarItem</type> describing the month names + //------------------------------------------------------------------------ + /** returns a sequence of <type>CalendarItem</type> describing the + month names. + */ sequence< CalendarItem > getMonths(); - /// returns a sequence of <type>CalendarItem</type> describing the day names + //------------------------------------------------------------------------ + /** returns a sequence of <type>CalendarItem</type> describing the + day names. + */ sequence< CalendarItem > getDays(); + //------------------------------------------------------------------------ /** Returns a string (name to display) matching the given parameters. @param nCalendarDisplayIndex - one of <type>CalendarDisplayIndex</type> values + One of <type>CalendarDisplayIndex</type> values @param nIdx - A value matching the <type>CalendarDisplayIndex</type> type: - <em>AM_PM</em> => one of <type>AmPmValue</type> - <em>DAY</em> => one of <type>Weekdays</type> - <em>MONTH</em> => one of <type>Months</type> - <em>YEAR</em> => <b>not used, empty string returned</b> - <em>ERA</em> => one of ??? - - The value should be obtained by a previous call to - <member>XCalendar::getValue()</member> with an appropriate - <type>CalendarFieldIndex</type> argument. + A value matching the <em>nCalendarDisplayIndex</em> type: + <dl> + <dt><const>CalendarDisplayIndex::AM_PM</const></dt> + <dd>one of <type>AmPmValue</type></dd> + <dt><const>CalendarDisplayIndex::DAY</const></dt> + <dd>one of <type>Weekdays</type> or a number used as + an offset into the corresponding + <member>Calendar::Days</member> sequence</dd> + <dt><const>CalendarDisplayIndex::MONTH</const></dt> + <dd>one of <type>Months</type> or a number used as + an offset into the corresponding + <member>Calendar::Months</member> sequence</dd> + <dt><const>CalendarDisplayIndex::YEAR</const></dt> + <dd>not used, empty string returned</dd> + <dt><const>CalendarDisplayIndex::ERA</const></dt> + <dd>a number used as an offset into the + corresponding <member>Calendar:Eras</member> + sequence</dd> + </dl> + + <p> The value should be obtained by a previous call to + <member>XCalendar::getValue()</member> with an appropriate + <type>CalendarFieldIndex</type> argument. </p> @param nNameType - 0 => abbreviated name, e.g., <b>Jan</b> - 1 => full name, e.g., <b>January</b> - - This parameter is not used if the <em>nCalendarDisplayIndex</em> - argument equals <type>CalendarDisplayIndex::AM_PM</type> + A value indicating whether to return the abbreviated or the + full name. + <dl> + <dt> 0 </dt> + <dd>abbreviated name, e.g. <b>"Jan"</b></dd> + <dt> 1 </dt> + <dd>full name, e.g. <b>"January"</b></dd> + + <p> This parameter is not used if the + <em>nCalendarDisplayIndex</em> argument equals + <const>CalendarDisplayIndex::AM_PM</const> </p> */ - string getDisplayName( [in] short nCalendarDisplayIndex, [in] short nIdx, [in] short nNameType ); + + string getDisplayName( [in] short nCalendarDisplayIndex, + [in] short nIdx, + [in] short nNameType ); }; -//============================================================================= +//============================================================================ }; }; }; }; -//============================================================================= +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/XCharacterClassification.idl b/offapi/com/sun/star/i18n/XCharacterClassification.idl index 50961a015f6c..b885413f45aa 100644 --- a/offapi/com/sun/star/i18n/XCharacterClassification.idl +++ b/offapi/com/sun/star/i18n/XCharacterClassification.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCharacterClassification.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: er $ $Date: 2002-01-14 15:57:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,189 +62,24 @@ #ifndef __com_sun_star_i18n_XCharacterClassification_idl__ #define __com_sun_star_i18n_XCharacterClassification_idl__ +#include <com/sun/star/i18n/ParseResult.idl> + #ifndef __com_sun_star_lang_Locale_idl__ #include <com/sun/star/lang/Locale.idl> #endif +#ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> +#endif -//============================================================================= +//============================================================================ module com { module sun { module star { module i18n { -//============================================================================= - -constants UnicodeType -{ - const short UNASSIGNED = 0; - const short UPPERCASE_LETTER = 1; - const short LOWERCASE_LETTER = 2; - const short TITLECASE_LETTER = 3; - const short MODIFIER_LETTER = 4; - const short OTHER_LETTER = 5; - const short NON_SPACING_MARK = 6; - const short ENCLOSING_MARK = 7; - const short COMBINING_SPACING_MARK = 8; - const short DECIMAL_DIGIT_NUMBER = 9; - const short LETTER_NUMBER = 10; - const short OTHER_NUMBER = 11; - const short SPACE_SEPARATOR = 12; - const short LINE_SEPARATOR = 13; - const short PARAGRAPH_SEPARATOR = 14; - const short CONTROL = 15; - const short FORMAT = 16; - const short PRIVATE_USE = 17; - const short SURROGATE = 18; - const short DASH_PUNCTUATION = 19; - const short INITIAL_PUNCTUATION = 20; - const short FINAL_PUNCTUATION = 21; - const short CONNECTOR_PUNCTUATION = 22; - const short OTHER_PUNCTUATION = 23; - const short MATH_SYMBOL = 24; - const short CURRENCY_SYMBOL = 25; - const short MODIFIER_SYMBOL = 26; - const short OTHER_SYMBOL = 27; - const short START_PUNCTUATION = 28; - const short END_PUNCTUATION = 29; - const short GENERAL_TYPES_COUNT = 30; -}; - - -enum UnicodeScript { - kBasicLatin, - kLatin1Supplement, - kLatinExtendedA, - kLatinExtendedB, - kIPAExtension, - kSpacingModifier, - kCombiningDiacritical, - kGreek, - kCyrillic, - kArmenian, - kHebrew, - kArabic, - kSyriac, - kThaana, - kDevanagari, - kBengali, - kGurmukhi, - kGujarati, - kOriya, - kTamil, - kTelugu, - kKannada, - kMalayalam, - kSinhala, - kThai, - kLao, - kTibetan, - kMyanmar, - kGeorgian, - kHangulJamo, - kEthiopic, - kCherokee, - kUnifiedCanadianAboriginalSyllabics, - kOgham, - kRunic, - kKhmer, - kMongolian, - kLatinExtendedAdditional, - kGreekExtended, - kGeneralPunctuation, - kSuperSubScript, - kCurrencySymbolScript, - kSymbolCombiningMark, - kLetterlikeSymbol, - kNumberForm, - kArrow, - kMathOperator, - kMiscTechnical, - kControlPicture, - kOpticalCharacter, - kEnclosedAlphanumeric, - kBoxDrawing, - kBlockElement, - kGeometricShape, - kMiscSymbol, - kDingbat, - kBraillePatterns, - kCJKRadicalsSupplement, - kKangxiRadicals, - kIdeographicDescriptionCharacters, - kCJKSymbolPunctuation, - kHiragana, - kKatakana, - kBopomofo, - kHangulCompatibilityJamo, - kKanbun, - kBopomofoExtended, - kEnclosedCJKLetterMonth, - kCJKCompatibility, - k_CJKUnifiedIdeographsExtensionA, - kCJKUnifiedIdeograph, - kYiSyllables, - kYiRadicals, - kHangulSyllable, - kHighSurrogate, - kHighPrivateUseSurrogate, - kLowSurrogate, - kPrivateUse, - kCJKCompatibilityIdeograph, - kAlphabeticPresentation, - kArabicPresentationA, - kCombiningHalfMark, - kCJKCompatibilityForm, - kSmallFormVariant, - kArabicPresentationB, - kNoScript, - kHalfwidthFullwidthForm, - kScriptCount - - }; - - -enum DirectionProperty { - LEFT_TO_RIGHT = 0, - RIGHT_TO_LEFT = 1, - EUROPEAN_NUMBER = 2, - EUROPEAN_NUMBER_SEPARATOR = 3, - EUROPEAN_NUMBER_TERMINATOR = 4, - ARABIC_NUMBER = 5, - COMMON_NUMBER_SEPARATOR = 6, - BLOCK_SEPARATOR = 7, - SEGMENT_SEPARATOR = 8, - WHITE_SPACE_NEUTRAL = 9, - OTHER_NEUTRAL = 10, - LEFT_TO_RIGHT_EMBEDDING = 11, - LEFT_TO_RIGHT_OVERRIDE = 12, - RIGHT_TO_LEFT_ARABIC = 13, - RIGHT_TO_LEFT_EMBEDDING = 14, - RIGHT_TO_LEFT_OVERRIDE = 15, - POP_DIRECTIONAL_FORMAT = 16, - DIR_NON_SPACING_MARK = 17, - BOUNDARY_NEUTRAL = 18 - }; - - -/** - constants to identify the Character Type - */ -constants KCharacterType{ - const long DIGIT =0x0000000000000001; - const long UPPER =0x0000000000000002; - const long LOWER =0x0000000000000004; - const long TITLE_CASE =0x0000000000000008; - const long ALPHA =0x000000000000000E; // ALPHA = UPPER | LOWER | TITLE_CASE - const long CONTROL =0x0000000000000010; - const long PRINTABLE =0x0000000000000020; - const long BASE_FORM =0x0000000000000040; - const long LETTER =0x0000000000000080; // any UnicodeType::..._LETTER - -}; - +//============================================================================ /* -Possible tokens to be parsed: +Possible tokens to be parsed with parse...Token(): UPASCALPHA=[A-Z] LOASCALPHA=[a-z] @@ -268,7 +103,6 @@ DECSEP=<locale dependent decimal separator> GRPSEP=<locale dependent thousand separator> EXPONENT=(E|e)[SIGN]1*ASC_DIGIT - IDENTIFIER=ALPHA *ALNUM UIDENTIFIER=(ALPHA | ASC_UNDERSCORE) *(ALNUM|ASC_UNDERSCORE) ALPHA_NAME=ALPHA *(ALNUM|DEFCHARS) @@ -278,302 +112,209 @@ DOUBLE_QUOTE_NAME=ASC_DBL_QUOTE(*CHAR)ASC_DBL_QUOTE ASC_NUMBER=[SIGN]*(1*ASC_DIGIT *(GRPSEP 1*ASC_DIGIT))[DECSEP]1*ASC_DIGIT[EXPONENT] NUMBER=[SIGN]*(1*DIGIT *(GRPSEP 1*DIGIT))[DECSEP]1*DIGIT[EXPONENT] - - */ +//============================================================================ /** - These constants specify the characters, a name or identifier token to be - parsed, can have. They are also set in the <member>ParseResult::StartFlags</member> - and <member>ParseResult::ContFlags</member>. + Character classification (upper, lower, digit, letter, number, ...) + and generic Unicode enabled parser. */ -constants KParseTokens -{ - /// Flags for characters below 128 - const long ASC_UPALPHA = 0x00000001; - const long ASC_LOALPHA = 0x00000002; - const long ASC_DIGIT = 0x00000004; - const long ASC_UNDERSCORE = 0x00000008; /// '_' - const long ASC_DOLLAR = 0x00000010; /// '$' - const long ASC_DOT = 0x00000020; /// '.' - const long ASC_COLON = 0x00000040; /// ':' - /// Special value to allow control characters (0x00 < char < 0x20) - const long ASC_CONTROL = 0x00000200; - /** Special value to allow anything below 128 except control characters. - <strong>Not</strong> set in <type>ParseResult</type>. */ - const long ASC_ANY_BUT_CONTROL = 0x00000400; - /** Additional flags set in <member>ParseResult::StartFlags</member> or - <member>ParseResult::ContFlags</member>. - Set if none of the above ASC_... (except ASC_ANY_...) single values - match a character. */ - const long ASC_OTHER = 0x00000800; - - /// Flags for characters above 127 - const long UNI_UPALPHA = 0x00001000; /// UPPERCASE_LETTER - const long UNI_LOALPHA = 0x00002000; /// LOWERCASE_LETTER - const long UNI_DIGIT = 0x00004000; /// DECIMAL_DIGIT_NUMBER - const long UNI_TITLE_ALPHA = 0x00008000; /// TITLECASE_LETTER - const long UNI_MODIFIER_LETTER = 0x00010000; - const long UNI_OTHER_LETTER = 0x00020000; - const long UNI_LETTER_NUMBER = 0x00040000; - const long UNI_OTHER_NUMBER = 0x00080000; - - /** If this bit is set in <em>nContCharFlags</em> parameters and a string - enclosed in double quotes is parsed and two consecutive double quotes - are encountered, the string is ended. If this bit is not set, the two - double quotes are parsed as one escaped double quote and string parsing - continues. The bit is ignored in <em>nStartCharFlags</em> parameters. - Example: - "abc""def" --> bit not set => abc"def - "abc""def" --> bit set => abc - */ - const long TWO_DOUBLE_QUOTES_BREAK_STRING = 0x10000000; - - /** Additional flags set in <member>ParseResult::StartFlags</member> or - <member>ParseResult::ContFlags</member>. - Set if none of the above UNI_... single values match a character. */ - const long UNI_OTHER = 0x20000000; - - /** Only valid for <em>nStartCharFlags</em> parameter to - <member>ChararacterClassification::parseAnyToken</member> and - <member>ChararacterClassification::parsePredefinedToken</member>, - ignored on <em>nContCharFlags</em> parameter. - <strong>Not</strong> set in <type>ParseResult</type>. */ - const long IGNORE_LEADING_WS = 0x40000000; - - /// Useful combinations - const long ASC_ALPHA = ASC_UPALPHA | ASC_LOALPHA; - const long ASC_ALNUM = ASC_ALPHA | ASC_DIGIT; - const long UNI_ALPHA = UNI_UPALPHA | UNI_LOALPHA | UNI_TITLE_ALPHA; - const long UNI_ALNUM = UNI_ALPHA | UNI_DIGIT; - const long UNI_LETTER = UNI_ALPHA | UNI_MODIFIER_LETTER | - UNI_OTHER_LETTER; - const long UNI_NUMBER = UNI_DIGIT | UNI_LETTER_NUMBER | - UNI_OTHER_NUMBER; - const long ANY_ALPHA = ASC_ALPHA | UNI_ALPHA; - const long ANY_DIGIT = ASC_DIGIT | UNI_DIGIT; - const long ANY_ALNUM = ASC_ALNUM | UNI_ALNUM; - const long ANY_LETTER = ASC_ALPHA | UNI_LETTER; - const long ANY_NUMBER = ASC_DIGIT | UNI_NUMBER; - const long ANY_LETTER_OR_NUMBER = ANY_LETTER | ANY_NUMBER; -}; - -/** - Constants set by the parser to specify the type of the parsed final token. - */ -constants KParseType +interface XCharacterClassification : com::sun::star::uno::XInterface { - /// One single character like ! # ; : $ et al. - const long ONE_SINGLE_CHAR = 0x00000001; - // For human .idl readers: <, >, <>, =, <=, >= - /// A Boolean operator like <, >, <>, =, <=, >= - const long BOOLEAN = 0x00000002; - /// A name matching the conditions passed. - const long IDENTNAME = 0x00000004; - // Hint for human .idl readers: do not get confused about the double - // quotation marks, they are needed for the unoidl compiler which otherwise - // gets confused about the single quotation marks. - /** "A single-quoted name matching the conditions passed ( 'na\'me' )." - "Dequoted name in <member>ParseResult::DequotedNameOrString</member> ( na'me )." */ - const long SINGLE_QUOTE_NAME = 0x00000008; - /** A double-quoted string ( "str\"i""ng" ). - Dequoted string in <member>ParseResult::DequotedNameOrString</member> ( str"i"ng ). */ - const long DOUBLE_QUOTE_STRING = 0x00000010; - /** A number where all digits are ASCII characters. - Numerical value in <member>ParseResult::Value</member>. */ - const long ASC_NUMBER = 0x00000020; - /** A number where at least some digits are Unicode (and maybe ASCII) characters. - Numerical value in <member>ParseResult::Value</member>. */ - const long UNI_NUMBER = 0x00000040; - - /// Set (ored) if SINGLE_QUOTE_NAME or DOUBLE_QUOTE_STRING has no closing quote. - const long MISSING_QUOTE = 0x40000000; - - /// Useful combinations - const long ANY_NUMBER = ASC_NUMBER | UNI_NUMBER; -}; - - -/** - Struct returned by <member>XCharacterClassification::parseAnyToken</member> - and <member>XCharacterClassification::parsePredefinedToken</member>. - */ -struct ParseResult { - /// Count of ignored leading whitespace, in code points, not characters. - long LeadingWhiteSpace; - /// Code point index of first unprocessed character. - long EndPos; - /// Number of characters (not code points) of the parsed token, not including leading whitespace. - long CharLen; - /// Value of token in case of numeric. - double Value; - /// <type>KParseType</type> token type like IDENTNAME. - long TokenType; - /** <type>KParseTokens</type> flags of first character of actual token matched. - If <member>TokenType</member> is a <em>SINGLE_QUOTE_NAME</em> or a - <em>DOUBLE_QUOTE_STRING</em> the first character is the first character - inside the quotes. */ - long StartFlags; - /// <type>KParseTokens</type> flags of remaining characters of actual token matched. - long ContFlags; - /// If a quoted name or string is encountered the dequoted result goes here. - string DequotedNameOrString; -}; - + //------------------------------------------------------------------------ + /** Convert lower case alpha to upper case alpha, starting at + position <em>nPos</em> for <em>nCount</em> code points. + */ + string toUpper( [in] string aText, [in] long nPos, [in] long nCount, + [in] com::sun::star::lang::Locale aLocale ); -interface XCharacterClassification : com::sun::star::uno::XInterface + //------------------------------------------------------------------------ + /** Convert upper case alpha to lower case alpha, starting at + position <em>nPos</em> for <em>nCount</em> code points. + */ + string toLower( [in] string aText, [in] long nPos, [in] long nCount, + [in] com::sun::star::lang::Locale aLocale ); -{ + //------------------------------------------------------------------------ + /** Convert to title case, starting at + position <em>nPos</em> for <em>nCount</em> code points. + */ + string toTitle( [in] string aText, [in] long nPos, [in] long nCount, + [in] com::sun::star::lang::Locale aLocale ); - /// @param nCount is code point count - string toUpper ([in] string Text, [in] long nPos, [in] long nCount, [in] com::sun::star::lang::Locale rLocale); - string toLower ([in] string Text, [in] long nPos, [in] long nCount, [in] com::sun::star::lang::Locale rLocale); - string toTitle ([in] string Text, [in] long nPos, [in] long nCount, [in] com::sun::star::lang::Locale rLocale); + //------------------------------------------------------------------------ + /// Get <type>UnicodeType</type> of character at position <em>nPos</em>. + short getType( [in] string aText, [in] long nPos ); + //------------------------------------------------------------------------ + /** Get <type>DirectionProperty</type> of character at position + <em>nPos</em>. + */ + short getCharacterDirection( [in] string aText, [in] long nPos ); - short getType ([in] string Text, [in] long nPos); - short getCharacterDirection([in] string Text, [in] long nPos); - short getScript ([in] string Text, [in] long nPos); + //------------------------------------------------------------------------ + /// Get <type>UnicodeScript</type> of character at position <em>nPos</em>. + short getScript( [in] string aText, [in] long nPos ); - /** - @returns a number with appropriate flag set to indicate the type of the - character at position nPos; the flag value is one of KCharacterType values. - */ - long getCharacterType([in] string text, [in] long nPos, [in] com::sun::star::lang::Locale rLocale); + //------------------------------------------------------------------------ + /// Get <type>KCharacterType</type> of character at position <em>nPos</em>. + long getCharacterType( [in] string aText, [in] long nPos, + [in] com::sun::star::lang::Locale aLocale ); + //------------------------------------------------------------------------ + /** Get accumulated <type>KCharacterType</type>s of string starting + at position <em>nPos</em> of length <em>nCount</em> code points. - /** - @returns a number with appropriate flags set to indicate what type of - characters the string contains; each flag value may be one of KCharacterType values. - */ - long getStringType([in] string text, [in] long nPos, [in] long nCount, [in] com::sun::star::lang::Locale rLocale); + @returns + A number with appropriate flags set to indicate what type of + characters the string contains, each flag value being one of + KCharacterType values. + */ + long getStringType( [in] string aText, [in] long nPos, [in] long nCount, + [in] com::sun::star::lang::Locale aLocale ); + //------------------------------------------------------------------------ /** Parse a string for a token starting at position <em>nPos</em>. - <p>A name or identifier must match the <type>KParseTokens</type> criteria - passed in <em>nStartCharFlags</em> and <em>nContCharFlags</em> and may - additionally contain characters of <em>userDefinedCharactersStart</em> - and/or <em>userDefinedCharactersCont</em>. - + <p> A name or identifier must match the + <type>KParseTokens</type> criteria passed in + <em>nStartCharFlags</em> and <em>nContCharFlags</em> and may + additionally contain characters of + <em>aUserDefinedCharactersStart</em> and/or + <em>aUserDefinedCharactersCont</em>. </p> - @returns <type>ParseResult</type> - If no unambigous token could be parsed, <member>ParseResult::TokenType</member> - will be set to zero, other fields will contain the values parsed so far. - <p>If a token may represent either a numeric value or a name according - to the passed Start/Cont-Flags/Chars, both <const>KParseType::ASC_NUM</const> - (or <const>KParseType::UNI_NUM</const>) and <const>KParseType::IDENTNAME</const> - are set in <member>ParseResult::TokenType</member>. + @returns + A filled <type>ParseResult</type> structure. If no + unambigous token could be parsed, + <member>ParseResult::TokenType</member> will be set to + <b>0</b> (zero), other fields will contain the values parsed + so far. + <p> If a token may represent either a numeric value or a + name according to the passed Start/Cont-Flags/Chars, both + <const>KParseType::ASC_NUM</const> (or + <const>KParseType::UNI_NUM</const>) and + <const>KParseType::IDENTNAME</const> are set in + <member>ParseResult::TokenType</member>. - @param Text - Text to be parsed. + @param aText + Text to be parsed. @param nPos - Position where parsing starts. + Position where parsing starts. - @param rLocale - The locale, e.g., for decimal and group separator or character type - determination. + @param aLocale + The locale, for example, for decimal and group separator or + character type determination. @param nStartCharFlags - A set of <type>KParseTokens</type> constants determining the allowed - characters a name or identifier may start with. + A set of <type>KParseTokens</type> constants determining the + allowed characters a name or identifier may start with. - @param userDefinedCharactersStart - A set of additionally allowed characters a name or identifier may start - with. + @param aUserDefinedCharactersStart + A set of additionally allowed characters a name or + identifier may start with. @param nContCharFlags - A set of <type>KParseTokens</type> constants determining the allowed - characters a name or identifier may continue with. - - @param userDefinedCharactersCont - A set of additionally allowed characters a name or identifier may - continue with. + A set of <type>KParseTokens</type> constants determining the + allowed characters a name or identifier may continue with. + @param aUserDefinedCharactersCont + A set of additionally allowed characters a name or + identifier may continue with. @example:C++ <listing> - using namespace ::com::sun::star::i18n; - // First character may be any alphabetic or underscore. - sal_Int32 nStartFlags = KParseTokens::ANY_ALPHA | KParseTokens::ASC_UNDERSCORE; - // Continuing characters may be any alphanumeric or underscore or dot. - sal_Int32 nContFlags = KParseTokens::ANY_ALNUM | KParseTokens::ASC_UNDERSCORE | KParseTokens::ASC_DOT; - // Parse any token. - ParseResult rRes = xCC->parseAnyToken( aText, nPos, aLocale, - nStartFlags, EMPTY_STRING, nContFlags, EMPTY_STRING ); - // Get parsed token. - if ( rRes.TokenType & (KParseType::ASC_NUMBER | KParseType::UNI_NUMBER) ) - fValue = rRes.Value; - if ( rRes.TokenType & KParseType::IDENTNAME ) - aName = aText.Copy( nPos, rRes.EndPos - nPos ); - else if ( rRes.TokenType & KParseType::SINGLE_QUOTE_NAME ) - aName = rRes.DequotedNameOrString; - else if ( rRes.TokenType & KParseType::DOUBLE_QUOTE_STRING ) - aString = rRes.DequotedNameOrString; - else if ( rRes.TokenType & KParseType::BOOLEAN ) - aSymbol = aText.Copy( nPos, rRes.EndPos - nPos ); - else if ( rRes.TokenType & KParseType::ONE_SINGLE_CHAR ) - aSymbol = aText.Copy( nPos, rRes.EndPos - nPos ); + using namespace ::com::sun::star::i18n; + // First character of an identifier may be any alphabetic or underscore. + sal_Int32 nStartFlags = KParseTokens::ANY_ALPHA | KParseTokens::ASC_UNDERSCORE; + // Continuing characters may be any alphanumeric or underscore or dot. + sal_Int32 nContFlags = KParseTokens::ANY_ALNUM | KParseTokens::ASC_UNDERSCORE | KParseTokens::ASC_DOT; + // No further characters assumed to be contained in an identifier + String aEmptyString; + // Parse any token. + ParseResult rRes = xCC->parseAnyToken( aText, nPos, aLocale, + nStartFlags, aEmptyString, nContFlags, aEmptyString ); + // Get parsed token. + if ( rRes.TokenType & (KParseType::ASC_NUMBER | KParseType::UNI_NUMBER) ) + fValue = rRes.Value; + if ( rRes.TokenType & KParseType::IDENTNAME ) + aName = aText.Copy( nPos, rRes.EndPos - nPos ); + else if ( rRes.TokenType & KParseType::SINGLE_QUOTE_NAME ) + aName = rRes.DequotedNameOrString; + else if ( rRes.TokenType & KParseType::DOUBLE_QUOTE_STRING ) + aString = rRes.DequotedNameOrString; + else if ( rRes.TokenType & KParseType::BOOLEAN ) + aSymbol = aText.Copy( nPos, rRes.EndPos - nPos ); + else if ( rRes.TokenType & KParseType::ONE_SINGLE_CHAR ) + aSymbol = aText.Copy( nPos, rRes.EndPos - nPos ); </listing> */ + ParseResult parseAnyToken( - [in] string Text, + [in] string aText, [in] long nPos, - [in] com::sun::star::lang::Locale rLocale, + [in] com::sun::star::lang::Locale aLocale, [in] long nStartCharFlags, - [in] string userDefinedCharactersStart, + [in] string aUserDefinedCharactersStart, [in] long nContCharFlags, - [in] string userDefinedCharactersCont + [in] string aUserDefinedCharactersCont ); + //------------------------------------------------------------------------ /** - Parse a string for a token of type <em>nTokenType</em> starting at - position <em>nPos</em>. - - <p>Other parameters are the same as in <member>parseAnyToken</member>. - If the actual token does not match a <em>nTokenType</em> a - <member>ParseResult::TokenType</member> is returned. + Parse a string for a token of type <em>nTokenType</em> starting + at position <em>nPos</em>. + <p> Other parameters are the same as in + <member>parseAnyToken</member>. If the actual token does not + match the passed <em>nTokenType</em> a + <member>ParseResult::TokenType</member> set to <b>0</b> (zero) + is returned. </p> @param nTokenType - One or more of the <type>KParseType</type> constants. - + One or more of the <type>KParseType</type> constants. @example:C++ <listing> - // Determine if a given name is a valid name (not quoted) and contains - // only allowed characters. - using namespace ::com::sun::star::i18n; - // First character may be any alphanumeric or underscore. - sal_Int32 nStartFlags = KParseTokens::ANY_ALNUM | KParseTokens::ASC_UNDERSCORE; - // Continuing characters may be any alphanumeric or underscore. - sal_Int32 nContFlags = nStartFlags; - // Additionally, continuing characters may be a blank. - String aContChars( RTL_CONSTASCII_USTRINGPARAM(" ") ); - // Parse predefined (must be an IDENTNAME) token. - rRes = xCC->parsePredefinedToken( KParseType::IDENTNAME, rName, 0, aLocale, - nStartFlags, EMPTY_STRING, nContFlags, aContChars ); - bValid = (rRes.TokenType & KParseType::IDENTNAME) && rRes.EndPos == rName.Len(); + // Determine if a given name is a valid name (not quoted) and contains + // only allowed characters. + using namespace ::com::sun::star::i18n; + // First character of an identifier may be any alphanumeric or underscore. + sal_Int32 nStartFlags = KParseTokens::ANY_ALNUM | KParseTokens::ASC_UNDERSCORE; + // No further characters assumed to be contained in an identifier start. + String aEmptyString; + // Continuing characters may be any alphanumeric or underscore. + sal_Int32 nContFlags = nStartFlags; + // Additionally, continuing characters may contain a blank. + String aContChars( RTL_CONSTASCII_USTRINGPARAM(" ") ); + // Parse predefined (must be an IDENTNAME) token. + ParseResult rRes = xCC->parsePredefinedToken( KParseType::IDENTNAME, rName, 0, aLocale, + nStartFlags, aEmptyString, nContFlags, aContChars ); + // Test if it is an identifier name and if it only is one + // and no more else is following it. + bValid = (rRes.TokenType & KParseType::IDENTNAME) && rRes.EndPos == rName.Len(); </listing> */ + ParseResult parsePredefinedToken( [in] long nTokenType, - [in] string Text, + [in] string aText, [in] long nPos, - [in] com::sun::star::lang::Locale rLocale, + [in] com::sun::star::lang::Locale aLocale, [in] long nStartCharFlags, - [in] string userDefinedCharactersStart, + [in] string aUserDefinedCharactersStart, [in] long nContCharFlags, - [in] string userDefinedCharactersCont + [in] string aUserDefinedCharactersCont ); }; //============================================================================= }; }; }; }; +//============================================================================= #endif diff --git a/offapi/com/sun/star/i18n/XCollator.idl b/offapi/com/sun/star/i18n/XCollator.idl index 666b815fd247..b9531f68e295 100644 --- a/offapi/com/sun/star/i18n/XCollator.idl +++ b/offapi/com/sun/star/i18n/XCollator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCollator.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,161 +64,140 @@ #include <com/sun/star/uno/Exception.idl> #include <com/sun/star/uno/XInterface.idl> #include <com/sun/star/lang/Locale.idl> -#include <com/sun/star/i18n/XTransliteration.idl> //============================================================================= module com { module sun { module star { module i18n { -/* collator options */ -constants CollatorOptions { - const short CollatorOptions_IGNORE_CASE = 1; - const short CollatorOptions_IGNORE_KANA = 2; - const short CollatorOptions_IGNORE_WIDTH = 4; -}; - - -/** Interface for Collator Objects - +/** Interface for collation algorithms used in sorting. */ interface XCollator: com::sun::star::uno::XInterface { - /** compares 2 sub-strings + //------------------------------------------------------------------------- + /** Compare 2 substrings. - @param s1 - first String + @param aStr1 + First string. - @param off1 - offset (from 0) of the first substring + @param nOff1 + Offset (from 0) of the first substring. - @param len1 - length (from offset) of the first substring + @param nLen1 + Length (from offset) of the first substring. - @param s2 - second String + @param aStr2 + Second string - @param off2 - offset (from 0) of the second substring + @param nOff2 + Offset (from 0) of the second substring. - @param len2 - length (from offset) of the second substring + @param nLen2 + Length (from offset) of the second substring. @returns - 1 if the first string is more than second string - 0 if the first string is equals to second string - -1 if the first string is less than second string + 1 if the first string is greater than the second string <br/> + 0 if the first string is equal to the second string <br/> + -1 if the first string is less than the second string */ - long compareSubstring([in] string s1, [in] long off1, [in] long len1, [in] string s2, [in] long off2, [in] long len2); + long compareSubstring( [in] string aStr1, [in] long nOff1, [in] long nLen1, + [in] string aStr2, [in] long nOff2, [in] long nLen2 ); - /** compares 2 strings + //------------------------------------------------------------------------- + /** Compare 2 strings. - @param s1 - first String + @param aStr1 + First string. - @param s2 - second String + @param aStr2 + Second string. @returns - 1 if the first string is more than second string - 0 if the first string is equals to second string - -1 if the first string is less than second string + 1 if the first string is greater than the second string <br/> + 0 if the first string is equal to the second string <br/> + -1 if the first string is less than the second string */ - long compareString([in] string s1, [in] string s2); + long compareString( [in] string aStr1, [in] string aStr2 ); - /** loads the Default Collator Implementation + //------------------------------------------------------------------------- + /** Load the default collator. - @param rLocale - the locale for this Collator + @param aLocale + The locale for this collator. - @param collatorOptions - collator options + @param nCollatorOptions + A mask of <type>CollatorOptions</type>. @returns TODO */ - long loadDefaultCollator([in] ::com::sun::star::lang::Locale rLocale, - [in] long collatorOptions); + long loadDefaultCollator( [in] ::com::sun::star::lang::Locale aLocale, + [in] long nCollatorOptions ); - /** loads a particular Collator Algorithm + //------------------------------------------------------------------------- + /** Load a particular collator algorithm. - @param impl - the implementation name to load + @param aAlgorithmName + Fhe algorithm to load. - @param rLocale - the locale for this Collator + @param aLocale + The locale for this collator. - @param collatorOptions - collator options + @param nCollatorOptions + A mask of <type>CollatorOptions</type>. @returns TODO */ - long loadCollatorAlgorithm([in] string impl, - [in] ::com::sun::star::lang::Locale rLocale, - [in] long collatorOptions); + long loadCollatorAlgorithm( [in] string aAlgorithmName, + [in] ::com::sun::star::lang::Locale aLocale, + [in] long nCollatorOptions ); - /** list all collator Algorithms + //------------------------------------------------------------------------- + /** List all collator algorithms for a given locale. - @param rLocale - the locale for this Collator + @param aLocale + The locale for which to list algorithms. @returns - an array of algorithms (string) + A sequence of algorithm names. */ - sequence <string> listCollatorAlgorithms([in] ::com::sun::star::lang::Locale rLocale); + sequence <string> listCollatorAlgorithms( + [in] ::com::sun::star::lang::Locale aLocale ); + //------------------------------------------------------------------------- + /** Load a collator algorithm with options chosen by end user. - /** loads Collator Algorithm with options chosen by end users + @param aAlgorithmName + The algorithm name to load. - @param impl - the implementation name to load + @param aLocale + The locale for this collator. - @param rLocale - the locale for this Collator - - @param collatorOptions - an array of collator options (long) - - @returns - VOID - */ - void loadCollatorAlgorithmWithEndUserOption([in] string impl, - [in] ::com::sun::star::lang::Locale rLocale, - [in] sequence<long> collatorOptions); + @param aCollatorOptions + A sequence of end user collator options like those returned + by <member>XCollator::listCollatorOptions()</member>. + */ + void loadCollatorAlgorithmWithEndUserOption( + [in] string aAlgorithmName, + [in] ::com::sun::star::lang::Locale aLocale, + [in] sequence<long> aCollatorOptions ); - /** list all collator options + //------------------------------------------------------------------------- + /** List all end user collator options for a given algorithm. - @param collatorAlgorithmName - the algorithm name for this Collator + @param aAlgorithmName + The algorithm name for this collator. - @returns - an array of options (long) + @returns + An array of end user options available for the algorithm. + */ + sequence <long> listCollatorOptions( [in] string aAlgorithmName ); - */ - sequence <long> listCollatorOptions([in] string collatorAlgorithmName); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2001/02/08 21:13:07 bustamam - add collator options constants - Joe Xu - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.2 2000/09/12 22:09:21 gmu - Change name of methods and put comments - - Revision 1.1 2000/09/08 01:21:10 gmu - Change classname and method - - Revision 1.1 2000/08/23 19:32:52 gmu - Add new IDL: XCollator.idl - +//============================================================================= -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/i18n/XForbiddenCharacters.idl b/offapi/com/sun/star/i18n/XForbiddenCharacters.idl index 03298bb0e7b1..45e674281367 100644 --- a/offapi/com/sun/star/i18n/XForbiddenCharacters.idl +++ b/offapi/com/sun/star/i18n/XForbiddenCharacters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XForbiddenCharacters.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,51 +61,60 @@ #ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__ #define __com_sun_star_i18n_XForbiddenCharacters_idl__ +#include <com/sun/star/i18n/ForbiddenCharacters.idl> + #ifndef __com_sun_star_lang_Locale_idl__ #include <com/sun/star/lang/Locale.idl> #endif -#ifndef __com_sun_star_i18n_XLocaleData_idl__ -#include <com/sun/star/i18n/XLocaleData.idl> -#endif #ifndef __com_sun_star_container_NoSuchElementException_idl__ #include <com/sun/star/container/NoSuchElementException.idl> #endif -//============================================================================= +//============================================================================ - module com { module sun { module star { module i18n { +module com { module sun { module star { module i18n { -//============================================================================= +//============================================================================ -/** provides access to forbidden character settings in a document. -<p>In some languages, particular characaters are not allowed to be placed at the beginning or -at the end of a text line.</p> +/** + provides access to forbidden character settings in a document. + + <p> In some languages, particular characters are not allowed to be + placed at the beginning or at the end of a text line. </p> */ + interface XForbiddenCharacters : com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + //------------------------------------------------------------------------ /** returns the forbidden characters for a given locale. */ - ForbiddenCharacters getForbiddenCharacters([in] com::sun::star::lang::Locale rLocale) + ForbiddenCharacters getForbiddenCharacters( + [in] com::sun::star::lang::Locale aLocale ) raises( com::sun::star::container::NoSuchElementException ); - //------------------------------------------------------------------------- - /** determins whether forbidden characters are set for a given locale. + + //------------------------------------------------------------------------ + /** determines if forbidden characters are set for a given locale. */ - boolean hasForbiddenCharacters([in] com::sun::star::lang::Locale rLocale); - //------------------------------------------------------------------------- + boolean hasForbiddenCharacters( + [in] com::sun::star::lang::Locale aLocale ); + + //------------------------------------------------------------------------ /** sets the forbidden characters for a given Locale. */ - void setForbiddenCharacters( [in] com::sun::star::lang::Locale rLocale, - [in] ForbiddenCharacters rForbiddenCharacters ); - //------------------------------------------------------------------------- + void setForbiddenCharacters( + [in] com::sun::star::lang::Locale aLocale, + [in] ForbiddenCharacters aForbiddenCharacters ); + + //------------------------------------------------------------------------ /** removes the setting of forbidden characters for a given locale. */ - void removeForbiddenCharacters([in] com::sun::star::lang::Locale rLocale); + void removeForbiddenCharacters( + [in] com::sun::star::lang::Locale aLocale ); }; -//============================================================================= - +//============================================================================ }; }; }; }; +//============================================================================ #endif diff --git a/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl b/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl index 337650c23733..f3ce129a40e3 100644 --- a/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl +++ b/offapi/com/sun/star/i18n/XIndexEntrySupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexEntrySupplier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,43 +65,48 @@ #include <com/sun/star/lang/Locale.idl> #endif +//============================================================================ + module com { module sun { module star { module i18n { +//============================================================================ + /** supplies information on index entries to generate a "table of - alphabetical index", to a given locale information. - <p></p> - @see Locale - @version 1.0 - @author <a href="mailto:juergen.pingel@germany.sun.com">Juergen Pingel</a> + alphabetical index" for a given locale. */ - interface XIndexEntrySupplier : com::sun::star::uno::XInterface + +interface XIndexEntrySupplier : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------ /** returns the capital index key for sorting a table of indexes, to - a given index entry, to - a given <type scope="com::sun::star::lang">Locale</type> and - to a given sort algorithm. - <p>For example, in english locale it returns<br> - "K" for "keyboard" -*/ - string getIndexCharacter( [in]string IndexEntry, - [in]com::sun::star::lang::Locale aLocale, - [in]string SortAlgorithm ); + a given index entry, to a given <type + scope="com::sun::star::lang">Locale</type> and to a given sort + algorithm. + + <p> For example, in English locale it returns <b>"K"</b> for + "keyboard" + */ + string getIndexCharacter( [in] string aIndexEntry, [in] + com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm ); + + //------------------------------------------------------------------------ /** - returns the pagenumber word of an index entry, where one page - or more pages are combined to one pagenumber entry, to - a given <type scope="com::sun::star::lang">Locale</type>. - <p>For example, in english locale it returns - <br> "p." for MorePages = false - <br> "pp." for MorePages = true + returns the page number word of an index entry, where one page + or more pages are combined to one page number entry, for a given + <type scope="com::sun::star::lang">Locale</type>. + + <p> For example, in English locale it returns <br/> + <b>"p."</b> for <em>bMorePages</em> == <FALSE/> <br/> + <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p> */ - string getIndexFollowPageWord( [in]boolean MorePages, - [in]com::sun::star::lang::Locale aLocale ); + string getIndexFollowPageWord( [in] boolean bMorePages, + [in] com::sun::star::lang::Locale aLocale ); }; -};};};}; +//============================================================================ +};};};}; +//============================================================================ #endif - - diff --git a/offapi/com/sun/star/i18n/XNumberFormatCode.idl b/offapi/com/sun/star/i18n/XNumberFormatCode.idl index cc1bfa39eb91..efb623c00fd4 100644 --- a/offapi/com/sun/star/i18n/XNumberFormatCode.idl +++ b/offapi/com/sun/star/i18n/XNumberFormatCode.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormatCode.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-25 10:01:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -59,13 +59,14 @@ * ************************************************************************/ -#ifndef __COM_SUN_STAR_LANG_XNUMBERFORMATCODE_IDL__ -#define __COM_SUN_STAR_LANG_XNUMBERFORMATCODE_IDL__ +#ifndef __com_sun_star_i18n_XNumberFormatCode_idl__ +#define __com_sun_star_i18n_XNumberFormatCode_idl__ #ifndef __com_sun_star_lang_Locale_idl__ #include <com/sun/star/lang/Locale.idl> #endif #include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/i18n/NumberFormatCode.idl> //============================================================================= @@ -73,75 +74,28 @@ module com { module sun { module star { module i18n { //============================================================================= - - - /** - Attribute of number format. - - LeastSignificantBit is used to distinguish between - positive or negative and second LSB is used for Long or Short format. - - <!-- ER 02.11.00 ? description does not seem to match reality --> - <!-- JRH: Meaning unclear still. -->*/ -constants KNumberFormatType -{ - const short SHORT =1; - const short MEDIUM =2; - const short LONG =3; -}; - - -constants KNumberFormatUsage -{ - const short DATE =1; - const short TIME =2; - const short DATE_TIME =3; - const short FIXED_NUMBER =4; - const short FRACTION_NUMBER =5; - const short PERCENT_NUMBER =6; - const short SCIENTIFIC_NUMBER =7; - const short CURRENCY =8; - -}; - - -struct NumberFormatCode { - /// One of <type>KNumberFormatType</type> values - short Type; - /// One of <type>KNumberFormatUsage</type> values - short Usage; - /// Format code like DD/MM/YY - string Code; - /// Descriptive name of the format for this locale - string DefaultName; - /// Message identifier to be used if the name of the format is localized - string NameID; - /// Index of the code as defined in <type>NumberFormatIndex</type> - short Index; - /// Whether this format is the default format of the usage group - boolean Default; -}; - - - -/** - This interface provides access to specific number format codes. + Access number format codes defined in locale data. */ + interface XNumberFormatCode : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------ /** - returns the default number format code of a specific category - (usage group) for a given locale and format length type. + returns the default number format code of a specific category + (usage group) for a given locale and format length type. @param nFormatType one of the constants listed in <type>KNumberFormatType</type> @param nFormatUsage - one of <type>KNumberFormatUsage</type> values + one of <type>KNumberFormatUsage</type> values */ - NumberFormatCode getDefault( [in] short nFormatType, [in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale ); + NumberFormatCode getDefault( [in] short nFormatType, + [in] short nFormatUsage, + [in] com::sun::star::lang::Locale rLocale ); + //------------------------------------------------------------------------ /** returns the number format pointed to by <em>nFormatIndex</em> for a given locale. @@ -149,20 +103,26 @@ interface XNumberFormatCode : com::sun::star::uno::XInterface @param nFormatIndex one of <type>NumberFormatIndex</type> values */ - NumberFormatCode getFormatCode( [in] short nFormatIndex, [in] com::sun::star::lang::Locale rLocale ); + NumberFormatCode getFormatCode( [in] short nFormatIndex, + [in] com::sun::star::lang::Locale rLocale ); + //------------------------------------------------------------------------ /** returns all format codes for a given <em>nFormatUsage</em> and locale. @param nFormatUsage one of <type>KNumberFormatUsage</type> values */ - sequence< NumberFormatCode > getAllFormatCode( [in] short nFormatUsage, [in] com::sun::star::lang::Locale rLocale ); + sequence< NumberFormatCode > getAllFormatCode( + [in] short nFormatUsage, + [in] com::sun::star::lang::Locale rLocale ); + //------------------------------------------------------------------------ /** returns all format codes for a given locale. */ - sequence< NumberFormatCode > getAllFormatCodes( [in] com::sun::star::lang::Locale rLocale ); + sequence< NumberFormatCode > getAllFormatCodes( + [in] com::sun::star::lang::Locale rLocale ); }; diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index f3f63f21835b..93f43f378fe3 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTransliteration.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: bustamam $ $Date: 2001-06-29 22:52:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,54 +63,61 @@ #include <com/sun/star/lang/Locale.idl> #include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/i18n/TransliterationModules.idl> +#include <com/sun/star/i18n/TransliterationModulesNew.idl> //============================================================================= module com { module sun { module star { module i18n { //============================================================================= -/* Transliteration is a character to character translation but it is -not always one to one mapping between characters. Transliteration -modules are primarily used by collation, search and replace modules to -perform approximate search. It can also be used to format the numbers -in different numbering systems also.In order to select transliteration -modules for different purposes, it is classified with two attributes -namely ONE_TO_ONE and NUMERIC, A transliteration module is -ONE_TO_ONE if and only if it mapping between characters is one to one -like a-z to A-Z. Transliteration module of this type can be used as -choice in regular expressions based search/replace. If you choose a -transliterator IGNORE_CASE, the regular expression A-Z can be -transformed to a-z. A transliteration module can have attribute -NUMERIC if it tranliteates numbers in different languages like chinese -numbers to arabic numbers and vice versa. This mapping need not be one -to one it should be primaily used by number formatting and parsing -methods.A transliteration module is ONE_TO_ONE_NUMERIC if it offers -both 1-1 mapping and handles number also. There could be a three -transliteration module for each pair of formats say uppercase , -lowercase ie upper to lower , lower to uppper and ignore case.Search, -Collation module present the user with option ignore case*/ + +/** + Character conversions like case folding or Hiragana to Katakana. + + <p> Transliteration is a character to character conversion but it is + not always a one to one mapping between characters. Transliteration + modules are primarily used by collation, and search and replace + modules to perform approximate search. It can also be used to format + the numbers in different numbering systems. <p/> + + <p> In order to select transliteration modules for different + purposes, they are classified with attributes of + <type>TransliterationType</type>. <p/> + + <p> For Western languages there would be three transliteration + modules available to compare two mixed case strings: upper to lower, + lower to upper, and ignore case. </p> + + <p> A typical calling sequence of transliteration is + <ol> + <li> getAvailableModules() </li> + <li> loadModulesByImplNames() </li> + <li> equals() </li> + </ol> + or another one is + <ol> + <li> loadModule() </li> + <li> transliterate() </li> + </ol> + </p> + +*/ /* comment: * 0. - * All the IGNORE-type functionalities (Range, Equals) are based on mapping. - * except Equals() method in IGNORE_CASE, which is based on Locale-independent + * All the IGNORE-type functionalities (Range, equals) are based on mapping. + * except equals() method in IGNORE_CASE, which is based on Locale-independent * casefolding * ( This second assumption is very complicated and may cause confusion of use) * - - - - - - - * 1. * We are assuming Upper to Lower mapping as one of transliteration. * The mapping depends on Locale. - * Upper <-> Lower methods are just wrappers to provide Equals() and Range() + * Upper <-> Lower methods are just wrappers to provide equals() and Range() * * 2. - * Equals() in IGNORE_CASE module is locale-independent and + * equals() in IGNORE_CASE module is locale-independent and * we don't provide locale-sensitive ones. * The reason we provided locale-independent ones is that IGNORE_CASE is mainly * dedicated to StarOffice internal code. @@ -126,322 +133,231 @@ Collation module present the user with option ignore case*/ * "LOWERCASE_UPPERCASE", "IGNORE_CASE", there is no registered name. */ -/* Typical calling sequence of Transliteration is - * - * (1) getAvailableModules () - * - * (2) loadModulesByImplNames () - * - * (3) equals () - * - * Or another one is - * (1) loadModule () - * - * (2) transliterate () - * - */ -enum TransliterationModulesNew -{ - UPPERCASE_LOWERCASE = 1, - LOWERCASE_UPPERCASE = 2, - HALFWIDTH_FULLWIDTH = 3, - FULLWIDTH_HALFWIDTH = 4, - KATAKANA_HIRAGANA = 5, - HIRAGANA_KATAKANA = 6, - IGNORE_CASE = 7, - IGNORE_KANA = 8, // ja_JP - IGNORE_WIDTH = 9, // ja_JP - ignoreTraditionalKanji_ja_JP = 10, - ignoreTraditionalKana_ja_JP = 11, - ignoreMinusSign_ja_JP = 12, - ignoreIterationMark_ja_JP = 13, - ignoreSeparator_ja_JP = 14, - ignoreZiZu_ja_JP = 15, - ignoreBaFa_ja_JP = 16, - ignoreTiJi_ja_JP = 17, - ignoreHyuByu_ja_JP = 18, - ignoreSeZe_ja_JP = 19, - ignoreIandEfollowedByYa_ja_JP = 20, - ignoreKiKuFollowedBySa_ja_JP = 21, - ignoreSize_ja_JP = 22, - ignoreProlongedSoundMark_ja_JP = 23, - ignoreMiddleDot_ja_JP = 24, - ignoreSpace_ja_JP = 25, - smallToLarge_ja_JP = 26, - largeToSmall_ja_JP = 27, - NumToTextLower_zh_CN = 28, - NumToTextUpper_zh_CN = 29, - NumToTextLower_zh_TW = 30, - NumToTextUpper_zh_TW = 31, - NumToTextFormalHangul_ko = 32, - NumToTextFormalLower_ko = 33, - NumToTextFormalUpper_ko = 34, - NumToTextInformalHangul_ko = 35, - NumToTextInformalLower_ko = 36, - NumToTextInformalUpper_ko = 37, - NumToCharLower_zh_CN = 38, - NumToCharUpper_zh_CN = 39, - NumToCharLower_zh_TW = 40, - NumToCharUpper_zh_TW = 41, - NumToCharHangul_ko = 42, - NumToCharLower_ko = 43, - NumToCharUpper_ko = 44, - NumToCharFullwidth = 45, - NumToCharKanjiShort_ja_JP = 46, - TextToNumLower_zh_CN = 47, - TextToNumUpper_zh_CN = 48, - TextToNumLower_zh_TW = 49, - TextToNumUpper_zh_TW = 50, - TextToNumFormalHangul_ko = 51, - TextToNumFormalLower_ko = 52, - TextToNumFormalUpper_ko = 53, - TextToNumInformalHangul_ko = 54, - TextToNumInformalLower_ko = 55, - TextToNumInformalUpper_ko = 56, -// 2 Spaces for Japanese TextToNum - CharToNumLower_zh_CN = 59, - CharToNumUpper_zh_CN = 60, - CharToNumLower_zh_TW = 61, - CharToNumUpper_zh_TW = 62, - CharToNumHangul_ko = 63, - CharToNumLower_ko = 64, - CharToNumUpper_ko = 65, - END_OF_MODULE = 0 -}; // Interim - -enum TransliterationModules +interface XTransliteration: com::sun::star::uno::XInterface { - UPPERCASE_LOWERCASE = 1, - LOWERCASE_UPPERCASE = 2, - HALFWIDTH_FULLWIDTH = 3, - FULLWIDTH_HALFWIDTH = 4, - KATAKANA_HIRAGANA = 5, - HIRAGANA_KATAKANA = 6, - NumToTextLower_zh_CN = 7, - NumToTextUpper_zh_CN = 8, - NumToTextLower_zh_TW = 9, - NumToTextUpper_zh_TW = 10, - NumToTextFormalHangul_ko = 11, - NumToTextFormalLower_ko = 12, - NumToTextFormalUpper_ko = 13, - NON_IGNORE_MASK = 0x000000ff, - IGNORE_MASK = 0xffffff00, - IGNORE_CASE = 0x00000100, - IGNORE_KANA = 0x00000200, // ja_JP - IGNORE_WIDTH = 0x00000400, // ja_JP -// not yet use 0x00000800 - ignoreTraditionalKanji_ja_JP = 0x00001000, - ignoreTraditionalKana_ja_JP = 0x00002000, - ignoreMinusSign_ja_JP = 0x00004000, - ignoreIterationMark_ja_JP = 0x00008000, - ignoreSeparator_ja_JP = 0x00010000, - ignoreZiZu_ja_JP = 0x00020000, - ignoreBaFa_ja_JP = 0x00040000, - ignoreTiJi_ja_JP = 0x00080000, - ignoreHyuByu_ja_JP = 0x00100000, - ignoreSeZe_ja_JP = 0x00200000, - ignoreIandEfollowedByYa_ja_JP = 0x00400000, - ignoreKiKuFollowedBySa_ja_JP = 0x00800000, - ignoreSize_ja_JP = 0x01000000, - ignoreProlongedSoundMark_ja_JP = 0x02000000, - ignoreMiddleDot_ja_JP = 0x04000000, - ignoreSpace_ja_JP = 0x08000000, - smallToLarge_ja_JP = 0x10000000, - largeToSmall_ja_JP = 0x20000000, - END_OF_MODULE = 0 -}; -/* - the first 3 modules above are implemented depending on Locale. - UPPERCASE_LOWERCASE - LOWERCASE_UPPERCASE - IGNORE_CASE - */ + //------------------------------------------------------------------------ + /** Unique ASCII name to identify a module. This name is used + to get its localized name for menus, dialogs etc. The behavior + is undefined for <const>TransliterationType::CASCADE</const> + modules. + */ + string getName(); + + //------------------------------------------------------------------------ + /** Return the attribute(s) associated with this transliterator + object, as defined in <type>TransliterationType</type>. The + value is determined by the transliteration modules. For example, + for UPPERCASE_LOWERCASE, a ONE_TO_ONE is returned, for + IGNORE_CASE, IGNORE is returned. + */ + short getType(); + + //------------------------------------------------------------------------ + /** Load instance of predefined module - old style method. + */ + void loadModule( [in] TransliterationModules eModType, + [in] ::com::sun::star::lang::Locale aLocale ); + + //------------------------------------------------------------------------ + /** Load a sequence of instances of predefined modules - supersedes + method <member>XTransliteration::loadModule()</member>. + */ + void loadModuleNew( [in] sequence <TransliterationModulesNew> aModType, + [in] ::com::sun::star::lang::Locale aLocale ); + + //------------------------------------------------------------------------ + /** Load instance of UNO registered module. + + <p> Each transliteration module is registered under a different + service name. The convention for the service name is + com.sun.star.i18n.Transliteration.l10n.{implName}. The + {implName} is a unique name used to identify a module. The + implName is used to get a localized name for the transliteration + module. The implName is used in locale data to list the + available transliteration modules for the locale. There are some + transliteration modules that are always available. The names of + those modules are listed as enum + <type>TransliterationModules</type> names. For modules not + listed there it is possible to load them directly by their + implName. + + @param aImplName + The module's {implName} under which it is registered with + com.sun.star.i18n.Transliteration.l10n.{implName}. + */ + void loadModuleByImplName( [in] string aImplName, + [in] ::com::sun::star::lang::Locale aLocale ); + + //------------------------------------------------------------------------ + /** Load a sequence of instances of transliteration modules. + Output of one module is feeded as input to the next module in + the sequence. The object created by this call has + <type>TransliterationType</type> CASCADE and IGNORE types. + + @param aImplNameList + Only IGNORE type modules can be specified. + */ + void loadModulesByImplNames( [in] sequence <string> aImplNameList, + [in] ::com::sun::star::lang::Locale aLocale ); + + //------------------------------------------------------------------------ + /** List the available transliteration modules for a given locale. + It can be filtered based on its type. + + @param nType + A bitmask field of values defined in + <type>TransliterationType</type> + */ + sequence<string> getAvailableModules( + [in] ::com::sun::star::lang::Locale aLocale, + [in] short nType ); + + + //------------------------------------------------------------------------ + /** Transliterate a substring. This method can be called if the + object doesn't have <type>TransliterationType</type> IGNORE + attribute. + + @param aStr + The input string. + + @param nStartPos + Start position within aStr from where transliteration starts. + + @param nCount + Number of codepoints to be transliterated. + + @param rOffset + To find the grapheme of input string corresponding to the + grapheme of output string, rOffset provides the offset array + whose index is the offset of output string, the element + containing the position within the input string before + transliteration. + */ + string transliterate( [in] string aInStr, [in] long nStartPos, + [in] long nCount, [out] sequence <long> rOffset ); + + //------------------------------------------------------------------------ + /** @deprecated + For internal use, this method is supported to get the + "transliteration", which equals() is based on. + */ + string folding( [in] string aInStr, [in] long nStartPos, + [in] long nCount, [out] sequence <long> rOffset ); + + //------------------------------------------------------------------------ + /** Match two substrings and find if they are equivalent as per this + transliteration. + + <p> This method can be called if the object has + <type>TransliterationType</type> IGNORE attribute. </p> + + <p> Returns the number of matched code points in any case, even if + strings are not equal, for example: <br/> + equals( "a", 0, 1, nMatch1, "aaa", 0, 3, nMatch2 ) <br/> + returns <FALSE/> and nMatch:=1 and nMatch2:=1 <br/> + equals( "aab", 0, 3, nMatch1, "aaa", 0, 3, nMatch2 ) <br/> + returns <FALSE/> and nMatch:=2 and nMatch2:=2 <br/> </p> + + @param aStr1 + First string to match. + + @param nPos1 + Start position within aStr1. + + @param nCount1 + Number of code points to use of aStr1. + + @param rMatch1 + Returns number of matched code points in aStr1. + + @param aStr2 + Second string to match. + + @param nPos2 + Start position within aStr2. + + @param nCount2 + Number of code points to use of aStr2. + + @param rMatch2 + Returns number of matched code points in aStr2. + + @returns + <TRUE/> if the substrings are equal per this + transliteration <br/> + <FALSE/> else. + */ + + boolean equals( [in] string aStr1, [in] long nPos1, [in] long nCount1, + [out] long rMatch1, + [in] string aStr2, [in] long nPos2, [in] long nCount2, + [out] long rMatch2 ); + + //------------------------------------------------------------------------ + /** Transliterate one set of characters to another. + + <p> This method is intended for getting corresponding ranges and + can be called if the object has <type>TransliterationType</type> + IGNORE attribute. </p> + + <p> For example: generic CASE_IGNORE transliterateRange( "a", "i" ) + returns {"A","I","a","i"}, transliterateRange( "a", "a" ) + returns {"A","A","a","a"}. </p> + + <p> Use this transliteration to create regular expresssions like + [a-i] --> [A-Ia-i]. </p> -constants TransliterationType -{ - const short NONE= 0; - const short ONE_TO_ONE = 1; - const short NUMERIC = 2; - const short ONE_TO_ONE_NUMERIC = 3; - const short IGNORE = 4; - const short CASCADE = 8; -}; + @returns + String sequence containing corresponding transliterated + pairs of characters to represent a range. + */ + sequence <string> transliterateRange( [in] string aStr1, [in] string aStr2 ); + + //------------------------------------------------------------------------ + /** Compare 2 substrings. -/* - non-IGNORE type module provide transliterate() - IGNORE type moudule provide equals(), transliterateRang() - */ + @param aStr1 + First string. + @param nOff1 + Offset (from 0) of the first substring. -interface XTransliteration: com::sun::star::uno::XInterface -{ + @param nLen1 + Length (from offset) of the first substring. + + @param aStr2 + Second string. + + @param nOff2 + Offset (from 0) of the second substring. - /* - Unique name to idenify this module in ASCII ; This name is used to get its localized name - for Menu, dialog etc - For CASCADE, behavior is undefined. - */ - - string getName (); - - - /* - Return the attribute associated with this transliterator object as - defined in TransliterationType - This value is determined by the TransliterationModules or implName. - For example, for UPPERCASE_LOWERCASE, ONE_TO_ONE is returned; - for IGNORE_CASE, IGNORE is returned. - */ - short getType (); - - - /* Transliteration modules can be created by different APIs.Each - transliteration module is registered under different service - name. The convention for the service name is - com.sun.star.L10N.transliteration.<implname>. The <implname> is a - unique name used to identify this module. This implName is used - to get localized name for this transliteration module. This - implname is used in locael data to list the available - transliteration modules for this locale. There are some - transliteration modules which are always available.The name of - those modules are listed in enum TransliterationModules. These - modules need be loaded as separate UNO service.This exception is - to load upper/lower while installing staroffice (at this moment - UNO is not available) */ - - /* Load instance of predefined module - Will be phase out */ - void loadModule([in] TransliterationModules modType, - [in] ::com::sun::star::lang::Locale rLocale); - - /* Load instance of predefined module - Interim, will replace above method */ - void loadModuleNew([in] sequence <TransliterationModulesNew> modType, - [in] ::com::sun::star::lang::Locale rLocale); - - /* Load instance from UNO */ - void loadModuleByImplName( [in] string implName, - [in] ::com::sun::star::lang::Locale rLocale); - - /* Create a instance of transliteration module from existing - transliteration module. Output of one module is given as input to - next one in the sequence. - the object created by this call has CASCADE and IGNORE type. - Only IGNORE type object can be specified as implNameList - */ - void loadModulesByImplNames ([in] sequence <string> implNamelist, - [in] ::com::sun::star::lang::Locale rLocale); - - /* List the available transliteration module for given locale. It - can be filtered based on its type. sType is a bitmask field and - can have one of the values defined in TransliterationModules - */ - sequence<string> - getAvailableModules ( [in] ::com::sun::star::lang::Locale rLocale ,[in] short sType ); - - - /* Transliterate input string and return a output string, nCount is - number of codepoints to be transliterated. To find the grapheme of inStr - corresponding to the grapheme of output string, offset provide the - offset array whose index is the offset of output string. - This method can be called when the object doesn't have IGNORE attribute. - Returning String length is nCount - */ - string transliterate ([in] string inStr, [in] long startPos,[in] long nCount, - [out] sequence <long> offset); - - /* - For internal use, this method is supported to get the 'trasliteration', - which Equals is based on. - */ - string folding([in] string inStr, [in] long startPos,[in] long nCount, - [out] sequence <long> offset); - - - - /* Match the two strings and find if the two strings are equivalent - as per this transliteration. Return the number of matched code - points as arguments nMatch1, nMatch2 - If the returned value is True, the strings are equivalent - as per this transliteration - This method can be called when the object has IGNORE attribute. - */ - boolean equals ([in] string str1, [in] long pos1, [in] long nCount1, [out] long nMatch1, - [in] string str2, [in] long pos2, [in] long nCount2, [out] long nMatch2); - - /* - fuzzy pattern matching. return the position of content. - */ - // long transliterateMatch ( - // [in] string content, [in] long pos1, [in] long nCount1, - // [in] string pattern, [in] long pos2, [in] long nCount2); - - - /* - Transliterates one set of characters by another. - return string sequences contains coressponding transliterated - paris of characters for representing range. - ex: generic CASE_IGNORE transliterateRange ("a", "i") returns - "A","I","a", and "i". - e.g.: transliterateRange ("a", "a") may return 'A', 'A', 'a', 'a'. - This method can be called when the object has IGNORE attribute. - - This method is intended for getting corresponding ranges. - User use transliteration to create reg exp like [a-i] --> [A-Ia-i]. - After that he or she search [A-Ia-i] pattern in some content. - */ - sequence <string> transliterateRange ([in] string str1, [in] string str2); - - - - /** compares 2 sub-strings - - @param s1 - first String - - @param off1 - offset (from 0) of the first substring - - @param len1 - length (from offset) of the first substring - - @param s2 - second String - - @param off2 - offset (from 0) of the second substring - - @param len2 - length (from offset) of the second substring - - @returns - 1 if the first string is more than second string - 0 if the first string is equals to second string - -1 if the first string is less than second string - */ - long compareSubstring([in] string s1, [in] long off1, [in] long len1, - [in] string s2, [in] long off2, [in] long len2); - - /** compares 2 strings - - @param s1 - first String - - @param s2 - second String - - @returns - 1 if the first string is more than second string - 0 if the first string is equals to second string - -1 if the first string is less than second string - */ - long compareString([in] string s1, [in] string s2); + @param nLen2 + Length (from offset) of the second substring. -}; + @returns + 1 if the first substring is greater than the second substring <br/> + 0 if the first substring is equal to the second substring <br/> + -1 if the first substring is less than the second substring + */ + long compareSubstring( [in] string aStr1, [in] long nOff1, [in] long nLen1, + [in] string aStr2, [in] long nOff2, [in] long nLen2 ); -//============================================================================= + //------------------------------------------------------------------------ + /** Compare 2 strings. -}; }; }; }; + @returns + 1 if the first string is greater than the second string <br/> + 0 if the first string is equal to the second string <br/> + -1 if the first string is less than the second string + */ + long compareString( [in] string aStr1, [in] string aStr2 ); +}; +//============================================================================= +}; }; }; }; +//============================================================================= #endif diff --git a/offapi/com/sun/star/i18n/reservedWords.idl b/offapi/com/sun/star/i18n/reservedWords.idl new file mode 100644 index 000000000000..3a23e8612d9a --- /dev/null +++ b/offapi/com/sun/star/i18n/reservedWords.idl @@ -0,0 +1,106 @@ +/************************************************************************* + * + * $RCSfile: reservedWords.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:05:51 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_i18n_reservedWords_idl__ +#define __com_sun_star_i18n_reservedWords_idl__ + +//============================================================================ + +module com { module sun { module star { module i18n { + +//============================================================================ + +/** + Offsets into the sequence of strings returned by + <member>XLocaleData::getReservedWord()</member>. + + @see XLocaleData + for links to DTD of XML locale data files. + */ + +constants reservedWords +{ + /// "true" + const short TRUE_WORD = 0; + /// "false" + const short FALSE_WORD = 1; + /// "1st quarter" + const short QUARTER1_WORD = 2; + /// "2nd quarter" + const short QUARTER2_WORD = 3; + /// "3rd quarter" + const short QUARTER3_WORD = 4; + /// "4th quarter" + const short QUARTER4_WORD = 5; + /// "above" + const short ABOVE_WORD = 6; + /// "below" + const short BELOW_WORD = 7; + + //! Yes, this must be the count of known reserved words and one more than + //! the maximum number used above! + /// Count of known reserved words. + const short COUNT = 8; +}; + +//============================================================================ +}; }; }; }; +//============================================================================ +#endif diff --git a/offapi/com/sun/star/installation/InstallationCheck.idl b/offapi/com/sun/star/installation/InstallationCheck.idl index c449f5ffa6d3..ec0ab0f92721 100644 --- a/offapi/com/sun/star/installation/InstallationCheck.idl +++ b/offapi/com/sun/star/installation/InstallationCheck.idl @@ -2,9 +2,9 @@ * * $RCSfile: InstallationCheck.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,10 @@ fix any missing RegistryKey of fonts which still reside in the font directory. </p> <p>If it is possbile to fix, the method returns <TRUE/>. - </p>@see XInstallationCheck + </p> + + @see XInstallationCheck + @deprecated */ service InstallationCheck { @@ -95,6 +98,12 @@ service InstallationCheck /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/07/29 09:53:09 mi + review -> module is deprecated + + Revision 1.5 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/14 12:53:37 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/installation/InstallationCheckService.idl b/offapi/com/sun/star/installation/InstallationCheckService.idl index f487f381197c..be724ef02028 100644 --- a/offapi/com/sun/star/installation/InstallationCheckService.idl +++ b/offapi/com/sun/star/installation/InstallationCheckService.idl @@ -2,9 +2,9 @@ * * $RCSfile: InstallationCheckService.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,15 @@ module com { module sun { module star { module installation { //============================================================================= /** This service is a simple implementation of the interface XInstallationCheck. - <P> - This implementation only checks the fonts "StarBats" and "StarMath". + + <p>This implementation only checks the fonts "StarBats" and "StarMath". When running under Win32 the methods check and checkWithDialog will try to fix any missing RegistryKey of fonts which still reside in the font directory. - If fixing is possible the methods returns TRUE. + If fixing is possible the methods returns TRUE.</p> @version 1.0 @author Berndt Reinhold @see XInstallationCheck - </P> + @deprecated */ service InstallationCheckService { @@ -95,6 +95,12 @@ service InstallationCheckService /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/29 09:53:09 mi + review -> module is deprecated + + Revision 1.3 2000/11/08 12:43:18 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:23 hjs initial import diff --git a/offapi/com/sun/star/installation/InternetSettings.idl b/offapi/com/sun/star/installation/InternetSettings.idl index 729ab42c1658..c7ccde1a5a4c 100644 --- a/offapi/com/sun/star/installation/InternetSettings.idl +++ b/offapi/com/sun/star/installation/InternetSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: InternetSettings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= -// DocMerge: empty anyway +/// @deprecated service InternetSettings { // DocMerge: empty anyway @@ -86,6 +86,12 @@ service InternetSettings /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/29 09:53:09 mi + review -> module is deprecated + + Revision 1.3 2000/11/08 12:43:18 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:23 hjs initial import diff --git a/offapi/com/sun/star/installation/ProtDlgRes.idl b/offapi/com/sun/star/installation/ProtDlgRes.idl index b02a46c605e5..73d735e2cc07 100644 --- a/offapi/com/sun/star/installation/ProtDlgRes.idl +++ b/offapi/com/sun/star/installation/ProtDlgRes.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtDlgRes.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,8 +68,9 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::installation::ProtDlgRes /** contains the status of a dialog with an 'always display Checkbox'. + + @deprecated */ enum ProtDlgRes { @@ -105,6 +106,12 @@ enum ProtDlgRes /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/07/29 09:53:10 mi + review -> module is deprecated + + Revision 1.4 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:18 mi moved from api diff --git a/offapi/com/sun/star/installation/ProtocolHandlerCheck.idl b/offapi/com/sun/star/installation/ProtocolHandlerCheck.idl index 09dfaad5587b..2bdd0c3be181 100644 --- a/offapi/com/sun/star/installation/ProtocolHandlerCheck.idl +++ b/offapi/com/sun/star/installation/ProtocolHandlerCheck.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtocolHandlerCheck.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= -// DocMerge: empty anyway +/// @deprecated service ProtocolHandlerCheck { // DocMerge: empty anyway @@ -86,6 +86,12 @@ service ProtocolHandlerCheck /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/07/29 09:53:10 mi + review -> module is deprecated + + Revision 1.3 2000/11/08 12:43:18 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:23 hjs initial import diff --git a/offapi/com/sun/star/installation/ProtocolHandlerCheckService.idl b/offapi/com/sun/star/installation/ProtocolHandlerCheckService.idl index 2a8f3012262b..de71c6091c00 100644 --- a/offapi/com/sun/star/installation/ProtocolHandlerCheckService.idl +++ b/offapi/com/sun/star/installation/ProtocolHandlerCheckService.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtocolHandlerCheckService.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module installation { //============================================================================= -/** +/** @deprecated */ service ProtocolHandlerCheckService { @@ -86,6 +86,12 @@ service ProtocolHandlerCheckService /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/07/29 09:53:11 mi + review -> module is deprecated + + Revision 1.4 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:18 mi moved from api diff --git a/offapi/com/sun/star/installation/XInstallationCheck.idl b/offapi/com/sun/star/installation/XInstallationCheck.idl index 7a225e87ee2f..f24e000ee48d 100644 --- a/offapi/com/sun/star/installation/XInstallationCheck.idl +++ b/offapi/com/sun/star/installation/XInstallationCheck.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInstallationCheck.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,13 +68,14 @@ //============================================================================= - module com { module sun { module star { module installation { +module com { module sun { module star { module installation { //============================================================================= // DocMerge from xml: interface com::sun::star::installation::XInstallationCheck /** a flag called "suppressed", changes the action of check and checkWithDialog - @see com::sun::star::uno::XInterface + @see com::sun::star::uno::XInterface + @deprecated */ interface XInstallationCheck: com::sun::star::uno::XInterface { @@ -147,6 +148,12 @@ interface XInstallationCheck: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/07/29 09:53:11 mi + review -> module is deprecated + + Revision 1.6 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/03/16 16:41:27 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/installation/XProtocolHandlerCheck.idl b/offapi/com/sun/star/installation/XProtocolHandlerCheck.idl index a3fa41dd195a..682ab47e8451 100644 --- a/offapi/com/sun/star/installation/XProtocolHandlerCheck.idl +++ b/offapi/com/sun/star/installation/XProtocolHandlerCheck.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProtocolHandlerCheck.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,11 @@ //============================================================================= - module com { module sun { module star { module installation { +module com { module sun { module star { module installation { //============================================================================= -// DocMerge: empty anyway +/// @deprecated interface XProtocolHandlerCheck: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -125,6 +125,12 @@ interface XProtocolHandlerCheck: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/07/29 09:53:12 mi + review -> module is deprecated + + Revision 1.5 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:27 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/installation/protocols.idl b/offapi/com/sun/star/installation/protocols.idl index dd3f9763db42..fdb07da6e358 100644 --- a/offapi/com/sun/star/installation/protocols.idl +++ b/offapi/com/sun/star/installation/protocols.idl @@ -2,9 +2,9 @@ * * $RCSfile: protocols.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 15:56:10 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:05:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,11 +68,12 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::installation::protocols /** A protocol-handler is a part of StarOffice which performs the comunication on a paticular protocol. This can be HTTP, FTP, HTTPS, MAILTO, or NEWS. An implementation of this interface should be able to check/set all of these protocols. + + @deprecated */ constants protocols { @@ -127,6 +128,12 @@ constants protocols /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/07/29 09:53:11 mi + review -> module is deprecated + + Revision 1.4 2001/11/15 15:56:10 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:18 mi moved from api diff --git a/offapi/com/sun/star/linguistic2/DictionaryEvent.idl b/offapi/com/sun/star/linguistic2/DictionaryEvent.idl index 36aa1447c881..8b13d102d92f 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryEvent.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryEvent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,9 +82,9 @@ module com { module sun { module star { module linguistic2 { It consists of an event type and may supply an affected dictionary entry.</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::linguistic2::XDictionaryEventListener - @see com::sun::star::lang::EventObject + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type> + @see <type scope="com::sun::star::lang">EventObject</type> */ struct DictionaryEvent : com::sun::star::lang::EventObject { @@ -94,17 +94,17 @@ struct DictionaryEvent : com::sun::star::lang::EventObject <p>This must be the value of a single flag. No combinations are allowed.</p> - @see com::sun::star::linguistic2::DictionaryEventFlags + @see <type scope="com::sun::star::linguistic2">DictionaryEventFlags</type> */ short nEvent; //------------------------------------------------------------------------- - /** is the affected dictionary entry (if any). + /** is the affected dictionary entry (if any). <p>It must be set if an entry was added or deleted, otherwise it should be empty.</p> - @see com::sun::star::linguistic2::XDictionaryEntry + @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type> */ com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry; diff --git a/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl b/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl index 12665556cef3..6c613193054e 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryEventFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryEventFlags.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-04-03 18:39:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,10 +69,10 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** flags used for the event type in dictionary events. - <P>These flags represent the types of event that a dictionary + <P>These flags represent the type of events that a dictionary may broadcast.</P> - @see com::sun::star::linguistic2::DictionaryEvent + @see <type scope="com::sun::star::linguistic2">DictionaryEvent</type> */ constants DictionaryEventFlags { diff --git a/offapi/com/sun/star/linguistic2/DictionaryList.idl b/offapi/com/sun/star/linguistic2/DictionaryList.idl index 123c0fa68219..5c2e867e937a 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryList.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryList.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tl $ $Date: 2000-12-04 14:12:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,9 +80,9 @@ interface XSearchableDictionaryList; <P>The active dictionaries of this list will be used for spellchecking and hyphenation.</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::linguistic2::XDictionaryList; - @see com::sun::star::linguistic2::XSearchableDictionaryList; + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryList</type> + @see <type scope="com::sun::star::linguistic2">XSearchableDictionaryList</type> */ service DictionaryList { diff --git a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl index 9be16aed444a..c62af0b61caa 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryListEvent.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,15 +81,16 @@ module com { module sun { module star { module linguistic2 { its listeners about certain events. Since the dictionary-list is able to collect several single events before broadcasting them to it's listeners the - integer argument may be a combination of several event types. + integer argument may be a combination (logical or) of several + event types. If more specific information about the events is requested by a listener, a sequence of all dictionary-list events since the last broadcasting will be supplied. Otherwise, that list will be empty.</P> - @see com::sun::star::linguistic2::XDictionaryList - @see com::sun::star::linguistic2::XDictionaryListEventListener - @see com::sun::star::lang::EventObject + @see <type scope="com::sun::star::linguistic2">DictionaryList</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <type scope="com::sun::star::lang">EventObject</type> */ struct DictionaryListEvent : com::sun::star::lang::EventObject { @@ -100,7 +101,7 @@ struct DictionaryListEvent : com::sun::star::lang::EventObject <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type> by applying the logical OR to them.</p> - @see com::sun::star::linguistic2::DictionaryListEventFlags + @see <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type> <!-- Dennis: Does the <type> tag change the display of its contents --> <!-- Thomas: AFAIK it should translate into a hyperlink or so. --> @@ -111,13 +112,11 @@ struct DictionaryListEvent : com::sun::star::lang::EventObject /** list of accumulated dictionary events. <p>It will be empty if all - <type scope="com::sun::star::linguistic2::"> - XDictionaryListEventListener</type> + <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> are satisfied with the the condensed representation of the - <member scope="com::sun::star::linguistic2"> - DictionaryListEvent::nCondensedEvent</member>.</p> + <member scope="com::sun::star::linguistic2">DictionaryListEvent::nCondensedEvent</member>.</p> - @see com::sun::star::linguistic2::DictionaryEvent + @see <type scope="com::sun::star::linguistic2">DictionaryEvent</type> */ sequence< com::sun::star::linguistic2::DictionaryEvent > aDictionaryEvents; diff --git a/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl b/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl index 1d06f1cbb1c1..da5f5bcaceec 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryListEventFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryListEventFlags.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: tl $ $Date: 2001-07-23 13:30:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,9 +72,9 @@ module com { module sun { module star { module linguistic2 { <P>These flags define the possible types for a dictionary-list event.</P> - @see com::sun::star::linguistic2::DictionaryListEvent - @see com::sun::star::linguistic2::XDictionaryListEventListener - @see com::sun::star::linguistic2::XDictionaryList + @see <type scope="com::sun::star::linguistic2">DictionaryListEvent</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryList</type> */ constants DictionaryListEventFlags { diff --git a/offapi/com/sun/star/linguistic2/DictionaryType.idl b/offapi/com/sun/star/linguistic2/DictionaryType.idl index 3e42128496ac..1c01df635e7b 100644 --- a/offapi/com/sun/star/linguistic2/DictionaryType.idl +++ b/offapi/com/sun/star/linguistic2/DictionaryType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DictionaryType.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,10 +71,12 @@ module com { module sun { module star { module linguistic2 { <P>This defines the type of a dictionary. It may be positive or negative. A positive dictionary may hold - only positive entries and a negative one only negative entries.</P> + only positive entries (words defined to be correct for spell + checking) and a negative one only negative entries (words defined + to be reported as incorrect by the spell checker).</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::linguistic2::XDictionaryEntry + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type> */ enum DictionaryType { diff --git a/offapi/com/sun/star/linguistic2/LinguProperties.idl b/offapi/com/sun/star/linguistic2/LinguProperties.idl index 94ecbf4b8e95..e7300c19dba0 100644 --- a/offapi/com/sun/star/linguistic2/LinguProperties.idl +++ b/offapi/com/sun/star/linguistic2/LinguProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinguProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,8 +95,6 @@ service LinguProperties /** defines whether new German spelling rules should be used for German text or not when doing spellchecking or hyphenation, or using the thesaurus. - - @deprecated */ [property] boolean IsGermanPreReform; @@ -147,14 +145,14 @@ service LinguProperties [property] short HyphMinWordLength; //------------------------------------------------------------------------- - /** the default language for new documents. + /** the default western language for new documents. */ [property] com::sun::star::lang::Locale DefaultLocale; //------------------------------------------------------------------------- /** defines whether interactive hyphenation should be performed without - requiring the user to select every hyphenation position after the user - has triggered the hyphenation. + requiring the user to select every hyphenation position after the user + has triggered the hyphenation. */ [property] boolean IsHyphAuto; diff --git a/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl b/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl index 86ec0076e820..1806afa3ff5e 100644 --- a/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl +++ b/offapi/com/sun/star/linguistic2/LinguServiceEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinguServiceEvent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,11 +79,11 @@ module com { module sun { module star { module linguistic2 { and/or the spelling of previously incorrect or correct words should be checked again.</P> - @see com::sun::star::linguistic2::XLinguServiceEventBroadcaster - @see com::sun::star::linguistic2::XLinguServiceEventListener - @see com::sun::star::linguistic2::SpellChecker - @see com::sun::star::linguistic2::Hyphenator - @see com::sun::star::lang::EventObject + @see <type scope="com::sun::star::linguistic2">XLinguServiceEventBroadcaster</type> + @see <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type> + @see <type scope="com::sun::star::linguistic2">SpellChecker</type> + @see <type scope="com::sun::star::linguistic2">Hyphenator</type> + @see <type scope="com::sun::star::lang">EventObject</type> */ struct LinguServiceEvent : com::sun::star::lang::EventObject { @@ -91,8 +91,7 @@ struct LinguServiceEvent : com::sun::star::lang::EventObject /** The type of event. <p>The value may be combined via logical OR from those values - defined in <type scope="com::sun::star::linguistic2"> - LinguServiceEventFlags</type></p> + defined in <type scope="com::sun::star::linguistic2">LinguServiceEventFlags</type></p> */ short nEvent; diff --git a/offapi/com/sun/star/linguistic2/LinguServiceManager.idl b/offapi/com/sun/star/linguistic2/LinguServiceManager.idl index 43d433a1c8db..eac11e49d9be 100644 --- a/offapi/com/sun/star/linguistic2/LinguServiceManager.idl +++ b/offapi/com/sun/star/linguistic2/LinguServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: LinguServiceManager.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tl $ $Date: 2000-12-04 14:13:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,13 +73,16 @@ module com { module sun { module star { module linguistic2 { interface XLinguServiceManager; +interface XAvailableLocales; //============================================================================= -/** offers linguistic functionality. +/** offers linguistic functionality. Is to be used to access spell checker, + hyphenator and thesaurus. */ service LinguServiceManager { interface com::sun::star::linguistic2::XLinguServiceManager; + interface com::sun::star::linguistic2::XAvailableLocales; interface com::sun::star::lang::XComponent; interface com::sun::star::lang::XServiceInfo; }; diff --git a/offapi/com/sun/star/linguistic2/SpellFailure.idl b/offapi/com/sun/star/linguistic2/SpellFailure.idl index f37a24595977..a3e4ad879603 100644 --- a/offapi/com/sun/star/linguistic2/SpellFailure.idl +++ b/offapi/com/sun/star/linguistic2/SpellFailure.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpellFailure.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 15:30:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,12 +69,12 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** these define the various return types for spellchecking to fail verification. - <P>A value of this type may be obtained as part of the + <P>A value of this type is part of the <type scope="com::sun::star::linguistic2">XSpellAlternatives</type> - interface that is the return type for an unsuccessfull + interface which is the return type for an unsuccessfull spelling attempt.</P> - @see com::sun::star::linguistic2::XSpellChecker + @see <type scope="com::sun::star::linguistic2">XSpellChecker</type> */ constants SpellFailure { @@ -84,7 +84,7 @@ constants SpellFailure const short IS_NEGATIVE_WORD = 2; //------------------------------------------------------------------------- - /** The caption of the word is wrong. + /** The capitalization of the word is wrong. */ const short CAPTION_ERROR = 3; diff --git a/offapi/com/sun/star/linguistic2/XAvailableLocales.idl b/offapi/com/sun/star/linguistic2/XAvailableLocales.idl index 8a72a4bbcb31..889a64f1df0a 100644 --- a/offapi/com/sun/star/linguistic2/XAvailableLocales.idl +++ b/offapi/com/sun/star/linguistic2/XAvailableLocales.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAvailableLocales.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: tl $ $Date: 2001-07-23 15:11:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,11 +77,16 @@ module com { module sun { module star { module linguistic2 { interface XAvailableLocales : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** retrieve the list of actual (not potential) supported - Locales for a given service + /** retrieve the list of supported languages (Locales). + + @see <type scope"com::sun::star::linguistic2">XSupportedLocales</type> @param aServiceName the name of the service to get the list of available Locales for. + @return + the list of locales supported by the whole of all registered + implementations of that service. The sequence will be empty + if there is no such language or the service is not known. */ sequence< com::sun::star::lang::Locale > getAvailableLocales( [in] string aServiceName ); diff --git a/offapi/com/sun/star/linguistic2/XDictionary.idl b/offapi/com/sun/star/linguistic2/XDictionary.idl index 6a946c28e7a5..2501d4a11e37 100644 --- a/offapi/com/sun/star/linguistic2/XDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XDictionary.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionary.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,8 +101,8 @@ module com { module sun { module star { module linguistic2 { spellcheck. An entry in a negative dictionary may supply a proposal for a word to be used instead of the one being used.</P> - @see com::sun::star::linguistic2::XDictionaryEvent - @see com::sun::star::container::XNamed + @see <type scope="com::sun::star::linguistic2">XDictionaryEvent</type> + @see <type scope="com::sun::star::container">XNamed</type> */ interface XDictionary : com::sun::star::container::XNamed { @@ -112,7 +112,7 @@ interface XDictionary : com::sun::star::container::XNamed @returns the type of the dictionary. - @see com::sun::star::linguistic2::DictionaryType + @see <type scope="com::sun::star::linguistic2">DictionaryType</type> */ com::sun::star::linguistic2::DictionaryType getDictionaryType(); @@ -120,7 +120,7 @@ interface XDictionary : com::sun::star::container::XNamed /** specifies whether the dictionary should be used or not . @param bAcvtivate - <TRUE/> if the dictionary should be used, <FALSE/> otherwise. + <TRUE/> if the dictionary should be used, <FALSE/> otherwise. */ void setActive( [in] boolean bActivate ); @@ -144,7 +144,7 @@ interface XDictionary : com::sun::star::container::XNamed @returns the language of the dictionary. - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::lang::Locale getLocale(); @@ -154,7 +154,7 @@ interface XDictionary : com::sun::star::container::XNamed @param aLocale the new language of the dictionary. - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::lang">Locale</type> */ void setLocale( [in] com::sun::star::lang::Locale aLocale ); @@ -168,7 +168,7 @@ interface XDictionary : com::sun::star::container::XNamed @param aWord the word to be looked for. - @see com::sun::star::linguistic2::XDictionaryEntry + @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type> */ com::sun::star::linguistic2::XDictionaryEntry getEntry( [in] string aWord ); @@ -187,11 +187,8 @@ interface XDictionary : com::sun::star::container::XNamed @returns <TRUE/> if the entry was successfully added <FALSE/> otherwise. - @see add - @see remove - @see isFull - @see com::sun::star::linguistic2::XDictionaryEntry - @see com::sun::star::linguistic2::DictionaryType + @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type> + @see <type scope="com::sun::star::linguistic2">DictionaryType</type> */ boolean addEntry( [in] com::sun::star::linguistic2::XDictionaryEntry xDicEntry ); @@ -218,10 +215,7 @@ interface XDictionary : com::sun::star::container::XNamed @returns <TRUE/> if the entry was successfully added, <FALSE/> otherwise. - @see addEntry - @see remove - @see isFull - @see com::sun::star::linguistic2::DictionaryType + @see <type scope="com::sun::star::linguistic2">DictionaryType</type> */ boolean add( [in] string aWord, @@ -237,9 +231,6 @@ interface XDictionary : com::sun::star::container::XNamed @returns <TRUE/> if the entry was successfully removed, <FALSE/> otherwise (especially if the entry was not found). - - @see addEntry - @see add */ boolean remove( [in] string aWord ); @@ -248,9 +239,6 @@ interface XDictionary : com::sun::star::container::XNamed @returns <TRUE/> if the dictionary is full and no further entry can be made, <FALSE/> otherwise. - - @see addEntry - @see add */ boolean isFull(); @@ -259,7 +247,7 @@ interface XDictionary : com::sun::star::container::XNamed @returns a sequence with all the entries of the dictionary. - @see com::sun::star::linguistic2::XDictionaryEntry + @see <type scope="com::sun::star::linguistic2">XDictionaryEntry</type> */ sequence<com::sun::star::linguistic2::XDictionaryEntry> getEntries(); @@ -274,20 +262,18 @@ interface XDictionary : com::sun::star::container::XNamed <P>On dictionary events, each entry in the listener list will be notified via a call to - <member scope="com::sun::star::linguistic2"> - XDictionaryEventListener::processDictionaryEvent</member>.</P> + <member scope="com::sun::star::linguistic2">XDictionaryEventListener::processDictionaryEvent</member>.</P> @param xListener the entry to be made, that is, the object that wants notifications. @returns <TRUE/> if the entry was successfully made, <FALSE/> otherwise. - If <member scope="com::sun::star::lang"> - XEventListener::disposing</member> was called before, - it will always fail. + If <member scope="com::sun::star::lang">XEventListener::disposing</member> was called before, + it will always fail. - @see removeDictionaryEventListener - @see com::sun::star::linguistic2::XDictionaryEventListener + @see <member scope="com::sun::star::linguistic2">XDictionary::removeDictionaryEventListener</member> + @see <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type> */ boolean addDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener ); @@ -302,8 +288,8 @@ interface XDictionary : com::sun::star::container::XNamed <TRUE/> if the object to be removed was found and removed, <FALSE/> if the object was not found in the list. - @see addDictionaryEventListener - @see com::sun::star::linguistic2::XDictionaryEventListener + @see <member scope="com::sun::star::linguistic2">XDictionary::addDictionaryEventListener</member> + @see <type scope="com::sun::star::linguistic2">XDictionaryEventListener</type> */ boolean removeDictionaryEventListener( [in] com::sun::star::linguistic2::XDictionaryEventListener xListener ); diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl index 9823971313c1..4be9d924329d 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryEntry.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,8 +91,8 @@ module com { module sun { module star { module linguistic2 { to be equal. Also a '.' at the end of the word will make no difference.</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::uno::XInterface + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::uno">XInterface</type> */ interface XDictionaryEntry : com::sun::star::uno::XInterface { @@ -108,8 +108,6 @@ interface XDictionaryEntry : com::sun::star::uno::XInterface @returns <TRUE/> if the word (entry) is a negative one and should not be used, <FALSE/> otherwise. - - @see getReplacementText */ boolean isNegative(); @@ -121,8 +119,6 @@ interface XDictionaryEntry : com::sun::star::uno::XInterface @returns the replacement text for a negative entry. An empty string indicates that no replacement text is provided. - - @see isNegative */ string getReplacementText(); diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl b/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl index 634e497914fb..2c1d1afeb707 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryEventListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 16:08:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,8 +81,8 @@ module com { module sun { module star { module linguistic2 { listeners about <type scope="com::sun::star::linguistic2">DictionaryEvent</type>s.</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::lang::XEventListener + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::lang">XEventListener</type> */ interface XDictionaryEventListener : com::sun::star::lang::XEventListener { @@ -92,7 +92,7 @@ interface XDictionaryEventListener : com::sun::star::lang::XEventListener @param aDicEvent the event to be notified of. - @see com::sun::star::linguistic2::DictionaryEvent + @see <type scope="com::sun::star::lang">DictionaryEvent</type> */ void processDictionaryEvent( [in] com::sun::star::linguistic2::DictionaryEvent aDicEvent ); diff --git a/offapi/com/sun/star/linguistic2/XDictionaryList.idl b/offapi/com/sun/star/linguistic2/XDictionaryList.idl index 246453e864dd..ed323893e0be 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryList.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,8 +85,8 @@ module com { module sun { module star { module linguistic2 { of dictionaries and additional information to be used for those purposes.</P> - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::uno::XInterface + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::uno">XInterface</type> */ interface XDictionaryList : com::sun::star::uno::XInterface { @@ -103,7 +103,7 @@ interface XDictionaryList : com::sun::star::uno::XInterface a sequence with an entry for every dictionary in the list. - @see com::sun::star::linguistic2::XDictionary + @see <type scope="com::sun::star::linguistic2">XDictionary</type> */ sequence<com::sun::star::linguistic2::XDictionary> getDictionaries(); @@ -117,7 +117,7 @@ interface XDictionaryList : com::sun::star::uno::XInterface @param aDictionaryName specifies the name of the dictionary to look for. - @see com::sun::star::linguistic2::XDictionary + @see <type scope="com::sun::star::linguistic2">XDictionary</type> */ com::sun::star::linguistic2::XDictionary getDictionaryByName( [in] string aDictionaryName ); @@ -135,8 +135,7 @@ interface XDictionaryList : com::sun::star::uno::XInterface @param xDictionary the dictionary to be added. - @see removeDictionary - @see com::sun::star::linguistic2::XDictionary + @see <type scope="com::sun::star::linguistic2">XDictionary</type> */ boolean addDictionary( [in] com::sun::star::linguistic2::XDictionary xDictionary ); @@ -155,8 +154,7 @@ interface XDictionaryList : com::sun::star::uno::XInterface @param xDictionary dictionary to be removed from the list of dictionaries. - @see addDictionary - @see com::sun::star::linguistic2::XDictionary + @see <type scope="com::sun::star::linguistic2">XDictionary</type> */ boolean removeDictionary( [in] com::sun::star::linguistic2::XDictionary xDictionary ); @@ -166,14 +164,12 @@ interface XDictionaryList : com::sun::star::uno::XInterface <P>On dictionary-list events, each entry in the listener list will be notified via a call to - <member scope="com::sun::star::linguistic2"> - XDictionaryListEventListener::processDictionaryListEvent</member>.</P> + <member scope="com::sun::star::linguistic2">XDictionaryListEventListener::processDictionaryListEvent</member>.</P> @returns <TRUE/> if the entry was made, <FALSE/> otherwise. - If <member scope="com::sun::star::lang"> - XEventListener::disposing</member> was called before, - it will always fail. + If <member scope="com::sun::star::lang">XEventListener::disposing</member> + was called before, it will always fail. @param xListener the object to be notified of dictionary-list events. @@ -182,9 +178,8 @@ interface XDictionaryList : com::sun::star::uno::XInterface </TRUE> if the listener requires more detailed event notification than usual. - @see removeDictionaryListEventListener - @see com::sun::star::linguistic2::XDictionaryListEventListener - @see com::sun::star::linguistic2::XDictionaryListEvent + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type> */ boolean addDictionaryListEventListener( [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener, @@ -200,8 +195,8 @@ interface XDictionaryList : com::sun::star::uno::XInterface @param xListener the object to be removed from the listener list. - @see addDictionaryListEventListener - @see com::sun::star::linguistic2::XDictionaryListEventListener + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type> */ boolean removeDictionaryListEventListener( [in] com::sun::star::linguistic2::XDictionaryListEventListener xListener ); @@ -217,9 +212,10 @@ interface XDictionaryList : com::sun::star::uno::XInterface @returns the current request level for event buffering. - @see com::sun::star::linguistic2::XDictionaryListEvent - @see com::sun::star::linguistic2::XDictionaryListEventListener - @see flushEvents + @see <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::endCollectEvents</member> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::flushEvents</member> */ short beginCollectEvents(); @@ -235,9 +231,10 @@ interface XDictionaryList : com::sun::star::uno::XInterface @returns the current request level for event buffering. - @see com::sun::star::linguistic2::XDictionaryListEvent - @see com::sun::star::linguistic2::XDictionaryListEventListener - @see flushEvents + @see <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::beginCollectEvents</member> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::flushEvents</member> */ short endCollectEvents(); @@ -248,8 +245,10 @@ interface XDictionaryList : com::sun::star::uno::XInterface @returns the current request level for event buffering. - @see com::sun::star::linguistic2::XDictionaryListEvent - @see com::sun::star::linguistic2::XDictionaryListEventListener + @see <type scope="com::sun::star::linguistic2">XDictionaryListEvent</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryListEventListener</type> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::beginCollectEvents</member> + @see <member scope="com::sun::star::linguistic2">XDictionaryList::endCollectEvents</member> */ short flushEvents(); @@ -276,9 +275,9 @@ interface XDictionaryList : com::sun::star::uno::XInterface if the XStorable interface is supported. It may be empty, which means the dictionary will not be persistent. - @see com::sun::star::linguistic2::XDictionary - @see com::sun::star::lang::Locale - @see com::sun::star::linguistic2::DictionaryType + @see <type scope="com::sun::star::linguistic2">XDictionary</type> + @see <type scope="com::sun::star::lang">Locale</type> + @see <type scope="com::sun::star::linguistic2">DictionaryType</type> */ com::sun::star::linguistic2::XDictionary createDictionary( [in] string aName, diff --git a/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl b/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl index 1dba152556f1..0d0f741e8299 100644 --- a/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XDictionaryListEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDictionaryListEventListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 16:22:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,8 +82,8 @@ module com { module sun { module star { module linguistic2 { listeners. Its single function will be called by the broadcasting dictionary-list in order to notify its registered listeners.</P> - @see com::sun::star::linguistic2::DictionaryListEvent - @see com::sun::star::linguistic2::XDictionaryList + @see <type scope="com::sun::star::linguistic2">DictionaryListEvent</type> + @see <type scope="com::sun::star::linguistic2">XDictionaryList</type> */ interface XDictionaryListEventListener : com::sun::star::lang::XEventListener { @@ -93,7 +93,7 @@ interface XDictionaryListEventListener : com::sun::star::lang::XEventListener @param aDicListEvent the event to be notified of. - @see com::sun::star::linguistic2::DictionaryListEvent + @see <type scope="com::sun::star::linguistic2">DictionaryListEvent</type> */ void processDictionaryListEvent( [in] com::sun::star::linguistic2::DictionaryListEvent aDicListEvent ); diff --git a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl index 18b06e809849..bf15235b133e 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenatedWord.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHyphenatedWord.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 16:27:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ module com { module sun { module star { module linguistic2 { <P>This interface is used as a return value for some of the hyphenator functions.</P> - @see com::sun::star::linguistic2::XHyphenator + @see <type scope="com::sun::star::linguistic2">XHyphenator</type> */ interface XHyphenatedWord : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/linguistic2/XHyphenator.idl b/offapi/com/sun/star/linguistic2/XHyphenator.idl index ff287d76f3c2..cd6eddef235e 100644 --- a/offapi/com/sun/star/linguistic2/XHyphenator.idl +++ b/offapi/com/sun/star/linguistic2/XHyphenator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHyphenator.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,8 +112,8 @@ module com { module sun { module star { module linguistic2 { fulfills all the restrictions implied by the properties MinLeading, MinTrailing and MinWordLength.</P> - @see com::sun::star::linguistic2::LinguProperties - @see com::sun::star::linguistic2::XSupportedLocales + @see <type scope="com::sun::star::linguistic2">LinguProperties</type> + @see <type scope="com::sun::star::linguistic2">XSupportedLocales</type> */ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales { @@ -149,8 +149,8 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales It is usually empty in order to use the default values supplied with the property set. - @see com::sun::star::linguistic2::XSupportedLocales - @see com::sun::star::linguistic2::XHyphenatedWord + @see <type scope="com::sun::star::linguistic2">XHyphenatedWord</type> + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::linguistic2::XHyphenatedWord hyphenate( [in] string aWord, @@ -197,8 +197,8 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales It is usually empty in order to use the default values supplied with the property set. - @see com::sun::star::linguistic2::XSupportedLocales - @see com::sun::star::linguistic2::XHyphenatedWord + @see <type scope="com::sun::star::linguistic2">XHyphenatedWord</type> + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::linguistic2::XHyphenatedWord queryAlternativeSpelling( [in] string aWord, @@ -230,8 +230,8 @@ interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales It is usually empty in order to use the default values supplied with the property set. - @see com::sun::star::linguistic2::XPossibleHyphens - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::linguistic2">XPossibleHyphens</type> + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::linguistic2::XPossibleHyphens createPossibleHyphens( [in] string aWord, diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl index 8c8384872d8e..7a3c9fe4ad31 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceEventBroadcaster.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,8 +88,8 @@ module com { module sun { module star { module linguistic2 { Thus, there should be no need to register as a listener for a specific implementation./P> - @see com::sun::star::linguistic2::XLinguServiceManager - @see com::sun::star::linguistic2::XLinguServiceEventListener + @see <type scope="com::sun::star::linguistic2">XLinguServiceManager</type> + @see <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type> */ interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl b/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl index 99f677b841bf..fb4b8c559187 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceEventListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 16:52:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,7 +83,7 @@ module com { module sun { module star { module linguistic2 { <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s. </P> - @see com::sun::star::linguistic2::XLinguServiceManager + @see <type scope="com::sun::star::linguistic2">XLinguServiceManager</type> */ interface XLinguServiceEventListener : com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl index b966be7b56f6..98151483fe4d 100644 --- a/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl +++ b/offapi/com/sun/star/linguistic2/XLinguServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinguServiceManager.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,9 +106,9 @@ module com { module sun { module star { module linguistic2 { <P> For the thesaurus, the behavior is the same when no meaning was found. </P> - @see com::sun::star::linguistic2::SpellChecker - @see com::sun::star::linguistic2::Hyphenator - @see com::sun::star::linguistic2::Thesaurus + @see <type scope="com::sun::star::linguistic2">SpellChecker</type> + @see <type scope="com::sun::star::linguistic2">Hyphenator</type> + @see <type scope="com::sun::star::linguistic2">Thesaurus</type> */ interface XLinguServiceManager : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/linguistic2/XMeaning.idl b/offapi/com/sun/star/linguistic2/XMeaning.idl index 8197a11075fc..3af99bef248f 100644 --- a/offapi/com/sun/star/linguistic2/XMeaning.idl +++ b/offapi/com/sun/star/linguistic2/XMeaning.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMeaning.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 17:09:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,7 @@ module com { module sun { module star { module linguistic2 { call and allows for retrieval of its synonyms. </P> - @see com::sun::star::linguistic2::XThesaurus + @see <type scope="com::sun::star::linguistic2">XThesaurus</type> */ interface XMeaning : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl b/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl index 7d08df03ee1d..00fb273af91b 100644 --- a/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl +++ b/offapi/com/sun/star/linguistic2/XPossibleHyphens.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPossibleHyphens.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,7 @@ module com { module sun { module star { module linguistic2 { position 9 you will get an additional "f" before the hyphen character.</P> - @see com::sun::star::linguistic2::XHyphenator + @see <type scope="com::sun::star::linguistic2">XHyphenator</type> */ interface XPossibleHyphens : com::sun::star::uno::XInterface { @@ -102,7 +102,7 @@ interface XPossibleHyphens : com::sun::star::uno::XInterface /** @returns the language of the hyphenated word. - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::lang::Locale getLocale(); @@ -122,10 +122,8 @@ interface XPossibleHyphens : com::sun::star::uno::XInterface an ascending sequence of numbers where each number is an offset within the original word which denotes a hyphenation position corresponding to one of the hyphens in the - 'getPossibleHyphens' string. - - @see getWord - @see getPossibleHyphens + string returned by + <member scope="com::sun::star::linguistic2">XPossibleHyphens::getPossibleHyphens</member>. */ sequence<short> getHyphenationPositions(); diff --git a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl index fdc16e245651..1ba0c196d632 100644 --- a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSearchableDictionaryList.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,7 +88,7 @@ module com { module sun { module star { module linguistic2 { the dictionary may hold entries of all langauges. <P> - @see com::sun::star::linguistic2::XDictionaryList + @see <type scope="com::sun::star::linguistic2">XDictionaryList</type> */ interface XSearchableDictionaryList : com::sun::star::linguistic2::XDictionaryList { diff --git a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl index f0560d9fa3b5..c42991bbcd02 100644 --- a/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl +++ b/offapi/com/sun/star/linguistic2/XSpellAlternatives.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpellAlternatives.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-04 17:21:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,7 @@ module com { module sun { module star { module linguistic2 { a failure-type that may specifiy why the word was not correct. </P> - @see com::sun::star::linguistic2::SpellFailure + @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> */ interface XSpellAlternatives : com::sun::star::uno::XInterface { @@ -107,7 +107,7 @@ interface XSpellAlternatives : com::sun::star::uno::XInterface @returns the type (reason) for spellchecking to have failed verification. - @see com::sun::star::linguistic2::SpellFailure + @see <tyoe scope="com::sun::star::linguistic2">SpellFailure</type> */ short getFailureType(); diff --git a/offapi/com/sun/star/linguistic2/XSpellChecker.idl b/offapi/com/sun/star/linguistic2/XSpellChecker.idl index 4389554e1178..77d9bb6bf0b2 100644 --- a/offapi/com/sun/star/linguistic2/XSpellChecker.idl +++ b/offapi/com/sun/star/linguistic2/XSpellChecker.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpellChecker.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,7 +93,7 @@ module com { module sun { module star { module linguistic2 { is correct or additionally, if it was misspelled, some proposals how it might be correctly written.</P> - @see com::sun::star::linguistic2::XSupportedLocales + @see <type scope="com::sun::star::linguistic2">XSupportedLocales</type> */ interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales { @@ -120,8 +120,7 @@ interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales It is usually empty in order to use the default values supplied with the property set. - @see com::sun::star::linguistic2::XSupportedLocales - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::lang">Locale</type> */ boolean isValid( [in] string aWord, @@ -153,9 +152,8 @@ interface XSpellChecker : com::sun::star::linguistic2::XSupportedLocales the property set. exception is raised.</P> - @see com::sun::star::linguistic2::XSupportedLocales - @see com::sun::star::linguistic2::XSpellAlternatives - @see com::sun::star::lang::Locale + @see <type scope="com::sun::star::linguistic2">XSpellAlternatives</type> + @see <type scope="com::sun::star::lang">Locale</type> */ com::sun::star::linguistic2::XSpellAlternatives spell( [in] string aWord, diff --git a/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl b/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl index 4afee14b48fd..f5481039733b 100644 --- a/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl +++ b/offapi/com/sun/star/linguistic2/XSupportedLanguages.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSupportedLanguages.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: arellano $ $Date: 2001-04-09 23:29:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,9 +76,6 @@ module com { module sun { module star { module linguistic2 { //============================================================================= /** @deprecated - - <P>Deprecated interface not guaranteed to be supported. Do not use this - for new implementations.</P> */ interface XSupportedLanguages : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl index aaee64d3e258..7e05fb453442 100644 --- a/offapi/com/sun/star/linguistic2/XSupportedLocales.idl +++ b/offapi/com/sun/star/linguistic2/XSupportedLocales.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSupportedLocales.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,8 +88,8 @@ module com { module sun { module star { module linguistic2 { can use. </P> - @see com::sun::star::lang::Locale - @see com::sun::star::uno::XInterface + @see <type scope="com::sun::star::lang">Locale</type> + @see <type scope="com::sun::star::uno">XInterface</type> */ interface XSupportedLocales : com::sun::star::uno::XInterface { @@ -97,8 +97,6 @@ interface XSupportedLocales : com::sun::star::uno::XInterface /** @returns the sequence of all supported languages. - - @see com::sun::star::lang::Locale */ sequence<com::sun::star::lang::Locale> getLocales(); @@ -110,8 +108,6 @@ interface XSupportedLocales : com::sun::star::uno::XInterface @returns <TRUE/> if the language is supported, otherwise <FALSE/>. - - @see com::sun::star::lang::Locale */ boolean hasLocale( [in] com::sun::star::lang::Locale aLocale ); }; diff --git a/offapi/com/sun/star/linguistic2/XThesaurus.idl b/offapi/com/sun/star/linguistic2/XThesaurus.idl index db5294519ec6..dc569f80649f 100644 --- a/offapi/com/sun/star/linguistic2/XThesaurus.idl +++ b/offapi/com/sun/star/linguistic2/XThesaurus.idl @@ -2,9 +2,9 @@ * * $RCSfile: XThesaurus.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:42:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,7 +90,7 @@ module com { module sun { module star { module linguistic2 { (or small text) with the same or similar meaning. </P> - @see com::sun::star::linguistic2::XSupportedLocales + @see <type scope="com::sun::star::linguistic2">XSupportedLocales</type> */ interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales { @@ -114,8 +114,8 @@ interface XThesaurus : com::sun::star::linguistic2::XSupportedLocales It is usually empty in order to use the default values supplied with the property set. - @see com::sun::star::lang::Locale - @see com::sun::star::linguistic2::XMeaning + @see <type scope="com::sun::star::lang">Locale</type> + @see <type scope="com::sun::star::linguistic2">XMeaning</type> */ sequence< com::sun::star::linguistic2::XMeaning > queryMeanings( [in] string aTerm, diff --git a/offapi/com/sun/star/modules.idl b/offapi/com/sun/star/modules.idl index d8a1efb9cbef..1d25d5eae932 100644 --- a/offapi/com/sun/star/modules.idl +++ b/offapi/com/sun/star/modules.idl @@ -1,232 +1,190 @@ +/************************************************************************* + * + * $RCSfile: modules.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:00:19 $ + * + * 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, 2001 + * + * 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: 2001 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_modules_idl__ +#define __com_sun_star_modules_idl__ + module com { module sun { module star { /// Java AWT-like user interface toolkit interface specifications for UNO. -module awk {}; - -/* -/<TD width=30%><A HREF="beans\/index.html">beans<\/A><\/TD>/ { print - print "<TD width=70%>Java beans-like property access and introspection.</TD>"; -getline; next } - -/<TD width=30%><A HREF="bridge\/index.html">bridge<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for building bridges to other component models.</TD>"; -getline; next } - -/<TD width=30%><A HREF="chart\/index.html">chart<\/A><\/TD>/ { print - print "<TD width=70%>Charting diagram interfaces.</TD>"; -getline; next } - -/<TD width=30%><A HREF="data\/index.html">data<\/A><\/TD>/ { print - print "<TD width=70%>Non-JDBC conform database interfaces <b>(deprecated)</d></TD>"; -getline; next } - -/<TD width=30%><A HREF="configuration\/index.html">configuration<\/A><\/TD>/ { print - print "<TD width=70%>Access to the tree of configuration data.</TD>"; -getline; next } - -/<TD width=30%><A HREF="connection\/index.html">connection<\/A><\/TD>/ { print - print "<TD width=70%>Data exchange interfaces for inter-process communication.</TD>"; -getline; next } - -/<TD width=30%><A HREF="container\/index.html">container<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for collections and containers.</TD>"; -getline; next } - -/<TD width=30%><A HREF="corba\/index.html">corba<\/A><\/TD>/ { print - print "<TD width=70%>Modules for IOP, IIOP and GIOP.</TD>"; -getline; next } +module awt {}; -/<TD width=30%><A HREF="data\/index.html">data<\/A><\/TD>/ { print - print "<TD width=70%>deprecated (StarOffice 5.2 only)</TD>"; -getline; next } +/// Charting diagram interfaces. +module chart {}; -/<TD width=30%><A HREF="datatransfer\/index.html">datatransfer<\/A><\/TD>/ { print - print "<TD width=70%>Clipboard and Drag&Drop interfaces.</TD>"; -getline; next } +/// Non-JDBC conform database interfaces <b>(deprecated)</d> +module data {}; -/<TD width=30%><A HREF="document\/index.html">document<\/A><\/TD>/ { print - print "<TD width=70%>Office document related interfaces.</TD>"; -getline; next } +/// Access to the tree of configuration data. +module configuration {}; -/<TD width=30%><A HREF="drawing\/index.html">drawing<\/A><\/TD>/ { print - print "<TD width=70%>Drawing and shape specific interfaces.</TD>"; -getline; next } +/// Clipboard and Drag&Drop interfaces. +module datatransfer {}; -/<TD width=30%><A HREF="form\/index.html">form<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for managing forms and controls.</TD>"; -getline; next } +/// Office document related interfaces. +module document {}; -/<TD width=30%><A HREF="formula\/index.html">formula<\/A><\/TD>/ { print - print "<TD width=70%>nterfaces for mathematical formulas.</TD>"; -getline; next } +/// Drawing and shape specific interfaces. +module drawing {}; -/<TD width=30%><A HREF="frame\/index.html">frame<\/A><\/TD>/ { print - print "<TD width=70%>Desktop environment framework interfaces.</TD>"; -getline; next } +/// Interfaces for managing forms and controls. +module form {}; -/<TD width=30%><A HREF="i18n\/index.html">i18n<\/A><\/TD>/ { print - print "<TD width=70%>Interface for internationalization (deprecated draft).</TD>"; -getline; next } +/// Interfaces for mathematical formulas. +module formula {}; -/<TD width=30%><A HREF="installation\/index.html">installation<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces to control installations.</TD>"; -getline; next } +/// Desktop environment framework interfaces. +module frame {}; -/<TD width=30%><A HREF="io\/index.html">io<\/A><\/TD>/ { print - print "<TD width=70%>General input/output interfaces.</TD>"; -getline; next } +/// Interface for internationalization (deprecated draft). +module i18n {}; -/<TD width=30%><A HREF="java\/index.html">java<\/A><\/TD>/ { print - print "<TD width=70%>Java to UNO connectivity interfaces.</TD>"; -getline; next } +/// Interfaces to control installations. +module installation {}; -/<TD width=30%><A HREF="lang\/index.html">lang<\/A><\/TD>/ { print - print "<TD width=70%>General UNO concepts like factories etc.</TD>"; -getline; next } +/// Spell checker, hyphenation and thesaurus interfaces. +module linguistic2 {}; -/<TD width=30%><A HREF="linguistic2\/index.html">linguistic2<\/A><\/TD>/ { print - print "<TD width=70%>Spell checker, hyphenation and thesaurus interfaces.</TD>"; -getline; next } +/// Interfaces for Mozilla integration. +module mozilla {}; -/<TD width=30%><A HREF="loader\/index.html">loader<\/A><\/TD>/ { print - print "<TD width=70%>Component implementation loader interfaces.</TD>"; -getline; next } +/// Interfaces to access package file formats. +module package {}; -/<TD width=30%><A HREF="mozilla\/index.html">mozilla<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for Mozilla integration.</TD>"; -getline; next } +/// Pretty Good Privacy (deprecated). +module pgp {}; -/<TD width=30%><A HREF="package\/index.html">package<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces to access package file formats.</TD>"; -getline; next } +/// Netscape-like plugin interfaces. +module plugin {}; -/<TD width=30%><A HREF="pgp\/index.html">pgp<\/A><\/TD>/ { print - print "<TD width=70%>Pretty Good Privacy.</TD>"; -getline; next } +/// Presentation specific interfaces. +module presentation {}; -/<TD width=30%><A HREF="plugin\/index.html">plugin<\/A><\/TD>/ { print - print "<TD width=70%>Netscape-like plugin interfaces."; -getline; next } +/// Interfaces to access (UI) resource files. +module resource {}; -/<TD width=30%><A HREF="presentation\/index.html">presentation<\/A><\/TD>/ { print - print "<TD width=70%>Presentation specific interfaces.</TD>"; -getline; next } +/// Interfaces for scanner control. +module scanner {}; -/<TD width=30%><A HREF="reflection\/index.html">reflection<\/A><\/TD>/ { print - print "<TD width=70%>Runtime object inspection / core reflection interfaces.</TD>"; -getline; next } +/// Basic interfaces for database access. +module sdb {}; -/<TD width=30%><A HREF="registry\/index.html">registry<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces to access registration databases.</TD>"; -getline; next } +/// Database component interfaces. +module sdbc {}; -/<TD width=30%><A HREF="resource\/index.html">resource<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces to access (UI) resource files.</TD>"; -getline; next } +/// High-level database component interfaces. +module sdbcx {}; -/<TD width=30%><A HREF="scanner\/index.html">scanner<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for scanner control.</TD>"; -getline; next } +/// Interfaces to control the setup process. +module setup {}; -/<TD width=30%><A HREF="script\/index.html">script<\/A><\/TD>/ { print - print "<TD width=70%>Scripting language bindings.</TD>"; -getline; next } +/// Spreadsheet specific interfaces. +module sheet {}; -/<TD width=30%><A HREF="sdb\/index.html">sdb<\/A><\/TD>/ { print - print "<TD width=70%>Basic interfaces for database access.</TD>"; -getline; next } +/// Formatting and layout style and stylesheet interfaces. +module style {}; -/<TD width=30%><A HREF="sdbc\/index.html">sdbc<\/A><\/TD>/ { print - print "<TD width=70%>Database component interfaces.</TD>"; -getline; next } +/// Interfaces for import/export of Scaleable Vector Format. +module svg {}; -/<TD width=30%><A HREF="sdbcx\/index.html">sdbcx<\/A><\/TD>/ { print - print "<TD width=70%>High-level database component interfaces.</TD>"; -getline; next } +/// Data synchronization interfaces (deprecated). +module sync {}; -/<TD width=30%><A HREF="security\/index.html">security<\/A><\/TD>/ { print - print "<TD width=70%>Interface for authorisation and authetification.</TD>"; -getline; next } +/// Data synchronization interfaces (new). +module sync2 {}; -/<TD width=30%><A HREF="setup\/index.html">setup<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces to control the setup process.</TD>"; -getline; next } +/// Table specific interfaces (for text and spreadsheet). +module table {}; -/<TD width=30%><A HREF="sheet\/index.html">sheet<\/A><\/TD>/ { print - print "<TD width=70%>Spreadsheet specific interfaces.</TD>"; -getline; next } +/// Task management interfaces. +module task {}; -/<TD width=30%><A HREF="style\/index.html">style<\/A><\/TD>/ { print - print "<TD width=70%>Formatting and layout style and stylesheet interfaces.</TD>"; -getline; next } +/// Test interfaces for core-reflection, introspection and marshalling. +module test {}; -/<TD width=30%><A HREF="svg\/index.html">svg<\/A><\/TD>/ { print - print "<TD width=70%>Interfaces for import/export of Scaleable Vector Format.</TD>"; -getline; next } +/// Text specific interfaces. +module text {}; -/<TD width=30%><A HREF="sync\/index.html">sync<\/A><\/TD>/ { print - print "<TD width=70%>Data synchronization interfaces (deprecated).</TD>"; -getline; next } +/// Universal Content Broker interfaces. +module ucb {}; -/<TD width=30%><A HREF="sync2\/index.html">sync2<\/A><\/TD>/ { print - print "<TD width=70%>Data synchronization interfaces (new).</TD>"; -getline; next } +/// Dialogs and other UI elements. +module ui {}; -/<TD width=30%><A HREF="table\/index.html">table<\/A><\/TD>/ { print - print "<TD width=70%>Table specific interfaces (for text and spreadsheet).</TD>"; -getline; next } +/// Miscellaneous interfaces for sorting, connecting objects etc. +module util {}; -/<TD width=30%><A HREF="task\/index.html">task<\/A><\/TD>/ { print - print "<TD width=70%>Task management interfaces.</TD>"; -getline; next } +/// Document view specfic interfaces (e.g. selection access and printing). +module view {}; -/<TD width=30%><A HREF="test\/index.html">test<\/A><\/TD>/ { print - print "<TD width=70%>Test interfaces for core-reflection, intropection and marshalling.</TD>"; -getline; next } +/// XML related interfaces. +module xml {}; -/<TD width=30%><A HREF="text\/index.html">text<\/A><\/TD>/ { print - print "<TD width=70%>Text specific interfaces.</TD>"; -getline; next } +/// Host operating system integration interfaces. +module system {}; -/<TD width=30%><A HREF="ucb\/index.html">ucb<\/A><\/TD>/ { print - print "<TD width=70%>Universal Content Broker interfaces.</TD>"; -getline; next } +/// Package file format interfaces. +module packages {}; -/<TD width=30%><A HREF="ui\/index.html">ui<\/A><\/TD>/ { print - print "<TD width=70%>Dialogs and other UI elements.</TD>"; -getline; next } - -/<TD width=30%><A HREF="uno\/index.html">uno<\/A><\/TD>/ { print - print "<TD width=70%>Basic UNO interfaces.</TD>"; -getline; next } - -/<TD width=30%><A HREF="util\/index.html">util<\/A><\/TD>/ { print - print "<TD width=70%>Miscellaneous interfaces for sorting, connecting objects etc.</TD>"; -getline; next } - -/<TD width=30%><A HREF="view\/index.html">view<\/A><\/TD>/ { print - print "<TD width=70%>Document view specfic interfaces (e.g. selection access and printing).</TD>"; -getline; next } - -/<TD width=30%><A HREF="xml\/index.html">xml<\/A><\/TD>/ { print - print "<TD width=70%>XML related interfaces.</TD>"; -getline; next } - -/<TD width=30%><A HREF="system\/index.html">system<\/A><\/TD>/ { print - print "<TD width=70%>host operating system integration interfaces.</TD>"; -getline; next } - -/<TD width=30%><A HREF="packages\/index.html">packages<\/A><\/TD>/ { print - print "<TD width=70%>package file format interfaces.</TD>"; -getline; next } - -/<TD width=30%><A HREF="image\/index.html">image<\/A><\/TD>/ { print - print "<TD width=70%>image manupulation interfaces.</TD>"; -getline; next } - -{ - print -} -*/ +/// image manupulation interfaces. +module image {}; }; }; }; + diff --git a/offapi/com/sun/star/mozilla/MenuMultipleChange.idl b/offapi/com/sun/star/mozilla/MenuMultipleChange.idl index efc3d9fbf1d2..a766e896d351 100644 --- a/offapi/com/sun/star/mozilla/MenuMultipleChange.idl +++ b/offapi/com/sun/star/mozilla/MenuMultipleChange.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuMultipleChange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ // DocMerge from idl: struct com::sun::star::mozilla::MenuMultipleChange -/** unique ID of this menu item +/** Explains properties of a menu item */ struct MenuMultipleChange { diff --git a/offapi/com/sun/star/mozilla/MenuProxy.idl b/offapi/com/sun/star/mozilla/MenuProxy.idl index 17d23c6d34bb..44c7f0bbf2e3 100644 --- a/offapi/com/sun/star/mozilla/MenuProxy.idl +++ b/offapi/com/sun/star/mozilla/MenuProxy.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuProxy.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,10 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from idl: service com::sun::star::mozilla::MenuProxy +/** Allows to execute dispatch for a menu item + and handles listeners for changes in menu items. + */ service MenuProxy { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/mozilla/MenuProxyListener.idl b/offapi/com/sun/star/mozilla/MenuProxyListener.idl index 4c4885c5a7c5..f47f84441714 100644 --- a/offapi/com/sun/star/mozilla/MenuProxyListener.idl +++ b/offapi/com/sun/star/mozilla/MenuProxyListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuProxyListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,9 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: service com::sun::star::mozilla::MenuProxyListener +/** Listens for changes in menu items. + */ service MenuProxyListener { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/mozilla/MenuSingleChange.idl b/offapi/com/sun/star/mozilla/MenuSingleChange.idl index 04f3c5592b67..22cbd2533a3c 100644 --- a/offapi/com/sun/star/mozilla/MenuSingleChange.idl +++ b/offapi/com/sun/star/mozilla/MenuSingleChange.idl @@ -2,9 +2,9 @@ * * $RCSfile: MenuSingleChange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ // DocMerge from idl: struct com::sun::star::mozilla::MenuSingleChange -/** unique ID of this menu item +/** Explains a change for a menu item */ struct MenuSingleChange { diff --git a/offapi/com/sun/star/mozilla/XCloseSessionListener.idl b/offapi/com/sun/star/mozilla/XCloseSessionListener.idl index 9c544192609b..0c47f6761fbf 100644 --- a/offapi/com/sun/star/mozilla/XCloseSessionListener.idl +++ b/offapi/com/sun/star/mozilla/XCloseSessionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCloseSessionListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,9 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XCloseSessionListener +/** Listener for closing of the corresponding session. +*/ interface XCloseSessionListener: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/mozilla/XMenuProxy.idl b/offapi/com/sun/star/mozilla/XMenuProxy.idl index 7cbd023f39a1..98cb2bb39ce1 100644 --- a/offapi/com/sun/star/mozilla/XMenuProxy.idl +++ b/offapi/com/sun/star/mozilla/XMenuProxy.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMenuProxy.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,10 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XMenuProxy +/** Allows to execute dispatch for a menu item + and handles listeners for changes in menu items. + */ interface XMenuProxy: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/mozilla/XMenuProxyListener.idl b/offapi/com/sun/star/mozilla/XMenuProxyListener.idl index 0bbc663531aa..4966d620b214 100644 --- a/offapi/com/sun/star/mozilla/XMenuProxyListener.idl +++ b/offapi/com/sun/star/mozilla/XMenuProxyListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMenuProxyListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:04:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,9 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XMenuProxyListener +/** Listens for changes in menu items. + */ interface XMenuProxyListener: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/mozilla/XPluginInstance.idl b/offapi/com/sun/star/mozilla/XPluginInstance.idl index dfe3ad4c7428..0ef0296b8cd5 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstance.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstance.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginInstance.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:04:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,10 @@ //============================================================================= -// DocMerge: empty anyway -/// @missing +// DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start +/** Allows to controll an office side plugin instance and to communicate with it. + This interface is oriented for communication with browsers plugins. + */ interface XPluginInstance: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -178,6 +180,12 @@ interface XPluginInstance: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8.2.1 2002/06/27 10:50:22 mav + fix comments + + Revision 1.8 2001/11/15 16:04:57 mi + proofreading and corrections from Richard Holt + Revision 1.7 2001/04/25 16:09:34 ssa #83025# documentation update diff --git a/offapi/com/sun/star/mozilla/XPluginInstanceNotifySink.idl b/offapi/com/sun/star/mozilla/XPluginInstanceNotifySink.idl index 7af859374cb5..a9a52db9719f 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstanceNotifySink.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstanceNotifySink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginInstanceNotifySink.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,11 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstanceNotifySink +/** Allows a plugin to get notification from office side + about status of new document opening. + This interface is oriented for communication with browsers plugins. + */ interface XPluginInstanceNotifySink: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -95,6 +99,12 @@ interface XPluginInstanceNotifySink: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.14.1 2002/06/27 10:50:23 mav + fix comments + + Revision 1.5 2001/04/25 16:09:34 ssa + #83025# documentation update + Revision 1.4 2001/03/16 16:41:29 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl b/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl index 55f67258cde5..cc0e302e8614 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginInstancePeer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,7 +88,10 @@ interface XPluginInstanceNotifySink; //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstancePeer +/** Allows to communicate with a plugin from the office side. + This interface is oriented for communication with browsers plugins. + */ interface XPluginInstancePeer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -201,6 +204,12 @@ interface XPluginInstancePeer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.14.1 2002/06/27 10:50:23 mav + fix comments + + Revision 1.5 2001/04/25 16:09:34 ssa + #83025# documentation update + Revision 1.4 2001/03/16 16:41:29 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl index d854692f7e55..f68430e4ec84 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginInstanceSyncPeer.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mav $ $Date: 2001-12-19 12:32:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,6 +75,10 @@ //============================================================================= +// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstanceSyncPeer +/** This interface is an extention for <type>XPluginInstancePeer</type> interface. + An object can support this interface in addition to <type>XPluginInstancePeer</type> interface. + */ interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -103,6 +107,12 @@ interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.2.1 2002/06/27 10:50:24 mav + fix comments + + Revision 1.2 2001/12/19 12:32:00 mav + #79295# syncronous call to the plugin + =============================================================================*/ #endif diff --git a/offapi/com/sun/star/mozilla/XPluginWindowPeer.idl b/offapi/com/sun/star/mozilla/XPluginWindowPeer.idl index 31df4c81a488..973a39ac5909 100644 --- a/offapi/com/sun/star/mozilla/XPluginWindowPeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginWindowPeer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginWindowPeer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,10 @@ //============================================================================= -// DocMerge: empty anyway +// DocMerge from xml: interface com::sun::star::mozilla::XPluginWindowPeer +/** Allows to notify a plugin from the office side about plugin window's child window creation. + This interface is oriented for communication with browsers plugins. + */ interface XPluginWindowPeer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- @@ -93,6 +96,12 @@ interface XPluginWindowPeer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.14.1 2002/06/27 10:50:24 mav + fix comments + + Revision 1.5 2001/04/25 16:09:34 ssa + #83025# documentation update + Revision 1.4 2001/03/16 16:41:29 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/mozilla/XRemoteServiceManagerProvider.idl b/offapi/com/sun/star/mozilla/XRemoteServiceManagerProvider.idl index 3b1189229e74..9e7b1e3de911 100644 --- a/offapi/com/sun/star/mozilla/XRemoteServiceManagerProvider.idl +++ b/offapi/com/sun/star/mozilla/XRemoteServiceManagerProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteServiceManagerProvider.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: ssa $ $Date: 2001-04-25 16:09:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:13 $ * * Copyright according the GNU Public License. * @@ -22,11 +22,10 @@ module com { module sun { module star { module mozilla { //============================================================================= -/** -*/ - - +/** Allows creation of the remote service manager for given session. + This interface is oriented for communication with browsers plugins. +*/ interface XRemoteServiceManagerProvider: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/packages/manifest/XManifestReader.idl b/offapi/com/sun/star/packages/manifest/XManifestReader.idl index 734b35d7a8a1..f8aeacaac2f4 100644 --- a/offapi/com/sun/star/packages/manifest/XManifestReader.idl +++ b/offapi/com/sun/star/packages/manifest/XManifestReader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XManifestReader.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mtg $ $Date: 2001-04-19 14:07:56 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,8 +81,9 @@ module com { module sun { module star { module packages { module manifest { //============================================================================= interface XManifestReader: com::sun::star::uno::XInterface { - /// Supplies the XManifestReader with an XInputStream to read from, reads - /// the data and returns it to the caller. + /** Supplies the XManifestReader with an XInputStream to read from, reads + the data and returns it to the caller. + */ sequence < sequence < com::sun::star::beans::PropertyValue > > readManifestSequence( [in] com::sun::star::io::XInputStream rStream ); }; }; }; }; }; }; diff --git a/offapi/com/sun/star/packages/manifest/XManifestWriter.idl b/offapi/com/sun/star/packages/manifest/XManifestWriter.idl index d8cd151c6fae..e700c2ecb4f6 100644 --- a/offapi/com/sun/star/packages/manifest/XManifestWriter.idl +++ b/offapi/com/sun/star/packages/manifest/XManifestWriter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XManifestWriter.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mtg $ $Date: 2001-04-19 14:07:56 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,8 +81,9 @@ module com { module sun { module star { module packages { module manifest { //============================================================================= interface XManifestWriter: com::sun::star::uno::XInterface { - /// Writes the supplied sequence of manifest entries to the supplied - /// XOutputStream + /** Writes the supplied sequence of manifest entries to the supplied + XOutputStream + */ void writeManifestSequence([in] com::sun::star::io::XOutputStream rStream, [in] sequence < sequence < com::sun::star::beans::PropertyValue > > rSequence ); }; diff --git a/offapi/com/sun/star/packages/zip/ZipConstants.idl b/offapi/com/sun/star/packages/zip/ZipConstants.idl index 6d329123e0b4..7c28a6a380c1 100644 --- a/offapi/com/sun/star/packages/zip/ZipConstants.idl +++ b/offapi/com/sun/star/packages/zip/ZipConstants.idl @@ -2,9 +2,9 @@ * * $RCSfile: ZipConstants.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mtg $ $Date: 2001-07-04 14:09:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,101 +73,269 @@ module com { module sun { module star { module packages { module zip { */ constants ZipConstants { - /*Compression method for the deflate algorithm (the only one currently - supported). + //------------------------------------------------------------------------- + /** Compression method for the deflate algorithm (the only one currently + supported). */ const short DEFLATED = 8; - /* Compression level for no compression. + + //------------------------------------------------------------------------- + /** Compression level for no compression. */ const short NO_COMPRESSION = 0; - /* Compression level for fastest compression + + //------------------------------------------------------------------------- + /** Compression level for fastest compression */ const short BEST_SPEED = 1; - /* Compression level for best compression + + //------------------------------------------------------------------------- + /** Compression level for best compression */ const short BEST_COMPRESSION = 9; - /* Default compression level. + + //------------------------------------------------------------------------- + /** Default compression level. */ const short DEFAULT_COMPRESSION = -1; - /* Compression strategy best used for data consisting mostly of small - values with a somewhat random distribution. Forces more Huffman - coding and less string matching. + + //------------------------------------------------------------------------- + /** Compression strategy best used for data consisting mostly of small + values with a somewhat random distribution. Forces more Huffman + coding and less string matching. */ const short FILTERED = 1; - /* Compression strategy for Huffman coding only. + + //------------------------------------------------------------------------- + /** Compression strategy for Huffman coding only. */ const short HUFFMAN_ONLY = 2; - /* Default compression strategy + + //------------------------------------------------------------------------- + /** Default compression strategy */ const short DEFAULT_STRATEGY = 0; - /* entry is uncompressed + + //------------------------------------------------------------------------- + /** entry is uncompressed */ const short STORED = 0; - /* entry is uncompressed + + //------------------------------------------------------------------------- + /** entry is uncompressed */ const short DEF_MEM_LEVEL = 8; - /* Header Signatures - */ - - const long LOCSIG = 0x04034b50; // "PK\003\004" - const long EXTSIG = 0x08074b50; // "PK\007\008" - const long CENSIG = 0x02014b50; // "PK\001\002" - const long ENDSIG = 0x06054b50; // "PK\005\006" - const long SPANSIG = 0x08074b50; // "PK\007\008" - - /* Header sizes in bytes (including signatures) - */ - const short LOCHDR = 30; // LOC header size - const short EXTHDR = 16; // EXT header size - const short CENHDR = 46; // CEN header size - const short ENDHDR = 22; // END header size - - /* Local file (LOC) header field offsets - */ - const short LOCVER = 4; // version needed to extract - const short LOCFLG = 6; // general purpose bit flags - const short LOCHOW = 8; // compression method - const short LOCTIM = 10; // modification time - const short LOCCRC = 14; // crc of uncompressed data - const short LOCSIZ = 18; // compressed data size - const short LOCLEN = 22; // uncompressed data size - const short LOCNAM = 26; // filename length - const short LOCEXT = 28; // extra field length - - /* Extra local (EXT) header field offsets - */ - const short EXTCRC = 4; // crc of uncompressed data - const short EXTSIZ = 8; // compressed size - const short EXTLEN = 12; // uncompressed size - - /* Central directory (CEN) header field offsets - */ - - const short CENVEM = 4; // version made by - const short CENVER = 6; // version needed to extract - const short CENFLG = 8; // general purpose bit flags - const short CENHOW = 10; // compression method - const short CENTIM = 12; // modification time - const short CENDAT = 14; // modification time - const short CENCRC = 16; // crc of uncompressed data - const short CENSIZ = 20; // compressed size - const short CENLEN = 24; // uncompressed size - const short CENNAM = 28; // length of filename - const short CENEXT = 30; // length of extra field - const short CENCOM = 32; // file comment length - const short CENDSK = 34; // disk number start - const short CENATT = 36; // internal file attributes - const short CENATX = 38; // external file attributes - const short CENOFF = 42; // offset of local header - - /* End of central directory (END) header field offsets - */ - const short ENDSUB = 8; // number of entries on this disk - const short ENDTOT = 10; // total number of entries - const short ENDSIZ = 12; // central directory size - const short ENDOFF = 16; // central directory offset - const short ENDCOM = 20; // size of zip file comment + //------------------------------------------------------------------------- + /** Header Signature: "PK\003\004" + */ + const long LOCSIG = 0x04034b50; + + //------------------------------------------------------------------------- + /** Header Signature: "PK\007\008" + */ + const long EXTSIG = 0x08074b50; + + //------------------------------------------------------------------------- + /** Header Signature: "PK\001\002" + */ + const long CENSIG = 0x02014b50; + + //------------------------------------------------------------------------- + /** Header Signature: "PK\005\006" + */ + const long ENDSIG = 0x06054b50; + + //------------------------------------------------------------------------- + /** Header Signature: "PK\007\008" + */ + const long SPANSIG = 0x08074b50; + + //------------------------------------------------------------------------- + /** LOC header size in bytes (including signatures) + */ + const short LOCHDR = 30; + + //------------------------------------------------------------------------- + /** EXT header size in bytes (including signatures) + */ + const short EXTHDR = 16; + + //------------------------------------------------------------------------- + /** CEN header size in bytes (including signatures) + */ + const short CENHDR = 46; + + //------------------------------------------------------------------------- + /** END header size in bytes (including signatures) + */ + const short ENDHDR = 22; + + //------------------------------------------------------------------------- + /// LOC LOC LOC + /** LOC header field "version needed to extract" offset + */ + const short LOCVER = 4; + + //------------------------------------------------------------------------- + /** LOC header field "general purpose bit flags" offset + */ + const short LOCFLG = 6; + + //------------------------------------------------------------------------- + /** LOC header field "compression method" offset + */ + const short LOCHOW = 8; + + //------------------------------------------------------------------------- + /** LOC header field "modification time" offset + */ + const short LOCTIM = 10; + + //------------------------------------------------------------------------- + /** LOC header field "crc of uncompressed data" offset + */ + const short LOCCRC = 14; + + //------------------------------------------------------------------------- + /** LOC header field "compressed data size" offset + */ + const short LOCSIZ = 18; + + //------------------------------------------------------------------------- + /** LOC header field "uncompressed data size" offset + */ + const short LOCLEN = 22; + + //------------------------------------------------------------------------- + /** LOC header field "filename length" offset + */ + const short LOCNAM = 26; + + //------------------------------------------------------------------------- + /** LOC header field "extra field length" offset + */ + const short LOCEXT = 28; + + //------------------------------------------------------------------------- + /** EXT header field "crc of uncompressed data" offsets + */ + const short EXTCRC = 4; + + //------------------------------------------------------------------------- + /** EXT header field "compressed size" offsets + */ + const short EXTSIZ = 8; + + //------------------------------------------------------------------------- + /** EXT header field "uncompressed size" offsets + */ + const short EXTLEN = 12; + + //------------------------------------------------------------------------- + /** CEN header field "version made by" offset + */ + const short CENVEM = 4; + + //------------------------------------------------------------------------- + /** CEN header field "version needed to extract" offset + */ + const short CENVER = 6; + + //------------------------------------------------------------------------- + /** CEN header field "general purpose bit flags" offset + */ + const short CENFLG = 8; + + //------------------------------------------------------------------------- + /** CEN header field "compression method" offset + */ + const short CENHOW = 10; + + //------------------------------------------------------------------------- + /** CEN header field "modification time" offset + */ + const short CENTIM = 12; + + //------------------------------------------------------------------------- + /** CEN header field "modification time" offset + */ + const short CENDAT = 14; + + //------------------------------------------------------------------------- + /** CEN header field "crc of uncompressed data" offset + */ + const short CENCRC = 16; + + //------------------------------------------------------------------------- + /** CEN header field "compressed size" offset + */ + const short CENSIZ = 20; + + //------------------------------------------------------------------------- + /** CEN header field "uncompressed size" offset + */ + const short CENLEN = 24; + + //------------------------------------------------------------------------- + /** CEN header field "length of filename" offset + */ + const short CENNAM = 28; + + //------------------------------------------------------------------------- + /** CEN header field "length of extra field" offset + */ + const short CENEXT = 30; + + //------------------------------------------------------------------------- + /** CEN header field "file comment length" offset + */ + const short CENCOM = 32; + + //------------------------------------------------------------------------- + /** CEN header field "disk number start" offset + */ + const short CENDSK = 34; + + //------------------------------------------------------------------------- + /** CEN header field "internal file attributes" offset + */ + const short CENATT = 36; + + //------------------------------------------------------------------------- + /** CEN header field "external file attributes" offset + */ + const short CENATX = 38; + + //------------------------------------------------------------------------- + /** CEN header field "offset of local header" offset + */ + const short CENOFF = 42; + + //------------------------------------------------------------------------- + /** END header field "number of entries on this disk" offset + */ + const short ENDSUB = 8; + + //------------------------------------------------------------------------- + /** END header field "total number of entries" offset + */ + const short ENDTOT = 10; + + //------------------------------------------------------------------------- + /** END header field "central directory size" offset + */ + const short ENDSIZ = 12; + + //------------------------------------------------------------------------- + /** END header field "central directory offset" offset + */ + const short ENDOFF = 16; + + //------------------------------------------------------------------------- + /** END header field "size of zip file comment" offset + */ + const short ENDCOM = 20; }; //============================================================================= diff --git a/offapi/com/sun/star/packages/zip/ZipEntry.idl b/offapi/com/sun/star/packages/zip/ZipEntry.idl index 375847327289..ca1e3dd25dde 100644 --- a/offapi/com/sun/star/packages/zip/ZipEntry.idl +++ b/offapi/com/sun/star/packages/zip/ZipEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: ZipEntry.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mtg $ $Date: 2001-07-04 14:09:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,40 +89,62 @@ module com { module sun { module star { module packages { module zip { struct ZipEntry { //------------------------------------------------------------------------- - /* version needed to extract + /** version needed to extract */ short nVersion; - /* bit flags + + //------------------------------------------------------------------------- + /** bit flags */ short nFlag; - /* compression method + + //------------------------------------------------------------------------- + /** compression method */ short nMethod; - /* modification time + + //------------------------------------------------------------------------- + /** modification time */ long nTime; - /* crc-32 of entry data + + //------------------------------------------------------------------------- + /** crc-32 of entry data */ long nCrc; - /* uncompressed size of entry data + + //------------------------------------------------------------------------- + /** uncompressed size of entry data */ long nCompressedSize; - /* uncompressed size of entry data + + //------------------------------------------------------------------------- + /** uncompressed size of entry data */ long nSize; - /* offset of LOC header + + //------------------------------------------------------------------------- + /** offset of LOC header */ long nOffset; - /* The number of the disk this entry is saved on + + //------------------------------------------------------------------------- + /** The number of the disk this entry is saved on */ short nDiskNumber; - /* the entry name + + //------------------------------------------------------------------------- + /** the entry name */ string sName; - /* optional extra field data for entry + + //------------------------------------------------------------------------- + /** optional extra field data for entry */ sequence<byte> extra; - /* optional comment + + //------------------------------------------------------------------------- + /** optional comment */ string sComment; }; diff --git a/offapi/com/sun/star/plugin/PluginDescription.idl b/offapi/com/sun/star/plugin/PluginDescription.idl index 748108eb69c9..f62f53e858b5 100644 --- a/offapi/com/sun/star/plugin/PluginDescription.idl +++ b/offapi/com/sun/star/plugin/PluginDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: PluginDescription.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:24:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,67 +68,23 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::plugin::PluginDescription -/** is a handle for one specific plugin shared object. - - <p>If there are multiple mimetypes and/or extensions, multiple - <type>PluginDescription</type> objects will be created.</p> - */ +/** Describes a specific plugin. If there are multiple mimetypes and/or + extensions, multiple <type>PluginDescription</type>s will be created. +*/ struct PluginDescription { - // DocMerge from xml: field com::sun::star::plugin::PluginDescription::PluginName - /** contains the plugin name (usually the shared object file name). - */ + /** the plugin's name (usually the shared object file name) */ string PluginName; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Mimetype - /** contains one mimetype for which this plugin should be registered. - */ + /** a mimetype for which this plugin should be registered */ string Mimetype; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Extension - /** contains the file extension for files of this type. - */ + /** the file extension for files the plugin can handle */ string Extension; - - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::plugin::PluginDescription::Description - /** contains a text description of the plugin. - */ + /** text description of the plugin */ string Description; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:28 hjs - initial import - - Revision 1.5 2000/09/11 11:52:34 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:02 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:41 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/PluginException.idl b/offapi/com/sun/star/plugin/PluginException.idl index 751d44256785..6ce26c3eb656 100644 --- a/offapi/com/sun/star/plugin/PluginException.idl +++ b/offapi/com/sun/star/plugin/PluginException.idl @@ -2,9 +2,9 @@ * * $RCSfile: PluginException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,38 +72,20 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::plugin::PluginException -/** indicates that an error occured in an NPN or NPP function call.@see XPlugin - @see XPluginContext - @see XPluginManager - */ +/** Indicates that an error occured in an NPN or NPP function call. + + @see XPlugin + @see XPluginContext + @see XPluginManager +*/ exception PluginException: com::sun::star::uno::Exception { - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::plugin::PluginException::ErrorCode - /** contains the original Netscape error code. - */ + /** original Netscape plugin error code */ short ErrorCode; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.3 2000/09/11 11:52:34 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/PluginManager.idl b/offapi/com/sun/star/plugin/PluginManager.idl index 9a0539054acf..4d780cec06b3 100644 --- a/offapi/com/sun/star/plugin/PluginManager.idl +++ b/offapi/com/sun/star/plugin/PluginManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: PluginManager.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,15 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::plugin::PluginManager -/** makes it possible to create plugins. - */ +/** This service manages all recognized Netscape plugins. +*/ service PluginManager { - // DocMerge: empty anyway interface com::sun::star::plugin::XPluginManager; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.3 2000/09/11 11:52:34 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/PluginMode.idl b/offapi/com/sun/star/plugin/PluginMode.idl index f31084541708..faf3ceca7211 100644 --- a/offapi/com/sun/star/plugin/PluginMode.idl +++ b/offapi/com/sun/star/plugin/PluginMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: PluginMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,42 +68,16 @@ //============================================================================= -// DocMerge: empty anyway constants PluginMode { - //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::1 - - // DocMerge: empty anyway + /** embedded into document */ const short EMBED = 1; - - //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::2 - - // DocMerge: empty anyway + /** full size */ const short FULL = 2; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.4 2000/09/11 11:52:34 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:42 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/PluginVariable.idl b/offapi/com/sun/star/plugin/PluginVariable.idl index 126ae17605a5..31f9f610292f 100644 --- a/offapi/com/sun/star/plugin/PluginVariable.idl +++ b/offapi/com/sun/star/plugin/PluginVariable.idl @@ -2,9 +2,9 @@ * * $RCSfile: PluginVariable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:24:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,57 +68,24 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::plugin::PluginVariable -/** describes the possible parameters to XPluginContext::getValue. - It describes what kind of object is requested - */ +/** Describes the possible parameters to XPluginContext::getValue. + It describes what kind of object is requested. +*/ enum PluginVariable { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR PluginVariable:: VxDisplay, - - // DocMerge from xml: value com::sun::star::plugin::PluginVariable::VxDisplay - /** XPluginContext::getValue will return the Xwindow Display pointer of + /** XPluginContext::getValue will return the XWindow display pointer of a display connection (UNIX only) - */ + */ VxDisplay, - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR PluginVariable:: VxtAppContext - - // DocMerge from xml: value com::sun::star::plugin::PluginVariable::VxtAppContext /** XPluginContext::getValue will return the global Xt application context (UNIX only) - */ + */ VxtAppContext - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.5 2000/09/11 11:52:35 mi - documentation merged from XML - - Revision 1.3 2000/03/17 13:15:29 pl - #74035# documentation - - Revision 1.2 2000/02/07 11:24:42 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/XPlugin.idl b/offapi/com/sun/star/plugin/XPlugin.idl index e28338e8af45..a9785a5481d6 100644 --- a/offapi/com/sun/star/plugin/XPlugin.idl +++ b/offapi/com/sun/star/plugin/XPlugin.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPlugin.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:24:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,16 +80,26 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::plugin::XPlugin -/** allows the container to control the plugin. - */ +/** This interface allows the container, e.g. document to control the plugin. +*/ interface XPlugin: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPlugin::provideNewStream - /** tells the plugin instance that a new stream is requested. - */ + /** Tells the plugin instance that a new stream is requested. + + @param mimetype + mime type of provided data + @param aSource + data source + @param url + url + @param length + number of bytes (if file) + @param lastmodified + time stamp of last modification (if file) + @param isfile + whether data comes from a file + @return true upon success + */ boolean provideNewStream( [in] string mimetype, [in] com::sun::star::io::XActiveDataSource aSource, [in] string url, @@ -97,31 +107,10 @@ interface XPlugin: com::sun::star::uno::XInterface [in] long lastmodified, [in] boolean isfile ) raises( com::sun::star::plugin::PluginException ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:31 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.3 2000/09/11 11:52:35 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/XPluginContext.idl b/offapi/com/sun/star/plugin/XPluginContext.idl index 40df6fe64f78..bdd87a4991bb 100644 --- a/offapi/com/sun/star/plugin/XPluginContext.idl +++ b/offapi/com/sun/star/plugin/XPluginContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginContext.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:24:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,52 +92,71 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::plugin::XPluginContext -/** implements the calls a plugin library can make on its browser. - - <p>A default context can be created by a <type>XPluginManager</type>. - - </p>@see XPluginManager - */ +/** Interface receiving calls from a plugin library. + A default context can be created using the <type>PluginManager</type>. +*/ interface XPluginContext: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XPluginContext::getValue - - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getValue - /** requests global application parameters like display connection on UNIX systems - */ + /** Requests global application parameters like display connection + on UNIX systems. + + @param xPlugin + plugin + @param aVariable + variable + @return value + */ string getValue( [in] com::sun::star::plugin::XPlugin xPlugin, [in] com::sun::star::plugin::PluginVariable aVariable ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getURLNotify - /** requests a notification of completion of the operation on an URL. - */ + /** Requests a notification of completion of the operation on an URL. + + @param plugin + plugin + @param url + url + @param target + target frame + @param listener + event listener + */ void getURLNotify( [in] com::sun::star::plugin::XPlugin plugin, [in] string url, [in] string target, [in] com::sun::star::lang::XEventListener listener ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- + /** Requests an URL to be loaded into the frame target. - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getURL - /** requests an URL to be loaded into the frame target. - */ + @param plugin + plugin + @param url + url + @param target + target frame + */ void getURL( [in] com::sun::star::plugin::XPlugin plugin, [in] string url, [in] string target ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::postURLNotify - /** posts data from a buffer or file to an URL and receives a + /** Posts data from a buffer or file to an URL and receives a notification upon completion. - */ + + @param plugin + plugin + @param url + url + @param target + target frame + @param buf + data + @param file + whether data is from file + @param listener + event listener + */ void postURLNotify( [in] com::sun::star::plugin::XPlugin plugin, [in] string url, [in] string target, @@ -146,11 +165,19 @@ interface XPluginContext: com::sun::star::uno::XInterface [in] com::sun::star::lang::XEventListener listener ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::postURL - /** posts data from a buffer or file to an URL. - */ + /** Posts data from a buffer or file to an URL. + + @param plugin + plugin + @param url + url + @param target + target frame + @param buf + data + @param file + whether data is from file + */ void postURL( [in] com::sun::star::plugin::XPlugin plugin, [in] string url, [in] string target, @@ -158,67 +185,48 @@ interface XPluginContext: com::sun::star::uno::XInterface [in] boolean file ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::newStream - /** requests a new stream that is created by the plugin and consumed + /** Requests a new stream that is created by the plugin and consumed by the browser. - */ + + @param plugin + plugin + @param mimetype + mime type + @param target + target frame + @param aSource + data source + */ void newStream( [in] com::sun::star::plugin::XPlugin plugin, [in] string mimetype, [in] string target, [in] com::sun::star::io::XActiveDataSource aSource ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- + /** Displays a message in the browser status line. - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::displayStatusText - /** displays a message in the browser status line. - */ + @param plugin + plugin + @param message + message + */ void displayStatusText( [in] com::sun::star::plugin::XPlugin plugin, [in] string message ) raises( com::sun::star::plugin::PluginException ); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XPluginContext::getUserAgent + /** Returns an application dependent identification string. + This is the same string that is transmitted by a browser to an http server. - // DocMerge from xml: method com::sun::star::plugin::XPluginContext::getUserAgent - /** returns an application dependent identification string. This is - the same string that is transmitted by a browser to an http server. - */ + @param plugin + plugin + @return id + */ string getUserAgent( [in] com::sun::star::plugin::XPlugin plugin ) raises( com::sun::star::plugin::PluginException ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:31 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.5 2000/09/11 11:52:35 mi - documentation merged from XML - - Revision 1.3 2000/03/17 13:15:29 pl - #74035# documentation - - Revision 1.2 2000/02/07 11:24:42 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/plugin/XPluginManager.idl b/offapi/com/sun/star/plugin/XPluginManager.idl index 7c26b2df3195..04fe0ee977dc 100644 --- a/offapi/com/sun/star/plugin/XPluginManager.idl +++ b/offapi/com/sun/star/plugin/XPluginManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPluginManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:24:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,59 +96,71 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::plugin::XPluginManager -/** manages all plugin instances. - - <p>Plugins can be created only from an <type>XPluginManager</type>. - It also creates <type>XPluginContext</type> objects, - which can be overloaded by aggregation.</p> - */ +/** Interface accessing all recognized Netscape plugins. +*/ interface XPluginManager: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPluginContext - /** creates a default context. - - <p>This context depends on the service + /** Creates a default context. This context depends on the service <type scope="com::sun::star::frame">Desktop</type>.</p> - */ - com::sun::star::plugin::XPluginContext createPluginContext(); - //------------------------------------------------------------------------- - - // DOCUMENTATION CHANGED FOR XPluginManager::getPluginDescriptions + @return plugin context + */ + com::sun::star::plugin::XPluginContext createPluginContext(); + /** Returns the descriptions for all recognized plugins. - // DocMerge from idl: method com::sun::star::plugin::XPluginManager::getPluginDescriptions - /** returns the descriptions for all available plugins. - */ + @return plugin descriptions + */ sequence<com::sun::star::plugin::PluginDescription> getPluginDescriptions(); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPlugin - /** creates a new plugin instance. - */ - com::sun::star::plugin::XPlugin createPlugin( [in] com::sun::star::plugin::XPluginContext acontext, - [in] short mode, - [in] sequence<string> argn, - [in] sequence<string> argv, - [in] com::sun::star::plugin::PluginDescription plugintype ) - raises( com::sun::star::plugin::PluginException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::plugin::XPluginManager::createPluginFromURL - /** creates a new plugin instance. - */ - com::sun::star::plugin::XPlugin createPluginFromURL( [in] com::sun::star::plugin::XPluginContext acontext, - [in] short mode, - [in] sequence<string> argn, - [in] sequence<string> argv, - [in] com::sun::star::awt::XToolkit toolkit, - [in] com::sun::star::awt::XWindowPeer parent, - [in] string url ); + /** Creates a new plugin instance. + + @param acontext + plugin context + @param mode + plugin mode + @param argn + argument name list provided to plugin + @param argv + argument value list provided to plugin + @param plugintype + plugin description + @return plugin instance + */ + com::sun::star::plugin::XPlugin createPlugin( + [in] com::sun::star::plugin::XPluginContext acontext, + [in] short mode, + [in] sequence<string> argn, + [in] sequence<string> argv, + [in] com::sun::star::plugin::PluginDescription plugintype ) + raises( com::sun::star::plugin::PluginException ); + + /** Creates a new plugin instance. + + @param acontext + plugin context + @param mode + plugin mode + @param argn + argument name list provided to plugin + @param argv + argument value list provided to plugin + @param toolkit + toolkit to be used to get system window handle for plugin + @param parent + parent window + @param url + url + @return plugin instance + */ + com::sun::star::plugin::XPlugin createPluginFromURL( + [in] com::sun::star::plugin::XPluginContext acontext, + [in] short mode, + [in] sequence<string> argn, + [in] sequence<string> argv, + [in] com::sun::star::awt::XToolkit toolkit, + [in] com::sun::star::awt::XWindowPeer parent, + [in] string url ); }; @@ -156,30 +168,4 @@ interface XPluginManager: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:31 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:29 hjs - initial import - - Revision 1.5 2000/09/11 11:52:35 mi - documentation merged from XML - - Revision 1.3 2000/03/17 13:15:29 pl - #74035# documentation - - Revision 1.2 2000/02/07 11:24:42 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/presentation/AnimationSpeed.idl b/offapi/com/sun/star/presentation/AnimationSpeed.idl index b8e3f775023c..b5e0de63bd3a 100644 --- a/offapi/com/sun/star/presentation/AnimationSpeed.idl +++ b/offapi/com/sun/star/presentation/AnimationSpeed.idl @@ -2,9 +2,9 @@ * * $RCSfile: AnimationSpeed.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,31 +68,24 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::presentation::AnimationSpeed /** specifies the speed values of animation/fade effects. */ enum AnimationSpeed { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR AnimationSpeed:: SLOW, - // DocMerge from xml: value com::sun::star::presentation::AnimationSpeed::SLOW /** set the speed from the animation/fade to slow. */ SLOW, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR AnimationSpeed:: MEDIUM, - // DocMerge from xml: value com::sun::star::presentation::AnimationSpeed::MEDIUM /** set the speed from the animation/fade to medium. */ MEDIUM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR AnimationSpeed:: FAST - // DocMerge from xml: value com::sun::star::presentation::AnimationSpeed::FAST /** set the speed from the animation/fade to fast. */ FAST @@ -106,6 +99,12 @@ enum AnimationSpeed /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:30 hjs initial import diff --git a/offapi/com/sun/star/presentation/ClickAction.idl b/offapi/com/sun/star/presentation/ClickAction.idl index 0b05f3c0bb17..aae7bf55472f 100644 --- a/offapi/com/sun/star/presentation/ClickAction.idl +++ b/offapi/com/sun/star/presentation/ClickAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ClickAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:52:05 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,6 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::presentation::ClickAction /** This enumeration specifies the actions which can be processed when a user clicks on an object. */ @@ -76,98 +75,84 @@ enum ClickAction { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::NONE /** No action is performed on click. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::PREVPAGE /** The presentation jumps to the previous page. */ PREVPAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::NEXTPAGE /** The presentation jumps to the next page. */ NEXTPAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::FIRSTPAGE /** The presentation continues with the first page. */ FIRSTPAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::LASTPAGE /** The presentation continues with the last page. */ LASTPAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::BOOKMARK /** The presentation jumps to a bookmark. */ BOOKMARK, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::DOCUMENT /** The presentation jumps to another document. */ DOCUMENT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::INVISIBLE /** The object renders itself invisible after a click. */ INVISIBLE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::SOUND /** A sound is played after a click. */ SOUND, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::VERB /** An ole verb is performed on this object. */ VERB, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::VANISH /** The object vanishes with its effect. */ VANISH, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::PROGRAM /** Another program is executed after a click. */ PROGRAM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::MACRO /** A star basic macro is executed after the click. */ MACRO, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::presentation::ClickAction::STOPPRESENTATION /** The presentation is stopped after the click. */ STOPPRESENTATION @@ -181,6 +166,12 @@ enum ClickAction /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.4 2001/11/01 14:52:05 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:28 mi moved from api diff --git a/offapi/com/sun/star/presentation/CustomPresentation.idl b/offapi/com/sun/star/presentation/CustomPresentation.idl index f39955891829..ff5f3422700c 100644 --- a/offapi/com/sun/star/presentation/CustomPresentation.idl +++ b/offapi/com/sun/star/presentation/CustomPresentation.idl @@ -2,9 +2,9 @@ * * $RCSfile: CustomPresentation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,27 +76,19 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::CustomPresentation /** A custom presentation can show the pages of its presentation in a customized order. - - <p>Such a presentation can use certain pages more than once, but it does not necessarily use all of the pages.</p> */ service CustomPresentation { - - - // DocMerge from xml: service com::sun::star::presentation::CustomPresentation: interface com::sun::star::container::XIndexContainer /** This is the container of the names of pages in this customized presentation. */ interface com::sun::star::container::XIndexContainer; - - // DocMerge from xml: service com::sun::star::presentation::CustomPresentation: interface com::sun::star::container::XNamed /** This gives you access to the name of this customized presentation. */ interface com::sun::star::container::XNamed; @@ -110,6 +102,12 @@ service CustomPresentation /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:30 hjs initial import diff --git a/offapi/com/sun/star/presentation/CustomPresentationAccess.idl b/offapi/com/sun/star/presentation/CustomPresentationAccess.idl index 3616487a2ea6..e28c9b840ffb 100644 --- a/offapi/com/sun/star/presentation/CustomPresentationAccess.idl +++ b/offapi/com/sun/star/presentation/CustomPresentationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: CustomPresentationAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 14:59:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,14 +75,10 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::CustomPresentationAccess /** This is a container for custom presentations. */ service CustomPresentationAccess { - - - // DocMerge from xml: service com::sun::star::presentation::CustomPresentationAccess: interface com::sun::star::container::XNameContainer /** This is the container of the custom presentations. <p>Each instance in this container implements the service @@ -92,8 +88,6 @@ service CustomPresentationAccess */ interface com::sun::star::container::XNameContainer; - - // DocMerge from xml: service com::sun::star::presentation::CustomPresentationAccess: interface com::sun::star::lang::XSingleServiceFactory /** This interface lets you create empty instances of the service <type>CustomPresentation</type>. @@ -111,6 +105,12 @@ service CustomPresentationAccess /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.4 2000/12/19 14:59:03 mi + documentation sytax errors fixed + Revision 1.3 2000/11/08 12:43:28 mi moved from api diff --git a/offapi/com/sun/star/presentation/DrawPage.idl b/offapi/com/sun/star/presentation/DrawPage.idl index 2d38b0b204cc..7234f3a56c69 100644 --- a/offapi/com/sun/star/presentation/DrawPage.idl +++ b/offapi/com/sun/star/presentation/DrawPage.idl @@ -2,9 +2,9 @@ * * $RCSfile: DrawPage.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,28 +84,23 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::DrawPage /** This is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a - <type>PresentationDocument</type>.@see PresentationDocument + <type>PresentationDocument</type>. + + @see PresentationDocument */ service DrawPage { - // DocMerge: empty anyway service com::sun::star::drawing::DrawPage; - - // DocMerge from xml: service com::sun::star::presentation::DrawPage: service com::sun::star::document::LinkTarget /** Every page is a link target inside the document object model. */ service com::sun::star::document::LinkTarget; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::DrawPage::Change /** specifies how the page change is triggered. - - <p>If this is 0, the user must click to start each object animation and to change the page. If set to 1, the page is automatically switched. If it is set to 2, all object effects run @@ -115,7 +110,6 @@ service DrawPage //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::DrawPage::Duration /** If the property <member scope="com::sun::star::drawing">DrawPage::Change</member> is set to 1, this is the time in seconds this page is shown before switching to the next page. @@ -124,14 +118,12 @@ service DrawPage //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::DrawPage::Effect /** This is the effect that is used to fade in this page. */ [property] com::sun::star::presentation::FadeEffect Effect; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::DrawPage::Layout /** If this property is not ZERO, this number specifies a presentation layout for this page. */ @@ -139,11 +131,9 @@ service DrawPage //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::DrawPage::Speed /** defines the speed of the fade-in effect of this page. */ [property] com::sun::star::presentation::AnimationSpeed Speed; - }; //============================================================================= @@ -153,6 +143,12 @@ service DrawPage /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:30 hjs initial import diff --git a/offapi/com/sun/star/presentation/FadeEffect.idl b/offapi/com/sun/star/presentation/FadeEffect.idl index a5b20297782c..739a39b58c6f 100644 --- a/offapi/com/sun/star/presentation/FadeEffect.idl +++ b/offapi/com/sun/star/presentation/FadeEffect.idl @@ -2,9 +2,9 @@ * * $RCSfile: FadeEffect.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,463 +68,348 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::presentation::FadeEffect /** specifies the fade effects to fade one page into another. */ enum FadeEffect { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: NONE, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::NONE /** use no fade effects. */ NONE, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_LEFT /** use the fade effect 'Fade from Left'. */ FADE_FROM_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_TOP, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_TOP /** use the fade effect 'Fade from Top'. */ FADE_FROM_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_RIGHT /** use the fade effect 'Fade from Right'. */ FADE_FROM_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_BOTTOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_BOTTOM /** use the fade effect 'Fade from Bottom'. */ FADE_FROM_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_TO_CENTER, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_TO_CENTER /** use the fade effect 'Fade to Center'. */ FADE_TO_CENTER, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_CENTER, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_CENTER /** use the fade effect 'Fade from Center'. */ FADE_FROM_CENTER, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::MOVE_FROM_LEFT /** use the fade effect 'Move from Left'. */ MOVE_FROM_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_TOP, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::MOVE_FROM_TOP /** use the fade effect 'Move from Top'. */ MOVE_FROM_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::MOVE_FROM_RIGHT /** use the fade effect 'Move from Right'. */ MOVE_FROM_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_BOTTOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::MOVE_FROM_BOTTOM /** use the fade effect 'Move from Bottom'. */ MOVE_FROM_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: ROLL_FROM_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::ROLL_FROM_LEFT /** use the fade effect 'Roll from Left'. */ ROLL_FROM_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: ROLL_FROM_TOP, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::ROLL_FROM_TOP /** use the fade effect 'Roll from Top'. */ ROLL_FROM_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: ROLL_FROM_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::ROLL_FROM_RIGHT /** use the fade effect 'Roll from Right'. */ ROLL_FROM_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: ROLL_FROM_BOTTOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::ROLL_FROM_BOTTOM /** use the fade effect 'Roll from Bottom'. */ ROLL_FROM_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: VERTICAL_STRIPES, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::VERTICAL_STRIPES /** use the fade effect 'Vertical Stripes'. */ VERTICAL_STRIPES, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: HORIZONTAL_STRIPES, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::HORIZONTAL_STRIPES /** use the fade effect 'Horizontal Stripes'. */ HORIZONTAL_STRIPES, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: CLOCKWISE, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::CLOCKWISE /** use the fade effect 'Clockwise'. */ CLOCKWISE, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: COUNTERCLOCKWISE, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::COUNTERCLOCKWISE /** use the fade effect 'Counter Clockwise'. */ COUNTERCLOCKWISE, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_UPPERLEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_UPPERLEFT /** use the fade effect 'Fade from Upper Left'. */ FADE_FROM_UPPERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_UPPERRIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_UPPERRIGHT /** use the fade effect 'Fade from Upper Right'. */ FADE_FROM_UPPERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_LOWERLEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_LOWERLEFT /** use the fade effect 'Fade from Lower Left'. */ FADE_FROM_LOWERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: FADE_FROM_LOWERRIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::FADE_FROM_LOWERRIGHT /** use the fade effect 'Fade from Lower Right'. */ FADE_FROM_LOWERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: CLOSE_VERTICAL, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::CLOSE_VERTICAL /** use the fade effect 'Close Vertical'. */ CLOSE_VERTICAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: CLOSE_HORIZONTAL, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::CLOSE_HORIZONTAL /** use the fade effect 'Close Horizontal'. */ CLOSE_HORIZONTAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: OPEN_VERTICAL, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::OPEN_VERTICAL /** use the fade effect 'Open Vertical'. */ OPEN_VERTICAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: OPEN_HORIZONTAL, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::OPEN_HORIZONTAL /** use the fade effect 'Open Horizontal'. */ OPEN_HORIZONTAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: SPIRALIN_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::SPIRALIN_LEFT /** use the fade effect 'Spiral Inward Left'. */ SPIRALIN_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: SPIRALIN_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::SPIRALIN_RIGHT /** use the fade effect 'Spiral Inward Right'. */ SPIRALIN_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: SPIRALOUT_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::SPIRALOUT_LEFT /** use the fade effect 'Spiral Outward Left'. */ SPIRALOUT_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: SPIRALOUT_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::SPIRALOUT_RIGHT /** use the fade effect 'Spiral Outward Right'. */ SPIRALOUT_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: DISSOLVE, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::DISSOLVE /** use the fade effect 'Dissolve'. */ DISSOLVE, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: WAVYLINE_FROM_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::WAVYLINE_FROM_LEFT /** use the fade effect 'Wavy Line from Left'. */ WAVYLINE_FROM_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: WAVYLINE_FROM_TOP, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::WAVYLINE_FROM_TOP /** use the fade effect 'Wavy Line from Top'. */ WAVYLINE_FROM_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: WAVYLINE_FROM_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::WAVYLINE_FROM_RIGHT /** use the fade effect 'Wavy Line from Right'. */ WAVYLINE_FROM_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: WAVYLINE_FROM_BOTTOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::WAVYLINE_FROM_BOTTOM /** use the fade effect 'Wavy Line from Bottom'. */ WAVYLINE_FROM_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: RANDOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::RANDOM /** use the fade effect 'Random'. */ RANDOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: STRETCH_FROM_LEFT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::STRETCH_FROM_LEFT /** use the fade effect 'Stretch from Left'. */ STRETCH_FROM_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: STRETCH_FROM_TOP, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::STRETCH_FROM_TOP /** use the fade effect 'Stretch from Top'. */ STRETCH_FROM_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: STRETCH_FROM_RIGHT, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::STRETCH_FROM_RIGHT /** use the fade effect 'Stretch from Right'. */ STRETCH_FROM_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: STRETCH_FROM_BOTTOM, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::STRETCH_FROM_BOTTOM /** use the fade effect 'Stretch from Bottom'. */ STRETCH_FROM_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: VERTICAL_LINES, - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::VERTICAL_LINES /** use the fade effect 'Vertical Lines'. */ VERTICAL_LINES, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: HORIZONTAL_LINES - // DocMerge from xml: value com::sun::star::presentation::FadeEffect::HORIZONTAL_LINES /** use the fade effect 'Horizontal Lines'. */ HORIZONTAL_LINES, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_UPPERLEFT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::MOVE_FROM_UPPERLEFT /** use the fade effect 'Move from Upper Left'. */ MOVE_FROM_UPPERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_UPPERRIGHT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::MOVE_FROM_UPPERRIGHT /** use the fade effect 'Move from Upper Right'. */ MOVE_FROM_UPPERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_LOWERRIGHT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::MOVE_FROM_LOWERRIGHT /** use the fade effect 'Move from Lower Right'. */ MOVE_FROM_LOWERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: MOVE_FROM_LOWERLEFT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::MOVE_FROM_LOWERLEFT /** use the fade effect 'Move from Lower Left'. */ MOVE_FROM_LOWERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_LEFT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_LEFT /** use the fade effect 'Uncover to Left'. */ UNCOVER_TO_LEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_UPPERLEFT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_UPPERLEFT /** use the fade effect 'Uncover to Upper Left'. */ UNCOVER_TO_UPPERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_TOP - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_TOP /** use the fade effect 'Uncover to Top'. */ UNCOVER_TO_TOP, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_UPPERRIGHT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_UPPERRIGHT /** use the fade effect 'Uncover to Upper Right'. */ UNCOVER_TO_UPPERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_RIGHT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_RIGHT /** use the fade effect 'Uncover to Right'. */ UNCOVER_TO_RIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_LOWERRIGHT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_LOWERRIGHT /** use the fade effect 'Uncover to Lower Right'. */ UNCOVER_TO_LOWERRIGHT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_BOTTOM - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_BOTTOM /** use the fade effect 'Uncover to Bottom'. */ UNCOVER_TO_BOTTOM, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: UNCOVER_TO_LOWERLEFT - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::UNCOVER_TO_LOWERLEFT /** use the fade effect 'Uncover to Lower Left'. */ UNCOVER_TO_LOWERLEFT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: VERTICAL_CHECKERBOARD - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::VERTICAL_CHECKERBOARD /** use the fade effect 'Vertical Checkerboard'. */ VERTICAL_CHECKERBOARD, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR FadeEffect:: HORIZONTAL_CHECKERBOARD - // DocMerge from xml: value com::sun::star::presentation::fadeEffect::HORIZONTAL_CHECKERBOARD /** use the fade effect 'Horizontal Checkerboard'. */ HORIZONTAL_CHECKERBOARD @@ -537,6 +422,12 @@ enum FadeEffect /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.2 2000/10/30 12:13:23 ka added new Effects diff --git a/offapi/com/sun/star/presentation/OutlinerShape.idl b/offapi/com/sun/star/presentation/OutlinerShape.idl index 3add0236fd61..9beafb4d2b5b 100644 --- a/offapi/com/sun/star/presentation/OutlinerShape.idl +++ b/offapi/com/sun/star/presentation/OutlinerShape.idl @@ -2,9 +2,9 @@ * * $RCSfile: OutlinerShape.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,8 @@ #include <com/sun/star/presentation/Shape.idl> #endif -#ifndef __com_sun_star_drawing_Shape_idl__ -#include <com/sun/star/drawing/Shape.idl> +#ifndef __com_sun_star_drawing_TextShape_idl__ +#include <com/sun/star/drawing/TextShape.idl> #endif @@ -76,17 +76,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::OutlinerShape /** This service is implemented by the outline presentation shape. + + <p>Presentation shapes can be used in a presentation + page layouts and theire position and size is by default set + by the presentation shapes on the <type>MasterPage</type>. */ service OutlinerShape { - // DocMerge: empty anyway service com::sun::star::presentation::Shape; - // DocMerge: empty anyway - service com::sun::star::drawing::Shape; - + service com::sun::star::drawing::TextShape; }; //============================================================================= @@ -96,6 +96,12 @@ service OutlinerShape /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:31 hjs initial import diff --git a/offapi/com/sun/star/presentation/PageShape.idl b/offapi/com/sun/star/presentation/PageShape.idl new file mode 100644 index 000000000000..bb2d03e5e4ac --- /dev/null +++ b/offapi/com/sun/star/presentation/PageShape.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: PageShape.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:22 $ + * + * 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_presentation_PageShape_idl__ +#define __com_sun_star_presentation_PageShape_idl__ + +#ifndef __com_sun_star_presentation_Shape_idl__ +#include <com/sun/star/presentation/Shape.idl> +#endif + +#ifndef __com_sun_star_drawing_PageShape_idl__ +#include <com/sun/star/drawing/PageShape.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module presentation { + +//============================================================================= + +/** This service is implemented by the page presentation shape. + + <p>Presentation shapes can be used in a presentation + page layouts and theire position and size is by default set + by the presentation shapes on the <type>MasterPage</type>. + */ +service PageShape +{ + service com::sun::star::presentation::Shape; + + service com::sun::star::drawing::PageShape; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/presentation/Presentation.idl b/offapi/com/sun/star/presentation/Presentation.idl index 8b7eb5d3afb5..283559c84707 100644 --- a/offapi/com/sun/star/presentation/Presentation.idl +++ b/offapi/com/sun/star/presentation/Presentation.idl @@ -2,9 +2,9 @@ * * $RCSfile: Presentation.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 14:52:05 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,40 +76,34 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::Presentation /** This service is a presentation that is available from a - <code>PresentationDocument</code> via the - <code>XPresentationSupplier</code> interface. + <type>PresentationDocument</type> via the + <type>XPresentationSupplier</type> interface. */ service Presentation { - - - // DocMerge from xml: service com::sun::star::presentation::Presentation: interface com::sun::star::presentation::XPresentation /** lets you start and stop a presentation. - <p>It also gives you access to the more advanced features, like - rehearse timing and the live modes. + <p>It also gives you access to the more advanced features, like + rehearse timing and the live modes. */ interface com::sun::star::presentation::XPresentation; + //------------------------------------------------------------------------- - // DocMerge from xml: service com::sun::star::presentation::Presentation: interface com::sun::star::beans::XPropertySet /** This is the standard interface for access to the properties from this - service. + service. */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::AllowAnimations /** enables/disables the shape animations. */ [property] boolean AllowAnimations; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::CustomShow /** If this string is not empty, it contains the name of a customized show that is used for the presentation. */ @@ -117,7 +111,6 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::FirstPage /** If this string is not empty, it contains the name of the page where the presentation is started. */ @@ -125,7 +118,6 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsAlwaysOnTop /** If this property is set to <TRUE/>, the window of the presentation is always on top of all other windows. */ @@ -133,18 +125,14 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsAutomatic /** If this property is <TRUE/>, all pages are changed automatically. - - <p>This overrides the properties of the pages.</p> */ [property] boolean IsAutomatic; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsEndless /** If this property is set to <TRUE/>, the presentation is repeated endlessly. */ @@ -152,7 +140,6 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsFullScreen /** If this property is set to <TRUE/>, the presentation runs in full-screen mode. */ @@ -160,14 +147,12 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsLivePresentation /** With this property, you can set the presentation to live mode. */ [property] boolean IsLivePresentation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::IsMouseVisible /** If this property is <TRUE/>, the mouse is visible during the presentation. */ @@ -175,19 +160,15 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::Pause /** is the duration of the black screen after the presentation has finished. - - <p>If this is set to <literal>0</literal>, no black screen is shown.</p> */ [property] long Pause; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::StartWithNavigator /** If this is set to <TRUE/>, the Navigator is opened at the start of the presentation. */ @@ -195,11 +176,8 @@ service Presentation //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Presentation::UsePen /** If this is <TRUE/>, a pen is shown during presentation. - - <p>You can draw on the presentation with this pen.</p> */ [property] boolean UsePen; @@ -213,6 +191,12 @@ service Presentation /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.5 2001/11/01 14:52:05 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/14 12:53:38 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/presentation/PresentationDocument.idl b/offapi/com/sun/star/presentation/PresentationDocument.idl index 80cc523c74f6..37ea81242b05 100644 --- a/offapi/com/sun/star/presentation/PresentationDocument.idl +++ b/offapi/com/sun/star/presentation/PresentationDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: PresentationDocument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,35 +84,40 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::PresentationDocument /** This is the service provided by a presentation document. */ service PresentationDocument { - - - // DocMerge from xml: service com::sun::star::presentation::PresentationDocument: service com::sun::star::drawing::DrawingDocument /** This is a basic service for a drawing document. + + <p>The following services are available at the <type>com.sun.star.lang.XMultiServiceFactory</type> + only in a presentation application + + <ul> + <li><type>TitleTextShape</type></li> + <li><type>OutlinerShape</type></li> + <li><type>SubtitleShape</type></li> + <li><type>GraphicObjectShape</type></li> + <li><type>PageShape</type></li> + <li><type>OLE2Shape</type></li> + <li><type>ChartShape</type></li> + <li><type>NotesShape</type></li> + <li><type>HandoutShape</type></li> + </ul> */ service com::sun::star::drawing::DrawingDocument; - - // DocMerge from xml: service com::sun::star::presentation::PresentationDocument: interface com::sun::star::presentation::XPresentationSupplier /** lets you access the presentation of this document. */ interface com::sun::star::presentation::XPresentationSupplier; - - // DocMerge from xml: service com::sun::star::presentation::PresentationDocument: interface com::sun::star::presentation::XCustomPresentationSupplier /** lets you access the custom presentations of this - document. + document. */ interface com::sun::star::presentation::XCustomPresentationSupplier; - - // DocMerge from xml: service com::sun::star::presentation::PresentationDocument: interface com::sun::star::document::XLinkTargetSupplier /** gives you access to the first link hierarchy inside - a document, the pages. + a document, the pages. */ interface com::sun::star::document::XLinkTargetSupplier; @@ -125,6 +130,12 @@ service PresentationDocument /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:30 hjs initial import diff --git a/offapi/com/sun/star/presentation/PresentationRange.idl b/offapi/com/sun/star/presentation/PresentationRange.idl index 92e5b196cf6d..c5a11792c565 100644 --- a/offapi/com/sun/star/presentation/PresentationRange.idl +++ b/offapi/com/sun/star/presentation/PresentationRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: PresentationRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,31 +68,22 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::presentation::PresentationRange /** specifies which part of the presentation is to show. */ enum PresentationRange { - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PresentationRange:: PRESENTATIONRANGE_ALL, - - // DocMerge from xml: value com::sun::star::presentation::PresentationRange::PRESENTATIONRANGE_ALL /** use all slides. */ PRESENTATIONRANGE_ALL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PresentationRange:: PRESENTATIONRANGE_FROM_PAGE, - // DocMerge from xml: value com::sun::star::presentation::PresentationRange::PRESENTATIONRANGE_FROM_PAGE /** use only the active slide. */ PRESENTATIONRANGE_FROM_PAGE, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PresentationRange:: PRESENTATIONRANGE_INDIVIDUAL - // DocMerge from xml: value com::sun::star::presentation::PresentationRange::PRESENTATIONRANGE_INDIVIDUAL /** use an individual choice of slides. */ PRESENTATIONRANGE_INDIVIDUAL @@ -106,6 +97,12 @@ enum PresentationRange /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:31 hjs initial import diff --git a/offapi/com/sun/star/presentation/Shape.idl b/offapi/com/sun/star/presentation/Shape.idl index c388d0ecd38b..d5552f4dde3f 100644 --- a/offapi/com/sun/star/presentation/Shape.idl +++ b/offapi/com/sun/star/presentation/Shape.idl @@ -2,9 +2,9 @@ * * $RCSfile: Shape.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,25 +80,24 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::Shape -/** This is the service for a shape inside a presentation document. - */ +/** this service is supported from all shapes inside a <type>PresentationDocument</type>. + + + This usually enahnces objects of type <type>com::sun::star::drawing::Shape</type> with + presentation properties. +*/ service Shape { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::Bookmark /** is a generic URL for the property OnClick. */ [property] string Bookmark; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::DimColor /** This is the color for dimming this shape. - - <p>This color is used if the property <member scope="com::sun::star::drawing">Shape::DimPrev</member> is <TRUE/> and <member scope="com::sun::star::drawing">Shape::DimHide</member> is <FALSE/>.</p> */ @@ -106,7 +105,6 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::DimHide /** If this property and the property <member scope="com::sun::star::drawing">Shape::DimPrev</member> are both <TRUE/>, the shape is hidden instead of dimmed to a color. */ @@ -114,7 +112,6 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::DimPrevious /** If this property is <TRUE/>, this shape is dimmed to the color of property <member scope="com::sun::star::drawing">Shape::DimColor</member> after executing its animation effect. @@ -123,26 +120,20 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::Effect /** selects the animation effect of this shape. */ [property] com::sun::star::presentation::AnimationEffect Effect; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::IsEmptyPresentationObject /** If this is a default presentation object and if it is empty, this property is <TRUE/>. */ - [readonly, property] boolean IsEmptyPresentationObject; + [property] boolean IsEmptyPresentationObject; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::IsPresentationObject /** If this is a presentation object, this property is <TRUE/>. - - - <p>Presentation objects are objects like TitleTextShape and OutlinerShape.</p> */ @@ -150,7 +141,6 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::OnClick /** selects an action performed after the user clicks on this shape. */ @@ -158,12 +148,9 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::PlayFull /** If this property is <TRUE/>, the sound of this shape is played in full. - - <p>The default behavior is to stop the sound after completing the animation effect.</p> */ @@ -171,12 +158,9 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::PresentationOrder /** This is the position of this shape in the order of the shapes which can be animated on its page. - - <p>The animations are executed in this order, starting at the shape with the PresentationOrder "one." You can change the order by changing this number. Setting it to "one" makes this shape the @@ -186,7 +170,6 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::Sound /** This is the URL to a soundfile that is played while the animation effect of this shape is running. */ @@ -194,7 +177,6 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::SoundOn /** If this property is set to <TRUE/>, a sound is played while the animation effect is executed. */ @@ -202,21 +184,18 @@ service Shape //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::Speed /** This is the speed of the animation effect. */ [property] com::sun::star::presentation::AnimationSpeed Speed; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::TextEffect /** This is the animation effect for the text inside this shape. */ [property] com::sun::star::presentation::AnimationEffect TextEffect; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::presentation::Shape::Verb /** specifies an "ole2" verb for the ClickAction VERB in the property <member scope="com::sun::star::drawing">Shape::OnClick</member>. */ @@ -231,6 +210,15 @@ service Shape /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/09/06 08:38:47 cl + #102051# fixed IsEmptyPresentationObject + + Revision 1.4.20.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.4 2000/12/14 12:53:38 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:28 mi moved from api diff --git a/offapi/com/sun/star/presentation/TitleTextShape.idl b/offapi/com/sun/star/presentation/TitleTextShape.idl index fe316861c251..325162379c83 100644 --- a/offapi/com/sun/star/presentation/TitleTextShape.idl +++ b/offapi/com/sun/star/presentation/TitleTextShape.idl @@ -2,9 +2,9 @@ * * $RCSfile: TitleTextShape.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,8 +65,8 @@ #include <com/sun/star/presentation/Shape.idl> #endif -#ifndef __com_sun_star_drawing_Shape_idl__ -#include <com/sun/star/drawing/Shape.idl> +#ifndef __com_sun_star_drawing_TextShape_idl__ +#include <com/sun/star/drawing/TextShape.idl> #endif @@ -76,17 +76,17 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::presentation::TitleTextShape /** This service is implemented by the title and subtitle presentation shape. + + <p>Presentation shapes can be used in a presentation + page layouts and theire position and size is by default set + by the presentation shapes on the <type>MasterPage</type>. */ service TitleTextShape { - // DocMerge: empty anyway service com::sun::star::presentation::Shape; - // DocMerge: empty anyway - service com::sun::star::drawing::Shape; - + service com::sun::star::drawing::TextShape; }; //============================================================================= @@ -96,6 +96,12 @@ service TitleTextShape /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.3 2000/11/08 12:43:28 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:31 hjs initial import diff --git a/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl b/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl index 441f95fce462..0d684319828a 100644 --- a/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl +++ b/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCustomPresentationSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,16 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::presentation::XCustomPresentationSupplier /** must be supported to provide access to customized - presentations of a presentation document.@see XCustomPresentation - @see XCustomPresentationAccess + presentations of a presentation document. + + @see XCustomPresentation + @see XCustomPresentationAccess */ interface XCustomPresentationSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::presentation::XCustomPresentationSupplier::getCustomPresentations /** @returns the <type>CustomPresentation</type>. */ @@ -100,6 +100,12 @@ interface XCustomPresentationSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.4 2001/03/16 16:41:31 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:28 mi moved from api diff --git a/offapi/com/sun/star/presentation/XPresentation.idl b/offapi/com/sun/star/presentation/XPresentation.idl index 515e21265050..5e92399094e9 100644 --- a/offapi/com/sun/star/presentation/XPresentation.idl +++ b/offapi/com/sun/star/presentation/XPresentation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPresentation.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,13 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::presentation::XPresentation /** With this interface you can control any object that implements - a presentation.@see Presentation - */ + a <type>Presentation</type>. +*/ interface XPresentation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::presentation::XPresentation::start /** The presentation is shown in full-screen and started from the beginning. */ @@ -88,14 +86,12 @@ interface XPresentation: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::presentation::XPresentation::end /** The presentation is stopped and the full-screen mode will end. */ void end(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::presentation::XPresentation::rehearseTimings /** Starts the presentation from the beginning and shows the actual running time to the user. */ @@ -110,6 +106,12 @@ interface XPresentation: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.5 2001/03/16 16:41:31 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:11 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/presentation/XPresentationPage.idl b/offapi/com/sun/star/presentation/XPresentationPage.idl index 5bb82b2ec3fe..32dfd9ae43af 100644 --- a/offapi/com/sun/star/presentation/XPresentationPage.idl +++ b/offapi/com/sun/star/presentation/XPresentationPage.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPresentationPage.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,14 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::presentation::XPresentationPage -/** describes a page from a presentation.@see com::sun::star::drawing::DrawPage +/** describes a page from a presentation. + + @see com::sun::star::drawing::DrawPage */ interface XPresentationPage: com::sun::star::drawing::XDrawPage { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XPresentationPage::getNotesPage - // DocMerge from xml: method com::sun::star::presentation::XPresentationPage::getNotesPage /** return the note page from the current page in the presentation, the name for the note page in the user interface note view, and one of the views from a presentation page. @@ -96,6 +95,12 @@ interface XPresentationPage: com::sun::star::drawing::XDrawPage /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.5 2001/03/16 16:41:31 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:11 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/presentation/XPresentationSupplier.idl b/offapi/com/sun/star/presentation/XPresentationSupplier.idl index 0febb7f2de64..32557c52f484 100644 --- a/offapi/com/sun/star/presentation/XPresentationSupplier.idl +++ b/offapi/com/sun/star/presentation/XPresentationSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPresentationSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,14 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::presentation::XPresentationSupplier /** controls a presentation directly. This supplier will do this. */ interface XPresentationSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR XPresentationSupplier::getPresentation - // DocMerge from xml: method com::sun::star::presentation::XPresentationSupplier::getPresentation - /** return an interface to control a presentation. + /** + @returns an interface to control a presentation. */ com::sun::star::presentation::XPresentation getPresentation(); @@ -98,6 +96,12 @@ interface XPresentationSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/07 07:53:10 cl + idl review + + Revision 1.4 2001/03/16 16:41:31 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:28 mi moved from api diff --git a/offapi/com/sun/star/resource/MissingResourceException.idl b/offapi/com/sun/star/resource/MissingResourceException.idl index 412e7eb44da8..e8e094ff15c0 100644 --- a/offapi/com/sun/star/resource/MissingResourceException.idl +++ b/offapi/com/sun/star/resource/MissingResourceException.idl @@ -2,9 +2,9 @@ * * $RCSfile: MissingResourceException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,13 @@ //============================================================================= - module com { module sun { module star { module resource { +module com { module sun { module star { module resource { //============================================================================= -// DocMerge from xml: exception com::sun::star::resource::MissingResourceException -/** is used to signal that a resource is missing.@see XResourceBundle +/** is used to signal that a resource is missing. + + @see XResourceBundle */ exception MissingResourceException: com::sun::star::uno::RuntimeException { @@ -83,21 +84,4 @@ exception MissingResourceException: com::sun::star::uno::RuntimeException }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:32 hjs - initial import - - Revision 1.4 2000/09/11 11:52:37 mi - documentation merged from XML - - Revision 1.2 2000/04/20 14:08:25 mi - documentation - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/resource/XResourceBundle.idl b/offapi/com/sun/star/resource/XResourceBundle.idl index 33b66e8bf76c..e25eb41c7ff4 100644 --- a/offapi/com/sun/star/resource/XResourceBundle.idl +++ b/offapi/com/sun/star/resource/XResourceBundle.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResourceBundle.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:33:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -129,11 +129,10 @@ module com { module sun { module star { module resource { When your program needs a locale-specific object, it loads the <code>XResourceBundle</code> implementation using the - <code>com.sun.star.resource.XResourceBundleLoader</code> service: + <type>XResourceBundleLoader</type> service: <listing> - XResourceBundle myResources = - xLoader->getBundle("MyResources", currentLocale); + XResourceBundle myResources = xLoader.getBundle("MyResources", currentLocale); </listing> <p>The first argument specifies the family name of the resource @@ -182,14 +181,14 @@ module com { module sun { module star { module resource { <listing> class MyResource extends com.sun.star.resource.XResourceBundle { - // some queryInterface stuff - // ... - public final Object getDirectElement(String key) - { - if (key.equals("okKey")) return "Ok"; - if (key.equals("cancelKey")) return "Cancel"; - return null; - } + // some queryInterface stuff + // ... + public final Object getDirectElement(String key) + { + if (key.equals("okKey")) return "Ok"; + if (key.equals("cancelKey")) return "Cancel"; + return null; + } } </listing> @@ -210,7 +209,7 @@ module com { module sun { module star { module resource { <p>The get methods all require the key as an argument and return the object if found. If the object is not found, the get methods - throw a <code>NoSuchElementException</code>. + throw a <type scope="com:sun:star:container">NoSuchElementException</type>. <P> <STRONG>NOTE:</STRONG> You should always supply a base service with no suffixes. This will be the class of "last resort" if a @@ -263,6 +262,9 @@ interface XResourceBundle: com::sun::star::container::XNameAccess exists. <p>It does not look in the parents. + + @param key + specifies the element. */ any getDirectElement( [in] string key ); diff --git a/offapi/com/sun/star/resource/XResourceBundleLoader.idl b/offapi/com/sun/star/resource/XResourceBundleLoader.idl index 3f2d87aeb2d4..e56baca74d9d 100644 --- a/offapi/com/sun/star/resource/XResourceBundleLoader.idl +++ b/offapi/com/sun/star/resource/XResourceBundleLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResourceBundleLoader.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:33:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,26 +80,24 @@ //============================================================================= - module com { module sun { module star { module resource { +module com { module sun { module star { module resource { //============================================================================= -// DocMerge from xml: interface com::sun::star::resource::XResourceBundleLoader /** makes it possible to load resource bundles. <p>The search algorithm is specified in the documentation of <type>XResourceBundle</type>. The implementations must follow the name scheme, but it is allowed to search in several locations. - </p>@see MissingResourceException - @see XResourceBundle - @see Locale + @see MissingResourceException + @see XResourceBundle + @see Locale */ interface XResourceBundleLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::resource::XResourceBundleLoader::loadBundle_Default /** loads the appropriate resource bundle. */ com::sun::star::resource::XResourceBundle loadBundle_Default( [in] string aBaseName ) @@ -107,7 +105,6 @@ interface XResourceBundleLoader: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::resource::XResourceBundleLoader::loadBundle /** loads the appropriate resource bundle subclass. */ com::sun::star::resource::XResourceBundle loadBundle( [in] string abaseName, @@ -120,30 +117,4 @@ interface XResourceBundleLoader: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:32 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:29 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:32 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:08:25 mi - documentation - - Revision 1.2 2000/02/23 11:41:17 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:44 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sdb/CallableStatement.idl b/offapi/com/sun/star/sdb/CallableStatement.idl index 1a4ce5891b4e..c04de9e878cc 100644 --- a/offapi/com/sun/star/sdb/CallableStatement.idl +++ b/offapi/com/sun/star/sdb/CallableStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: CallableStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,9 +75,9 @@ // DocMerge from xml: service com::sun::star::sdb::CallableStatement /** represents a procedure call. The service differs only in the access of the columns and parameters to the service - <type scope="com::sun::star::sdbc">CallableStatement</type>. - -<!-- JRH: <type scope="com::sun::star::sdbc">CallableStatement</type> --> */ + <type scope="com::sun::star::sdbc">CallableStatement</type> + . +*/ service CallableStatement { // DocMerge: empty anyway @@ -93,6 +93,12 @@ service CallableStatement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:27:10 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:30 mi moved from api diff --git a/offapi/com/sun/star/sdb/ColumnSettings.idl b/offapi/com/sun/star/sdb/ColumnSettings.idl index f1949caf5ce9..27e084a589c1 100644 --- a/offapi/com/sun/star/sdb/ColumnSettings.idl +++ b/offapi/com/sun/star/sdb/ColumnSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnSettings.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,10 +83,12 @@ service ColumnSettings interface. </p> <p> - If the value is <void/>, a default numberformat should be used according - to the datatype of the column.</p> + If the value is + <void/> + , a default numberformat should be used according to the datatype of the column. + </p> -<!-- JRH: orig: <type scope="com::sun::star::util">XNumberFormatter</type> -->*/ + */ [property] long FormatKey; @@ -97,23 +99,34 @@ service ColumnSettings 1: center 2: right </pre> - <p> If the value is <void/>, a default alignment should be used according - to the datatype of the column.</p> + <p> + If the value is + <void/> + , a default alignment should be used according + to the datatype of the column. + </p> */ [property] long Align; /** specifies the width of the column displayed in a grid, the unit is 10THMM. - <p> If the value is <void/>, a default width should be used according to the label - of the column. </p> + <p> + If the value is + <void/> + , a default width should be used according to the label of the column. + </p> */ [property] long Width; /** Position of the column within a grid. - <p> If the value is <void/>, the default position should be taken according. </p> + <p> + If the value is + <void/> + , the default position should be taken according. + </p> */ [property] long Position; @@ -124,14 +137,26 @@ service ColumnSettings /** indicates a control model whichs defines the settings for layouting. - The default is <NULL/>. + The default is + <NULL/> + . */ [optional, property] com::sun::star::beans::XPropertySet ControlModel; /** describes an optional help text which can be used by UI components - when representing this column. + when representing this column. + The default is + <NULL/> + . */ [optional, property] string HelpText; + + /** describes the default value which should be displayed by a control when moving to a new row. + The default is + <NULL/> + . + */ + [optional, property] string ControlDefault; }; //============================================================================= @@ -140,6 +165,12 @@ service ColumnSettings /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.8.2.1 2002/02/18 10:23:37 oj + #97563# parameter,return value and exception description + + Revision 1.8 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.7 2001/09/24 11:21:17 fs #65293# diff --git a/offapi/com/sun/star/sdb/Connection.idl b/offapi/com/sun/star/sdb/Connection.idl index 23a4c86bd5ae..6c1b21a185cb 100644 --- a/offapi/com/sun/star/sdb/Connection.idl +++ b/offapi/com/sun/star/sdb/Connection.idl @@ -2,9 +2,9 @@ * * $RCSfile: Connection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,8 +81,9 @@ interface XCommandPreparation; // DocMerge from xml: service com::sun::star::sdb::Connection -/** extends the connection of SDBC by providing the data definitions - of a connected database. +/** extends the + <type scope="com::sun::star::sdbc">connection</type> + of SDBC by providing the data definitions of a connected database. */ service Connection { @@ -97,7 +98,7 @@ service Connection // DocMerge from xml: service com::sun::star::sdb::Connection: interface com::sun::star::sdb::XCommandPreparation - /** interface for complex command execution + /** interface for complex command execution. */ interface XCommandPreparation; @@ -126,6 +127,12 @@ service Connection /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:23:31 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:30 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/offapi/com/sun/star/sdb/ContentLoader.idl b/offapi/com/sun/star/sdb/ContentLoader.idl index 63884248ae95..2fb5b40f0b96 100644 --- a/offapi/com/sun/star/sdb/ContentLoader.idl +++ b/offapi/com/sun/star/sdb/ContentLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentLoader.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,9 +72,11 @@ module com { module sun { module star { module sdb { //============================================================================= /** implements a loader for various datasource-related user interface components. - <p>Usually, you don't deal with this loader directly. Instead it is registered for + <p> + Usually, you don't deal with this loader directly. Instead it is registered for a particular URL scheme, and you use the dispatch mechanism provided by the application - framework, dispatching URLs the loader is registered for.</p> + framework, dispatching URLs the loader is registered for. + </p> @see com::sun::star::frame::XDispatch @see com::sun::star::frame::XDispatchProvider @@ -83,24 +85,46 @@ service ContentLoader { /** ensures the basic functionality. - <p>Supporting this service ensures that you can plug any of the components - the loader can create into an arbitrary frame.</p> + <p> + Supporting this service ensures that you can plug any of the components + the loader can create into an arbitrary frame. + </p> - The loader should be registered for the URL scheme <b>.component:DB/ *</b>, - the concrete URLs supported are: + The loader should be registered for the URL scheme + <b> + .component:DB/ * + </b> + , the concrete URLs supported are: <ul> - <li><b>.component:DB/DataSourceBrowser</b><br/> - Using this URL creates an instance of the <service>DataSourceBrowser</service> service - and plugs it into the frame passed to the loader. + <li> + <b> + .component:DB/DataSourceBrowser + </b> + <br/> + Using this URL creates an instance of the + <service scope="com::sun::star::sdb"> + DataSourceBrowser + </service> + service and plugs it into the frame passed to the loader. </li> - <li><b>.component:DB/FormGridView</b><br/> - Using this URL creates an instance of the <service>ExternalSourceBrowser</service> service - and plugs it into the frame passed to the loader. + <li> + <b> + .component:DB/FormGridView + </b> + <br/> + Using this URL creates an instance of the + <service scope="com::sun::star::sdb"> + ExternalSourceBrowser + </service> + service and plugs it into the frame passed to the loader. </li> </ul> - The parameters passed to the <member scope="com::sun::star::frame">XFrameLoader::load</member> are forwarded - to the object beeing created, in particular to it's <type scope="com::sun::star::lang">XIntialization</type> + The parameters passed to the + <member scope="com::sun::star::frame">XFrameLoader::load()</member> + are forwarded to the object beeing created, + in particular to it's + <type scope="com::sun::star::lang">XIntialization</type> interface. **/ service com::sun::star::frame::FrameLoader; diff --git a/offapi/com/sun/star/sdb/DataColumn.idl b/offapi/com/sun/star/sdb/DataColumn.idl index 8fb2608629e6..82b98739a6bd 100644 --- a/offapi/com/sun/star/sdb/DataColumn.idl +++ b/offapi/com/sun/star/sdb/DataColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataColumn.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,14 +104,6 @@ service DataColumn // DocMerge from xml: property com::sun::star::sdb::DataColumn::OriginalValue /** contains the original value of the column. - - - - - - - - @optional */ [optional, readonly, property] any OriginalValue; @@ -123,6 +115,12 @@ service DataColumn /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:22:06 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:30 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/offapi/com/sun/star/sdb/DataSettings.idl b/offapi/com/sun/star/sdb/DataSettings.idl index 251f6cbb1d86..2c9ef5b694e9 100644 --- a/offapi/com/sun/star/sdb/DataSettings.idl +++ b/offapi/com/sun/star/sdb/DataSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataSettings.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,10 +73,11 @@ // DocMerge from xml: service com::sun::star::sdb::DataSettings -/** extends the <type scope="com::sun::star::sdbcx">Table</type> with additional - display informations, sorting and filtering criterias. +/** extends the + <type scope="com::sun::star::sdbcx">Table</type> + with additional display information, sorting and filtering criterias. -<!-- JRH: invisible: <type scope="com::sun::star::sdbcx">Table</type> --> */ + */ service DataSettings { @@ -123,6 +124,15 @@ service DataSettings /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/06/27 12:34:27 oj + information corrected + + Revision 1.5.2.1 2002/02/18 10:22:00 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/14 12:53:38 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl index 96c4f472f42b..ccc80b191ef3 100644 --- a/offapi/com/sun/star/sdb/DataSource.idl +++ b/offapi/com/sun/star/sdb/DataSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataSource.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: oj $ $Date: 2002-08-05 07:38:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -124,8 +124,13 @@ service DataSource /** provides the access to DataSource related queries. - <p>The object returned by the <method>XQueryDefinitionsSupplier::getQueryDefinitions</method> supports the - <service>DefinitionContainer</service> service.</p> + <p> + The object returned by the + <method scope="com::sun::star::sdb">XQueryDefinitionsSupplier::getQueryDefinitions()</method> + supports the + <service scope="com::sun::star::sdb">DefinitionContainer</service> + service. + </p> */ interface XQueryDefinitionsSupplier; @@ -134,8 +139,13 @@ service DataSource interface com::sun::star::sdbc::XDataSource; /** provides access to bookmarks to documents associated with the data source - <p>The object returned by the <method>XBookmarksSupplier::getBookmarks</method> supports the - <service>DefinitionContainer</service> service.</p> + <p> + The object returned by the + <method scope="com::sun::star::sdb">XBookmarksSupplier::getBookmarks()</method> + supports the + <service scope="com::sun::star::sdb">DefinitionContainer</service> + service. + </p> */ [optional] interface XBookmarksSupplier; @@ -145,8 +155,9 @@ service DataSource /** indicates a database url of the form <br> - <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or - <code> sdbc:<em>subprotocol</em>:<em>subname</em></code> + <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> + or + <code>sdbc:<em>subprotocol</em>:<em>subname</em></code> */ [property] string URL; @@ -174,7 +185,7 @@ service DataSource /** indicates that components displaying data obtained from this - data source should suppress columns used for versioning. + data source should suppress columns used for versioning. */ [property] boolean SuppressVersionColumns; @@ -191,16 +202,16 @@ service DataSource /** defines a list of tables, on which the DataSource should have it's focus. - If empty, all the tables of the are used. + If empty, all tables are rejected. -<!-- JRH: the second line is incomplete --> */ + */ [property] sequence<string> TableFilter; /** defines a list of table types, on which the DataSource should have it's focus. - If empty, all the table types of the are used. + If empty, all table types are rejected. -<!-- JRH: the second line is incomplete --> */ + */ [property] sequence<string> TableTypeFilter; }; @@ -208,61 +219,4 @@ service DataSource }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.9 2002/07/08 15:21:26 obo - #100000# - - Revision 1.8 2002/06/17 07:01:55 oj - interface XDataSource was missing. - - Revision 1.7.2.2 2002/06/17 07:00:12 oj - interface XDataSource was missing. - - Revision 1.7.2.1 2002/02/18 10:23:09 oj - #97563# parameter,return value and exception description - - Revision 1.7 2001/10/25 15:00:32 mi - proofreading and corrections from Richard Holt - - Revision 1.6 2001/04/26 09:13:56 fs - added (optional) interface XBookmarksSupplier - - Revision 1.5 2001/02/07 11:11:30 fs - a new missing detail ... - - Revision 1.4 2001/02/06 07:56:02 fs - removed XFormDocumentsSupplier / XReportDocumentsSupplier from the service description - they're obsolete - - Revision 1.3 2000/11/08 12:43:30 mi - moved from api - - Revision 1.2 2000/10/20 09:42:58 fs - new property SuppressVersionColumns - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.8 2000/09/11 11:52:39 mi - documentation merged from XML - - Revision 1.6 2000/07/05 17:12:07 os - wrong property name corrected: NumberFormats -> NumberFormatsSupplier - - Revision 1.5 2000/06/27 06:57:50 dg - CommandPreparation new - - Revision 1.4 2000/06/08 08:31:08 dg - XDatabaseAccess is no longer part of the DataSource - - Revision 1.3 2000/06/05 13:35:37 dg - services changed - - Revision 1.2 2000/06/05 13:20:27 dg - services changed - - Revision 1.1 1999/11/24 08:39:00 dg - new Star Data Beans - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index 9526fa47b6ce..459212e0bc81 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataSourceBrowser.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-10-31 15:32:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,76 +81,132 @@ module com { module sun { module star { module sdb { //============================================================================= /** implements a component which allows browsing the data sources registered on the system. - <p>This service implements a user interface for browsing data sources registered on the - <service>DatabaseContext</service> instance of the system.</p> + <p> + This service implements a user interface for browsing data sources registered on the + <service scope="com::sun::star::sdb"> + DatabaseContext + </service> + instance of the system. + </p> - <p>It is possible to navigate through all the data sources, it's queries and it's tables. + <p> + It is possible to navigate through all the data sources, it's queries and it's tables. The queries/tables can be displayed in a grid-like view, where functionality for searching, - sorting, filtering, and such is provided</p> + sorting, filtering, and such is provided. + </p> - <p>Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms + <p> + Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms of the application framework to load the URL <b>.component:DB/DataSourceBrowser</b> into an arbitrary - frame. This should involve a <service>ContentLoader</service> service, which creates and initializes - the browser.</p> - - <p>Some aspects of the browser can be controlled from outside, eg., it is possible to dispatch a sort or filter - request, if a table or query is being displayed.</p> - - <p>The communication between the browser and external instances works in two ways.<br> - The way <em>in</em> is provided by the <type scope="com::sun::star::frame">XDispatchProvider</type> interface - the service exports (Please see below for more details on this).<br> - The way <em>out</em> works in another way. There are several URL's which an external instance can provide - dispatches for (usually by implementing a <type scope="com::sun::star::frame">XDispatchProviderInterceptor</type> - for the parent frame of the browser), thus indicating that the browser should provide special functionality.<br> + frame. This should involve a + <service scope="com::sun::star::sdb"> + ContentLoader + </service> + service, which creates and initializes + the browser. + </p> + + <p> + Some aspects of the browser can be controlled from outside, eg., + it is possible to dispatch a sort or filter + request, if a table or query is being displayed. + </p> + + <p + >The communication between the browser and external instances works in two ways. + <br/> + The way <em>in</em> is provided by the + <type scope="com::sun::star::frame">XDispatchProvider</type> + interface the service exports (Please see below for more details on this). + <br/> + The way <em>out</em> works in another way. There are several URL's which an external + instance can provide dispatches for (usually by implementing a + <type scope="com::sun::star::frame">XDispatchProviderInterceptor</type> + for the parent frame of the browser), thus indicating that the browser should provide special functionality. + <br/> In this case, the browser displays and maintains some additional slots (to be more concrete: toolbox items), which, - upon triggering, call the <member scope="com::sun::star::frame">XDispatch::dispatch</member> method of the object - provided by the external instance.</p> + upon triggering, call the + <member scope="com::sun::star::frame">XDispatch::dispatch()</member>methodoftheobject + provided by the external instance. + </p> - <p>In particular, the supported URL's for communicating to an external instance are: + <p> + In particular, the supported URL's for communicating to an external instance are: <ul> - <li><b>.uno:DataSourceBrowser/InsertColumns</b><br> - Available whenever an external instance provides a dispatcher (<type scope="com::sun::star::frame">XDispatch</type>) - for this URL.<br> - Enabled, if at least one row in the grid view of a table or query is selected.<br> + <li><b>.uno:DataSourceBrowser/InsertColumns</b> + <br/> + Available whenever an external instance provides a dispatcher ( + <type scope="com::sun::star::frame">XDispatch</type>) + for this URL. + <br/> + Enabled, if at least one row in the grid view of a table or query is selected. + <br/> It is the task of the external instance to provide functionality for this URL, but usually it is used - to implement some kind of "Data To Text" functionality.<br> + to implement some kind of "Data To Text" functionality. + <br/> </li> - <li><b>.uno:DataSourceBrowser/InsertContent</b><br> - Available whenever an external instance provides a dispatcher - (<type scope="com::sun::star::frame">XDispatch</type>) for this URL.<br> - Enabled, if at least one row in the grid view of a table or query is selected.<br> + <li><b>.uno:DataSourceBrowser/InsertContent</b> + <br/> + Available whenever an external instance provides a dispatcher( + <type scope="com::sun::star::frame">XDispatch</type> + ) for this URL. + <br/> + Enabled, if at least one row in the grid view of a table or query is selected. + <br/> It is the task of the external instance to provide functionality for this URL, but usually it is used - to implement some kind of "Data To Fields" functionality.<br> + to implement some kind of "Data To Fields" functionality. + <br/> </li> - <li><b>.uno:DataSourceBrowser/FormLetter</b><br> - Available whenever an external instance provides a dispatcher (<type scope="com::sun::star::frame">XDispatch</type>) - for this URL.<br> + <li><b>.uno:DataSourceBrowser/FormLetter</b> + <br/> + Available whenever an external instance provides a dispatcher ( + <type scope="com::sun::star::frame">XDispatch</type>)forthisURL. + <br/> It is the task of the external instance to provide functionality for this URL, but usually it is used - to implement some kind of "Form Letter" functionality.<br> + to implement some kind of "Form Letter" functionality. + <br/> </li> </ul> For all kinds of URL's, the parameters supplied when dispatching it are as follows: <ul> - <li><b>DataSourceName</b><br> - The name of the globally registered <service>DataSource</service> from which the currently displayed data is - taken. + <li><b>DataSourceName</b> + <br/> + The name of the globally registered + <service> + DataSource + </service> + from which the currently displayed data is taken. </li> - <li><b>CommandType</b><br> - A <type>CommandType</type> value, specifying the type of the object displayed currently. + <li><b>CommandType</b> + <br/> + A + <type> + CommandType + </type> + value, specifying the type of the object displayed currently. </li> - <li><b>Command</b><br> + <li><b>Command</b> + <br/> A string value, specifying the name of the object displayed currently (or the SQL statement used to populate the grid view). </li> - <li><b>Selection</b><br> + <li><b>Selection</b> + <br/> A sequence of integers, containing the numbers of the rows currently selected. </li> - <li><b>Cursor</b> (optional)<br> + <li><b>Cursor</b> (optional) + <br/> If available, this parameter contains an object implementing the - <service scope="com::sun::star::sdb">ResultSet</service> service. + <service scope="com::sun::star::sdb"> + ResultSet + </service> + service. It may be used to obtain the data described by the <em>Selection</em> parameter (which otherwise - would have to be retrieved from the <service>DatabaseContext</service>, using the information given - in the other parameters). + would have to be retrieved from the + <service> + DatabaseContext + </service> + , using the information given in the other parameters). </li> </ul> </p> @@ -164,12 +220,16 @@ module com { module sun { module star { module sdb { service DataSourceBrowser { /** implements basic form controller functionality. - <p>With a data source browser implementing this interface, external components have access to + <p> + With a data source browser implementing this interface, external components have access to <ul><li>the grid control which is used to display the currently selected table/query - (see <method scope="com.sun.star.form">XFormController::getControls</method>) + (see + <method scope="com.sun.star.form">XFormController::getControls()</method> + ) </li> <li>the data form used for displaying objects. As always for components implementing this service, - the object returned by <method scope="com.sun.star.awt">XTabController::getModel</method> is a data form. + the object returned by + <method scope="com.sun.star.awt">XTabController::getModel()</method>isadataform. </li> </ul> </p> @@ -182,27 +242,49 @@ service DataSourceBrowser /** is used to initialize the browser. - <p>Parameters (passed to the method - <member scope="com::sun::star::lang">XInitialization::initialize</member>) - have to be instances of <type scope="com::sun::star::beans">PropertyValue</type>, where the - <member scope="com::sun::star::beans">PropertyValue::Name</member> member specifies what the parameter controls, - with the <member scope="com::sun::star::beans">PropertyValue::Value</member> member containing the value - to be used.<br> + <p> + Parameters (passed to the method + <member scope="com::sun::star::lang">XInitialization::initialize()</member> + ) + have to be instances of + <type scope="com::sun::star::beans">PropertyValue</type> + , where the + <member scope="com::sun::star::beans">PropertyValue::Name</member> + member specifies what the parameter controls, + with the + <member scope="com::sun::star::beans">PropertyValue::Value</member> + member containing the value + to be used. + <br/> Recognized parameters are: <ul> - <li><b>Frame</b><br> - has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the + <li><b>Frame</b> + <br/> + has to be an + <type scope="com::sun::star::frame">XFrame</type> + interface specifying the frame to plug the browser component into. </li> - <li><b>DataSourceName</b><br> - The name of the globally registered <service>DataSource</service> to be used for initial display. It is only + <li><b>DataSourceName</b> + <br/> + The name of the globally registered + <service> + DataSource + </service> + to be used for initial display. It is only meaningful together with the other parameters specifying the object to display. </li> - <li><b>CommandType</b><br> - This has to be a <type>CommandType</type> value, specifying the type of the object to display initially. + <li><b>CommandType</b> + <br/> + This has to be a + <type> + CommandType + </type> + value, specifying the type of the object to display initially. It is only meaningful together with the <em>DataSourceName</em> and the <em>Command</em> parameters. </li> - <li><b>Command</b><br> + <li><b>Command</b> + <br/> This is a string giving the name of the object to display initially. Whether it is table name, a query name or a SQL string is controller by the <em>CommandType</em> parameter. </li> @@ -213,30 +295,42 @@ service DataSourceBrowser /** is used to control the browser from outside. - <p>You may use the <member scope="com::sun::star::frame">XDispatchProvider::queryDispatch</member> method - to query for objects which implement the <type scope="com::sun::star::frame">XDispatch</type> interface, - and which allow you to be notified on status changes and to dispatch special requests.</p> - <p>The recognized URLs are: + <p> + You may use the + <member scope="com::sun::star::frame">XDispatchProvider::queryDispatch</member> + method + to query for objects which implement the + <type scope="com::sun::star::frame">XDispatch</type> + interface, + and which allow you to be notified on status changes and to dispatch special requests. + </p> + <p> + The recognized URLs are: <ul> - <li><b>.uno:Copy</b><br> + <li><b>.uno:Copy</b> + <br/> implements the usual <em>Copy</em> command. Enabled if the grid view has the focus and text in any cell is selected. </li> - <li><b>.uno:Cut</b><br> + <li><b>.uno:Cut</b> + <br/> implements the usual <em>Cut</em> command. Enabled if the grid view has the focus and text in any cell is selected. </li> - <li><b>.uno:Paste</b><br> + <li><b>.uno:Paste</b> + <br/> implements the usual <em>Paste</em> command. Enabled if the grid view has the focus and a cell which allows text input is being edited. </li> - <li><b>.uno:EditDoc</b><br> + <li><b>.uno:EditDoc</b> + <br/> allows switching the edit mode of the grid view. Enabled if editing the data is allowed in general. </li> - <li><b>.uno:Undo</b><br> + <li><b>.uno:Undo</b> + <br/> revokes any changes done in the current row. </li> - <li><b>.uno:Save</b><br> + <li><b>.uno:Save</b><br/> saves the changes done in the current row. </li> </ul> diff --git a/offapi/com/sun/star/sdb/DatabaseAccess.idl b/offapi/com/sun/star/sdb/DatabaseAccess.idl index 401653be3745..f05bc29854ce 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccess.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,7 @@ interface XCompletedConnection; */ service DatabaseAccess { - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -155,17 +155,16 @@ service DatabaseAccess // DocMerge from idl: property com::sun::star::sdb::DatabaseAccess::TableFilter /** defines a list of tables, on which the bean should have it's focus. - If empty, all the tables of the are used. - -<!-- JRH: second sentence is incomplete -->*/ + If empty, all tables are rejected. + */ [optional, property] sequence<string> TableFilter; // DocMerge from idl: property com::sun::star::sdb::DatabaseAccess::TableTypeFilter /** defines a list of table types, on which the bean should have it's focus. - If empty, all the tables types of the are used. + If empty, all tables types are rejected. -<!-- JRH: second sentence is incomplete --> */ + */ [optional, property] sequence<string> TableTypeFilter; }; @@ -175,6 +174,15 @@ service DatabaseAccess /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:53:58 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 10:24:40 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:25 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl index 300eadfd3136..9f145bf3c8d7 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccessConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseAccessConnection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,21 +86,26 @@ interface XSQLQueryComposerFactory; to a certain database connection, such as, DatabaseQueries, FormDocuments, and ReportDocuments. Objects for data definition are supplied as well, for instance, Tables, Views, etc. - <p>Implements the service <type scope="com::sun::star::sdbc">Connection</type>. - It is possible to open more than one connection at the same time, but the - method <member>DatabaseAccessConnection::dispose</member> will close - only one of these connections. You have to close all connections in order - to close the connection to the database.</p> + <p> + Implements the service + <type scope="com::sun::star::sdbc">Connection</type> + . + It is possible to open more than one connection at the same time, but the method + <member scope="com::sun::star::sdb">DatabaseAccessConnection::dispose()</member> + will close only one of these connections. You have to close all connections in order + to close the connection to the database. + </p> */ service DatabaseAccessConnection { // DocMerge from xml: service com::sun::star::sdb::DatabaseAccessConnection: service com::sun::star::sdbc::Connection /** supporting of the base connection service. - <p><B>Note:</B><br> - Don't use the "dispose" method of the XComponent interface, as the DataAccess - uses a more sophisticated interface for closing a connection. - @see XDatabaseAccess@see XDatabaseAccess + <p><B>Note:</B><br/> + Don't use the "dispose" method of the XComponent interface, as the DataAccess + uses a more sophisticated interface for closing a connection. + @see XDatabaseAccess + </p> */ service com::sun::star::sdbc::Connection; @@ -122,7 +127,8 @@ service DatabaseAccessConnection */ interface XSQLQueryComposerFactory; - // DocMerge: empty anyway + /** provides access to the queries. + */ interface XQueriesSupplier; }; @@ -132,6 +138,15 @@ service DatabaseAccessConnection /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.2 2002/02/18 12:53:58 oj + #97563# parameter,return value and exception description + + Revision 1.4.2.1 2002/02/18 10:23:26 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/DatabaseAccessContext.idl b/offapi/com/sun/star/sdb/DatabaseAccessContext.idl index 5e0b461d54a3..8016816c0b67 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccessContext.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccessContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseAccessContext.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,8 @@ access beans. It is possible to have different aliases for different locales. - <p>A DatabaseContext stores an alias for the URL of a database access component + <p> + A DatabaseContext stores an alias for the URL of a database access component for a given locale. It is also allowed to work with a default locale. This is useful in connection with Enumeration or NameAccess to the context. In common use, the default language is set during the initialization of the component. @@ -129,6 +130,12 @@ service DatabaseAccessContext /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:23:42 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl b/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl index 028a1dce8b55..17f5ca4de8fb 100644 --- a/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl +++ b/offapi/com/sun/star/sdb/DatabaseAccessDataSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseAccessDataSource.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,13 +90,16 @@ service DatabaseAccessDataSource interface com::sun::star::beans::XPropertySet; interface com::sun::star::sdbc::XDataSource; - /** is optional for implementation. */ + /** is optional for implementation. + */ [optional] interface XCompletedConnection; - /** locates the database access bean. */ + /** locates the database access bean. + */ [property] string URL; - /** determines the password handling. */ + /** determines the password handling. + */ [optional, property] com::sun::star::ucb::RememberAuthentication PasswordMode; }; @@ -106,6 +109,12 @@ service DatabaseAccessDataSource /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:26:32 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:26 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdb/DatabaseContext.idl b/offapi/com/sun/star/sdb/DatabaseContext.idl index f3748382115f..a3380e8c4baf 100644 --- a/offapi/com/sun/star/sdb/DatabaseContext.idl +++ b/offapi/com/sun/star/sdb/DatabaseContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseContext.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,14 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif +#ifndef __com_sun_star_container_XContainer_idl__ +#include <com/sun/star/container/XContainer.idl> +#endif + +#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__ +#include <com/sun/star/lang/XSingleServiceFactory.idl> +#endif + #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif @@ -78,11 +86,14 @@ // DocMerge from xml: service com::sun::star::sdb::DatabaseContext /** is the context for accessing datasource. - <p>A datasource contains information how to create a connection to a database, such as, which databse driver - should be used, for which user should a connection be established, etc. <br> + <p> + A datasource contains information how to create a connection to a database, such as, + which database driver should be used, for which user should a connection be established, etc. + <br/> The context stores datasources under a given name. - </p>@see com::sun::star::sdb::DataSource + </p> + @see com::sun::star::sdb::DataSource */ service DatabaseContext { @@ -103,6 +114,14 @@ service DatabaseContext /** Interface for registering new datasources. */ interface com::sun::star::uno::XNamingService; + + /** Interface for registering listener to get notified when new datasources are created or removed. + */ + interface com::sun::star::container::XContainer; + + /** Interface for creation of new datasources. + */ + interface com::sun::star::lang::XSingleServiceFactory; }; //============================================================================= @@ -111,6 +130,12 @@ service DatabaseContext /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:26:46 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/DatabaseDocument.idl b/offapi/com/sun/star/sdb/DatabaseDocument.idl index abc117845434..3d12d68682b7 100644 --- a/offapi/com/sun/star/sdb/DatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/DatabaseDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseDocument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,21 +79,22 @@ interface XRename; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::DatabaseDocument /** specifies documents which belong to a database access bean. - - - <p>These documents typically process information from a connected - data source. A <type>DatabaseDocument</type> could be a form - or a report.</p> + <p> + These documents typically process information from a connected + data source. A + <type scope="com::sun::star::sdb">DatabaseDocument</type> + could be a form or a report. + </p> */ service DatabaseDocument { - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway + // allows to create new DatabaseDocument objects interface com::sun::star::sdbcx::XDataDescriptorFactory; - // DocMerge: empty anyway + // allows to rename the object. interface com::sun::star::sdbcx::XRename; // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::DatabaseDocument::Name @@ -114,6 +115,15 @@ service DatabaseDocument /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/02/18 12:53:58 oj + #97563# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 10:21:53 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:31 mi + moved from api + Revision 1.2 2000/10/17 08:42:32 fs removed the obsolete chaos::XDataStreamSupplier diff --git a/offapi/com/sun/star/sdb/DatabaseEnvironment.idl b/offapi/com/sun/star/sdb/DatabaseEnvironment.idl index 19f3830b7a4a..d4a7cb699fdc 100644 --- a/offapi/com/sun/star/sdb/DatabaseEnvironment.idl +++ b/offapi/com/sun/star/sdb/DatabaseEnvironment.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseEnvironment.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,8 @@ interface XDatabaseEnvironment; // DocMerge from xml: service com::sun::star::sdb::DatabaseEnvironment -/** is the top level service for accessing database components. +/** @deprecated + is the top level service for accessing database components. @@ -106,6 +107,12 @@ service DatabaseEnvironment /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:23:03 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl index 950b8ce937d2..2af67524ee22 100644 --- a/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl +++ b/offapi/com/sun/star/sdb/DatasourceAdministrationDialog.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatasourceAdministrationDialog.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: kz $ $Date: 2002-07-09 10:30:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,8 +84,14 @@ module com { module sun { module star { module sdb { /** provides a user interface for administrating the system wide registered data sources. - <p>Here, <em>system wide registered</em> means registered on the (one and only) instance - of the <service>DatabaseContext</service> service.</p> + <p> + Here, <em>system wide registered</em> means registered on the (one and only) instance + of the + <service scope="com::sun::star::sdb"> + DatabaseContext + </service> + service. + </p> */ service DatasourceAdministrationDialog { @@ -94,7 +100,9 @@ service DatasourceAdministrationDialog [property] string Title; /** parent window to use for the administration dialog - <p>This property can't be set while the dialog is being displayed.</p> + <p> + This property can't be set while the dialog is being displayed. + </p> */ [property] com::sun::star::awt::XWindow ParentWindow; @@ -107,27 +115,40 @@ service DatasourceAdministrationDialog interface com::sun::star::ui::dialogs::XExecutableDialog; /** allows initializing the dialog - <p>You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments - method of your <type scope="com::sun::star::lang">XMultiServiceFactory</type>.</p> + <p> + You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments + method of your + <type scope="com::sun::star::lang">XMultiServiceFactory</type> + . + </p> - <p>You specify a parameter by passing one (or more) <type scope="com::sun::star::beans">PropertyValue</type> + <p> + You specify a parameter by passing one (or more) + <type scope="com::sun::star::beans">PropertyValue</type> object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect you want to affect, and the <em>Value</em> field containing a value. - <br> - Imagine the initialization values as if you use setPropertyValue of the <type scope="com::sun::star::beans">XPropertySet</type> + <br/> + Imagine the initialization values as if you use setPropertyValue of the + <type scope="com::sun::star::beans">XPropertySet</type> interface ... - <br> + <br/> allowed parameters are <ul> <li><b>Title</b><br/> - String describing the initial title of the dialog. If not specified, a default title is used. + String describing the initial title of the dialog. + If not specified, a default title is used. </li> <li><b>ParentWindow</b><br/> - <type scope="com::sun::star::awt">XWindow</type> describing the parent window to use for the dialog. + <type scope="com::sun::star::awt">XWindow</type> + describing the parent window to use for the dialog. </li> <li><b>InitialSelection</b><br/> - String describing which data source should be selected initially. This name must be known to the - <service>DatabaseContext</service>. + String describing which data source should be selected initially. + This name must be known to the + <service scope="com::sun::star::sdb"> + DatabaseContext + </service> + . </li> </ul> </p> @@ -139,31 +160,4 @@ service DatasourceAdministrationDialog }; }; }; }; -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.7 2001/10/25 15:00:32 mi - * proofreading and corrections from Richard Holt - * - * Revision 1.6 2001/07/03 09:00:57 tra - * must change com/sun/star/ui -> com/sun/star/ui/dialogs/ - * - * Revision 1.5 2001/03/16 16:41:32 jsc - * remove interfaceheader with uik and remove [const] in method definitions - * - * Revision 1.4 2001/02/20 14:32:12 fs - * syntax - * - * Revision 1.3 2000/11/08 12:43:31 mi - * moved from api - * - * Revision 1.1 2000/11/01 17:00:53 fs - * initial checkin - the service for an user interface for administrating data sources - * - * - * Revision 1.0 01.11.00 17:37:14 fs - ************************************************************************/ - -// __com_sun_star_sdb_DatasourceAdministrationDialog_idl__ - #endif diff --git a/offapi/com/sun/star/sdb/DefinitionContainer.idl b/offapi/com/sun/star/sdb/DefinitionContainer.idl index 5f50ba4554eb..f363bae30ee6 100644 --- a/offapi/com/sun/star/sdb/DefinitionContainer.idl +++ b/offapi/com/sun/star/sdb/DefinitionContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: DefinitionContainer.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,23 +86,26 @@ interface XSingleServiceFactory; The container supports access to its elements by the elements name or by the elements position. </p> - <p>Simple enumeration must be supported as well. + <p> + Simple enumeration must be supported as well. + </p> + <p> + To reflect the changes with the underlying database, a refresh mechanism + needs to be supported. </p> - <p>To reflect the changes with the underlying database, a refresh mechanism - needs to be supported. </p> */ service DefinitionContainer { - // DocMerge: empty anyway + // gives access to the elements by name. interface com::sun::star::container::XNameAccess; - // DocMerge: empty anyway + // allows to insert and remove by name. interface com::sun::star::container::XNameContainer; - // DocMerge: empty anyway + // gives access to the elements by index. interface com::sun::star::container::XIndexAccess; - // DocMerge: empty anyway + // allows to create an enumeration of the elements. interface com::sun::star::container::XEnumerationAccess; @@ -112,9 +115,11 @@ service DefinitionContainer [optional] interface com::sun::star::util::XRefreshable; /** can be used to create container elements. - <p>If this interface is supported, the object created using it (e.g., the object returned by - <method scope="com.sun.star.lang">XSingleServiceFactory::createInstance</method>) can be used as - container elements.</p> + <p> + If this interface is supported, the object created using it (e.g., the object returned by + <method scope="com.sun.star.lang">XSingleServiceFactory::createInstance()</method> + ) can be used as container elements. + </p> */ [optional] interface com::sun::star::lang::XSingleServiceFactory; }; @@ -125,6 +130,15 @@ service DefinitionContainer /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.2 2002/02/18 12:53:58 oj + #97563# parameter,return value and exception description + + Revision 1.6.2.1 2002/02/18 10:23:14 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/02/07 13:15:17 fs added an optional interface XSingleServiceFactory diff --git a/offapi/com/sun/star/sdb/DocumentDefinition.idl b/offapi/com/sun/star/sdb/DocumentDefinition.idl index a82d6266d2b6..637e500c370d 100644 --- a/offapi/com/sun/star/sdb/DocumentDefinition.idl +++ b/offapi/com/sun/star/sdb/DocumentDefinition.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentDefinition.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,9 +69,13 @@ module com { module sun { module star { module sdb { /** specifies documents which belong to a database source. - <p>These documents typically process information from a connected - data source. A <type>Document</type> could be a form - or a report. + <p> + These documents typically process information from a connected + data source. A + <type> + Document + </type> + could be a form or a report. @deprecated */ diff --git a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl index 21018ada1fb0..0d0d73d7fbaa 100644 --- a/offapi/com/sun/star/sdb/ErrorMessageDialog.idl +++ b/offapi/com/sun/star/sdb/ErrorMessageDialog.idl @@ -2,9 +2,9 @@ * * $RCSfile: ErrorMessageDialog.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: rt $ $Date: 2002-06-17 16:12:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,13 +84,32 @@ module com { module sun { module star { module sdb { /** provides a dialog for displaying database related exceptions. - <p>If applications use any of the functionality provided in the modules - <module scope="com.sun.star">sdbc</module>, <module scope="com.sun.star">sdbcx</module> and <module scope="com.sun.star">sdb</module>, - they will - sooner or later - encounter <type scope="com.sun.star.sdbc">SQLException</type>'s.<br> - These exceptions can be chained, so the information wrapped in one single <type scope="com.sun.star.sdbc">SQLException</type> + <p> + If applications use any of the functionality provided in the modules + <module scope="com.sun.star"> + sdbc + </module> + , + <module scope="com.sun.star"> + sdbcx + </module> + and + <module scope="com.sun.star"> + sdb + </module> + , + they will - sooner or later - encounter + <type scope="com.sun.star.sdbc">SQLException</type> + 's. + <br/> + These exceptions can be chained, so the information wrapped in one single + <type scope="com.sun.star.sdbc">SQLException</type> can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could - append a <type scope="com.sun.star.sdb">SQLContext</type> to explain what it was doing), and they should be - presented to the user in a consistent way.<br> + append a + <type scope="com.sun.star.sdb">SQLContext</type> + to explain what it was doing), and they should be + presented to the user in a consistent way. + <br/> This can be reached by using this service. @see com.sun.star.sdb.InteractionHandler </p> @@ -102,14 +121,22 @@ service ErrorMessageDialog [property] string Title; /** parent window to use for the dialog - <p>This property can't be set while the dialog is being displayed.</p> + <p> + This property can't be set while the dialog is being displayed. + </p> */ [property] com::sun::star::awt::XWindow ParentWindow; /** is the exception displayed by the dialog - <p>This should contain a <type scope="com.sun.star.sdbc">SQLException</type> instance, or an instance - of any class derived from this exception.</p> - <p>This property can't be set while the dialog is being displayed.</p> + <p> + This should contain a + <type scope="com.sun.star.sdbc">SQLException</type> + instance, or an instance + of any class derived from this exception. + </p> + <p> + This property can't be set while the dialog is being displayed. + </p> */ [property] any SQLException; @@ -122,26 +149,40 @@ service ErrorMessageDialog interface com::sun::star::ui::dialogs::XExecutableDialog; /** allows initializing the dialog - <p>You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments - method of your <type scope="com::sun::star::lang">XMultiServiceFactory</type>.</p> - <p>You specify a parameter by passing one (or more) <type scope="com::sun::star::beans">PropertyValue</type> + <p> + You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments + method of your + <type scope="com::sun::star::lang">XMultiServiceFactory</type> + . + </p> + <p> + You specify a parameter by passing one (or more) + <type scope="com::sun::star::beans">PropertyValue</type> object(s) to the initialize method, where the <em>Name</em> field contains a string describing which aspect you want to affect, and the <em>Value</em> field containing a value. - <br> - Imagine the initialization values, as if you use setPropertyValue of the <type scope="com::sun::star::beans">XPropertySet</type> + <br/> + Imagine the initialization values, as if you use + <method scope="com::sun::star::beans">XPropertySet::setPropertyValue() + </method> + of the + <type scope="com::sun::star::beans">XPropertySet</type> interface ... - <br> + <br/> allowed parameters are <ul> - <li><b>Title</b><br> + <li><b>Title</b><br/> String describing the initial title of the dialog. If not specified, a default title is used. </li> - <li><b>ParentWindow</b><br> - <type scope="com::sun::star::awt">XWindow</type> describing the parent window to use for the dialog. + <li><b>ParentWindow</b><br/> + <type scope="com::sun::star::awt">XWindow</type> + describing the parent window to use for the dialog. </li> - <li><b>SQLException</b><br> - <type scope="com::sun::star::sdbc">SQLException</type> describing the error which is beeing displayed.<br> - When initializing this value, you may use any derivative of <type scope="com::sun::star::sdbc">SQLException</type>. + <li><b>SQLException</b><br/> + <type scope="com::sun::star::sdbc">SQLException</type> + describing the error which is beeing displayed.<br/> + When initializing this value, you may use any derivative of + <type scope="com::sun::star::sdbc">SQLException</type> + . </li> </ul> </p> @@ -153,25 +194,5 @@ service ErrorMessageDialog }; }; }; }; -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.5 2001/10/25 15:00:32 mi - * proofreading and corrections from Richard Holt - * - * Revision 1.4 2001/07/03 09:00:57 tra - * must change com/sun/star/ui -> com/sun/star/ui/dialogs/ - * - * Revision 1.3 2001/03/16 16:41:32 jsc - * remove interfaceheader with uik and remove [const] in method definitions - * - * Revision 1.2 2001/03/12 16:26:34 fs - * ooops .... corrected the name of the SQLException property - * - * Revision 1.1 2001/02/20 14:32:46 fs - * initial checkin - service description for the ErrorMessageDialog - * - ************************************************************************/ - #endif diff --git a/offapi/com/sun/star/sdb/InteractionHandler.idl b/offapi/com/sun/star/sdb/InteractionHandler.idl index ef62e82168c5..c94226be6148 100644 --- a/offapi/com/sun/star/sdb/InteractionHandler.idl +++ b/offapi/com/sun/star/sdb/InteractionHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionHandler.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,40 +68,57 @@ module com { module sun { module star { module sdb { -/** is a service for user interaction for databases.</p> +/** is a service for user interaction for databases. + <p> interaction requests that the handler can provide are: <ul> - <li><b>database related errors</b><br> - The general structure to transport such errors is the <type scope="com.sun.star.sdbc">SQLException</type>, - and if your <type scope="com.sun.star.task">XInteractionRequest</type> supplies such a - <type scope="com.sun.star.sdbc">SQLException</type> (or an instance of any derived class), + <li><b>database related errors</b><br/> + The general structure to transport such errors is the + <type scope="com.sun.star.sdbc">SQLException</type> + , and if your + <type scope="com.sun.star.task">XInteractionRequest</type> + supplies such a + <type scope="com.sun.star.sdbc">SQLException</type> + (or an instance of any derived class), the handler will display a generic error dialog, which is able to travel the object chain which may be contained in the exception. </li> - <li><b>authentication</b><br> - If your <type scope="com.sun.star.task">XInteractionRequest</type> - (see <member scope="com.sun.star.task">XInteractionHandler::handle</member>) supplies a - <type scope="com.sun.star.ucb">AuthenticationRequest</type>, the handler will open a standard login + <li><b>authentication</b><br/> + If your + <type scope="com.sun.star.task">XInteractionRequest</type> + (see + <member scope="com.sun.star.task">XInteractionHandler::handle()</member> + ) supplies a + <type scope="com.sun.star.ucb">AuthenticationRequest</type> + , the handler will open a standard login dialog to allow user authentication. - <br> + <br/> Besides the using the members of the AuthenticationRequest in the usual manner, the member <em>Server</em> (if not empty) is interpreted as datasource name, thus leading to a slightly different message when requesting the user to enter it's login data. - <br> + <br/> In the case you want to use this authentication feature, you should supply a special authentication - continuation (<type scope="com.sun.star.ucb">XInteractionSupplyAuthentication</type>) as well, so the + continuation ( + <type scope="com.sun.star.ucb">XInteractionSupplyAuthentication</type> + ) as well, so the handler can return to you, the entered information. </li> - <li><b>parameter requests</b><br> - If your <type scope="com.sun.star.task">XInteractionRequest</type> supplies an - <type scope="com.sun.star.ucb">ParametersRequest</type>, the handler will open a standard dialog asking + <li><b>parameter requests</b><br/> + If your + <type scope="com.sun.star.task">XInteractionRequest</type> + supplies an + <type scope="com.sun.star.ucb">ParametersRequest</type> + , the handler will open a standard dialog asking the user to fill in parameter values. - <br> + <br/> In the case you want to use this feature of the handler, you should supply a special continuation - (<type scope="com.sun.star.sdb">XInteractionSupplyParameters</type>) as well, so the + ( + <type scope="com.sun.star.sdb">XInteractionSupplyParameters</type> + ) as well, so the handler can return to you, the entered information. </li> </ul> + </p> */ service InteractionHandler { @@ -116,6 +133,12 @@ service InteractionHandler /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:26:06 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/19 16:03:41 mi documentations syntax errors fixed diff --git a/offapi/com/sun/star/sdb/ParametersRequest.idl b/offapi/com/sun/star/sdb/ParametersRequest.idl index f11ccff865f7..9bd6a5184b7b 100644 --- a/offapi/com/sun/star/sdb/ParametersRequest.idl +++ b/offapi/com/sun/star/sdb/ParametersRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: ParametersRequest.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,20 +78,28 @@ //============================================================================= -/** an error specifying the lack of parameters values</p> +/** an error specifying the lack of parameters values + <p> Usually thrown if someone tries to execute an SQL statement containing parameters which can't be filled by the executing instance. + </p> */ exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest { - /** is the list of parameters requested.</p> - The objects returned by the <type scope="com.sun.star.container">XIndexAccess</type> have to + /** is the list of parameters requested. + The objects returned by the + <type scope="com.sun.star.container">XIndexAccess</type> + have to be property sets describing the respective parameter. For this, the objects have to support the - service <service scope="com.sun.star.sdbcx">Column</service>. + service + <service scope="com.sun.star.sdbcx"> + Column + </service> + . */ com::sun::star::container::XIndexAccess Parameters; - /** specifies the connection on which the statement is to be executed.</p> + /** specifies the connection on which the statement is to be executed. Somebody handling the request could, e.g., use the connection for determining the identifier quote string, etc. */ @@ -105,6 +113,12 @@ exception ParametersRequest: com::sun::star::task::ClassifiedInteractionRequest /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:22:59 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/PreparedStatement.idl b/offapi/com/sun/star/sdb/PreparedStatement.idl index e7a180a920ae..051372567392 100644 --- a/offapi/com/sun/star/sdb/PreparedStatement.idl +++ b/offapi/com/sun/star/sdb/PreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: PreparedStatement.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,9 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::PreparedStatement /** represents a precompiled SQL statement. The service differs only in the access - of the columns and parameters to the service <type scope="com::sun::star::sdbc">PreparedStatement</type>. + of the columns and parameters to the service + <type scope="com::sun::star::sdbc">PreparedStatement</type> + . */ service PreparedStatement { @@ -94,6 +96,12 @@ service PreparedStatement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:23:19 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/offapi/com/sun/star/sdb/Query.idl b/offapi/com/sun/star/sdb/Query.idl index 770f52096783..b2b75cbf93c6 100644 --- a/offapi/com/sun/star/sdb/Query.idl +++ b/offapi/com/sun/star/sdb/Query.idl @@ -2,9 +2,9 @@ * * $RCSfile: Query.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,9 +85,11 @@ interface XRename; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::Query /** is a stored definition of a SQL query. - <p>It can be used if there is a need to execute SQL statements more than once, or + <p> + It can be used if there is a need to execute SQL statements more than once, or if you want to format the query result fields differently from the - underlying table definitions.</p> + underlying table definitions. + </p> */ service Query { @@ -109,7 +111,7 @@ service Query */ interface com::sun::star::sdbcx::XDataDescriptorFactory; - // DocMerge: empty anyway + // allows to rename the object. interface com::sun::star::sdbcx::XRename; @@ -125,6 +127,15 @@ service Query /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.2 2002/02/18 12:53:58 oj + #97563# parameter,return value and exception description + + Revision 1.4.2.1 2002/02/18 10:25:59 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/QueryDefinition.idl b/offapi/com/sun/star/sdb/QueryDefinition.idl index 1bf72f24fa6f..f0da8dc2362f 100644 --- a/offapi/com/sun/star/sdb/QueryDefinition.idl +++ b/offapi/com/sun/star/sdb/QueryDefinition.idl @@ -2,9 +2,9 @@ * * $RCSfile: QueryDefinition.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,9 @@ // DocMerge from xml: service com::sun::star::sdb::QueryDefinition /** is a stored definition of a SQL "Select statement". - <p>It can be used, if there is a need to execute SQL statement more than once. </p> + <p> + It can be used, if there is a need to execute SQL statement more than once. + </p> */ service QueryDefinition { @@ -89,7 +91,7 @@ service QueryDefinition // DocMerge from xml: property com::sun::star::sdb::QueryDefinition::Command - /** is the command of the query, this is typically a Select statement. + /** is the command of the query, this is typically a select statement. */ [property] string Command; @@ -125,6 +127,12 @@ service QueryDefinition /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:22:11 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/QueryDescriptor.idl b/offapi/com/sun/star/sdb/QueryDescriptor.idl index fe8269a9b9c2..599c7cfb189b 100644 --- a/offapi/com/sun/star/sdb/QueryDescriptor.idl +++ b/offapi/com/sun/star/sdb/QueryDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: QueryDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,11 +78,13 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor -/** A query is a stored definition of a SQL "Select statement". +/** is a stored definition of a SQL "Select statement". - <p>It can be used, if there is a need to execute SQL statement more than once or + <p> + It can be used, if there is a need to execute SQL statement more than once or if you want to format the query result fields different from the - underlying table definitions.</p> + underlying table definitions. + </p> */ service QueryDescriptor { @@ -109,7 +111,7 @@ service QueryDescriptor // DocMerge from xml: property com::sun::star::sdbcx::com::sun::star::sdb::QueryDescriptor::Command - /** is the command of the query, this is typically a Select statement. + /** is the command of the query, this is typically a select statement. */ [property] string Command; @@ -145,6 +147,12 @@ service QueryDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:26:26 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/ResultColumn.idl b/offapi/com/sun/star/sdb/ResultColumn.idl index a7d20031aba5..bfe159acb974 100644 --- a/offapi/com/sun/star/sdb/ResultColumn.idl +++ b/offapi/com/sun/star/sdb/ResultColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultColumn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -138,7 +138,8 @@ service ResultColumn // DocMerge from xml: property com::sun::star::sdb::ResultColumn::ServiceName /** returns the fully-qualified name of the service whose instances - are manufactured if the method <code>ResultSet.getObject</code> + are manufactured if the method + <method scope="com::sun::star::sdbc">XRow::getObject)=</method> is called to retrieve a value from the column. */ [readonly, property] string ServiceName; @@ -168,6 +169,12 @@ service ResultColumn /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:24:23 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/ResultSet.idl b/offapi/com/sun/star/sdb/ResultSet.idl index 11fcdc54e017..9060becba1a1 100644 --- a/offapi/com/sun/star/sdb/ResultSet.idl +++ b/offapi/com/sun/star/sdb/ResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,9 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::ResultSet -/** extends the sdbcx ResultSet by a more sophisticated access to the result sets +/** extends the + <type scope="com::sun::star::sdbcx">ResultSet</type> + by a more sophisticated access to the result sets data. */ service ResultSet @@ -94,6 +96,12 @@ service ResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:25:41 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/RowChangeEvent.idl b/offapi/com/sun/star/sdb/RowChangeEvent.idl index 05725afd3507..a426c44eafeb 100644 --- a/offapi/com/sun/star/sdb/RowChangeEvent.idl +++ b/offapi/com/sun/star/sdb/RowChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowChangeEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,8 @@ struct RowChangeEvent: com::sun::star::lang::EventObject { // DocMerge from xml: field com::sun::star::sdb::RowChangeEvent::Action - /** indicates the type of change.@see com::sun::star::sdb::RowChangeAction + /** indicates the type of change. + @see com::sun::star::sdb::RowChangeAction */ long Action; @@ -92,6 +93,12 @@ struct RowChangeEvent: com::sun::star::lang::EventObject /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:24:34 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:37 hjs initial import diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index 50e69cc5cced..ef9e69bcc8db 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowSet.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,10 @@ interface XConnection; #include <com/sun/star/sdb/ResultSet.idl> #endif +#ifndef __com_sun_star_sdb_XCompletedExecution_idl__ +#include <com/sun/star/sdb/XCompletedExecution.idl> +#endif + module com { module sun { module star { module sdbcx { interface XDeleteRows; };};};}; @@ -80,7 +84,6 @@ interface XDeleteRows; module com { module sun { module star { module sdb { interface XRowSetApproveBroadcaster; -interface XParametersSupplier; interface XResultSetAccess; @@ -89,19 +92,18 @@ interface XResultSetAccess; a query or a SQL command or by a rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated connection. -<!-- JRH: Trial text below, is this what is intended? No changes to above text. - - is a client side RowSet, use of which retrieves data, based on a database table, - a query or a SQL command or by a rowset reader, which must not support SQL. - The connection of the rowset is typically a named DataSource, a DataAccess component, - or a previous instanciated connection. - --> - <p>Depending on the ResultSetConcurrency, the RowSet caches all data or uses + <p> + Depending on the + <type scope="com::sun::star::sdbc">ResultSetConcurrency</type> + , the RowSet caches all data or uses an optimized way for retrieving the data, such as, refetching rows by their keys or if provided, by their bookmarks. </p> - <p>In addition, it provides events for RowSet navigation and RowSet modifications + <p> + In addition, it provides events for RowSet navigation and RowSet modifications to approve the actions and to react on them. + @see com::sun::star::sdb::RowChangeAction + @see com::sun::star::sdb::RowChangeEvent </p> */ service RowSet @@ -113,7 +115,18 @@ service RowSet service com::sun::star::sdb::ResultSet; - // DocMerge from xml: service com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet: interface com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::XRowSetApproveBroadcaster + /** can be used to allow an interaction handler to supply missing data during a execute process. + + <p>If you want a row set to be based on a parametrized query, you will usually use + the <type scope="com::sun::star::sdbc">XParameters</type> interface.<br/> + However, you can also choose to let an interaction handler supply such data. For this, you may + for instance instantiate an <type>InteractionHandler</type>, which asks the user for the + data, or you may write your own one, which supplies the data from somewhere else.</p> + + @see com::sun::star::sdb::InteractionHandler + */ + interface com::sun::star::sdb::XCompletedExecution; + /** approving of actions performed on the rowset. */ interface XRowSetApproveBroadcaster; @@ -121,16 +134,22 @@ service RowSet // DocMerge from xml: service com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet: interface com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::XResultSetAccess /** creates a second result set which is based on the same data. - <p>The new result set is interoperable with the row set which created it, - e.g., you can exchange bookmarks between both sets.</p> - <p>If the row set is not alive (i.e., it was not executed before), <NULL/> is returned.</p> + <p> + The new result set is interoperable with the row set which created it, + e.g., you can exchange bookmarks between both sets. + </p> + <p> + If the row set is not alive (i.e., it was not executed before), + <NULL/> + is returned. + </p> */ interface XResultSetAccess; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::ActiveConnection /** is the connection generated by a DataSource or by a URL. It could - also be set from outside. + also be set from outside. When set from outside the RowSet is not responsible for the closing of the connection. */ [property] com::sun::star::sdbc::XConnection ActiveConnection; @@ -144,19 +163,23 @@ service RowSet // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::Command /** is the command which should be executed, the type of command depends - on the CommandType.@see com::sun::star::sdb::CommandType + on the CommandType. + @see com::sun::star::sdb::CommandType */ [property] string Command; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::CommandType - /** is the type of the command@see com::sun::star::sdb::CommandType.@see com::sun::star::sdb::CommandType. + /** is the type of the command. + @see com::sun::star::sdb::CommandType + @see com::sun::star::sdb::CommandType */ [property] long CommandType; // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::ActiveCommand - /** is the command which is currently used.@see com::sun::star::sdb::CommandType + /** is the command which is currently used. + @see com::sun::star::sdb::CommandType */ [readonly, property] string ActiveCommand; @@ -187,7 +210,8 @@ service RowSet // DocMerge from xml: property com::sun::star::sdbc::com::sun::star::sdbcx::com::sun::star::sdb::RowSet::Privileges - /** indicates the privileges for insert, update, and delete.@see com::sun::star::sdbcx::Privilege + /** indicates the privileges for insert, update, and delete. + @see com::sun::star::sdbcx::Privilege */ [readonly, property] long Privileges; @@ -246,6 +270,15 @@ service RowSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.7.2.2 2002/08/05 13:01:36 fs + added XCompletedExecution + + Revision 1.7.2.1 2002/02/18 10:23:56 oj + #97563# parameter,return value and exception description + + Revision 1.7 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.6 2001/01/24 09:56:11 fs #83074# extended the doc for the XResultSetAccess interface diff --git a/offapi/com/sun/star/sdb/RowSetVetoException.idl b/offapi/com/sun/star/sdb/RowSetVetoException.idl index 9fc350ac456d..a06746f20cda 100644 --- a/offapi/com/sun/star/sdb/RowSetVetoException.idl +++ b/offapi/com/sun/star/sdb/RowSetVetoException.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowSetVetoException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,6 +71,7 @@ // DocMerge from xml: exception com::sun::star::sdb::RowSetVetoException /** is an exception fired whenever a rowset operation was cancelled because of of a veto of an approved listener. + @see com::sun::star::sdb::XRowSetApproveListener */ exception RowSetVetoException: com::sun::star::sdbc::SQLException { @@ -82,6 +83,12 @@ exception RowSetVetoException: com::sun::star::sdbc::SQLException /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:26:12 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:37 hjs initial import diff --git a/offapi/com/sun/star/sdb/SQLContext.idl b/offapi/com/sun/star/sdb/SQLContext.idl index 056d2418c798..402edb3d4bac 100644 --- a/offapi/com/sun/star/sdb/SQLContext.idl +++ b/offapi/com/sun/star/sdb/SQLContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: SQLContext.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,8 @@ // DocMerge from xml: exception com::sun::star::sdb::SQLContext /** provides special information about the context where a - <type scope="com::sun::star::sdbc">SQLException</type> occurred. As usual + <type scope="com::sun::star::sdbc">SQLException</type> + occurred. As usual for SQLExceptions, several SQLContext-objects may be chained, then the most recent context is appended to the list's tail. @@ -81,7 +82,9 @@ exception SQLContext: com::sun::star::sdbc::SQLWarning { // DocMerge from xml: field com::sun::star::sdb::SQLContext::Details - /** provides special info about the details where a <type scope="com::sun::star::sdbc">SQLException</type> occured. + /** provides special info about the details where a + <type scope="com::sun::star::sdbc">SQLException</type> + occured. As usual for SQLExceptions, several SQLContext-objects may be chained, then the most recent context is appended to the list's tail */ @@ -96,6 +99,12 @@ exception SQLContext: com::sun::star::sdbc::SQLWarning /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:24:07 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/19 16:03:41 mi documentations syntax errors fixed diff --git a/offapi/com/sun/star/sdb/SQLQueryComposer.idl b/offapi/com/sun/star/sdb/SQLQueryComposer.idl index 11aea540298d..3e0f23dd21f6 100644 --- a/offapi/com/sun/star/sdb/SQLQueryComposer.idl +++ b/offapi/com/sun/star/sdb/SQLQueryComposer.idl @@ -2,9 +2,9 @@ * * $RCSfile: SQLQueryComposer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,12 +74,14 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::com::sun::star::sdb::SQLQueryComposer -/** represents a tool for composing SQL Select statements. +/** represents a tool for composing SQL select statements. - <p>It hides the complexity of parsing and evaluating SQL Statements and provides + <p> + It hides the complexity of parsing and evaluating SQL Statements and provides sophisticated methods for expanding a SQL-Statement with filter and order - criteria.</p> + criteria. + </p> */ service SQLQueryComposer { @@ -108,6 +110,12 @@ service SQLQueryComposer /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:25:16 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/Table.idl b/offapi/com/sun/star/sdb/Table.idl index e260b90d7eb2..2d34412e0173 100644 --- a/offapi/com/sun/star/sdb/Table.idl +++ b/offapi/com/sun/star/sdb/Table.idl @@ -2,9 +2,9 @@ * * $RCSfile: Table.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,9 @@ // DocMerge from xml: service com::sun::star::sdb::Table -/** extends the <type scope="com::sun::star::sdbcx">Table</type> with additional - display information, sorting, and filtering criterias. +/** extends the service + <type scope="com::sun::star::sdbcx">Table</type> + with additional display information, sorting, and filtering criterias. */ service Table { @@ -89,7 +90,8 @@ service Table // DocMerge from xml: property com::sun::star::sdb::Table::Privileges - /** indicates the privileges for the table.@see com::sun::star::sdbcx::Privilege + /** indicates the privileges for the table. + @see com::sun::star::sdbcx::Privilege */ [readonly, property] long Privileges; }; @@ -100,6 +102,12 @@ service Table /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:21:40 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/TableDescriptor.idl b/offapi/com/sun/star/sdb/TableDescriptor.idl index 84c256b633b7..927603088864 100644 --- a/offapi/com/sun/star/sdb/TableDescriptor.idl +++ b/offapi/com/sun/star/sdb/TableDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,9 @@ // DocMerge from xml: service com::sun::star::sdb::TableDescriptor -/** extends the <type scope="com::sun::star::sdbcx">TableDescriptor</type> with additional - display informations, sorting, and filtering criteria. +/** extends the service + <type scope="com::sun::star::sdbcx">TableDescriptor</type> + with additional display informations, sorting, and filtering criteria. */ service TableDescriptor { @@ -94,6 +95,12 @@ service TableDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 10:25:09 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XAlterQuery.idl b/offapi/com/sun/star/sdb/XAlterQuery.idl index ccbe15b5110a..46e256c2a048 100644 --- a/offapi/com/sun/star/sdb/XAlterQuery.idl +++ b/offapi/com/sun/star/sdb/XAlterQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAlterQuery.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,13 +72,19 @@ module com { module sun { module star { module sdb { // DocMerge from xml: interface com::sun::star::sdb::XAlterQuery -/** is used for creating and appending new objects to a specific container. +/** is used to alter the command of a query. */ interface XAlterQuery: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdb::XAlterQuery::alterCommand /** is intended to alter the command of a query object. + @param command + the SQL statement + @param useEscapeProcessing + <TRUE/> when escape processing should be used + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void alterCommand([in]string command, [in]boolean useEscapeProcessing) raises (com::sun::star::sdbc::SQLException); @@ -90,6 +96,12 @@ interface XAlterQuery: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:24:54 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XBookmarksSupplier.idl b/offapi/com/sun/star/sdb/XBookmarksSupplier.idl index 33e348336b3c..9fd2bdcadfaa 100644 --- a/offapi/com/sun/star/sdb/XBookmarksSupplier.idl +++ b/offapi/com/sun/star/sdb/XBookmarksSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBookmarksSupplier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,17 @@ //============================================================================= -/** provides access to the collection of all bookmarks associated with a data source +/** provides access to the collection of all bookmarks associated with a data source. */ interface XBookmarksSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** @returns the collection of all bookmarks associated with a data source - <p>A bookmark is simply a string specifying the location of the - bookmarked document.</p> + <p> + A bookmark is simply a string specifying the location of the + bookmarked document. + </p> */ com::sun::star::container::XNameAccess getBookmarks(); @@ -97,6 +99,12 @@ interface XBookmarksSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.2.1 2002/02/18 10:26:57 oj + #97563# parameter,return value and exception description + + Revision 1.2 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.1 2001/04/26 09:10:51 fs initial checkin - supply bookmarks associated with a DataSource diff --git a/offapi/com/sun/star/sdb/XColumn.idl b/offapi/com/sun/star/sdb/XColumn.idl index 2e44acfdd00c..6c16ec779451 100644 --- a/offapi/com/sun/star/sdb/XColumn.idl +++ b/offapi/com/sun/star/sdb/XColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumn.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -109,56 +109,93 @@ interface XColumn: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::wasNull /** reports whether the last column read had a value of SQL NULL. Note that you must first call getXXX on a column to try to read - its value and then call wasNull() to see if the value read was - SQL NULL. + its value and then call + <code>wasNull()</code> + to see if the value read was SQL NULL. + @returns + <TRUE/> if so + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ boolean wasNull() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getString /** gets the value of a column in the current row as a String. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ string getString() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getBoolean /** gets the value of a column in the current row as boolean. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ boolean getBoolean() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getByte /** gets the value of a column in the current row as a byte. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ byte getByte() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getShort /** gets the value of a column in the current row as a short. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ short getShort() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getInt /** gets the value of a column in the current row as a long. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ long getInt() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getLong /** gets the value of a column in the current row as a hyper. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ hyper getLong() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getFloat /** gets the value of a column in the current row as a float. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ float getFloat() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getDouble /** gets the value of a column in the current row as a double. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ double getDouble() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- @@ -167,7 +204,7 @@ interface XColumn: com::sun::star::uno::XInterface /** gets the value of a column in the current row as a byte array. The bytes represent the raw values returned by the driver. @returns the column value; -if the value is SQL NULL, the result is empty. + if the value is SQL NULL, the result is empty. @throws com::sun::star::sdbc::SQLException if a database access error occurs. */ @@ -176,6 +213,10 @@ if the value is SQL NULL, the result is empty. // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getDate /** gets the value of a column in the current row as a date object. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::util::Date getDate() raises (com::sun::star::sdbc::SQLException); @@ -183,6 +224,10 @@ if the value is SQL NULL, the result is empty. // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getTime /** gets the value of a column in the current row as a time object. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::util::Time getTime() raises (com::sun::star::sdbc::SQLException); @@ -190,6 +235,10 @@ if the value is SQL NULL, the result is empty. // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getTimestamp /** gets the value of a column in the current row as a datetime object. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::util::DateTime getTimestamp() raises (com::sun::star::sdbc::SQLException); @@ -206,10 +255,14 @@ if the value is SQL NULL, the result is empty. <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> - is called whether there is data - available or not. + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> + is called whether there is data available or not. </p> + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream() raises (com::sun::star::sdbc::SQLException); @@ -225,9 +278,14 @@ if the value is SQL NULL, the result is empty. <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> is called whether there is data available or not. </p> + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getCharacterStream() raises (com::sun::star::sdbc::SQLException); @@ -235,9 +293,17 @@ if the value is SQL NULL, the result is empty. // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getObject /** @returns the value of a column in the current row as an object. - This method uses the given <code>Map</code> object + This method uses the given + <code>Map</code> + object for the custom mapping of the SQL structure or distinct type that is being retrieved. + @param typeMap + the type map is used to fetch the correct type + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ any getObject([in]com::sun::star::container::XNameAccess typeMap) raises (com::sun::star::sdbc::SQLException); @@ -246,25 +312,40 @@ if the value is SQL NULL, the result is empty. // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getRef /** gets a REF(<structured-type>) column value from the current row. -<!-- JRH: html changed from "REF(&lt;structured-type&gt;)" --> -*/ + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ com::sun::star::sdbc::XRef getRef() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getBlob /** gets a BLOB (Binary Large OBject) value in the current row. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::sdbc::XBlob getBlob() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getClob /** gets a CLOB value in the current row of this <code>ResultSet</code> object. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::sdbc::XClob getClob() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::com::sun::star::sdb::XColumn::getArray /** gets a SQL ARRAY value from the current row. + @returns + the column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::sdbc::XArray getArray() raises (com::sun::star::sdbc::SQLException); }; @@ -275,6 +356,12 @@ if the value is SQL NULL, the result is empty. /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:21:46 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XColumnUpdate.idl b/offapi/com/sun/star/sdb/XColumnUpdate.idl index f0087becde8f..b37888af8c87 100644 --- a/offapi/com/sun/star/sdb/XColumnUpdate.idl +++ b/offapi/com/sun/star/sdb/XColumnUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumnUpdate.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,66 +96,108 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateNull /** gives a nullable column a null value. + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateNull() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBoolean /** updates a column with a boolean value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateBoolean([in]boolean x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateByte /** updates a column with a byte value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateByte([in]byte x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateShort /** updates a column with a short value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateShort([in]short x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateInt /** updates a column with a long value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateInt([in]long x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateLong /** updates a column with a hyper value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateLong([in]hyper x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateFloat /** updates a column with a float value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateFloat([in]float x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateDouble - /** updates a column with a Double value. + /** updates a column with a double value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateDouble([in]double x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateString - /** updates a column with a String value. + /** updates a column with a string value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateString([in]string x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBytes /** updates a column with a byte array value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateBytes([in]sequence<byte> x) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateDate /** updates a column with a Date value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateDate([in]com::sun::star::util::Date x) raises (com::sun::star::sdbc::SQLException); @@ -163,6 +205,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateTime /** updates a column with a Time value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateTime([in]com::sun::star::util::Time x) raises (com::sun::star::sdbc::SQLException); @@ -170,6 +216,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateTimestamp /** updates a column with a Timestamp value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateTimestamp([in]com::sun::star::util::DateTime x) raises (com::sun::star::sdbc::SQLException); @@ -177,6 +227,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateBinaryStream /** updates a column with a stream value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateBinaryStream([in]com::sun::star::io::XInputStream x, [in]long length) raises (com::sun::star::sdbc::SQLException); @@ -184,6 +238,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateCharacterStream /** updates a column with a stream value. + @param x + the new column value + @param length + the length of the stream + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateCharacterStream([in]com::sun::star::io::XInputStream x, [in]long length) raises (com::sun::star::sdbc::SQLException); @@ -191,6 +251,10 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateObject /** updates a column with an Object value. + @param x + the new column value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateObject([in]any x) raises (com::sun::star::sdbc::SQLException); @@ -198,6 +262,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdb::XColumnUpdate::updateNumericObject /** updates a column with an Object value. + @param x + the new column value + @param scale + the scale + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void updateNumericObject([in]any x, [in]long scale) raises (com::sun::star::sdbc::SQLException); @@ -209,6 +279,12 @@ interface XColumnUpdate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:25:31 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XCommandPreparation.idl b/offapi/com/sun/star/sdb/XCommandPreparation.idl index caddd9b7ca23..8d3e24b9f17a 100644 --- a/offapi/com/sun/star/sdb/XCommandPreparation.idl +++ b/offapi/com/sun/star/sdb/XCommandPreparation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandPreparation.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,21 +75,34 @@ interface XPreparedStatement; // DocMerge from xml: interface com::sun::star::sdbc::com::sun::star::sdb::XCommandPreparation /** is used for preparation of commands. - <p> A command could be a table, query, or any kind of SQLstatement - prepared by the user.</p> + <p> + A command could be a table, query, or any kind of SQL statement + prepared by the user. + </p> */ interface XCommandPreparation: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XCommandPreparation::prepareCommand - /** creates a <code>PreparedStatement</code> object for sending - parameterized SQL statements to the database. + /** creates a + <type scope="com::sun::star::sdbc">PreparedStatement</type> + object for sending parameterized SQL statements to the database. - <p>A SQL statement with or without IN parameters can be + <p> + A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. </p> + @param command + the command to be prepared. Any SQL statement. + @param commandType + kind of the command + <type scope="com::sun::star::sdb">CommandType</type> + @returns + the PreparedStatement object + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType) raises (com::sun::star::sdbc::SQLException); @@ -101,6 +114,12 @@ interface XCommandPreparation: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:25:48 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XCompletedConnection.idl b/offapi/com/sun/star/sdb/XCompletedConnection.idl index 09448c0a6255..7ebecdd4a3ba 100644 --- a/offapi/com/sun/star/sdb/XCompletedConnection.idl +++ b/offapi/com/sun/star/sdb/XCompletedConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCompletedConnection.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,6 +87,12 @@ interface XCompletedConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XCompletedConnection::connectWithCompletion /** attempts to establish a database connection. If information is missing, such as a user's password, they are completed by user interaction. + @param handler + will be asked when more information is needed + @returns + the Connection object + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ com::sun::star::sdbc::XConnection connectWithCompletion([in]com::sun::star::task::XInteractionHandler handler) @@ -99,6 +105,12 @@ interface XCompletedConnection: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:22:53 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XCompletedExecution.idl b/offapi/com/sun/star/sdb/XCompletedExecution.idl index 6fa5c5e1c3b3..9f9b8b8e5df6 100644 --- a/offapi/com/sun/star/sdb/XCompletedExecution.idl +++ b/offapi/com/sun/star/sdb/XCompletedExecution.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCompletedExecution.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,10 @@ interface XCompletedExecution: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XCompletedExecution::executeWithCompletion /** completes necessary information before execution, for example parameter values. + @param handler + will be asked when more information is needed + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void executeWithCompletion([in]com::sun::star::task::XInteractionHandler handler) raises (com::sun::star::sdbc::SQLException); @@ -92,6 +96,12 @@ interface XCompletedExecution: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:24:46 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XDatabaseAccess.idl b/offapi/com/sun/star/sdb/XDatabaseAccess.idl index 66eed6072c34..e6e3605c4b5c 100644 --- a/offapi/com/sun/star/sdb/XDatabaseAccess.idl +++ b/offapi/com/sun/star/sdb/XDatabaseAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,6 +95,8 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource // DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::hasConnections /** indicates that connections already exist. + @returns + <TRUE/> if so */ boolean hasConnections(); //------------------------------------------------------------------------- @@ -102,6 +104,15 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource // DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::getIsolatedConnection /** attempts to establish a database connection, that can not be shared with other components. This should be used for transaction processing. + @param user + the user name + @param password + the password + @returns + an isolated connection object + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + @see com::sun::star::sdb::XConnection */ XConnection getIsolatedConnection([in]string user, [in]string password) raises (com::sun::star::sdbc::SQLException); @@ -110,6 +121,8 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource // DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::suspendConnections /** closes the all connections to database. This request could be aborted by listeners of the component. + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ boolean suspendConnections() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- @@ -117,12 +130,18 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource // DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::addDatabaseAccessListener /** adds the specified listener to receive the events "connectionChanged", "approveConnectionClose", and "connectionClosing". + @param listener + the listener to append + @see com::sun::star::sdb::XDatabaseAccessListener */ [oneway] void addDatabaseAccessListener([in]XDatabaseAccessListener listener); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::task::com::sun::star::sdb::XDatabaseAccess::removeDatabaseAccessListener /** removes the specified listener. + @param listener + the listener to append + @see com::sun::star::sdb::XDatabaseAccessListener */ [oneway] void removeDatabaseAccessListener( [in]XDatabaseAccessListener listener); @@ -135,6 +154,12 @@ interface XDatabaseAccess: com::sun::star::sdbc::XDataSource /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:24:28 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl b/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl index 925590b8e743..675a14c59721 100644 --- a/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl +++ b/offapi/com/sun/star/sdb/XDatabaseAccessListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseAccessListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,30 +73,42 @@ "connectionClosing" events posted by a database access bean. - <p>A database access bean setting may be changed to connect to a different database. + <p> + A database access bean setting may be changed to connect to a different database. In that case, the connection of the bean must be closed and a new connection must be established. The could affect the current data processing on the bean, as it could be shared by a number of components. To prevent the bean from closing it's - connection, a DatabaseAccessListener could abort the closing.</p> + connection, a DatabaseAccessListener could abort the closing. + </p> */ interface XDatabaseAccessListener: com::sun::star::lang::XEventListener { // DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::connectionChanged /** indicates that a new connection for the bean has been established. + @param evenet + the event happend */ [oneway] void connectionChanged([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::approveConnectionClosing /** indicates that the connection of the bean will be closed. If there are pending - actions on the connection of the bean, "approveConnectionClosing" should return <FALSE/>. + actions on the connection of the bean, "approveConnectionClosing" should return + <FALSE/>. + + @param evenet + the event happend + @returns + <TRUE/> when approved, otherwise <FALSE/> */ boolean approveConnectionClosing([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdb::XDatabaseAccessListener::connectionClosing /** indicates that the connection will definitely be closed. + @param evenet + the event happend */ [oneway] void connectionClosing([in]com::sun::star::lang::EventObject event); }; @@ -107,6 +119,12 @@ interface XDatabaseAccessListener: com::sun::star::lang::XEventListener /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 10:22:37 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/14 12:53:38 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl b/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl index ae090e29faa0..d63e9032b8dd 100644 --- a/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl +++ b/offapi/com/sun/star/sdb/XDatabaseEnvironment.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseEnvironment.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,6 +89,8 @@ interface XDatabaseAccess; /** specifies the root of the data access beans. It provides the possiblity to open a data access bean, which contains tables, queries, forms, and report documents, or to open a connection to a database. + + @deprecated */ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager { @@ -101,6 +103,10 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager <p>Database Access beans are always shared, so if there's a second request for the same bean, the same instance of the bean will be returned, if it is still alive. </p> + @param URL + a database url of the form sdbc:subprotocol:subname + @returns + the database access object for this url */ XDatabaseAccess getDatabaseAccess([in]string URL) raises (com::sun::star::sdbc::SQLException); @@ -108,6 +114,12 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager // DocMerge from xml: method com::sun::star::sdb::XDatabaseEnvironment::createDatabaseAccess /** creates a new DatabaseAccess bean specified by it's URL. + @param URL + a database url of the form sdbc:subprotocol:subname + @param title + the title of the database access + @returns + the new created database access object for this url */ XDatabaseAccess createDatabaseAccess([in]string URL, [in]string title) raises (com::sun::star::sdbc::SQLException); @@ -120,6 +132,12 @@ interface XDatabaseEnvironment: com::sun::star::sdbc::XDriverManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:22:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl b/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl index 7f3a77373c9f..eed839475f59 100644 --- a/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl +++ b/offapi/com/sun/star/sdb/XFormDocumentsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormDocumentsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XFormDocumentsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XFormDocumentsSupplier::getFormDocuments /** returns the container of forms. + @returns + the form documents */ com::sun::star::container::XNameAccess getFormDocuments(); }; @@ -90,6 +92,12 @@ interface XFormDocumentsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:24:12 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl index 8f924eeb993d..23e08222b09e 100644 --- a/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl +++ b/offapi/com/sun/star/sdb/XInteractionSupplyParameters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionSupplyParameters.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,16 @@ module com { module sun { module star { module sdb { /** An interaction continuation handing back parameter data. - <p>This continuation is typically used in conjunction with a - <type scope="com.sun.star.sdb">ParametersRequest</type>. </p> + <p> + This continuation is typically used in conjunction with a + <type scope="com.sun.star.sdb">ParametersRequest</type>. + </p> */ interface XInteractionSupplyParameters: com::sun::star::task::XInteractionContinuation { /** set the parameters chosen by the interaction handler + @param Values + the parameters to set */ void setParameters( [in] sequence< com::sun::star::beans::PropertyValue > Values); }; @@ -89,6 +93,12 @@ interface XInteractionSupplyParameters: com::sun::star::task::XInteractionContin /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 10:25:25 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/15 11:29:29 mi @desc removed (now <p>...</p>), @desc is not a valid tag diff --git a/offapi/com/sun/star/sdb/XParametersSupplier.idl b/offapi/com/sun/star/sdb/XParametersSupplier.idl index 03c0659e8db9..fdacb2009702 100644 --- a/offapi/com/sun/star/sdb/XParametersSupplier.idl +++ b/offapi/com/sun/star/sdb/XParametersSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParametersSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XParametersSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XParametersSupplier::getParameters /** returns the container of parameters. + @returns + the parameters */ com::sun::star::container::XIndexAccess getParameters(); }; @@ -91,6 +93,12 @@ interface XParametersSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:23:50 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XQueriesSupplier.idl b/offapi/com/sun/star/sdb/XQueriesSupplier.idl index a76cba165547..0863baa4a2df 100644 --- a/offapi/com/sun/star/sdb/XQueriesSupplier.idl +++ b/offapi/com/sun/star/sdb/XQueriesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XQueriesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XQueriesSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XQueriesSupplier::getQueries /** returns the container of queries. + @returns + the queries */ com::sun::star::container::XNameAccess getQueries(); }; @@ -90,6 +92,12 @@ interface XQueriesSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:22:49 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl b/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl index 19dbbefe4cbf..b42ab75a32d1 100644 --- a/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl +++ b/offapi/com/sun/star/sdb/XQueryDefinitionsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XQueryDefinitionsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XQueryDefinitionsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XQueryDefinitionsSupplier::getQueryDefinitions /** returns the container of commands. + @returns + the query definitions */ com::sun::star::container::XNameAccess getQueryDefinitions(); }; @@ -90,6 +92,12 @@ interface XQueryDefinitionsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:28:04 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl b/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl index 9c094a5e3efa..93752fab4090 100644 --- a/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl +++ b/offapi/com/sun/star/sdb/XReportDocumentsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XReportDocumentsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XReportDocumentsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XReportDocumentsSupplier::getReportDocuments /** returns the container of reports. + @returns + the report documents */ com::sun::star::container::XNameAccess getReportDocuments(); }; @@ -90,6 +92,12 @@ interface XReportDocumentsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:27:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XResultSetAccess.idl b/offapi/com/sun/star/sdb/XResultSetAccess.idl index 6fc39c6f533a..6af51ca05407 100644 --- a/offapi/com/sun/star/sdb/XResultSetAccess.idl +++ b/offapi/com/sun/star/sdb/XResultSetAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,13 +80,19 @@ interface XResultSet; // DocMerge from xml: interface com::sun::star::sdbc::com::sun::star::sdb::XResultSetAccess -/** is the interface to create a ResultSet based on the object providing the interface. +/** is the interface to create a + <type scope="com::sun::star::sdbc">ResultSet</type> + based on the object providing the interface. */ interface XResultSetAccess: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdb::XResultSetAccess::createResultSet - /** returns a new ResultSet based on the object. + /** returns a new + <type scope="com::sun::star::sdbc">ResultSet</type> + based on the object. + @returns + the new created ResultSet object */ com::sun::star::sdbc::XResultSet createResultSet() raises (com::sun::star::sdbc::SQLException); }; @@ -97,6 +103,12 @@ interface XResultSetAccess: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:27:50 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl index f4822d3d611c..7c6ac177dd5e 100644 --- a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl +++ b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSetApproveBroadcaster.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,7 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XRowSetApproveBroadcaster::addRowSetApproveListener /** adds the specified listener to receive the events "approveCursorMove", "approveRowChange", and "appproveRowSetChange". + @param com::sun::star::sdb::XRowSetApproveListener */ [oneway] void addRowSetApproveListener( [in]XRowSetApproveListener listener ); @@ -87,6 +88,7 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XRowSetApproveBroadcaster::removeRowSetApproveListener /** removes the specified listener. + @param com::sun::star::sdb::XRowSetApproveListener */ [oneway] void removeRowSetApproveListener( [in]XRowSetApproveListener listener ); @@ -98,6 +100,12 @@ interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:24:17 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl index b29e1540f4d0..99b551372381 100644 --- a/offapi/com/sun/star/sdb/XRowSetApproveListener.idl +++ b/offapi/com/sun/star/sdb/XRowSetApproveListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSetApproveListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,12 +80,18 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveCursorMove /** is called before a rowset's cursor is moved. + @param event + the event which happend + @returns <TRUE/> when moving is allowed, otherwise <FALSE/> */ boolean approveCursorMove([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveRowChange /** is called before a row is inserted, updated, or deleted. + @param event + the event which happend + @returns <TRUE/> when changing is allowed, otherwise <FALSE/> */ boolean approveRowChange([in]RowChangeEvent event); //------------------------------------------------------------------------- @@ -93,8 +99,10 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdb::XRowSetApproveListener::approveRowSetChange /** is called before a rowset is changed, or in other words before a rowset is reexecuted. - -<!-- JRH: check that sense is correct. -->*/ + @param event + the event which happend + @returns <TRUE/> when changing is allowed, otherwise <FALSE/> + */ boolean approveRowSetChange([in]com::sun::star::lang::EventObject event); }; @@ -104,6 +112,12 @@ interface XRowSetApproveListener: com::sun::star::lang::XEventListener /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:27:43 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XRowSetSupplier.idl b/offapi/com/sun/star/sdb/XRowSetSupplier.idl index bf3926bdcd5b..4b22867c9993 100644 --- a/offapi/com/sun/star/sdb/XRowSetSupplier.idl +++ b/offapi/com/sun/star/sdb/XRowSetSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSetSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,6 +82,8 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XRowSetSupplier::getRowSet /** provides access to the data source. + @returns + the RowSet object */ com::sun::star::sdbc::XRowSet getRowSet(); @@ -89,6 +91,8 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XRowSetSupplier::setRowSet /** sets the data source. + @param xDataSource + the RowSet object to set */ [oneway] void setRowSet( [in] com::sun::star::sdbc::XRowSet xDataSource ); @@ -102,6 +106,12 @@ interface XRowSetSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:27:35 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl index 7d0abf3f9e89..680b09ab717b 100644 --- a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl +++ b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLErrorBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,14 +74,16 @@ // DocMerge from xml: interface com::sun::star::sdb::XSQLErrorBroadcaster /** interface for notifying potential listeners - of <type scope="com::sun::star::sdbc">SQLException</type>s posted by - any database object. + of + <type scope="com::sun::star::sdbc">SQLException</type> + s posted by any database object. */ interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdb::XSQLErrorBroadcaster::addSQLErrorListener /** adds the specified listener to receive the event "errorOccured" + @param com::sun::star::sdb::XSQLErrorListener */ [oneway] void addSQLErrorListener( [in]XSQLErrorListener _rListener ); @@ -89,6 +91,7 @@ interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLErrorBroadcaster::removeSQLErrorListener /** removes the specified listener. + @param com::sun::star::sdb::XSQLErrorListener */ [oneway] void removeSQLErrorListener( [in]XSQLErrorListener _rListener ); @@ -102,6 +105,12 @@ interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface #endif /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:27:26 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XSQLErrorListener.idl b/offapi/com/sun/star/sdb/XSQLErrorListener.idl index 69e2657e5e23..f75f3bd86ca1 100644 --- a/offapi/com/sun/star/sdb/XSQLErrorListener.idl +++ b/offapi/com/sun/star/sdb/XSQLErrorListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLErrorListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,11 @@ interface XSQLErrorListener: com::sun::star::lang::XEventListener { // DocMerge from xml: method com::sun::star::sdb::XSQLErrorListener::errorOccured - /** invoked when a database error occurs, just before a SQLException + /** invoked when a database error occurs, just before a + <type scope="com::sun::star::sdbc">SQLException</type> is thrown to the application. + @param aEvent + the event which occured */ void errorOccured([in]com::sun::star::sdb::SQLErrorEvent aEvent); }; @@ -92,6 +95,12 @@ interface XSQLErrorListener: com::sun::star::lang::XEventListener /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:27:18 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl index 266c1f26f631..c749175894d6 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLQueryComposer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:00:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,17 +80,20 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposer -/** should be provided by a tool which simplifies the handling with SQL SELECT statements. +/** should be provided by a tool which simplifies the handling with SQL select statements. - - <p>The interface can be used for composing SELECT statements without knowing the - structure of the used query.</p> + <p> + The interface can be used for composing SELECT statements without knowing the + structure of the used query. + </p> */ interface XSQLQueryComposer: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getQuery /** returns the query used for composing. + @returns + the query */ string getQuery(); //------------------------------------------------------------------------- @@ -98,6 +101,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setQuery /** sets a new query for the composer, which may be expanded by filters and sort criteria. + @param command + the command to set + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void setQuery([in] string command ) raises (com::sun::star::sdbc::SQLException); @@ -105,6 +112,8 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getComposedQuery /** returns the query composed with filters and sort criterias. + @returns + the composed query */ string getComposedQuery(); //------------------------------------------------------------------------- @@ -112,19 +121,26 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::getFilter /** returns the currently used filter. - - <p>The filter criteria returned is part of the where condition of the - select command, but it does not contain the where token.</p> + <p> + The filter criteria returned is part of the where condition of the + select command, but it does not contain the where token. + </p> + @returns + the filter */ string getFilter(); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::sdb::XSQLQueryComposer::getStructuredFilter /** returns the currently used filter. - <p>The filter criteria is split into levels. Each level represents the - OR criterias. Within each level, the Filters are provided as an AND criteria + <p> + The filter criteria is split into levels. Each level represents the + OR criterias. Within each level, the filters are provided as an AND criteria with the name of the column and the filter condition. The filter condition is of type string. + </p> + @returns + the structured filter */ sequence< sequence<com::sun::star::beans::PropertyValue> > getStructuredFilter(); @@ -134,15 +150,24 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface /** returns the currently used sort order. - <p>The order criteria returned is part of the ORDER BY clause of the - select command, but it does not contain the ORDER BY keyword .</p> + <p> + The order criteria returned is part of the ORDER BY clause of the + select command, but it does not contain the ORDER BY keyword . + </p> + @returns + the order */ string getOrder(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendFilterByColumn - /** appends a new filter condition by a <type>DataColumn</type> providing - the name and the value for the filter. + /** appends a new filter condition by a + <type scope="com::sun::star::sdb">DataColumn</type> + providing the name and the value for the filter. + @param column + the column which is used to create a filter + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void appendFilterByColumn([in] com::sun::star::beans::XPropertySet column) raises (com::sun::star::sdbc::SQLException); @@ -151,6 +176,12 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::appendOrderByColumn /** appends an additional part to the sort order criteria of the select statement. + @param column + the column which is used to create a order part + @param ascending + <TRUE/> when the order should be ascending, otherwise <FALSE/> + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void appendOrderByColumn([in] com::sun::star::beans::XPropertySet column, [in] boolean ascending) @@ -159,6 +190,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setFilter /** makes it possible to set a filter condition for the query. + @param filter + the filter to set + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void setFilter([in] string filter) raises (com::sun::star::sdbc::SQLException); @@ -166,6 +201,10 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposer::setOrder /** makes it possibile to set a sort condition for the query. + @param order + the order part to set + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void setOrder([in] string order) raises (com::sun::star::sdbc::SQLException); @@ -178,6 +217,12 @@ interface XSQLQueryComposer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:26:19 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:00:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:32 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl index 0afa0a59f384..d96976cfb25d 100644 --- a/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl +++ b/offapi/com/sun/star/sdb/XSQLQueryComposerFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLQueryComposerFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,13 +71,17 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::sdb::XSQLQueryComposerFactory -/** is a factory for instances of service <type>SQLQueryComposer</type>. +/** is a factory for instances of service + <type scope="com::sun::star::sdb">SQLQueryComposer</type> + . */ interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdb::XSQLQueryComposerFactory::createQueryComposer /** creates a new query composer. + @returns + the SQLQueryComposer object */ com::sun::star::sdb::XSQLQueryComposer createQueryComposer(); }; @@ -89,6 +93,12 @@ interface XSQLQueryComposerFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:25:01 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:32 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:31 mi moved from api diff --git a/offapi/com/sun/star/sdbc/BatchUpdateException.idl b/offapi/com/sun/star/sdbc/BatchUpdateException.idl index 4b8a1c4ac312..bf1ffa317b2b 100644 --- a/offapi/com/sun/star/sdbc/BatchUpdateException.idl +++ b/offapi/com/sun/star/sdbc/BatchUpdateException.idl @@ -2,9 +2,9 @@ * * $RCSfile: BatchUpdateException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,10 @@ <p>In addition to the information provided by - <type scope="com::sun::star::sdbc">SQLException</type>}, a - <code>BatchUpdateException</code> provides the update counts for all commands + <type scope="com::sun::star::sdbc">SQLException</type> + , a + <code>BatchUpdateException</code> + provides the update counts for all commands that were executed successfully during the batch update, that is, all commands that were executed before the error occurred. The order of elements in an array of update counts corresponds to the order in which commands were added @@ -84,9 +86,11 @@ exception BatchUpdateException: SQLException { // DocMerge from idl: field com::sun::star::sdbc::BatchUpdateException::UpdateCounts - /** is an array of <code>long</code>, with each element - indicating the update count for a SQL command that executed - successfully before the exception was thrown. + /** is an array of + <code>long</code> + , with each element + indicating the update count for a SQL command that executed + successfully before the exception was thrown. */ sequence<long> UpdateCounts; }; @@ -97,6 +101,12 @@ exception BatchUpdateException: SQLException /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:38 hjs initial import diff --git a/offapi/com/sun/star/sdbc/BestRowScope.idl b/offapi/com/sun/star/sdbc/BestRowScope.idl index ba8a6b3bd9c1..6bef5e0139a9 100644 --- a/offapi/com/sun/star/sdbc/BestRowScope.idl +++ b/offapi/com/sun/star/sdbc/BestRowScope.idl @@ -2,9 +2,9 @@ * * $RCSfile: BestRowScope.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,8 +75,12 @@ constants BestRowScope very temporary, lasting only while the row is being used. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long TEMPORARY = 0; //------------------------------------------------------------------------- @@ -86,8 +90,12 @@ constants BestRowScope the remainder of the current transaction. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long TRANSACTION = 1; //------------------------------------------------------------------------- @@ -97,8 +105,12 @@ constants BestRowScope the remainder of the current session. A possible value for the column <code>SCOPE</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long SESSION = 2; }; @@ -109,6 +121,12 @@ constants BestRowScope /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/BestRowType.idl b/offapi/com/sun/star/sdbc/BestRowType.idl index 162e69150a74..d82ca650df42 100644 --- a/offapi/com/sun/star/sdbc/BestRowType.idl +++ b/offapi/com/sun/star/sdbc/BestRowType.idl @@ -2,9 +2,9 @@ * * $RCSfile: BestRowType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,8 +74,12 @@ constants BestRowType /** indicates that the best row identifier may or may not be a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -84,8 +88,12 @@ constants BestRowType /** indicates that the best row identifier is NOT a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long NOT_PSEUDO = 1; //------------------------------------------------------------------------- @@ -94,8 +102,12 @@ constants BestRowType /** indicates that the best row identifier is a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getBestRowIdentifier</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member>XDatabaseMetaData::getBestRowIdentifier()</member> + . */ const long PSEUDO = 2; }; @@ -106,6 +118,12 @@ constants BestRowType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/CallableStatement.idl b/offapi/com/sun/star/sdbc/CallableStatement.idl index 98a1661e492d..54024c0df33f 100644 --- a/offapi/com/sun/star/sdbc/CallableStatement.idl +++ b/offapi/com/sun/star/sdbc/CallableStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: CallableStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,8 @@ interface XOutParameters; /** is used to execute SQL stored procedures. - <p>SDBC provides a stored procedure SQL escape that allows stored procedures + <p> + SDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters @@ -83,24 +84,42 @@ interface XOutParameters; by number. The first parameter is 1. </p> <p> - <code> - {?= call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} - {call &lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;, ...]} + <code>{?=call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]}<br/>{call&lt;procedure-name&gt;[&lt;arg1&gt;,&lt;arg2&gt;,...]} </code> </p> - <p>IN parameter values are set using the set methods inherited from - <type scope="com::sun::star::sdbc">PreparedStatement</type>. The type of all + <p> + IN parameter values are set using the set methods inherited from + <type scope="com::sun::star::sdbc">PreparedStatement</type> + . The type of all OUT parameters must be registered prior to executing the stored procedure; - their values are retrieved after execution via the <code>get</code> methods - provided by the <type scope="com::sun::star::sdbc">XRow</type>.</p> - <p>A <code>CallableStatement</code> can return one - <type scope="com::sun::star::sdbc">XResultSet</type> or multiple - <code>ResultSet</code> objects. Multiple <code>ResultSet</code> objects are + their values are retrieved after execution via the + <code>get</code> + methods + provided by the + <type scope="com::sun::star::sdbc">XRow</type> + . + </p> + <p> + A + <code>CallableStatement</code> + can return one + <type scope="com::sun::star::sdbc">XResultSet</type> + or multiple + <type scope="com::sun::star::sdbc">ResultSet</type> + objects. Multiple + <code>ResultSet</code> + objects are handled using operations inherited from - <type scope="com::sun::star::sdbc">XPreparedStatement</type>.</p> - <p>For maximum portability, a call's <code>ResultSet</code> objects and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + . + </p> + <p> + For maximum portability, a call's + <type scope="com::sun::star::sdbc">ResultSet</type> + objects and update counts should be processed prior to getting the values of output - parameters.</p> + parameters. + </p> */ service CallableStatement { @@ -126,6 +145,12 @@ service CallableStatement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ChangeAction.idl b/offapi/com/sun/star/sdbc/ChangeAction.idl index ce21b669f4ba..398770e96647 100644 --- a/offapi/com/sun/star/sdbc/ChangeAction.idl +++ b/offapi/com/sun/star/sdbc/ChangeAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangeAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,7 +63,7 @@ module com { module sun { module star { module sdbc { -/** determines the type of the change which is going to be performed. +/** @deprecated determines the type of the change which is going to be performed. */ constants ChangeAction { diff --git a/offapi/com/sun/star/sdbc/ChangeEvent.idl b/offapi/com/sun/star/sdbc/ChangeEvent.idl index c36455b3451a..15899fd670cb 100644 --- a/offapi/com/sun/star/sdbc/ChangeEvent.idl +++ b/offapi/com/sun/star/sdbc/ChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangeEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ module com { module sun { module star { module sdbc { -/** indicates the type of change action on the data source. +/** @deprecated indicates the type of change action on the data source. */ struct ChangeEvent : com::sun::star::lang::EventObject { diff --git a/offapi/com/sun/star/sdbc/ColumnSearch.idl b/offapi/com/sun/star/sdbc/ColumnSearch.idl index 469ef49889bd..0b0d07b86d1e 100644 --- a/offapi/com/sun/star/sdbc/ColumnSearch.idl +++ b/offapi/com/sun/star/sdbc/ColumnSearch.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnSearch.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,9 +73,14 @@ constants ColumnSearch // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::NONE /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that <code>WHERE</code> search clauses are not supported + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that + <code>WHERE</code> + search clauses are not supported for this type. */ const long NONE = 0; @@ -83,30 +88,51 @@ constants ColumnSearch // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::CHAR /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that the only <code>WHERE</code> search clause that can - be based on this type is <code>WHERE . . .LIKE</code>. + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that the only + <code>WHERE</code> + search clause that can + be based on this type is + <code>WHERE...LIKE</code> + . */ const long CHAR = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::BASIC /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that one can base all <code>WHERE</code> search clauses - except <code>WHERE . . .LIKE</code> on this data type. + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that one can base all + <code>WHERE</code> + search clauses + except + <code>WHERE...LIKE</code> + on this data type. */ const long BASIC = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ColumnSearch::FULL - /** A possible value for column <code>SEARCHABLE</code> in the - <code>XResultSet</code> object returned by the method - <code>getTypeInfo</code>. - <p>Indicates that all <code>WHERE</code> search clauses can be - based on this type. + /** A possible value for column + <code>SEARCHABLE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getTypeInfo()</member> + . + <p> + Indicates that all + <code>WHERE</code> + search clauses can be + based on this type. */ const long FULL = 3; }; @@ -117,6 +143,12 @@ constants ColumnSearch /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ColumnType.idl b/offapi/com/sun/star/sdbc/ColumnType.idl index 6aa80e43799f..c9c16f85d1ea 100644 --- a/offapi/com/sun/star/sdbc/ColumnType.idl +++ b/offapi/com/sun/star/sdbc/ColumnType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,8 +74,12 @@ constants ColumnType /** indicates that this column may or may not be a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -84,8 +88,12 @@ constants ColumnType /** indicates that this column is NOT a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long NOT_PSEUDO = 1; //------------------------------------------------------------------------- @@ -94,8 +102,12 @@ constants ColumnType /** indicates that this column is a pseudo-column. A possible value for the column <code>PSEUDO_COLUMN</code> - in the <code>XResultSet</code> object - returned by the method <code>getVersionColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getVersionColumns()</member> + . */ const long PSEUDO = 2; }; @@ -106,6 +118,12 @@ constants ColumnType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/Connection.idl b/offapi/com/sun/star/sdbc/Connection.idl index 41a111b4dc62..963fd0e2780b 100644 --- a/offapi/com/sun/star/sdbc/Connection.idl +++ b/offapi/com/sun/star/sdbc/Connection.idl @@ -2,9 +2,9 @@ * * $RCSfile: Connection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,23 +76,27 @@ interface XWarningsSupplier; database. Within the context of a Connection, SQL statements are executed and results are returned. - - - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, and the capabilities of this connection. This - information is obtained with the <code>getMetaData</code> method. - + information is obtained with the + <member scope="com::sun::star::sdbc">XConnection::getMetaData()</member> + method. </p> <p> - <b>Note:</b> By default the Connection automatically commits + <b> + Note: + </b> + By default the Connection automatically commits changes after executing each statement. If auto commit has been disabled, an explicit commit must be done or database changes will not be saved. - </p>@see com::sun::star::sdbc::XStatement - @see com::sun::star::sdbc::XResultSet - @see com::sun::star::sdbc::XDatabaseMetaData + </p> + @see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XResultSet + @see com::sun::star::sdbc::XDatabaseMetaData */ service Connection { @@ -123,6 +127,12 @@ service Connection /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ConnectionPool.idl b/offapi/com/sun/star/sdbc/ConnectionPool.idl index ff4228a64b16..48a9d7ba3357 100644 --- a/offapi/com/sun/star/sdbc/ConnectionPool.idl +++ b/offapi/com/sun/star/sdbc/ConnectionPool.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConnectionPool.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: oj $ $Date: 2001-04-26 10:40:22 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,19 @@ interface XDriverManager; // DocMerge from xml: service com::sun::star::sdbc::ConnectionPool -/** is the basic service for pooling SDBC connections. +/** is the basic service for pooling SDBC connections. - </p> - <p>When the method <code>getConnection</code> is called, + <p> + When the method + <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member> + is called, the ConnectionPool will attempt to locate a suitable pooled connection or create a new connection from the DriverManager. When the connection will be released it will move to the pool of unused connections. - </p>@see com::sun::star::sdbc::XDriver - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection */ service ConnectionPool { diff --git a/offapi/com/sun/star/sdbc/ConnectionProperties.idl b/offapi/com/sun/star/sdbc/ConnectionProperties.idl new file mode 100644 index 000000000000..68e236b8862d --- /dev/null +++ b/offapi/com/sun/star/sdbc/ConnectionProperties.idl @@ -0,0 +1,105 @@ +/************************************************************************* + * + * $RCSfile: ConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ + * + * 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_sdbc_ConnectionProperties_idl__ +#define __com_sun_star_sdbc_ConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + + + +/** represents the properties for a connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::JDBCConnectionProperties + @see com::sun::star::sdbc::ODBCConnectionProperties + @see com::sun::star::sdbc::FILEConnectionProperties + @see com::sun::star::sdbc::DBASEConnectionProperties + @see com::sun::star::sdbc::FLATConnectionProperties + + */ +service ConnectionProperties +{ + /** the username + */ + [optional, property] string user; + + /** the password + */ + [optional, property] string password; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl new file mode 100644 index 000000000000..294c438651cc --- /dev/null +++ b/offapi/com/sun/star/sdbc/DBASEConnectionProperties.idl @@ -0,0 +1,100 @@ +/************************************************************************* + * + * $RCSfile: DBASEConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:53 $ + * + * 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_sdbc_DBASEConnectionProperties_idl__ +#define __com_sun_star_sdbc_DBASEConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#include <com/sun/star/sdbc/FILEConnectionProperties.idl> +#endif + +/** represents the properties for a dBase connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::FILEConnectionProperties + */ +service DBASEConnectionProperties +{ + service com::sun::star::sdbc:: FILEConnectionProperties; + + /** <TRUE/> when deleted rows should be shown, otherwise <FALSE/> + */ + [optional, property] boolean ShowDeleted; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/DataTruncation.idl b/offapi/com/sun/star/sdbc/DataTruncation.idl index 627b51e194ff..cfe2d07f9bb7 100644 --- a/offapi/com/sun/star/sdbc/DataTruncation.idl +++ b/offapi/com/sun/star/sdbc/DataTruncation.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataTruncation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,9 +72,13 @@ /** reports a DataTruncation warning, on reads, or is thrown as a DataTruncation exception, on writes, when a data value is unexpectedly truncated. - - - <p>The SQLstate for a <code>DataTruncation</code> is <code>01004</code>.</p> + <p> + The SQL state for a + <code>DataTruncation</code> + is + <code>01004</code> + . + </p> */ exception DataTruncation: SQLWarning { @@ -86,13 +90,17 @@ exception DataTruncation: SQLWarning // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::IsParameter - /** is <TRUE/> if a parameter value is truncated. + /** is + <TRUE/> + if a parameter value is truncated. */ boolean IsParameter; // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DuringRead - /** is <TRUE/> if a read was truncated. + /** is + <TRUE/> + if a read was truncated. */ boolean DuringRead; @@ -100,14 +108,18 @@ exception DataTruncation: SQLWarning // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::DataSize /** contains the number of bytes of data that should have been transferred. This number may be approximate if data conversions were being - performed. The value may be <code>-1</code> if the size is unknown. + performed. The value may be + <code>-1</code> + if the size is unknown. */ long DataSize; // DocMerge from xml: field com::sun::star::sdbc::DataTruncation::TransferSize /** contains the number of bytes of data actually transferred. - The value may be <code>-1</code> if the size is unknown. + The value may be + <code>-1</code> + if the size is unknown. */ long TransferSize; }; @@ -117,6 +129,12 @@ exception DataTruncation: SQLWarning }; }; }; }; /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2000/12/14 12:53:39 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DataType.idl b/offapi/com/sun/star/sdbc/DataType.idl index b05288ecd440..917fa2b885fb 100644 --- a/offapi/com/sun/star/sdbc/DataType.idl +++ b/offapi/com/sun/star/sdbc/DataType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,13 @@ /** These constants are used to specify database data types which are used to identify the generic SQL types. The definition is based on JDBC 2.0. - <p>The actual type constant values are equivalent to those in the X/Open CLI. + <p> + The actual type constant values are equivalent to those in the X/Open CLI. + </p> + <p> + Precise information about the specfic types can be got from + <member>XDatabaseMetaData::getTypeInfo()</member> + .</p> */ constants DataType { @@ -136,7 +142,9 @@ constants DataType // DocMerge from idl: value com::sun::star::sdbc::DataType::OTHER /** indicates that the SQL type is database-specific and gets mapped to an object that can be accessed via - the method <member scope="com::sun::star::sql">XGetData::getObject()</member>. + the method + <member scope="com::sun::star::sdbc">XRow::getObject()</member> + . */ const long OTHER = 1111; @@ -192,6 +200,15 @@ constants DataType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:39 hjs initial import diff --git a/offapi/com/sun/star/sdbc/Driver.idl b/offapi/com/sun/star/sdbc/Driver.idl index 858d750e5e3b..150ed330d8c1 100644 --- a/offapi/com/sun/star/sdbc/Driver.idl +++ b/offapi/com/sun/star/sdbc/Driver.idl @@ -2,9 +2,9 @@ * * $RCSfile: Driver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,26 +69,29 @@ interface XDriver; // DocMerge from xml: service com::sun::star::sdbc::Driver /** is the service that every driver class must implement. - - - <p>Each driver should supply a service that implements + <p> + Each driver should supply a service that implements the Driver interface. </p> - <p>The DriverManager will try to load as many drivers as it can + <p> + The DriverManager will try to load as many drivers as it can find and then for any given connection request, it will ask each driver in turn to try to connect to the target URL. </p> - <p>It is strongly recommended that each Driver object should be + <p> + It is strongly recommended that each Driver object should be small and standalone so that the Driver object can be loaded and queried without bringing in vast quantities of supporting code. </p> - <p>Each driver should be a one instance service. + <p> + Each driver should be a one instance service. - </p>@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XConnection */ service Driver { @@ -105,6 +108,12 @@ service Driver /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DriverManager.idl b/offapi/com/sun/star/sdbc/DriverManager.idl index ee6ae825225e..6f270c929c35 100644 --- a/offapi/com/sun/star/sdbc/DriverManager.idl +++ b/offapi/com/sun/star/sdbc/DriverManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: DriverManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,19 @@ interface XDriverManager; /** is the basic service for managing a set of SDBC drivers. - <p>As part of its initialization, the DriverManager service will + <p> + As part of its initialization, the DriverManager service will attempt to load the registered drivers. </p> - <p>When the method <code>getConnection</code> is called, + <p> + When the method <code>getConnection</code> is called, the DriverManager will attempt to locate a suitable driver. - </p>@see com::sun::star::sdbc::XDriver - @see com::sun::star::sdbc::XConnection + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XConnection */ service DriverManager { @@ -107,6 +110,12 @@ service DriverManager /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl index 99603e1fd91a..f12ef061d541 100644 --- a/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl +++ b/offapi/com/sun/star/sdbc/DriverPropertyInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: DriverPropertyInfo.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,9 +68,11 @@ /** describes the driver properties for making a connection. - <p>The DriverPropertyInfo is of interest only to advanced programmers + <p> + The DriverPropertyInfo is of interest only to advanced programmers who need to interact with a driver to discover and supply properties - for connections.</p> + for connections. + </p> */ struct DriverPropertyInfo { @@ -87,8 +89,14 @@ struct DriverPropertyInfo // DocMerge from xml: field com::sun::star::sdbc::DriverPropertyInfo::IsRequired - /** is <TRUE/> if a value must be supplied for this property - during <code>Driver.connect</code> and <FALSE/> otherwise. + /** is + <TRUE/> + if a value must be supplied for this property + during + <code>Driver.connect</code> + and + <FALSE/> + otherwise. */ boolean IsRequired; @@ -103,8 +111,9 @@ struct DriverPropertyInfo // DocMerge from idl: field com::sun::star::sdbc::DriverPropertyInfo::Choices /** contains a sequence of possible values if the value for the field - <code>DriverPropertyInfo.value</code> may be selected - from a particular set of values; otherwise empty. + <code>DriverPropertyInfo.value</code> + may be selected + from a particular set of values; otherwise empty. */ sequence<string> Choices; }; @@ -115,6 +124,12 @@ struct DriverPropertyInfo /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2000/12/14 12:53:39 mi + <true></true> -> <TRUE/> and same with FALSE + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl b/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl new file mode 100644 index 000000000000..2c29933846e8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/FILEConnectionProperties.idl @@ -0,0 +1,99 @@ +/************************************************************************* + * + * $RCSfile: FILEConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#define __com_sun_star_sdbc_FILEConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a FILE connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service FILEConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + /** which charset should be used to fetch data. + */ + [optional, property] long Charset; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl new file mode 100644 index 000000000000..3d86d7a47084 --- /dev/null +++ b/offapi/com/sun/star/sdbc/FLATConnectionProperties.idl @@ -0,0 +1,120 @@ +/************************************************************************* + * + * $RCSfile: FLATConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_FLATConnectionProperties_idl__ +#define __com_sun_star_sdbc_FLATConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_FILEConnectionProperties_idl__ +#include <com/sun/star/sdbc/FILEConnectionProperties.idl> +#endif + +/** represents the properties for a FLAT connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::FILEConnectionProperties + */ +service FLATConnectionProperties +{ + service com::sun::star::sdbc::FILEConnectionProperties; + + /** <TRUE/> when the file contains a header line otherwise <FALSE/> + */ + [optional, property] boolean HeaderLine; + + /** A one character delimiter to seperate the fields. + */ + [optional, property] string FieldDelimiter; + + /** A one character delimiter to seperate the strings. + */ + [optional, property] string StringDelimiter; + + /** A one character delimiter to seperate the decimal. + */ + [optional, property] string DecimalDelimiter; + + /** A one character delimiter to seperate the thousands. + */ + [optional, property] string ThousandDelimiter; + + /** the extension of the files to be used. + */ + [property] string Extension; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/IndexType.idl b/offapi/com/sun/star/sdbc/IndexType.idl index 2a09737294dd..fe36c362488e 100644 --- a/offapi/com/sun/star/sdbc/IndexType.idl +++ b/offapi/com/sun/star/sdbc/IndexType.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,40 +71,64 @@ constants IndexType { // DocMerge from idl: value com::sun::star::sdbc::IndexType::STATISTIC - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indentifies table statistics that are returned in conjunction - with a table's index description. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indentifies table statistics that are returned in conjunction + with a table's index description. + </P> */ const short STATISTIC = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::CLUSTERED - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is a clustered index. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is a clustered index. + </P> */ const short CLUSTERED = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::HASHED - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is a hashed index. + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is a hashed index. + </P> */ const short HASHED = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::IndexType::OTHER - /** A possible value for column <code>TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getIndexInfo</code>. - <P>Indicates that this table index is not a clustered + /** A possible value for column + <code>TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getIndexInfo()</member> + . + <P> + Indicates that this table index is not a clustered index, a hashed index, or table statistics; it is something other than these. + </P> */ const short OTHER = 3; }; @@ -115,6 +139,12 @@ constants IndexType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl new file mode 100644 index 000000000000..3ad73b868fc8 --- /dev/null +++ b/offapi/com/sun/star/sdbc/JDBCConnectionProperties.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * $RCSfile: JDBCConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_JDBCConnectionProperties_idl__ +#define __com_sun_star_sdbc_JDBCConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a JDBC connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service JDBCConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + + /** which jdbc driver class should be loaded to create the connection. + */ + [optional, property] string JavaDriverClass; + + /** specifies if retrieving of auto generated values should be enabled or not. + If <TRUE/> than the statement will support the XGeneratedResultSet interface, otherwise not. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] boolean IsAutoRetrievingEnabled; + + /** specifies the statement which should be executed + when asking an "INSERT" statement for the XGeneratedResultSet interface. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] string AutoRetrievingStatement; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/KeyRule.idl b/offapi/com/sun/star/sdbc/KeyRule.idl index 8157c9269181..14f5b6b328d7 100644 --- a/offapi/com/sun/star/sdbc/KeyRule.idl +++ b/offapi/com/sun/star/sdbc/KeyRule.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyRule.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,79 +71,154 @@ constants KeyRule { // DocMerge from idl: value com::sun::star::sdbc::KeyRule::CASCADE - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the column <code>UPDATE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the column + <code>UPDATE_RULE</code> + , it indicates that when the primary key is updated, the foreign key (imported key) is changed to agree with it. - <P>For the column <code>DELETE_RULE</code>, + </P> + <P> + For the column + <code>DELETE_RULE</code> + , it indicates that when the primary key is deleted, rows that imported that key are deleted. + </P> */ const long CASCADE = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::RESTRICT - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the column <code>UPDATE_RULE</code>, it indicates that + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the column + <code>UPDATE_RULE</code> + , it indicates that a primary key may not be updated if it has been imported by another table as a foreign key. - <P>For the column <code>DELETE_RULE</code>, it indicates that + </P> + <P> + For the column + <code>DELETE_RULE</code> + , it indicates that a primary key may not be deleted if it has been imported by another table as a foreign key. + </P> */ const long RESTRICT = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_NULL - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , it indicates that when the primary key is updated or deleted, the foreign key (imported key) is changed to <code>NULL</code>. + </P> */ const long SET_NULL = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::NO_ACTION - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, - it indicates that - if the primary key has been imported, it cannot be updated or deleted. + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , + it indicates that if the primary key has been imported, it cannot be updated or deleted. + </P> */ const long NO_ACTION = 3; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::KeyRule::SET_DEFAULT - /** a possible value for the column's <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code> in the - <code>XResultSet</code> objects returned by the methods - <code>getImportedKeys</code>, <code>getExportedKeys</code>, - and <code>getCrossReference</code>. - <P>For the columns <code>UPDATE_RULE</code> - and <code>DELETE_RULE</code>, + /** a possible value for the column's + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + objects returned by the methods + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getImportedKeys()</member> + , + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getExportedKeys()</member> + , + and + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getCrossReference()</member> + . + <P> + For the columns + <code>UPDATE_RULE</code> + and + <code>DELETE_RULE</code> + , it indicates that if the primary key is updated or deleted, the foreign key (imported key) is set to the default value. + </P> */ const long SET_DEFAULT = 4; }; @@ -154,6 +229,12 @@ constants KeyRule /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:54:13 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:45 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl new file mode 100644 index 000000000000..a52418b745d2 --- /dev/null +++ b/offapi/com/sun/star/sdbc/ODBCConnectionProperties.idl @@ -0,0 +1,127 @@ +/************************************************************************* + * + * $RCSfile: ODBCConnectionProperties.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_sdbc_ODBCConnectionProperties_idl__ +#define __com_sun_star_sdbc_ODBCConnectionProperties_idl__ + + module com { module sun { module star { module sdbc { + +#ifndef __com_sun_star_sdbc_ConnectionProperties_idl__ +#include <com/sun/star/sdbc/ConnectionProperties.idl> +#endif + +/** represents the properties for a ODBC connection (session) with a specific + database. These properties can be used when calling the method + <member scope="com::sun::star::sdbc">XDriver::connect()</member> or + <member scope="com::sun::star::sdbc">XDriverManager::getConnectionWithInfo()</member>. + + <p> + The properties for a connection contain additonal information about how to connect to a database and + how to control the behavior of the resulting connection should be. + + </p> + @see com::sun::star::sdbc::XDriver + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::ConnectionProperties + */ +service ODBCConnectionProperties +{ + service com::sun::star::sdbc::ConnectionProperties; + /** should the parameter '?' in prepared statement be substituated with an distinct name + */ + [optional, property] boolean ParameterNameSubstitution; + + /** the Timeout after which time a timeout should happen + */ + [optional, property] long Timeout; + + /** Silent - should the connection be silent. No user interaction while creating the connection. + */ + [optional, property] boolean Silent; + + /** should the driver should support a catalog. + */ + [optional, property] boolean UseCatalog; + + /** which charset should be used to fetch data. + */ + [optional, property] long Charset; + + /** specifies if retrieving of auto generated values should be enabled or not. + If <TRUE/> than the statement will support the XGeneratedResultSet interface, otherwise not. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] boolean IsAutoRetrievingEnabled; + + /** specifies the statement which should be executed + when asking an "INSERT" statement for the XGeneratedResultSet interface. + @see com::sun::star::sdbc::XGeneratedResultSet + */ + [optional, property] string AutoRetrievingStatement; +}; + +//============================================================================= + +}; }; }; }; + +/*=========================================================================== + +===========================================================================*/ +#endif diff --git a/offapi/com/sun/star/sdbc/PreparedStatement.idl b/offapi/com/sun/star/sdbc/PreparedStatement.idl index c9c085456c02..e5f5059df483 100644 --- a/offapi/com/sun/star/sdbc/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/PreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: PreparedStatement.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: oj $ $Date: 2002-07-19 11:16:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,17 +87,30 @@ interface XGeneratedResultSet; // DocMerge from idl: service com::sun::star::sdbc::PreparedStatement /** represents a precompiled SQL statement. - <P>A SQL statement is pre-compiled and stored in a PreparedStatement object. + <P> + A SQL statement is pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. - <P><B>Note:</B> The setXXX methods for setting IN parameter values + </P> + <P> + <B> + Note: + </B> + The + <code>setXXX</code> + methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type - Integer, then the method <code>setLong</code> should be used. - - <p>If arbitrary parameter type conversions are required, the method - <code>setObject</code> should be used with a target SQL type. - <br> + Integer, then the method + <member scope="com::sun::star::sdbc">XParameters::setInt()</member> + should be used. + </P> + <p> + If arbitrary parameter type conversions are required, the method + <member scope="com::sun::star::sdbc">XParameters::setObject()</member> + should be used with a target SQL type. + </p> + <p> Example of setting a parameter; <code>con</code> is an active connection. @example:StarBASIC <listing> @@ -105,11 +118,19 @@ interface XGeneratedResultSet; pstmt.setDouble(1, 153833.00) pstmt.setLong(2, 110592) </listing> - <P>Only one ResultSet per Statement can be open at any point in + </p> + <P> + Only one + <type scope="com::sun::star::sdbc">ResultSet</type> + per + <type scope="com::sun::star::sdbc">Statement</type> + can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by - different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists. + different Statements. All statement + <code>execute</code> + methods implicitly close a statement's current ResultSet if an open one exists. + </p> */ service PreparedStatement { @@ -127,7 +148,7 @@ service PreparedStatement */ interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::util::XCancellable @@ -166,9 +187,12 @@ service PreparedStatement // DocMerge from xml: service com::sun::star::sdbc::PreparedStatement: interface com::sun::star::sdbc::XPreparedBatchExecution /** provides the ability of batch execution. This interface is optional for execution. - <p>A driver implementing batch execution must return <TRUE/> for - <member scope= "com::sun::star::sdbc"> - XDatabaseMetaData::supportsBatchUpdates()</member> + <p> + A driver implementing batch execution must return + <TRUE/> + for + <member scope= "com::sun::star::sdbc">XDatabaseMetaData::supportsBatchUpdates()</member> + </p> */ [optional] interface XPreparedBatchExecution; @@ -197,11 +221,27 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero. + </p> + <p> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -216,18 +256,26 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. - <p>This name can then be used in SQL positioned update/delete statements to + <code>execute</code> + methods. + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database does not support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail. - <P><B>Note:</B> By definition, positioned update/delete + </p> + <P> + <B> + Note: + </B> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a connection. + </p> */ [property] string CursorName; @@ -249,18 +297,29 @@ service PreparedStatement // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch direction, + <code>Statement</code> + object. + <p> + If this + <code>Statement</code> + object has not set a fetch direction, the return value is implementation-specific. + </p> */ [property] long FetchDirection; // DocMerge from idl: property com::sun::star::sdbc::PreparedStatement::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <code>Statement</code> + object. + <p> + If this + <code>Statement</code> + object has not set a fetch size, the return value is implementation-specific. + </p> */ [property] long FetchSize; }; @@ -269,40 +328,4 @@ service PreparedStatement }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.8 2002/07/19 10:09:03 oj - #95146# new interface to query for autogenerated values - - Revision 1.7 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.6 2001/02/20 13:30:07 fs - #82875# removed XClearParameters - this interface is obsolete, the functionality is covered by XParameters - - Revision 1.5 2001/01/23 10:08:28 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.4 2000/12/19 16:03:44 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:40 hjs - initial import - - Revision 1.5 2000/09/11 11:52:42 mi - documentation merged from XML - - Revision 1.3 1999/12/20 16:11:34 dg - #70278# changes in API - - Revision 1.2 1999/12/14 12:05:45 dg - #70278# CompareBookmark removed - - Revision 1.1 1999/11/24 08:41:01 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/ProcedureColumn.idl b/offapi/com/sun/star/sdbc/ProcedureColumn.idl index d89b526f27a1..fb868660e4b7 100644 --- a/offapi/com/sun/star/sdbc/ProcedureColumn.idl +++ b/offapi/com/sun/star/sdbc/ProcedureColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProcedureColumn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,13 @@ constants ProcedureColumn // DocMerge from idl: value com::sun::star::sdbc::ProcedureColumn::UNKNOWN /** indicates that the type of the column is unknown. A possible value for - the column <code>COLUMN_TYPE</code> in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + the column + <code>COLUMN_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long UNKNOWN = 0; //------------------------------------------------------------------------- @@ -82,8 +87,11 @@ constants ProcedureColumn /** indicates that the column stores IN parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long IN = 1; //------------------------------------------------------------------------- @@ -92,8 +100,11 @@ constants ProcedureColumn /** indicates that the column stores INOUT parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long INOUT = 2; //------------------------------------------------------------------------- @@ -102,8 +113,11 @@ constants ProcedureColumn /** indicates that the column stores results. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long RESULT = 3; //------------------------------------------------------------------------- @@ -112,8 +126,11 @@ constants ProcedureColumn /** indicates that the column stores OUT parameters. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long OUT = 4; //------------------------------------------------------------------------- @@ -122,8 +139,11 @@ constants ProcedureColumn /** Indicates that the column stores return values. A possible value for the column <code>COLUMN_TYPE</code> - in the <code>XResultSet</code> - returned by the method <code>getProcedureColumns</code>. + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedureColumns()</member> + . */ const long RETURN = 5; }; @@ -134,6 +154,12 @@ constants ProcedureColumn /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/ProcedureResult.idl b/offapi/com/sun/star/sdbc/ProcedureResult.idl index c0dd0a45ef69..5ec9a3458295 100644 --- a/offapi/com/sun/star/sdbc/ProcedureResult.idl +++ b/offapi/com/sun/star/sdbc/ProcedureResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProcedureResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,31 +71,49 @@ constants ProcedureResult { // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::UNKNOWN - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that it is not known whether the procedure returns + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that it is not known whether the procedure returns a result. + </p> */ const long UNKNOWN = 0; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::NONE - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that the procedure does not return + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that the procedure does not return a result. + </p> */ const long NONE = 1; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::sdbc::ProcedureResult::RETURN - /** A possible value for column <code>PROCEDURE_TYPE</code> in the - <code>XResultSet</code> object returned by the method - <code>getProcedures</code>. - <p> Indicates that the procedure returns + /** A possible value for column + <code>PROCEDURE_TYPE</code> + in the + <type scope="com::sun::star::sdbc">XResultSet</type> + object returned by the method + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getProcedures()</member> + . + <p> + Indicates that the procedure returns a result. + </p> */ const long RETURN = 2; }; @@ -106,6 +124,12 @@ constants ProcedureResult /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ResultSet.idl b/offapi/com/sun/star/sdbc/ResultSet.idl index 9d8dcf81243a..121dfda71c15 100644 --- a/offapi/com/sun/star/sdbc/ResultSet.idl +++ b/offapi/com/sun/star/sdbc/ResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,22 +92,27 @@ interface XCloseable; - <p>A ResultSet maintains a cursor pointing to its current row of + <p> + A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The 'next' method moves the cursor to the next row. </p> - <p>The getXXX methods retrieve column values for the current + <p> + The getXXX methods retrieve column values for the current row. You can retrieve values using either the index number of the column. Columns are numbered from 1. </p> - <p>For maximum portability, ResultSet columns within each row should be + <p> + For maximum portability, ResultSet columns within each row should be read in left-to-right order and each column should be read only once. </p> - <p>For the getXXX methods, the SDBC driver attempts to convert the + <p> + For the getXXX methods, the SDBC driver attempts to convert the underlying data to the specified type and returns a suitable value. </p> - <p>Column names used as input to the findColumn method are case + <p> + Column names used as input to the findColumn method are case insensitive. When several columns have the same name, then the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL @@ -116,13 +121,16 @@ interface XCloseable; no way for the programmer to guarantee that they actually refer to the intended columns. </p> - <p>A ResultSet is automatically closed (disposed) by the Statement that + <p> + A ResultSet is automatically closed (disposed) by the Statement that generated it when that Statement is closed, re-executed, or used to retrieve the next result from a sequence of multiple results. </p> - <p>The number, types, and properties of a ResultSet's columns are + <p> + The number, types, and properties of a ResultSet's columns are provided by the ResultSetMetaData object returned by the getMetaData - method.</p> + method. + </p> */ service ResultSet { @@ -137,14 +145,18 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XCloseable /** freeing all resources of a result set. - <p>The creating statement will still be open after disposing. + <p> + The creating statement will still be open after disposing. + </p> - <p>This interface is mandatory only for JDBC conformance, + <p> + This interface is mandatory only for JDBC conformance, otherwise it is optional. + </p> */ [optional] interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -152,11 +164,13 @@ service ResultSet /** controls the chaining of warnings, which may occur on every call to the connected database. - <p>Chained warnings from previous calls will be - cleared before processing a new call. + <p> + Chained warnings from previous calls will be cleared before processing a new call. + </p> - <p>This interface is mandatory only for JDBC conformance, - otherwise it is optional. + <p> + This interface is mandatory only for JDBC conformance, otherwise it is optional. + </p> */ [optional] interface XWarningsSupplier; @@ -176,7 +190,9 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XResultSetUpdate /** is the interface for updating row data to the database. - <p>The implementation is optional. + <p> + The implementation is optional. + </p> */ [optional] interface XResultSetUpdate; @@ -196,17 +212,21 @@ service ResultSet // DocMerge from xml: service com::sun::star::sdbc::ResultSet: interface com::sun::star::sdbc::XRowUpdate /** is the interface for updating the data of the current row. - <p>The implementation is optional. + <p> + The implementation is optional. + </p> */ [optional] interface XRowUpdate; // DocMerge from xml: property com::sun::star::sdbc::ResultSet::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. + <code>execute</code> + methods. - <p>This name can then be used in SQL positioned update/delete statements to + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database doesn't support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support @@ -215,10 +235,14 @@ service ResultSet positioned updates may fail. </p> <p> - <b>Note:</b> By definition, positioned update/delete + <b> + Note: + </b> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, - cursor names must be unique within a connection.</p> + cursor names must be unique within a connection. + </p> @optional */ @@ -240,7 +264,9 @@ service ResultSet // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> + <type scope="sun::com::star::sdbc">Statement</type> + object. + <br/> If this <code>Statement</code> object has not set a fetch direction, the return value is implementation-specific. */ @@ -249,8 +275,13 @@ service ResultSet // DocMerge from xml: property com::sun::star::sdbc::ResultSet::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <type scope="sun::com::star::sdbc">Statement</type> + object. + <br/> + If this + <type scope="sun::com::star::sdbc">Statement</type> + object has not set a fetch size, the return value is implementation-specific. */ [property] long FetchSize; @@ -262,6 +293,15 @@ service ResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:29 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl index 5a50ed9ffde6..1557e3c01231 100644 --- a/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl +++ b/offapi/com/sun/star/sdbc/ResultSetConcurrency.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSetConcurrency.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,14 +71,17 @@ constants ResultSetConcurrency { // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::READ_ONLY - /** is the concurrency mode for a <code>ResultSet</code> object that may NOT be updated. + /** is the concurrency mode for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that may NOT be updated. */ const long READ_ONLY = 1007; // DocMerge from idl: value com::sun::star::sdbc::ResultSetConcurrency::UPDATABLE - /** is the concurrency mode for a <code>ResultSet</code> object - that may be updated. + /** is the concurrency mode for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that may be updated. */ const long UPDATABLE = 1008; }; @@ -89,6 +92,12 @@ constants ResultSetConcurrency /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/ResultSetType.idl b/offapi/com/sun/star/sdbc/ResultSetType.idl index 0368ae9b9894..76487a6fe03c 100644 --- a/offapi/com/sun/star/sdbc/ResultSetType.idl +++ b/offapi/com/sun/star/sdbc/ResultSetType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultSetType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,21 +71,26 @@ constants ResultSetType { // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::FORWARD_ONLY - /** is the type for a <code>ResultSet</code> object whose cursor may - move only forward. + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object whose cursor may move only forward. */ const long FORWARD_ONLY = 1003; // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_INSENSITIVE - /** is the type for a <code>ResultSet</code> object that is scrollable + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that is scrollable but generally not sensitive to changes made by others. */ const long SCROLL_INSENSITIVE = 1004; // DocMerge from idl: value com::sun::star::sdbc::ResultSetType::SCROLL_SENSITIVE - /** is the type for a <code>ResultSet</code> object that is scrollable + /** is the type for a + <type scope="sun::com::star::sdbc">ResultSet</type> + object that is scrollable and generally sensitive to changes made by others. */ const long SCROLL_SENSITIVE = 1005; @@ -97,6 +102,12 @@ constants ResultSetType /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:35 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:40 hjs initial import diff --git a/offapi/com/sun/star/sdbc/RowSet.idl b/offapi/com/sun/star/sdbc/RowSet.idl index 2ea716cf860b..ba29e1ecc1f1 100644 --- a/offapi/com/sun/star/sdbc/RowSet.idl +++ b/offapi/com/sun/star/sdbc/RowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: RowSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,6 +64,9 @@ #ifndef __com_sun_star_sdbc_ResultSet_idl__ #include <com/sun/star/sdbc/ResultSet.idl> #endif +#ifndef __com_sun_star_sdbc_XColumnLocate_idl__ +#include <com/sun/star/sdbc/XColumnLocate.idl> +#endif module com { module sun { module star { module container { interface XNameAccess; @@ -76,33 +79,44 @@ interface XParameters; // DocMerge from xml: service com::sun::star::container::com::sun::star::sdbc::RowSet -/** is a client side ResultSet, which combines the characteristics of a Statement - and a ResultSet. +/** is a client side ResultSet, which combines the characteristics of a + <type scope="sun::com::star::sdbc">Statement</type> + and a + <type scope="sun::com::star::sdbc">ResultSet</type> + . - <p> It acts like a typical bean. Before you use the RowSet, you have to specify a + <p> + It acts like a typical bean. Before you use the RowSet, you have to specify a set of properties like a DataSource and a Command and other properties known of - Statement.<br> + Statement. + <br/> Afterwards, you can populate the RowSet by its execute method to fill the set with data. </p> - <p>On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource. + <p> + On the one hand, a RowSet can be used as a short cut to retrieve the data of a DataSource. You don't have to establish a connection, create a Statement, and then create a ResultSet. On the other hand, a rowset can be used to implement capabilties for a result set, which are not supported by a driver result set, like caching - strategies or update capabilities.</p> + strategies or update capabilities. + </p> */ service RowSet { // DocMerge: empty anyway service com::sun::star::sdbc::ResultSet; - // DocMerge: empty anyway + // used to execute and to add/remove listeners. interface XRowSet; - // DocMerge: empty anyway + // used to set parameters. interface XParameters; + /** allows locating columns which's name is known only. + */ + interface XColumnLocate; + // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::DataSourceName /** is the name of a named datasource to use.@see com::sun::star::sdbc:XDataSource */ @@ -146,7 +160,9 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::QueryTimeOut /** retrieves the number of seconds the driver will wait for a Statement - to execute. If the limit is exceeded, a SQLException is thrown. + to execute. If the limit is exceeded, a + <type scope="sun::com::star::sdbc">SQLException</type> + is thrown. There is no limitation, if set to zero. */ [property] long QueryTimeOut; @@ -155,12 +171,26 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero.</p> + <br/> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -168,7 +198,8 @@ service RowSet // DocMerge from xml: property com::sun::star::container::com::sun::star::sdbc::RowSet::MaxRows /** retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. - <br>There is no limitation, if set to zero. + <br/> + There is no limitation, if set to zero. */ [property] long MaxRows; @@ -197,6 +228,18 @@ service RowSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.3 2002/06/07 09:47:05 fs + added XColumnLocate + + Revision 1.5.2.2 2002/02/18 12:55:23 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/02/20 13:30:07 fs #82875# removed XClearParameters - this interface is obsolete, the functionality is covered by XParameters diff --git a/offapi/com/sun/star/sdbc/SQLException.idl b/offapi/com/sun/star/sdbc/SQLException.idl index 33d23616dd99..5cfff101f616 100644 --- a/offapi/com/sun/star/sdbc/SQLException.idl +++ b/offapi/com/sun/star/sdbc/SQLException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SQLException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,20 @@ // DocMerge from xml: exception com::sun::star::sdbc::SQLException /** is an exception that provides information on a database access error. - - - <p>Each <type scope="com::sun::star::sdbc">SQLException</type> provides several kinds of information: + <p> + Each + <type scope="com::sun::star::sdbc">SQLException</type> + provides several kinds of information: </p> + <p> <ul> - <li> a string describing the error. This is used as the <type scope="com::sun::star::uno">Exception</type> + <li> + a string describing the error. This is used as the + <type scope="com::sun::star::uno">Exception</type> message. </li> </ul> + </p> */ exception SQLException: com::sun::star::uno::Exception { @@ -111,6 +116,12 @@ exception SQLException: com::sun::star::uno::Exception /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/Statement.idl b/offapi/com/sun/star/sdbc/Statement.idl index 53dd8e14e1f4..966b3726c512 100644 --- a/offapi/com/sun/star/sdbc/Statement.idl +++ b/offapi/com/sun/star/sdbc/Statement.idl @@ -2,9 +2,9 @@ * * $RCSfile: Statement.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: oj $ $Date: 2002-07-19 11:16:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,11 +87,13 @@ interface XGeneratedResultSet; /** is used for executing a static SQL statement and obtaining the results produced by it. - <p>Only one ResultSet per Statement can be open at any point in + <p> + Only one ResultSet per Statement can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists.</p> + close a statement's current ResultSet if an open one exists. + </p> */ service Statement { @@ -109,7 +111,7 @@ service Statement */ interface XCloseable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::util::XCancellable @@ -135,9 +137,12 @@ service Statement // DocMerge from xml: service com::sun::star::sdbc::Statement: interface com::sun::star::sdbc::XBatchExecution /** provides the ability of batch execution. This interface is optional for execution. - <p>A driver implementing batch execution must return <TRUE/> for - <member scope= "com::sun::star::sdbc"> - XDatabaseMetaData::supportsBatchUpdates()</member> + <p> + A driver implementing batch execution must return + <TRUE/> + for + <member scope= "com::sun::star::sdbc"> XDatabaseMetaData::supportsBatchUpdates()</member> + </p> */ [optional] interface XBatchExecution; @@ -168,12 +173,26 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxFieldSize /** returns the maximum number of bytes allowed for any column value. - - <p>This limit is the maximum number of bytes that can be returned - for any column value. The limit applies only to BINARY, - VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. + <p> + This limit is the maximum number of bytes that can be returned + for any column value. The limit applies only to + <member scope= "com::sun::star::sdbc">DataType::BINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::LONGVARBINARY</member> + , + <member scope= "com::sun::star::sdbc">DataType::CHAR</member> + , + <member scope= "com::sun::star::sdbc">DataType::VARCHAR</member> + , + and + <member scope= "com::sun::star::sdbc">DataType::LONGVARCHAR</member> + columns. If the limit is exceeded, the excess data is silently discarded. - <br>There is no limitation, if set to zero.</p> + <br/> + There is no limitation, if set to zero. + </p> */ [property] long MaxFieldSize; @@ -181,17 +200,19 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::MaxRows /** retrieves the maximum number of rows that a ResultSet can contain. If the limit is exceeded, the excess rows are silently dropped. - <br>There is no limitation, if set to zero. + <br/> + There is no limitation, if set to zero. */ [property] long MaxRows; // DocMerge from xml: property com::sun::star::sdbc::Statement::CursorName /** defines the SQL cursor name that will be used by subsequent Statement - <code>execute</code> methods. + <code>execute</code> + methods. - - <p>This name can then be used in SQL positioned update/delete statements to + <p> + This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database does not support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support @@ -200,10 +221,14 @@ service Statement positioned updates may fail. </p> <p> - <b>Note:</b> By definition, positioned update/delete + <b> + Note: + </b> + By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, - cursor names must be unique within a connection.</p> + cursor names must be unique within a connection. + </p> */ [property] string CursorName; @@ -223,8 +248,12 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchDirection /** retrieves the direction for fetching rows from database tables that is the default for result sets generated from this - <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch direction, + <code>Statement</code> + object. + <br/> + If this + <code>Statement</code> + object has not set a fetch direction, the return value is implementation-specific. */ [property] long FetchDirection; @@ -232,8 +261,13 @@ service Statement // DocMerge from xml: property com::sun::star::sdbc::Statement::FetchSize /** retrieves the number of result set rows that is the default fetch size - for result sets generated from this <code>Statement</code> object.<br> - If this <code>Statement</code> object has not set a fetch size, + for result sets generated from this + <code>Statement</code> + object. + <br/> + If this + <code>Statement</code> + object has not set a fetch size, the return value is implementation-specific. */ [property] long FetchSize; @@ -251,43 +285,4 @@ service Statement }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.7 2002/07/19 10:09:02 oj - #95146# new interface to query for autogenerated values - - Revision 1.6 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.5 2001/01/23 10:08:29 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.4 2000/12/19 16:03:44 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:41 hjs - initial import - - Revision 1.7 2000/09/11 11:52:42 mi - documentation merged from XML - - Revision 1.5 2000/01/27 08:08:01 dg - #72164# EscapeProcessing instead of UseEscapeProcessing - - Revision 1.4 1999/12/20 16:11:34 dg - #70278# changes in API - - Revision 1.3 1999/12/14 12:05:45 dg - #70278# CompareBookmark removed - - Revision 1.2 1999/11/30 20:21:19 dg - #70248# XMultipleResultSet optional - - Revision 1.1 1999/11/24 08:41:02 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/TransactionIsolation.idl b/offapi/com/sun/star/sdbc/TransactionIsolation.idl index e0323390e5f4..bf28a48918ba 100644 --- a/offapi/com/sun/star/sdbc/TransactionIsolation.idl +++ b/offapi/com/sun/star/sdbc/TransactionIsolation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransactionIsolation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,7 +105,8 @@ constants TransactionIsolation // DocMerge from idl: value com::sun::star::sdbc::TransactionIsolation::SERIALIZABLE /** Dirty reads, non-repeatable reads and phantom reads are prevented. This level includes the prohibitions in - <code>REPEATABLE_READ</code> and further prohibits the + <code>REPEATABLE_READ</code> + and further prohibits the situation where one transaction reads all rows that satisfy a WHERE condition, a second transaction inserts a row that satisfies that WHERE condition, and the first transaction @@ -121,6 +122,12 @@ constants TransactionIsolation /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl index 40bb29f5a75d..914b03175927 100644 --- a/offapi/com/sun/star/sdbc/XArray.idl +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArray.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,9 +79,16 @@ interface XResultSet; // DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XArray -/** is used for mapping the SQL type <code>ARRAY</code>. - By default, an <code>Array</code> is a transaction duration - reference to an SQL array. By default, an <code>Array</code> +/** is used for mapping the SQL type + <member scope= "com::sun::star::sdbc">DataType::ARRAY</member> + . + By default, an + <code>Array</code> + is a transaction duration + reference to an SQL array. By default, an + + <code>Array</code> + is implemented using a SQL LOCATOR(array) internally. */ interface XArray: com::sun::star::uno::XInterface @@ -89,15 +96,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseTypeName /** returns the SQL type name of the elements in - the array designated by this <code>Array</code> object. - - - <p>If the elements are a built-in type, it returns + the array designated by this + <code>Array</code> + object. + <p> + If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name. - </p> + @returns + a String that is the database-specific name for a built-in base type or the fully-qualified SQL type name for a base type that is a UDT + + @throws SQLException + if a database access error occurs. */ string getBaseTypeName() raises (SQLException); @@ -105,7 +117,13 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseType /** returns the SDBC type of the elements in the array designated - by this <code>Array</code> object. + by this + <code>Array</code> + object. + @returns + a constant from the SDBC types that is the type code for the elements in the array designated by this Array object. + @throws SQLException + if a database access error occurs. */ long getBaseType() raises (SQLException); @@ -113,14 +131,23 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArray /** retrieves the contents of the SQL array designated by this - <code>Array</code> object, using the specified <code>typeMap</code> + <code>Array</code> + object, using the specified + <code>typeMap</code> for type map customizations. - <p>If the base type of the array does not match a user-defined type - in <code>typeMap</code>, the standard mapping is used instead. + <p> + If the base type of the array does not match a user-defined type + in + <code>typeMap</code> + , the standard mapping is used instead. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @@ -138,7 +165,10 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArrayAtIndex /** returns an array containing a slice of the SQL array, beginning with the - specified <code>index</code> and containing up to <code>count</code> + specified + <code>index</code> + and containing up to + <code>count</code> successive elements of the SQL array. @param index @@ -148,12 +178,20 @@ interface XArray: com::sun::star::uno::XInterface is the number of successive SQL array elements to retrieve. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @returns - an array containing up to <code>count</code> consecutive elements - of the SQL array, beginning with element <code>index</code>. + an array containing up to + <code>count</code> + consecutive elements + of the SQL array, beginning with element + <code>index</code> + . @throws SQLException if an error occurs while attempting to access the array. */ @@ -167,10 +205,18 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSet /** returns a result set that contains the elements of the array - designated by this <code>Array</code> object and uses the given - <code>typeMap</code> to map the array elements. If the base + designated by this + <code>Array</code> + object and uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -182,6 +228,14 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + + @param typeMap + contains mapping of SQL user-defined types to classes in the UNO programming language + @returns + a ResultSet object containing one row for each of the elements in the array designated by this Array object, + with the rows in ascending order based on the indices. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSet([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException); @@ -190,11 +244,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSetAtIndex /** returns a result set holding the elements of the subarray that - starts at index <code>index</code> and contains up to - <code>count</code> successive elements. This method uses the given - <code>typeMap</code> to map the array elements. If the base + starts at index + <code>index</code> + and contains up to + <code>count</code> + successive elements. This method uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -206,6 +269,17 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + @param index + the array index of the first element to retrieve; the first element is at index 1. + @param count + the number of successive SQL array elements to retrieve, + @param typeMap + the Map object that contains the mapping of SQL type names to classes in the UNO programming language. + @returns + a ResultSet object containing up to count consecutive elements of the SQL array + designated by this Array object, starting at index index. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSetAtIndex([in]long index, [in]long count, @@ -219,6 +293,12 @@ interface XArray: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XBatchExecution.idl b/offapi/com/sun/star/sdbc/XBatchExecution.idl index a0b5f317030b..3c1da816d60b 100644 --- a/offapi/com/sun/star/sdbc/XBatchExecution.idl +++ b/offapi/com/sun/star/sdbc/XBatchExecution.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBatchExecution.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,12 +83,19 @@ interface XBatchExecution: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::addBatch /** adds a SQL command to the current batch of commmands for the statement object. + @param sql + the SQL statement which should be appended to the batch. + + @throws SQLException + if a database access error occurs. */ void addBatch([in]string sql ) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XBatchExecution::clearBatch /** makes the set of commands in the current batch empty. + @throws SQLException + if a database access error occurs. */ void clearBatch() raises (SQLException); //------------------------------------------------------------------------- @@ -111,6 +118,12 @@ interface XBatchExecution: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XBlob.idl b/offapi/com/sun/star/sdbc/XBlob.idl index 1f949ace6572..2ed9694a3e3b 100644 --- a/offapi/com/sun/star/sdbc/XBlob.idl +++ b/offapi/com/sun/star/sdbc/XBlob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBlob.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,61 +77,135 @@ interface XInputStream; // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XBlob -/** is the representation (mapping) of an SQL <i>BLOB</i>. - +/** is the representation (mapping) of an SQL + <i> + BLOB + </i> + . <p> - A SQL <i>BLOB</i> is a built-in type that stores a + A SQL + <i> + BLOB + </i> + is a built-in type that stores a Binary Large Object as a column value in a row of a database table. - The driver implements <i>BLOB</i> using a - SQL <code>locator(BLOB)</code>, which means that a <code>Blob</code> - object contains a logical pointer to the SQL <i>BLOB</i> data rather - than the data itself. - <br> - A <code>Blob</code> object is valid for the duration of the - transaction in which is was created. + The driver implements + <i> + BLOB + </i> + using a + SQL + <code>locator(BLOB)</code> + , which means that a + <code>Blob</code> + object contains a logical pointer to the SQL + <i> + BLOB + </i> + data rather than the data itself. + <br/> + A + <code>Blob</code> + object is valid for the duration of the transaction in which is was created. </p> - <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, - and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as - <code>getBlob</code> and <code>setBlob</code> allow a programmer to - access the SQL <i>BLOB</i>.<br> - The <code>Blob</code> interface provides methods for getting the - length of a SQL <i>BLOB</i> (Binary Large Object) value, - for materializing a <i>BLOB</i> value on the client and for - determining the position of a pattern of bytes within a - <i>BLOB</i> value.</p> + <p> + Methods in the interfaces + <type scope="com::sun::star::sdbc">XResultSet</type> + , + and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + , such as + <code>getBlob</code> + and + <code>setBlob</code> + allow a programmer to access the SQL + <i> + BLOB + </i> + . + <br/> + The + <code>Blob</code> + interface provides methods for getting the length of a SQL + <i> + BLOB + </i> + (Binary Large Object) value, for materializing a + <i> + BLOB + </i> + value on the client and for determining the position of a pattern of bytes within a + <i> + BLOB + </i> + value. + </p> */ interface XBlob: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::length - /** returns the number of bytes in the <i>BLOB</i> value - designated by this <code>Blob</code> object. + /** returns the number of bytes in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object. + @returns + the length + @throws SQLException + if a database access error occurs. */ hyper length() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBytes - /** returns as an array of bytes part or all of the <i>BLOB</i> - value that this <code>Blob</code> object designates. The byte - array contains up to <code>length</code> consecutive bytes - starting at position <code>pos</code>. + /** returns as an array of bytes part or all of the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object designates. The byte + array contains up to + <code>length</code> + consecutive bytes + starting at position + <code>pos</code>. @param pos is the ordinal position of the first byte in the - <i>BLOB</i> value to be extracted; the first byte is at + <i> + BLOB + </i> + value to be extracted; the first byte is at position 1. @param length is the number of consecutive bytes to be copied. @returns - a byte array containing up to <code>length</code> - consecutive bytes from the <i>BLOB</i> value designated - by this <code>Blob</code> object, starting with the - byte at position <code>pos</code>. + a byte array containing up to + <code>length</code> + consecutive bytes from the + <i> + BLOB + </i> + value designated + by this + <code>Blob</code> + object, starting with the byte at position + <code>pos</code> + . @throws SQLException - if there is an error accessing the <i>BLOB</i>. + if there is an error accessing the + <i> + BLOB + </i> + . */ sequence<byte> getBytes([in]hyper pos, [in]long length) raises (SQLException); @@ -139,8 +213,17 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::getBinaryStream - /** retrieves the <i>BLOB</i> designated by this - <code>Blob</code> instance as a stream. + /** retrieves the + <i> + BLOB + </i> + designated by this + <code>Blob</code> + instance as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream() raises (SQLException); @@ -148,10 +231,25 @@ interface XBlob: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::position /** determines the byte position at which the specified byte - <code>pattern</code> begins within the <i>BLOB</i> - value that this <code>Blob</code> object represents. The - search for <code>pattern</code> begins at position - <code>start</code>. + <code>pattern</code> + begins within the + <i> + BLOB + </i> + value that this + <code>Blob</code> + object represents. The + search for + <code>pattern</code> + begins at position + <code>start</code> + . + @param pattern + the pattern to search + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper position([in]sequence<byte> pattern, [in]hyper start) raises (SQLException); @@ -159,10 +257,26 @@ interface XBlob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XBlob::positionOfBlob - /** determines the byte position in the <i>BLOB</i> value - designated by this <code>Blob</code> object at which - <code>pattern</code> begins. The search begins at position - <code>start</code>. + /** determines the byte position in the + <i> + BLOB + </i> + value + designated by this + <code>Blob</code> + object at which + <code>pattern</code> + begins. The search begins at position + <code>start</code> + . + @param pattern + the pattern to search + @param start + position to start + @returns + the position + @throws SQLException + if a database access error occurs. */ hyper positionOfBlob([in]XBlob pattern,[in] hyper start) raises (SQLException); @@ -174,6 +288,12 @@ interface XBlob: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XClob.idl b/offapi/com/sun/star/sdbc/XClob.idl index 5035e1a2b786..1d0e5b4ca7e8 100644 --- a/offapi/com/sun/star/sdbc/XClob.idl +++ b/offapi/com/sun/star/sdbc/XClob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XClob.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,28 +77,62 @@ interface XInputStream; // DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XClob -/** is the mapping for the SQL <code>CLOB</code> type. +/** is the mapping for the SQL + <code>CLOB</code> + type. - <p>A SQL <code>CLOB</code> is a built-in type + <p> + A SQL + <code>CLOB</code> + is a built-in type that stores a Character Large Object as a column value in a row of a database table. - The driver implements a <code>Clob</code> object using a SQL - <code>locator(CLOB)</code>, which means that a <code>Clob</code> object - contains a logical pointer to the SQL <code>CLOB</code> data rather than - the data itself. A <code>Clob</code> object is valid for the duration + The driver implements a + <code>Clob</code> + object using a SQL + <code>locator(CLOB)</code> + , which means that a + <code>Clob</code> + object + contains a logical pointer to the SQL + <code>CLOB</code> + data rather than + the data itself. A + <code>Clob</code> + object is valid for the duration of the transaction in which it was created. </p> - <p>The <code>Clob</code> interface provides methods for getting the - length of a SQL <code>CLOB</code> (Character Large Object) value, - for materializing a <code>CLOB</code> value on the client, and for - searching for a substring or <code>CLOB</code> object within a - <code>CLOB</code> value. + <p> + The + <code>Clob</code> + interface provides methods for getting the + length of a SQL + <code>CLOB</code> + (Character Large Object) value, + for materializing a + <code>CLOB</code> + value on the client, and for + searching for a substring or + <code>CLOB</code> + object within a + <code>CLOB</code> + value. </p> - <p>Methods in the interfaces <type scope="com::sun::star::sdbc">XResultSet</type>, - and <type scope="com::sun::star::sdbc">XPreparedStatement</type>, such as - <code>getClob</code> and <code>setClob</code> allow a programmer to - access the SQL <code>CLOB</code>.<br> + <p> + Methods in the interfaces + <type scope="com::sun::star::sdbc">XResultSet</type> + , + and + <type scope="com::sun::star::sdbc">XPreparedStatement</type> + , such as + <code>getClob</code> + and + <code>setClob</code> + allow a programmer to + access the SQL + <code>CLOB</code> + . </p> */ interface XClob: com::sun::star::uno::XInterface @@ -106,28 +140,57 @@ interface XClob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::length - /** returns the number of characters in the <code>CLOB</code> value - designated by this <code>Clob</code> object. + /** returns the number of characters in the + <code>CLOB</code> + value + designated by this + <code>Clob</code> + object. + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. */ hyper length() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getSubString - /** returns a copy of the specified substring in the <code>CLOB</code> value - designated by this <code>Clob</code> object. + /** returns a copy of the specified substring in the + <code>Clob</code> + value + designated by this + <code>Clob</code> + object. - <p>The substring begins at position <code>pos</code> and has up - to <code>length</code> consecutive characters. + <p> + The substring begins at position <code>pos</code> and has up + to + <code>length</code> + consecutive characters. </p> + @param pos + the starting position + @param length + the length of the substring + @returns + the substring + @throws SQLException + if a database access error occurs. */ string getSubString([in]hyper pos, [in]long length) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::getCharacterStream - /** gets the <code>Clob</code> contents as a stream. + /** gets the + <code>Clob</code> + contents as a stream. + @returns + the stream + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getCharacterStream() raises (SQLException); @@ -135,8 +198,20 @@ interface XClob: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::position /** determines the character position at which the specified substring - <code>searchstr</code> appears in the <code>CLOB</code>. The search - begins at position <code>start</code>. + <code>searchstr</code> + appears in the + <code>Clob</code> + . The search begins at position + <code>start</code> + . + @param searchstr + the string to search + @param start + the starting position + @returns + the length of the CLOB object + @throws SQLException + if a database access error occurs. */ hyper position([in]string searchstr, [in]long start) raises (SQLException); @@ -144,10 +219,23 @@ interface XClob: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XClob::positionOfClob - /** determines the character position at which the specified - <code>Clob</code> object <code>searchstr</code> appears in this - <code>Clob</code> object. The search begins at position - <code>start</code>. + /** determines the position at which the specified + <code>Clob</code> + object + <code>pattern</code> + appears in this + <code>Clob</code> + object. The search begins at position + <code>start</code> + . + @param pattern + the CLOB to search + @param start + the starting position + @returns + the position of the CLOB inside + @throws SQLException + if a database access error occurs. */ hyper positionOfClob([in]XClob pattern, [in]hyper start) raises (SQLException); @@ -159,6 +247,12 @@ interface XClob: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XCloseable.idl b/offapi/com/sun/star/sdbc/XCloseable.idl index cd5d2f92caf0..9256a2d5ef86 100644 --- a/offapi/com/sun/star/sdbc/XCloseable.idl +++ b/offapi/com/sun/star/sdbc/XCloseable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCloseable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,6 +80,8 @@ interface XCloseable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XCloseable::close /** releases all resources connected to an object. + @throws SQLException + if a database access error occurs. */ void close() raises (SQLException); }; @@ -90,6 +92,12 @@ interface XCloseable: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XColumnLocate.idl b/offapi/com/sun/star/sdbc/XColumnLocate.idl index 751644a1715e..324e17240def 100644 --- a/offapi/com/sun/star/sdbc/XColumnLocate.idl +++ b/offapi/com/sun/star/sdbc/XColumnLocate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumnLocate.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,19 +78,27 @@ interface XResultSetMetaData; /** provides the possibility to find columns by their name. - <p>When several columns have the same name, then the value + <p> + When several columns have the same name, then the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL query. For columns that are NOT explicitly named in the query, it is best to use column numbers. If column names are used, there is no way for the programmer to guarantee that they actually refer to - the intended columns.</p> + the intended columns. + </p> */ interface XColumnLocate: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XColumnLocate::findColumn /** maps the given Resultset column name to its ResultSet column index. + @param columnName + the name of the column + @returns + the position of the column + @throws SQLException + if a database access error occurs. */ long findColumn([in]string columnName) raises (SQLException); }; @@ -101,6 +109,12 @@ interface XColumnLocate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl index ac5856dcc6ef..b821c0cab39c 100644 --- a/offapi/com/sun/star/sdbc/XConnection.idl +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnection.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,87 +90,133 @@ interface XDatabaseMetaData; executed and results are returned. - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, and the capabilities of this connection. This - information is obtained with the <code>getMetaData</code> method. - - </p>@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XStatement - @see com::sun::star::sdbc::XDatabaseMetaData + information is obtained with the + <member scope="com::sun::star::sdbc">XDatabaseMetaData::getMetaData()</member> + method. + + </p> + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XStatement + @see com::sun::star::sdbc::XDatabaseMetaData */ interface XConnection: com::sun::star::sdbc::XCloseable { // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::createStatement - /** creates a new <code>Statement</code> object for sending - SQL statements to the database. + /** creates a new + <type scope="com::sun::star::sdbc">Statement</type> + object for sending SQL statements to the database. - <p>SQL statements without parameters are normally + <p> + SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a - PreparedStatement <type scope="com::sun::star::sdbc">PreparedStatement</type>. + <type scope="com::sun::star::sdbc">PreparedStatement</type> + . </p> - <p>Result sets created using the returned Statement will have + <p> + Result sets created using the returned Statement will have forward-only type, and read-only concurrency, by default. </p> - <p>Escape processing for the SQL-Statement is enabled, by default. + <p> + Escape processing for the SQL-Statement is enabled, by default. </p> + + @returns + a new Statement object + @throws SQLException + if a database access error occurs. */ XStatement createStatement() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareStatement - /** creates a <code>PreparedStatement</code> object for sending - parameterized SQL statements to the database. + /** creates a + <type scope="com::sun::star::sdbc">PreparedStatement</type> + object for sending parameterized SQL statements to the database. - <p>A SQL statement with or without IN parameters can be + <p> + A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times. </p> <p> - <b>Note:</b> This method is optimized for handling + <b> + Note: + </b> + This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, - the method <code>prepareStatement</code> will send + the method + <code>prepareStatement</code> + will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may - not be sent to the database until the <code>PreparedStatement</code> is - executed. This has no direct effect on users; however, it does + not be sent to the database until the + <type scope="com::sun::star::sdbc">PreparedStatement</type> + is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. </p> - <p> Result sets created using the returned PreparedStatement will have + <p> + Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default. </p> - <p>Escape processing for the SQL-Statement is enabled, by default. + <p> + Escape processing for the SQL-Statement is enabled, by default. </p> + + @param sql + a SQL statement that may contain one or more '?' IN parameter placeholders + @returns + a new PreparedStatement object containing the pre-compiled statement + @throws SQLException + if a database access error occurs. */ XPreparedStatement prepareStatement([in]string sql) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::prepareCall - /** creates a <code>CallableStatement</code> object for calling + /** creates a + <type scope="com::sun::star::sdbc">CallableStatement</type> + object for calling database stored procedures. - <p>The CallableStatement provides methods for setting up its IN and OUT + <p> + The CallableStatement provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure. </p> <p> - <b>Note:</b> This method is optimized for handling stored + <b> + Note: + </b> + This method is optimized for handling stored procedure call statements. Some drivers may send the call - statement to the database when the method <code>prepareCall</code> - is done;<br> + statement to the database when the method + <code>prepareCall</code> + is done; + <br/> others may wait until the CallableStatement is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default. </p> + + @param sql + a SQL statement that may contain one or more '?' IN parameter placeholders + @returns + a new PreparedStatement object containing the pre-compiled statement + @throws SQLException + if a database access error occurs. */ XPreparedStatement prepareCall([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -180,6 +226,13 @@ interface XConnection: com::sun::star::sdbc::XCloseable A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent. + + @param sql + a SQL statement that may contain one or more '?' parameter placeholders + @returns + the native form of this statement + @throws SQLException + if a database access error occurs. */ string nativeSQL([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -188,14 +241,20 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** sets this connection's auto-commit mode. - <p>If a connection is in auto-commit mode, then all its SQL + <p> + If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either - the method <code>commit</code> or the method <code>rollback</code>. + the method + <member scope="com::sun::star::sdbc">XConnection::commit()</member> + or the method + <member scope="com::sun::star::sdbc">XConnection::rollback()</member> + . By default, new connections are in auto-commit mode. </p> - <p>The commit occurs when the statement completes or the next + <p> + The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the @@ -204,6 +263,11 @@ interface XConnection: com::sun::star::sdbc::XCloseable parameter values. In these cases the commit occurs when all results and output parameter values have been retrieved. </p> + + @param autoCommit + <TRUE/> enables auto-commit; <FALSE/> disables auto-commit. + @throws SQLException + if a database access error occurs. */ void setAutoCommit([in] boolean autoCommit) raises (SQLException); //------------------------------------------------------------------------- @@ -211,6 +275,11 @@ interface XConnection: com::sun::star::sdbc::XCloseable // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getAutoCommit /** gets the current auto-commit state. + @returns + the current state of auto-commit mode. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ boolean getAutoCommit() raises (SQLException); @@ -222,6 +291,9 @@ interface XConnection: com::sun::star::sdbc::XCloseable by the Connection. This method should be used only when auto-commit mode has been disabled. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ void commit() raises (SQLException); @@ -232,6 +304,9 @@ interface XConnection: com::sun::star::sdbc::XCloseable commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto-commit has been disabled. + @throws SQLException + if a database access error occurs. + @see setAutoCommit */ void rollback() raises (SQLException); @@ -242,9 +317,17 @@ interface XConnection: com::sun::star::sdbc::XCloseable <p> - <b>Note:</b> A Connection is automatically closed if no one references it + <b> + Note: + </b> + A Connection is automatically closed if no one references it anymore. Certain fatal errors also result in a closed Connection. </p> + + @returns + <TRUE/> if the connection is closed; <FALSE/> if it's still open. + @throws SQLException + if a database access error occurs. */ boolean isClosed() raises (SQLException); //------------------------------------------------------------------------- @@ -253,12 +336,18 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** gets the metadata regarding this connection's database. - <p>A Connection's database is able to provide information + <p> + A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object. </p> + + @returns + a DatabaseMetaData object for this Connection. + @throws SQLException + if a database access error occurs. */ XDatabaseMetaData getMetaData() raises (SQLException); //------------------------------------------------------------------------- @@ -269,16 +358,30 @@ interface XConnection: com::sun::star::sdbc::XCloseable <p> - <b>Note:</b> This method cannot be called while in the - middle of a transaction. Calling setReadOnly with <TRUE/> does not + <b> + Note: + </b> + This method cannot be called while in the + middle of a transaction. Calling setReadOnly with + <TRUE/> + does not necessarily cause writes to be prohibited. </p> + + @param readONly + <TRUE/> enables read-only mode; <FALSE/> disables read-only mode. + @throws SQLException + if a database access error occurs. */ void setReadOnly([in]boolean readOnly) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::isReadOnly /** tests to see if the connection is in read-only mode. + @returns + <TRUE/> if connection is read-only and <FALSE/> otherwise. + @throws SQLException + if a database access error occurs. */ boolean isReadOnly() raises (SQLException); //------------------------------------------------------------------------- @@ -288,12 +391,20 @@ interface XConnection: com::sun::star::sdbc::XCloseable a subspace of this Connection's database in which to work. If the driver does not support catalogs, it will silently ignore this request. + @param catalog + the name of the catalog. + @throws SQLException + if a database access error occurs. */ void setCatalog([in]string catalog) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getCatalog /** returns the Connection's current catalog name. + @returns + the current catalog name or an empty string. + @throws SQLException + if a database access error occurs. */ string getCatalog() raises (SQLException); //------------------------------------------------------------------------- @@ -302,21 +413,34 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** attempts to change the transaction isolation level to the one given. - <p>The constants defined in - <type scope="com::sun::star::sdbc">TransactionIsolation</type> are the possible - transaction isolation levels. + <p> + The constants defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type> + are the possible transaction isolation levels. </p> <p> - <b>Note:</b> This method cannot be called while + <b> + Note: + </b> + This method cannot be called while in the middle of a transaction. - </p>@see - com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel() + </p> + @param level + one of the TransactionIsolation values with the exception of NONE; some databases may not support other values. + @throws SQLException + if a database access error occurs. + + @see com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel() */ void setTransactionIsolation([in]long level) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XConnection::getTransactionIsolation /** gets this Connection's current transaction isolation level. + @returns + the current TransactionIsolation mode value. + @throws SQLException + if a database access error occurs. */ long getTransactionIsolation() raises (SQLException); //------------------------------------------------------------------------- @@ -325,11 +449,16 @@ interface XConnection: com::sun::star::sdbc::XCloseable /** gets the type map object associated with this connection. Only drivers which implement the custom type mapping facility will return an object otherwise NULL could be returned. -<!-- JRH: changed "how implement" to "which implement" --> - <p>Unless the application has added an entry to the type map, the map + <p> + Unless the application has added an entry to the type map, the map returned will be empty. </p> + @returns + the XNameAccess object associated with this Connection object. + + @throws SQLException + if a database access error occurs. */ com::sun::star::container::XNameAccess getTypeMap() raises (SQLException); //------------------------------------------------------------------------- @@ -340,8 +469,14 @@ interface XConnection: com::sun::star::sdbc::XCloseable and distinct types. - <p>Only if the driver supports custom type mapping is the setting of a map allowed. + <p> + Only if the driver supports custom type mapping is the setting of a map allowed. </p> + + @param typeMap + set the XNameAccess object associated with this Connection object. + @throws SQLException + if a database access error occurs. */ void setTypeMap([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException); @@ -353,6 +488,12 @@ interface XConnection: com::sun::star::sdbc::XCloseable /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.7.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.7 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.6 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XDataSource.idl b/offapi/com/sun/star/sdbc/XDataSource.idl index b21d07425c95..ba2e0466ac95 100644 --- a/offapi/com/sun/star/sdbc/XDataSource.idl +++ b/offapi/com/sun/star/sdbc/XDataSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataSource.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,6 +85,14 @@ interface XDataSource: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDataSource::getConnection /** attempts to establish a database connection. + @param user + the user name + @param password + the password + @returns + the connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection([in]string user, [in]string password) raises (SQLException); @@ -95,10 +103,15 @@ interface XDataSource: com::sun::star::uno::XInterface while attempting to connect to a database. - <p>A value of zero specifies that the timeout is the default system + <p> + A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created the login timeout is initially zero. </p> + @param seconds + the login time limit in seconds + @throws SQLException + if a database access error occurs. */ void setLoginTimeout([in]long seconds) raises (SQLException); @@ -109,10 +122,15 @@ interface XDataSource: com::sun::star::uno::XInterface while attempting to connect to a database. - <p> A value of zero means that the timeout is the default system timeout + <p> + A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created the login timeout is initially zero. </p> + @returns + the login time limit in seconds + @throws SQLException + if a database access error occurs. */ long getLoginTimeout() raises (SQLException); }; @@ -123,6 +141,12 @@ interface XDataSource: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl index cd8f7687983e..cdfac633cbd2 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseMetaData.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: jsc $ $Date: 2001-11-28 15:32:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,30 @@ interface XConnection; <p>Many of the methods here return lists of information in - the form of <code>XResultSet</code> objects. - You can use the normal XResultSet methods such as getString and getInt + the form of + <type scope="com::sun::star::sdbc">XResultSet</type> + objects. + You can use the normal <type scope="com::sun::star::sdbc">XResultSet</type> + methods such as + <member scope="com::sun::star::sdbc">XResultSet::getString()</member> + and + <member scope="com::sun::star::sdbc">XResultSet::getInt()</member> to retrieve the data from these XResultSets. If a given form of - metadata is not available, these methods should throw a SQLException. + metadata is not available, these methods should throw a + <type scope="com::sun::star::sdbc">SQLException</type> + . </p> - <p>Some of these methods take arguments that are String patterns. These - arguments all have names such as fooPattern. Within a pattern String, "%" + <p>Some of these methods take arguments that are String patterns. These + arguments all have names such as fooPattern. Within a pattern String, "%" means match any substring of 0 or more characters, and "_" means match any one character. Only metadata entries matching the search pattern - are returned. If a search pattern argument is set to a null ref, + are returned. If a search pattern argument is set to a <NULL/> ref, that argument's criteria will be dropped from the search. </p> - <p>A <code>SQLException</code> will be thrown if a driver does not support + <p> + A + <type scope="com::sun::star::sdbc">SQLException</type> + will be thrown if a driver does not support a meta data method. In the case of methods that return an XResultSet, either an XResultSet (which may be empty) is returned or a SQLException is thrown.</p> @@ -104,7 +115,14 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** Can all the procedures returned by getProcedures be called by the current user? -<!-- JRH:/MI: These questions are unclear, see "@return\<TRUE/>..." examples in this document for a better solution. --> + @return + <TRUE/> + if the user is allowed to call all procedures returned by getProcedures + otherwise + <FALSE/> + . + @throws SQLException + if a database access error occurs. */ boolean allProceduresAreCallable() raises (SQLException); //------------------------------------------------------------------------- @@ -112,6 +130,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::allTablesAreSelectable /** Can all the tables returned by getTable be SELECTed by the current user? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean allTablesAreSelectable() raises (SQLException); //------------------------------------------------------------------------- @@ -130,30 +152,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isReadOnly /** checks if the database in read-only mode. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isReadOnly() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedHigh /** Are NULL values sorted high? -<!-- JRH: meaning sorted to start of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedHigh() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedLow /** Are NULL values sorted low? -<!-- JRH: meaning to end of file? -->*/ + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + */ boolean nullsAreSortedLow() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtStart /** Are NULL values sorted at the start regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullsAreSortedAtEnd /** Are NULL values sorted at the end, regardless of sort order? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullsAreSortedAtEnd() raises (SQLException); //------------------------------------------------------------------------- @@ -196,18 +238,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFiles /** use the database local files to save the tables. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFiles() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::usesLocalFilePerTable /** use the database one local file to save for each table. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean usesLocalFilePerTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseIdentifiers /** use the database 'mixed case unquoted SQL identifiers' case sensitive. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -215,6 +269,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in upper case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesUpperCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -222,6 +280,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in lower case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesLowerCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -229,6 +291,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseIdentifiers /** Does the database treat mixed case unquoted SQL identifiers as case insensitive and store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesMixedCaseIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -236,6 +302,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMixedCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case sensitive and as a result store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -243,6 +313,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesUpperCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in upper case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesUpperCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -250,6 +324,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesLowerCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in lower case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesLowerCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -257,6 +335,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::storesMixedCaseQuotedIdentifiers /** Does the database treat mixed case quoted SQL identifiers as case insensitive and store them in mixed case? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean storesMixedCaseQuotedIdentifiers() raises (SQLException); //------------------------------------------------------------------------- @@ -264,6 +346,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getIdentifierQuoteString /** What's the string used to quote SQL identifiers? This returns a space " " if identifier quoting is not supported. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getIdentifierQuoteString() raises (SQLException); //------------------------------------------------------------------------- @@ -271,36 +357,56 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSQLKeywords /** gets a comma-separated list of all a database's SQL keywords that are NOT also SQL92 keywords. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSQLKeywords() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getNumericFunctions - /** gets a comma-separated list of math functions. These are the + /** gets a comma-separated list of math functions. These are the X/Open CLI math function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getNumericFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getStringFunctions - /** gets a comma-separated list of string functions. These are the + /** gets a comma-separated list of string functions. These are the X/Open CLI string function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getStringFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSystemFunctions - /** gets a comma-separated list of system functions. These are the + /** gets a comma-separated list of system functions. These are the X/Open CLI system function names used in the SDBC function escape clause. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSystemFunctions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTimeDateFunctions /** gets a comma-separated list of time and date functions. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getTimeDateFunctions() raises (SQLException); //------------------------------------------------------------------------- @@ -311,11 +417,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface the string pattern style catalog search parameters. - <p>The '_' character represents any single character. + <p> + The '_' character represents any single character. </p> - <p>The '%' character represents any sequence of zero or + <p> + The '%' character represents any sequence of zero or more characters. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSearchStringEscape() raises (SQLException); //------------------------------------------------------------------------- @@ -323,18 +435,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExtraNameCharacters /** gets all the "extra" characters that can be used in unquoted identifier names (those beyond a-z, A-Z, 0-9 and _). + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getExtraNameCharacters() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithAddColumn /** support the Database "ALTER TABLE" with add column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithAddColumn() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsAlterTableWithDropColumn /** support the Database "ALTER TABLE" with drop column? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsAlterTableWithDropColumn() raises (SQLException); //------------------------------------------------------------------------- @@ -343,31 +467,52 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** support the Database column aliasing? - <p>The SQL AS clause can be used to provide names for + <p> + The SQL AS clause can be used to provide names for computed columns or to provide alias names for columns as required. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsColumnAliasing() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::nullPlusNonNullIsNull /** are concatenations between NULL and non-NULL values NULL? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean nullPlusNonNullIsNull() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTypeConversion - /** @returns - <TRUE/>, if the Database supports the CONVERT function between SQL types, - otherwise <FALSE/>. + /** <TRUE/> + , if the Database supports the CONVERT function between SQL types, + otherwise + <FALSE/> + . + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTypeConversion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsConvert - /** @returns - <TRUE/>, if the Database supports the CONVERT between the given SQL types - otherwise <FALSE/>. + /** <TRUE/> + , if the Database supports the CONVERT between the given SQL types + otherwise + <FALSE/> + . + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsConvert([in]long fromType, [in]long toType) raises (SQLException); @@ -375,6 +520,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTableCorrelationNames /** Are table correlation names supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTableCorrelationNames() raises (SQLException); //------------------------------------------------------------------------- @@ -382,6 +531,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDifferentTableCorrelationNames /** If table correlation names are supported, are they restricted to be different from the names of the tables? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsDifferentTableCorrelationNames() raises (SQLException); @@ -389,24 +542,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExpressionsInOrderBy /** Are expressions in "ORDER BY" lists supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExpressionsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOrderByUnrelated /** Can an "ORDER BY" clause use columns not in the SELECT statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOrderByUnrelated() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupBy /** Is some form of "GROUP BY" clause supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByUnrelated /** Can a "GROUP BY" clause use columns not in the SELECT? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupByUnrelated() raises (SQLException); //------------------------------------------------------------------------- @@ -414,18 +583,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsGroupByBeyondSelect /** Can a "GROUP BY" clause add columns not in the SELECT provided it specifies all the columns in the SELECT? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsGroupByBeyondSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLikeEscapeClause /** Is the escape character in "LIKE" clauses supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsLikeEscapeClause() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleResultSets /** Are multiple XResultSets from a single execute supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleResultSets() raises (SQLException); //------------------------------------------------------------------------- @@ -433,36 +614,54 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMultipleTransactions /** Can we have multiple transactions open at once (on different connections)? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMultipleTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsNonNullableColumns /** Can columns be defined as non-nullable? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsNonNullableColumns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsMinimumSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Minimum SQL grammar, + /** <TRUE/>, if the database supports ODBC Minimum SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsMinimumSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCoreSQLGrammar - /** @returns - <TRUE/>, if the database supports ODBC Core SQL grammar, + /** <TRUE/>, if the database supports ODBC Core SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCoreSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsExtendedSQLGrammar - /** @returns + /** <TRUE/>, if the database supports ODBC Extended SQL grammar, otherwise <FALSE/>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsExtendedSQLGrammar() raises (SQLException); //------------------------------------------------------------------------- @@ -471,6 +670,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 entry level SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92EntryLevelSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -479,6 +680,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 intermediate SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92IntermediateSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -487,6 +690,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if the database supports ANSI92 full SQL grammar, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsANSI92FullSQL() raises (SQLException); //------------------------------------------------------------------------- @@ -495,6 +700,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** returns <TRUE/>, if the Database supports SQL Integrity Enhancement Facility, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsIntegrityEnhancementFacility() raises (SQLException); //------------------------------------------------------------------------- @@ -503,6 +710,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if some form of outer join is supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -511,6 +720,8 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** @returns <TRUE/>, if full nested outer joins are supported, otherwise <FALSE/>. + @throws SQLException + if a database access error occurs. */ boolean supportsFullOuterJoins() raises (SQLException); //------------------------------------------------------------------------- @@ -518,26 +729,40 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsLimitedOuterJoins /** @returns <TRUE/>, if there is limited support for outer joins. - (This will be true if supportFullOuterJoins is true.) + (This will be <TRUE/> if supportFullOuterJoins is <TRUE/>.) <FALSE/> is returned otherwise. + @throws SQLException + if a database access error occurs. */ boolean supportsLimitedOuterJoins() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getSchemaTerm /** return the database vendor's preferred term for "schema" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getSchemaTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getProcedureTerm /** return the database vendor's preferred term for "procedure" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getProcedureTerm() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogTerm /** return the database vendor's preferred term for "catalog" + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogTerm() raises (SQLException); //------------------------------------------------------------------------- @@ -545,42 +770,70 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::isCatalogAtStart /** Does a catalog appear at the start of a qualified table name? (Otherwise it appears at the end) + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCatalogAtStart() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getCatalogSeparator /** return the separator between catalog and table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ string getCatalogSeparator() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInDataManipulation /** Can a schema name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInProcedureCalls /** Can a schema name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInTableDefinitions /** Can a schema name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInIndexDefinitions /** Can a schema name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSchemasInPrivilegeDefinitions /** Can a schema name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSchemasInPrivilegeDefinitions() raises (SQLException); @@ -588,30 +841,50 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInDataManipulation /** Can a catalog name be used in a data manipulation statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInDataManipulation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInProcedureCalls /** Can a catalog name be used in a procedure call statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInProcedureCalls() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInTableDefinitions /** Can a catalog name be used in a table definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInTableDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInIndexDefinitions /** Can a catalog name be used in an index definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInIndexDefinitions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCatalogsInPrivilegeDefinitions /** Can a catalog name be used in a privilege definition statement? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCatalogsInPrivilegeDefinitions() raises (SQLException); @@ -619,18 +892,30 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedDelete /** Is positioned DELETE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedDelete() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsPositionedUpdate /** Is positioned UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsPositionedUpdate() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSelectForUpdate /** Is SELECT for UPDATE supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSelectForUpdate() raises (SQLException); //------------------------------------------------------------------------- @@ -638,72 +923,120 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsStoredProcedures /** Are stored procedure calls using the stored procedure escape syntax supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsStoredProcedures() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInComparisons /** Are subqueries in comparison expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInComparisons() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInExists /** Are subqueries in 'exists' expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInExists() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInIns /** Are subqueries in 'in' statements supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInIns() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsSubqueriesInQuantifieds /** Are subqueries in quantified expressions supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsSubqueriesInQuantifieds() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsCorrelatedSubqueries /** Are correlated subqueries supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsCorrelatedSubqueries() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnion /** Is SQL UNION supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnion() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsUnionAll /** Is SQL UNION ALL supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsUnionAll() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossCommit /** Can cursors remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenCursorsAcrossRollback /** Can cursors remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenCursorsAcrossRollback() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossCommit /** Can statements remain open across commits? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossCommit() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsOpenStatementsAcrossRollback /** Can statements remain open across rollbacks? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsOpenStatementsAcrossRollback() raises (SQLException); @@ -711,90 +1044,150 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxBinaryLiteralLength /** return the maximal number of hex characters in an inline binary literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxBinaryLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCharLiteralLength /** return the max length for a character literal + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCharLiteralLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnNameLength /** return the limit on column name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInGroupBy /** return the maximum number of columns in a "GROUP BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInGroupBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInIndex /** return the maximum number of columns allowed in an index + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInIndex() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInOrderBy /** return the maximum number of columns in an "ORDER BY" clause + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInOrderBy() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInSelect /** return the maximum number of columns in a "SELECT" list + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxColumnsInTable /** return the maximum number of columns in a table + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxColumnsInTable() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxConnections /** return the number of active connections at a time to this database. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxConnections() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCursorNameLength /** return the maximum cursor name length + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCursorNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxIndexLength /** return the maximum length of an index (in bytes) + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxIndexLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxSchemaNameLength /** return the maximum length allowed for a schema name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxSchemaNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxProcedureNameLength /** return the maximum length of a procedure name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxProcedureNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxCatalogNameLength /** return the maximum length of a catalog name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxCatalogNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxRowSize /** return the maximum length of a single row. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxRowSize() raises (SQLException); //------------------------------------------------------------------------- @@ -802,57 +1195,97 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::doesMaxRowSizeIncludeBlobs /** Did getMaxRowSize() include LONGVARCHAR and LONGVARBINARY blobs? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean doesMaxRowSizeIncludeBlobs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatementLength /** return the maximum length of a SQL statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxStatementLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxStatements /** return the maximal number of open active statements at one time to this database + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxStatements() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTableNameLength /** return the maximum length of a table name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTableNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxTablesInSelect /** return the maximum number of tables in a SELECT statement + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxTablesInSelect() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getMaxUserNameLength /** return the maximum length of a user name + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long getMaxUserNameLength() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getDefaultTransactionIsolation /** return the database default transaction isolation level. - The values are defined in <type scope="com::sun::star::sdbc">TransactionIsolation</type>.@see com::sun::star::sdbc::XConnection + The values are defined in + <type scope="com::sun::star::sdbc">TransactionIsolation</type>. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. + @see com::sun::star::sdbc::XConnection */ long getDefaultTransactionIsolation() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactions /** support the Database transactions? - If not, invoking the method <code>commit</code> is a noop and the + If not, invoking the method + <member scope="com::Sun::star::sdbc">XConnection::commit()</member> + is a noop and the isolation level is TransactionIsolation_NONE. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsTransactions() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsTransactionIsolationLevel /** Does this database support the given transaction isolation level? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. @see com::sun::star::sdbc::Connection */ boolean supportsTransactionIsolationLevel([in]long level) @@ -862,6 +1295,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataDefinitionAndDataManipulationTransactions /** support the Database both data definition and data manipulation statements within a transaction? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. <!-- JRH: Unclear on the intent of these many support questions. If asking, it should state, "Does the Database support both ....? If declaring, it should state something like the following: @@ -877,6 +1314,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsDataManipulationTransactionsOnly /** are only data manipulation statements within a transaction supported? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsDataManipulationTransactionsOnly() raises (SQLException); @@ -885,6 +1326,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionCausesTransactionCommit /** does a data definition statement within a transaction force the transaction to commit? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean dataDefinitionCausesTransactionCommit() raises (SQLException); @@ -892,6 +1337,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::dataDefinitionIgnoredInTransactions /** is a data definition statement within a transaction ignored? + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean dataDefinitionIgnoredInTransactions() raises (SQLException); @@ -902,18 +1351,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface catalog. - <p>Only procedure descriptions matching the schema and - procedure name criteria are returned. They are ordered by + <p> + Only procedure descriptions matching the schema and + procedure name criteria are returned. They are ordered by PROCEDURE_SCHEM, and PROCEDURE_NAME. </p> - <p>Each procedure description has the the following columns: + <p> + Each procedure description has the the following columns: </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -939,6 +1390,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @returns + each row is a procedure description + @throws SQLException + if a database access error occurs. */ XResultSet getProcedures([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern) raises (SQLException); @@ -949,8 +1410,9 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface and result columns. - <p>Only descriptions matching the schema, procedure and - parameter name criteria are returned. They are ordered by + <p> + Only descriptions matching the schema, procedure and + parameter name criteria are returned. They are ordered by PROCEDURE_SCHEM and PROCEDURE_NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order. @@ -960,10 +1422,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be null) + <b>PROCEDURE_CAT</b> string =&gt; procedure catalog (may be <NULL/>) </li> <li> - <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be null) + <b>PROCEDURE_SCHEM</b> string =&gt; procedure schema (may be <NULL/>) </li> <li> <b>PROCEDURE_NAME</b> string =&gt; procedure name @@ -1027,6 +1489,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface descriptions for a procedure. Additional columns beyond REMARKS can be defined by the database. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param procedureNamePattern + a procedure name pattern + @param columnNamePattern + a column name pattern + @returns + each row describes a stored procedure parameter or column + @throws SQLException + if a database access error occurs. */ XResultSet getProcedureColumns([in]any catalog, [in]string schemaPattern, [in]string procedureNamePattern, @@ -1039,23 +1513,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only table descriptions matching the catalog, schema, table - name, and type criteria are returned. They are ordered by + name, and type criteria are returned. They are ordered by TABLE_TYPE, TABLE_SCHEM, and TABLE_NAME. </p> <p>Each table description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> @@ -1067,6 +1541,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> Some databases may not return information for all tables. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param types + a list of table types to include; <NULL/> returns all types + @returns + each row is a table description + @throws SQLException + if a database access error occurs. */ XResultSet getTables([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]sequence<string> types) @@ -1085,6 +1571,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_SCHEM</b> string =&gt; schema name </li> </ol> + @returns + each row has a single String column that is a schema name + @throws SQLException + if a database access error occurs. */ XResultSet getSchemas() raises (SQLException); //------------------------------------------------------------------------- @@ -1101,12 +1591,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>TABLE_CAT</b> string =&gt; catalog name </li> </ol> + @returns + each row has a single String column that is a catalog name + @throws SQLException + if a database access error occurs. */ XResultSet getCatalogs() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getTableTypes - /** gets the table types available in this database. The results + /** gets the table types available in this database. The results are ordered by table type. @@ -1114,11 +1608,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", + <b>TABLE_TYPE</b> string =&gt; table type. Typical types are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM". </li> </ol> + @returns + each row has a single String column that is a table type + @throws SQLException + if a database access error occurs. */ XResultSet getTableTypes() raises (SQLException); //------------------------------------------------------------------------- @@ -1129,17 +1627,17 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <p>Only column descriptions matching the catalog, schema, table - and column name criteria are returned. They are ordered by + and column name criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION. </p> <p>Each column description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1155,7 +1653,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface for a UDT the type name is fully qualified </li> <li> - <b>COLUMN_SIZE</b> long =&gt; column size. For char or date + <b>COLUMN_SIZE</b> long =&gt; column size. For char or date types this is the maximum number of characters, for numeric or decimal types this is precision. </li> @@ -1180,10 +1678,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>REMARKS</b> string =&gt; comment describing column (may be null) + <b>REMARKS</b> string =&gt; comment describing column (may be <NULL/>) </li> <li> - <b>COLUMN_DEF</b> string =&gt; default value (may be null) + <b>COLUMN_DEF</b> string =&gt; default value (may be <NULL/>) </li> <li> <b>SQL_DATA_TYPE</b> long =&gt; unused @@ -1202,9 +1700,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <li> <b>IS_NULLABLE</b> string =&gt; "NO" means column definitely does not allow NULL values; "YES" means the column might - allow NULL values. An empty string means nobody knows. + allow NULL values. An empty string means nobody knows. </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @param columnNamePattern + a column name pattern + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getColumns([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern, [in]string columnNamePattern) @@ -1215,17 +1725,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for a table's columns. - <p>Only privileges matching the column name criteria are - returned. They are ordered by COLUMN_NAME and PRIVILEGE. + <p> + Only privileges matching the column name criteria are + returned. They are ordered by COLUMN_NAME and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1234,7 +1745,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>COLUMN_NAME</b> string =&gt; column name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1245,9 +1756,21 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name ; "" retrieves those without a schema + @param table + a table name + @param columnNamePattern + a column name pattern + @returns + each row is a column privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getColumnPrivileges([in]any catalog, [in]string schema, [in]string table, [in]string columnNamePattern) raises (SQLException); @@ -1257,28 +1780,28 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /** gets a description of the access rights for each table available in a catalog. Note that a table privilege applies to one or more columns in the table. It would be wrong to assume that - this priviledge applies to all columns (this may be true for - some systems but is not true for all.) + this priviledge applies to all columns (this may be <TRUE/> for + some systems but is not <TRUE/> for all.) <p>Only privileges matching the schema and table name - criteria are returned. They are ordered by TABLE_SCHEM, + criteria are returned. They are ordered by TABLE_SCHEM, TABLE_NAME, and PRIVILEGE. </p> <p>Each privilige description has the following columns: </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> - <b>GRANTOR</b> =&gt; grantor of access (may be null) + <b>GRANTOR</b> =&gt; grantor of access (may be <NULL/>) </li> <li> <b>GRANTEE</b> string =&gt; grantee of access @@ -1289,9 +1812,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>IS_GRANTABLE</b> string =&gt; "YES" if grantee is permitted - to grant to others; "NO" if not; null if unknown + to grant to others; "NO" if not; <NULL/> if unknown </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param tableNamePattern + a table name pattern + @returns + each row is a table privilege description + @throws SQLException + if a database access error occurs. */ XResultSet getTablePrivileges([in]any catalog, [in]string schemaPattern, [in]string tableNamePattern) raises (SQLException); @@ -1348,6 +1881,20 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @param scope + the scope of interest; use same values as SCOPE + @param nullable + include columns that are nullable? + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getBestRowIdentifier([in]any catalog, [in]string schema, [in]string table, [in]long scope, [in] boolean nullable) @@ -1356,7 +1903,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getVersionColumns /** gets a description of a table's columns that are automatically - updated when any value in a row is updated. They are + updated when any value in a row is updated. They are unordered. @@ -1397,13 +1944,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a column description + @throws SQLException + if a database access error occurs. */ XResultSet getVersionColumns([in]any catalog, [in]string schema, [in]string table) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getPrimaryKeys - /** gets a description of a table's primary key columns. They + /** gets a description of a table's primary key columns. They are ordered by COLUMN_NAME. @@ -1411,10 +1968,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name @@ -1426,9 +1983,19 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>KEY_SEQ</b> short =&gt; sequence number within primary key </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getPrimaryKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1437,7 +2004,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getImportedKeys /** gets a description of the primary key columns that are referenced by a table's foreign key columns (the primary keys - imported by a table). They are ordered by PKTABLE_CAT, + imported by a table). They are ordered by PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME, and KEY_SEQ. @@ -1446,11 +2013,11 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <ol> <li> <b>PKTABLE_CAT</b> string =&gt; primary key table catalog - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema - being imported (may be null) + being imported (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1461,10 +2028,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface being imported </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1517,10 +2084,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1535,6 +2102,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a primary key column description + @throws SQLException + if a database access error occurs. */ XResultSet getImportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1543,7 +2120,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getExportedKeys /** gets a description of the foreign key columns that reference a table's primary key columns (the foreign keys exported by a - table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, + table). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1551,10 +2128,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1563,12 +2140,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1623,10 +2200,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1641,6 +2218,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + a table name + @returns + each row is a foreign key column description + @throws SQLException + if a database access error occurs. */ XResultSet getExportedKeys([in]any catalog, [in]string schema, [in]string table) raises (SQLException); @@ -1651,7 +2238,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface table that reference the primary key columns of the primary key table (describe how one table imports another's key.) This should normally return a single foreign key/primary key pair - (most tables only import a foreign key from a table once.) They + (most tables only import a foreign key from a table once.). They are ordered by FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME, and KEY_SEQ. @@ -1660,10 +2247,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be null) + <b>PKTABLE_CAT</b> string =&gt; primary key table catalog (may be <NULL/>) </li> <li> - <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be null) + <b>PKTABLE_SCHEM</b> string =&gt; primary key table schema (may be <NULL/>) </li> <li> <b>PKTABLE_NAME</b> string =&gt; primary key table name @@ -1672,12 +2259,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>PKCOLUMN_NAME</b> string =&gt; primary key column name </li> <li> - <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be null) - being exported (may be null) + <b>FKTABLE_CAT</b> string =&gt; foreign key table catalog (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> - <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be null) - being exported (may be null) + <b>FKTABLE_SCHEM</b> string =&gt; foreign key table schema (may be <NULL/>) + being exported (may be <NULL/>) </li> <li> <b>FKTABLE_NAME</b> string =&gt; foreign key table name @@ -1732,10 +2319,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> <li> - <b>FK_NAME</b> string =&gt; foreign key name (may be null) + <b>FK_NAME</b> string =&gt; foreign key name (may be <NULL/>) </li> <li> - <b>PK_NAME</b> string =&gt; primary key name (may be null) + <b>PK_NAME</b> string =&gt; primary key name (may be <NULL/>) </li> <li> <b>DEFERRABILITY</b> short =&gt; can the evaluation of foreign key @@ -1750,6 +2337,22 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </ul> </li> </ol> + @param primaryCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param primarySchema + a schema name; "" retrieves those without a schema + @param primaryTable + the table name that exports the key + @param foreignCatalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param foreignSchema + a schema name; "" retrieves those without a schema + @param foreignTable + the table name that imports the key + @returns + each row is a foreign key column description + @throws SQLException + if a database access error occurs. */ XResultSet getCrossReference( [in]any primaryCatalog, [in]string primarySchema, @@ -1779,15 +2382,15 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LITERAL_PREFIX</b> string =&gt; prefix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>LITERAL_SUFFIX</b> string =&gt; suffix used to quote a literal - (may be null) + (may be <NULL/>) </li> <li> <b>CREATE_PARAMS</b> string =&gt; parameters used in creating - the type (may be null) + the type (may be <NULL/>) </li> <li> <b>NULLABLE</b> short =&gt; can you use NULL for this type? @@ -1828,7 +2431,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>LOCAL_TYPE_NAME</b> string =&gt; localized version of type name - (may be null) + (may be <NULL/>) </li> <li> <b>MINIMUM_SCALE</b> short =&gt; minimum scale supported @@ -1846,6 +2449,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>NUM_PREC_RADIX</b> long =&gt; usually 2 or 10 </li> </ol> + @returns + each row is a SQL type description + @throws SQLException + if a database access error occurs. */ XResultSet getTypeInfo() raises (SQLException); //------------------------------------------------------------------------- @@ -1859,24 +2466,24 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </p> <ol> <li> - <b>TABLE_CAT</b> string =&gt; table catalog (may be null) + <b>TABLE_CAT</b> string =&gt; table catalog (may be <NULL/>) </li> <li> - <b>TABLE_SCHEM</b> string =&gt; table schema (may be null) + <b>TABLE_SCHEM</b> string =&gt; table schema (may be <NULL/>) </li> <li> <b>TABLE_NAME</b> string =&gt; table name </li> <li> <b>NON_UNIQUE</b> boolean =&gt; Can index values be non-unique? - false when TYPE is tableIndexStatistic + <FALSE/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be null); - null when TYPE is tableIndexStatistic + <b>INDEX_QUALIFIER</b> string =&gt; index catalog (may be <NULL/>); + <NULL/> when TYPE is tableIndexStatistic </li> <li> - <b>INDEX_NAME</b> string =&gt; index name; null when TYPE is + <b>INDEX_NAME</b> string =&gt; index name; <NULL/> when TYPE is tableIndexStatistic </li> <li> @@ -1898,13 +2505,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface within index; zero when TYPE is tableIndexStatistic </li> <li> - <b>COLUMN_NAME</b> string =&gt; column name; null when TYPE is + <b>COLUMN_NAME</b> string =&gt; column name; <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>ASC_OR_DESC</b> string =&gt; column sort sequence, "A" =&gt; ascending, - "D" =&gt; descending, may be null if sort sequence is not supported; - null when TYPE is tableIndexStatistic + "D" =&gt; descending, may be <NULL/> if sort sequence is not supported; + <NULL/> when TYPE is tableIndexStatistic </li> <li> <b>CARDINALITY</b> long =&gt; When TYPE is tableIndexStatistic, then @@ -1918,9 +2525,23 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface </li> <li> <b>FILTER_CONDITION</b> string =&gt; Filter condition, if any. - (may be null) + (may be <NULL/>) </li> </ol> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schema + a schema name; "" retrieves those without a schema + @param table + the table name that exports the key + @param unique + when <TRUE/>, return only indices for unique values; when <FALSE/>, return indices regardless of whether unique or not + @param approximate + when <TRUE/>, result is allowed to reflect approximate or out of data values; when <FALSE/>, results are requested to be accurate + @returns + each row is an index column description + @throws SQLException + if a database access error occurs. */ XResultSet getIndexInfo([in]any catalog, [in]string schema, [in]string table, [in]boolean unique, [in]boolean approximate) @@ -1929,6 +2550,13 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetType /** Does the database support the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetType([in]long setType) raises (SQLException); //------------------------------------------------------------------------- @@ -1936,6 +2564,16 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsResultSetConcurrency /** Does the database support the concurrency type in combination with the given result set type? + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @param concurrency + defined in + <type scop="com::sun::star::sdbc">ResultSetConcurrency</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsResultSetConcurrency([in]long setType, [in]long concurrency) @@ -1944,88 +2582,159 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownUpdatesAreVisible /** indicates whether a result set's own updates are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownDeletesAreVisible /** indicates whether a result set's own deletes are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::ownInsertsAreVisible /** indicates whether a result set's own inserts are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean ownInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersUpdatesAreVisible /** indicates whether updates made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersUpdatesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersDeletesAreVisible /** indicates whether deletes made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersDeletesAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::othersInsertsAreVisible /** indicates whether inserts made by others are visible. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean othersInsertsAreVisible([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::updatesAreDetected /** indicates whether or not a visible row update can be detected by - calling the method <code>XResultSet.rowUpdated</code>. + calling the method + <code>XResultSet.rowUpdated</code>. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean updatesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::deletesAreDetected /** indicates whether or not a visible row delete can be detected by - calling XResultSet.rowDeleted(). If deletesAreDetected() + calling + <member scope="com::sun::star::sdbc">XResultSet::rowDeleted()</member> + . If deletesAreDetected() returns <FALSE/>, then deleted rows are removed from the result set. + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean deletesAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::insertsAreDetected /** indicates whether or not a visible row insert can be detected - by calling XResultSet.rowInserted(). + by calling + <member scope="com::sun::star::sdbc">XResultSet::rowInserted().</member> + @param setType + defined in + <type scop="com::sun::star::sdbc">ResultSetType</type> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean insertsAreDetected([in]long setType) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::supportsBatchUpdates /** indicates whether the driver supports batch updates. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean supportsBatchUpdates() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getUDTs /** Gets a description of the user-defined types defined in a particular - schema. Schema-specific UDTs may have type OBJECT, STRUCT, + schema. Schema-specific UDTs may have type OBJECT, STRUCT, or DISTINCT. <p>Only types matching the catalog, schema, type name, and type - criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM, - and TYPE_NAME. The type name parameter may be a fully-qualified - name. In this case, the catalog and schemaPattern parameters are + criteria are returned. They are ordered by DATA_TYPE, TYPE_SCHEM, + and TYPE_NAME. The type name parameter may be a fully-qualified + name. In this case, the catalog and schemaPattern parameters are ignored. </p> <p>Each type description has the following columns: </p> <ol> <li> - <b>TYPE_CAT</b> string =&gt; the type's catalog (may be null) + <b>TYPE_CAT</b> string =&gt; the type's catalog (may be <NULL/>) </li> <li> - <b>TYPE_SCHEM</b> string =&gt; type's schema (may be null) + <b>TYPE_SCHEM</b> string =&gt; type's schema (may be <NULL/>) </li> <li> <b>TYPE_NAME</b> string =&gt; type name @@ -2045,6 +2754,18 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface <b>Note:</b> If the driver does not support UDTs, an empty result set is returned. </p> + @param catalog + a catalog name; "" retrieves those without a catalog; <NULL/> means drop catalog name from the selection criteria + @param schemaPattern + a schema name pattern; "" retrieves those without a schema + @param typeNamePattern + a type name pattern; may be a fully-qualified name + @param types + a list of user-named types to include (OBJECT, STRUCT, or DISTINCT); <NULL/> returns all types + @returns + each row is a type description + @throws SQLException + if a database access error occurs. */ XResultSet getUDTs([in]any catalog, [in]string schemaPattern, [in]string typeNamePattern, [in]sequence<long> types) @@ -2053,6 +2774,10 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XDatabaseMetaData::getConnection /** retrieves the connection that produced this metadata object. + @returns + the Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -2063,6 +2788,12 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.9.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.9 2001/11/28 15:32:14 jsc + remove double closed comment + Revision 1.8 2001/11/02 12:47:42 mi needs <TRUE/> instead of <TRUE> etc. @@ -2076,7 +2807,7 @@ interface XDatabaseMetaData: com::sun::star::uno::XInterface remove interfaceheader with uik and remove [const] in method definitions Revision 1.4 2000/12/14 12:53:39 mi - <true></true> -> <TRUE/> and same with FALSE + <<TRUE/>></<TRUE/>> -> <TRUE/> and same with FALSE Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XDriver.idl b/offapi/com/sun/star/sdbc/XDriver.idl index 6d823e50af68..735fffd35681 100644 --- a/offapi/com/sun/star/sdbc/XDriver.idl +++ b/offapi/com/sun/star/sdbc/XDriver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriver.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: oj $ $Date: 2002-06-25 06:12:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -216,40 +216,4 @@ interface XDriver: com::sun::star::uno::XInterface }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.7.2.2 2002/06/25 06:10:18 oj - new service for ConnectionProperties implemented - - Revision 1.7.2.1 2002/02/18 08:58:22 oj - #97563# parameter,return value and exception description - - Revision 1.7 2001/11/01 16:46:46 mi - proofreading and corrections from Richard Holt - - Revision 1.6 2001/03/16 16:41:35 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 13:46:04 mi - syntax errors in documentation fixed - - Revision 1.4 2000/12/14 12:53:39 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:41 hjs - initial import - - Revision 1.4 2000/09/11 11:52:43 mi - documentation merged from XML - - Revision 1.2 1999/12/13 13:47:55 dg - #70278# XSQLErrorBroadcaster removed - - Revision 1.1 1999/11/24 08:41:05 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/XDriverAccess.idl b/offapi/com/sun/star/sdbc/XDriverAccess.idl index 65f61807a1bf..be612451f1ad 100644 --- a/offapi/com/sun/star/sdbc/XDriverAccess.idl +++ b/offapi/com/sun/star/sdbc/XDriverAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriverAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,21 @@ interface XDriver; // DocMerge from xml: interface com::sun::star::sdbc::XDriverAccess -/** provides the access of sdbc driver components@see com::sun::star::sdbc::XDriverManager - @see com::sun::star::sdbc::XDriver +/** provides the access of sdbc driver components + @see com::sun::star::sdbc::XDriverManager + @see com::sun::star::sdbc::XDriver */ interface XDriverAccess: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XDriverAccess::getDriverByURL - /** get a driver which accepts a given url.@see XDriver::acceptsURL + /** get a driver which accepts a given url.@see com::sun::star::sdbc::XDriver::acceptsURL + @param url + a database url of the form sdbc:subprotocol:subname + @returns + a Driver that can connect to the URL + @throws SQLException + if a database access error occurs. */ XDriver getDriverByURL([in]string url); }; @@ -90,6 +97,12 @@ interface XDriverAccess: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XDriverManager.idl b/offapi/com/sun/star/sdbc/XDriverManager.idl index 8200bd61a962..6bfdac7cbeee 100644 --- a/offapi/com/sun/star/sdbc/XDriverManager.idl +++ b/offapi/com/sun/star/sdbc/XDriverManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDriverManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: oj $ $Date: 2002-06-25 06:12:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -162,34 +162,4 @@ interface XDriverManager: com::sun::star::uno::XInterface }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.4.16.2 2002/06/25 06:10:18 oj - new service for ConnectionProperties implemented - - Revision 1.4.16.1 2002/02/18 08:58:22 oj - #97563# parameter,return value and exception description - - Revision 1.4 2001/03/16 16:41:35 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:43:35 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:42 hjs - initial import - - Revision 1.5 2000/09/11 11:52:43 mi - documentation merged from XML - - Revision 1.3 1999/12/14 12:05:46 dg - #70278# CompareBookmark removed - - Revision 1.2 1999/12/13 13:47:55 dg - #70278# XSQLErrorBroadcaster removed - - Revision 1.1 1999/11/24 08:41:06 dg - new StarDataBaseConnectivity - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbc/XMultipleResults.idl b/offapi/com/sun/star/sdbc/XMultipleResults.idl index 820a4480194f..d4aeb8819070 100644 --- a/offapi/com/sun/star/sdbc/XMultipleResults.idl +++ b/offapi/com/sun/star/sdbc/XMultipleResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultipleResults.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,35 @@ interface XResultSet; SQL statement. - <p>Under some (uncommon) situations a single SQL statement may return + <p> + Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an - unknown SQL string. The methods <code>getMoreResults</code>, - <code>getResultSet</code> and <code>getUpdateCount</code> let you navigate - through multiple results. - - </p>@see com::sun::star::sdbc::XStatement + unknown SQL string. The methods + <member scope="com::sun::star::sdbc">XMultipleResults::getMoreResults()</member> + , + <member scope="com::sun::star::sdbc">XMultipleResults::getResultSet()</member> + and + <member scope="com::sun::star::sdbc">XMultipleResults::getUpdateCount()</member> + let you navigate through multiple results. + + </p> + @see com::sun::star::sdbc::XStatement @see com::sun::star::sdbc::XPreparedStatement */ interface XMultipleResults: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getResultSet - /** returns the current result as a <code>ResultSet</code> object. + /** returns the current result as a + <type scope="com::sun::star::sdbc">ResultSet</type> + object. This method should be called only once per result. + @returns + the ResultSet object + @throws SQLException + if a database access error occurs. */ XResultSet getResultSet() raises (SQLException); //------------------------------------------------------------------------- @@ -104,9 +116,14 @@ interface XMultipleResults: com::sun::star::uno::XInterface /** returns the current result as an update count. - <p>if the result is a ResultSet or there are no more results, -1 + <p> + If the result is a ResultSet or there are no more results, -1 is returned. This method should be called only once per result. </p> + @returns + the current result as an update count. + @throws SQLException + if a database access error occurs. */ long getUpdateCount() raises (SQLException); //------------------------------------------------------------------------- @@ -116,12 +133,15 @@ interface XMultipleResults: com::sun::star::uno::XInterface this result is a ResultSet. This method also implicitly closes any current ResultSet obtained with getResultSet. - - - <p>There are no more results when <code>(!getMoreResults() &amp;&amp; + <p> + There are no more results when <code>(!getMoreResults() &amp;&amp; getUpdateCount() == -1)</code>. </p> + @returns + <TRUE/> if there exists more ResultSet objects + @throws SQLException + if a database access error occurs. */ boolean getMoreResults() raises (SQLException); }; @@ -132,6 +152,12 @@ interface XMultipleResults: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/14 12:53:39 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/sdbc/XOutParameters.idl b/offapi/com/sun/star/sdbc/XOutParameters.idl index 130228edb9f0..a82173c920fb 100644 --- a/offapi/com/sun/star/sdbc/XOutParameters.idl +++ b/offapi/com/sun/star/sdbc/XOutParameters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XOutParameters.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,36 @@ /** is used to register Out-Parameters for stored procedures. - <p>SDBC provides a stored procedure SQL escape that allows stored procedures + <p> + SDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output, or both. Parameters are referred to sequentially, - by number. The first parameter is 1.</p> + by number. The first parameter is 1. + </p> */ interface XOutParameters: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerOutParameter /** registers the designated output parameter. This version of - the method <code>registerOutParameter</code> + the method + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, OBJECT, and named array types. - <p>Before executing a stored procedure call, you must explicitly - call <code>registerOutParameter</code> to register the type from - <code>DataType</code> for each OUT parameter. - <br>For a user-named parameter the fully-qualified SQL type name of the + <p> + Before executing a stored procedure call, you must explicitly + call + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> + to register the type from + <type scope="com::sun::star::sdbc">DataType</type> + for each OUT parameter. + <br/> + For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. An SDBC driver that does not need the type code and type name information @@ -111,9 +119,19 @@ interface XOutParameters: com::sun::star::uno::XInterface </p> <p> <b>Note:</b> When reading the value of an out parameter, you - must use the <code>getXXX</code> method whose type XXX corresponds to the + must use the + <code>getXXX</code> + method whose type XXX corresponds to the parameter's registered SQL type. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to register + @param typeName + the name of the type + @throws SQLException + if a database access error occurs. */ void registerOutParameter([in]long parameterIndex, [in]long sqlType, [in]string typeName) @@ -122,16 +140,35 @@ interface XOutParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XOutParameters::registerNumericOutParameter /** registers the OUT parameter in ordinal position - <code>parameterIndex</code> to the SDBC type <code>sqlType</code>. All + <code>parameterIndex</code> + to the SDBC type + <code>sqlType</code> + . All OUT parameters must be registered before a stored procedure is executed. - <p>The SDBC type specified by <code>sqlType</code> for an OUT parameter - determines the type that must be used in the <code>get</code> method to - read the value of that parameter. - This version of <code>registerOutParameter</code> should be - used when the parameter is of SDBC type <code>NUMERIC</code> - or <code>DECIMAL</code>. + <p> + The SDBC type specified by + <code>sqlType</code> + for an OUT parameter determines the type that must be used in the + <code>get</code> + method to read the value of that parameter. + This version of + <member scope="com::sun::star::sdbc">XOutParameters::registerOutParameter()</member> + should be + used when the parameter is of SDBC type + <member scope="com::sun::star::sdbc">DataType::NUMERIC</member> + or + <member scope="com::sun::star::sdbc">DataType::DECIMAL</member> + . + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to register + @param scale + the scale of the type + @throws SQLException + if a database access error occurs. </p> */ void registerNumericOutParameter([in]long parameterIndex, [in]long sqlType, @@ -145,6 +182,12 @@ interface XOutParameters: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XParameters.idl b/offapi/com/sun/star/sdbc/XParameters.idl index 67782c41d09d..821cc817d6eb 100644 --- a/offapi/com/sun/star/sdbc/XParameters.idl +++ b/offapi/com/sun/star/sdbc/XParameters.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParameters.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -102,20 +102,22 @@ interface XClob; <b>Note:</b> The setXXX methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type - Integer, then the method <code>setLong</code> should be used. + Integer, then the method + <member scope="com::sun::star::sdbc">XParameters::setInt()</member> + should be used. </p> - <p>If arbitrary parameter type conversions are required, the method - <code>setObject</code> should be used with a target SQL type. - <br> - <br> - Example of setting a parameter; <code>con</code> is an active connection. + <p> + If arbitrary parameter type conversions are required, the method + <member scope="com::sun::star::sdbc">XParameters::setObject()</member> + should be used with a target SQL type. + <br/> + <br/> + Example of setting a parameter; + <code>con</code> + is an active connection. </p> - - - - @example <listing>pstmt = con.prepareStatement("UPDATE EMPLOYEES SET SALARY = ? WHERE ID = ?") pstmt.setDouble(1, 153833.00) pstmt.setLong(2, 110592) @@ -145,12 +147,21 @@ interface XParameters: com::sun::star::uno::XInterface the name is the type name of the parameter itself. For a REF parameter the name is the type name of the referenced type. If a SDBC driver does not need the type code or type name information, - it may ignore it.<br> + it may ignore it. + <br/> Although it is intended for user-named and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-named or REF type, the given typeName is ignored. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param sqlType + the type of the column to set to <NULL/> + @param typeName + the name of the type + @throws SQLException + if a database access error occurs. */ void setObjectNull([in]long parameterIndex, [in]long sqlType, @@ -160,6 +171,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBoolean /** sets the designated parameter to a boolean value. The driver converts this to a SQL BIT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBoolean([in]long parameterIndex, [in]boolean x) raises (SQLException); @@ -168,6 +185,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setByte /** sets the designated parameter to a byte value. The driver converts this to a SQL TINYINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setByte([in]long parameterIndex, [in]byte x) raises (SQLException); //------------------------------------------------------------------------- @@ -175,6 +198,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setShort /** sets the designated parameter to a short value. The driver converts this to a SQL SMALLINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setShort([in]long parameterIndex, [in]short x) raises (SQLException); //------------------------------------------------------------------------- @@ -182,6 +211,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setInt /** sets the designated parameter to a long value. The driver converts this to a SQL INTEGER value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setInt([in]long parameterIndex, [in]long x) raises (SQLException); //------------------------------------------------------------------------- @@ -189,6 +224,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setLong /** sets the designated parameter to a hyper value. The driver converts this to a SQL BIGINT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setLong([in]long parameterIndex, [in]hyper x) raises (SQLException); //------------------------------------------------------------------------- @@ -196,6 +237,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setFloat /** sets the designated parameter to a float value. The driver converts this to a SQL FLOAT value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setFloat([in]long parameterIndex, [in]float x) raises (SQLException); //------------------------------------------------------------------------- @@ -203,6 +250,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDouble /** sets the designated parameter to a double value. The driver converts this to a SQL DOUBLE value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setDouble([in]long parameterIndex, [in]double x) raises (SQLException); //------------------------------------------------------------------------- @@ -212,6 +265,12 @@ interface XParameters: com::sun::star::uno::XInterface to a SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHARs) when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setString([in]long parameterIndex, [in]string x) raises (SQLException); //------------------------------------------------------------------------- @@ -221,6 +280,12 @@ interface XParameters: com::sun::star::uno::XInterface this to a SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARYs) when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBytes([in]long parameterIndex, [in]sequence<byte> x) raises (SQLException); @@ -229,6 +294,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setDate /** sets the designated parameter to a date value. The driver converts this to a SQL DATE value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setDate([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException); @@ -237,6 +308,12 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setTime /** sets the designated parameter to a time value. The driver converts this to a SQL TIME value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setTime([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException); @@ -246,6 +323,12 @@ interface XParameters: com::sun::star::uno::XInterface /** sets the designated parameter to a datetime value. The driver converts this to a SQL TIMESTAMP value when it sends it to the database. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setTimestamp([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException); @@ -256,8 +339,16 @@ interface XParameters: com::sun::star::uno::XInterface the specified number of bytes. When a very large binary value is input to a LONGVARBINARY or LONGVARCHAR parameter, it may be more practical to send it via an - <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data - from the stream as needed, until it reaches end-of-file. + <type scope="com::sun::star::io">XInputStream</type> + . SDBC will read the data from the stream as needed, until it reaches end-of-file. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param length + the number of bytes in the stream + @throws SQLException + if a database access error occurs. */ void setBinaryStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, @@ -269,8 +360,16 @@ interface XParameters: com::sun::star::uno::XInterface the specified number of bytes. When a very large binary value is input to a LONGVARCHAR parameter, it may be more practical to send it via a - <type scope="com::sun::star::io">XInputStream</type>. SDBC will read the data - from the stream as needed, until it reaches end-of-file. + <type scope="com::sun::star::io">XInputStream</type> + . SDBC will read the data from the stream as needed, until it reaches end-of-file. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param length + the number of characters in the stream + @throws SQLException + if a database access error occurs. */ void setCharacterStream([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, @@ -293,6 +392,12 @@ interface XParameters: com::sun::star::uno::XInterface <p>Note that this method may be used to pass database-specific abstract data types. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setObject([in]long parameterIndex, [in]any x) raises (SQLException); @@ -315,6 +420,22 @@ interface XParameters: com::sun::star::uno::XInterface <p>Note that this method may be used to pass database-specific abstract data types. </p> + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @param targetSqlType + the SQL type (as defined in + <type scope="com::sun::star::sdbc">DataType</type> + ) to be sent to the database. The scale argument may further qualify this type. + @param scale + for + <member scope="com::sun::star::sdbc">DataType::DECIMAL</member> + or + <member scope="com::sun::star::sdbc">DataType::NUMERIC</member> + types, this is the number of digits after the decimal point. For all other types, this value will be ignored. + @throws SQLException + if a database access error occurs. */ void setObjectWithInfo([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) @@ -323,24 +444,48 @@ interface XParameters: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setRef /** sets a REF(&lt;structured-type&gt;) parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setBlob /** sets a BLOB parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setClob /** sets a CLOB parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XParameters::setArray /** sets an Array parameter. + @param parameterIndex + the first parameter is 1, the second is 2, ... + @param x + the parameter value + @throws SQLException + if a database access error occurs. */ void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException); @@ -356,6 +501,8 @@ interface XParameters: com::sun::star::uno::XInterface release the resources used by the current parameter values; this can be done by calling clearParameters. </p> + @throws SQLException + if a database access error occurs. */ void clearParameters() raises (SQLException); }; @@ -366,6 +513,12 @@ interface XParameters: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XPooledConnection.idl b/offapi/com/sun/star/sdbc/XPooledConnection.idl index 671a17e17f04..cf024d9bcf82 100644 --- a/offapi/com/sun/star/sdbc/XPooledConnection.idl +++ b/offapi/com/sun/star/sdbc/XPooledConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPooledConnection.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,8 +83,14 @@ interface XConnection; <!-- JRH: unclear meaning --> - <p>When the method <code>getConnection</code> is called, - the PooledConnection return the connection which is pooled. + <p> + PoolConnections are handled by the connection pool. + </p> + <p> + When the method + <member scope="com::sun::star::sdbc">XPooledConnection::getConnection()</member> + is called, the PooledConnection returns the connection which is pooled. + </p> @see com::sun::star::sdbc::XConnection */ @@ -94,6 +100,10 @@ interface XPooledConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XPooledConnection::getConnection /** return the connection which is pooled + @returns + the pooled Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); diff --git a/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl index 0ff977832ea9..ff7a21551915 100644 --- a/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl +++ b/offapi/com/sun/star/sdbc/XPreparedBatchExecution.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPreparedBatchExecution.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,21 +76,29 @@ /** is used for batch execution on PreparedStatements. - <p>A PreparedStatement uses one precompiled SQL Statement. In batch execution + <p> + A + <type scope="com::sun::star::sdbc">PreparedStatement</type> + uses one precompiled SQL Statement. In batch execution it is possible to set collection of parameter settings, which are executed in - one batch job.</p> + one batch job. + </p> */ interface XPreparedBatchExecution: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::addBatch /** adds a set of parameters to the batch. + @throws SQLException + if a database access error occurs. */ void addBatch() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedBatchExecution::clearBatch /** makes the set of commands in the current batch empty. + @throws SQLException + if a database access error occurs. */ void clearBatch() raises (SQLException); //------------------------------------------------------------------------- @@ -113,6 +121,12 @@ interface XPreparedBatchExecution: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XPreparedStatement.idl b/offapi/com/sun/star/sdbc/XPreparedStatement.idl index fcb970aefc93..f6d7b6cbef00 100644 --- a/offapi/com/sun/star/sdbc/XPreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/XPreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPreparedStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,25 +79,38 @@ interface XResultSet; /** provides the possibilty of executing a precompiled SQL statement. - <p>A SQL statement is pre-compiled and stored in a PreparedStatement object. + <p> + A SQL statement is pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple - times.</p> + times. + </p> */ interface XPreparedStatement: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeQuery - /** executes the SQL query in this <code>PreparedStatement</code> object - and returns the result set generated by the query. + /** executes the SQL query in this + <code>PreparedStatement</code> + object and returns the result set generated by the query. + @returns + the ResultSet object + @throws SQLException + if a database access error occurs. */ XResultSet executeQuery() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::executeUpdate /** executes the SQL INSERT, UPDATE or DELETE statement in this - <code>PreparedStatement</code> object.<br> + <type scope="com::sun::star::sdbc">PreparedStatement</type> + object. + <br/> In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed. + @returns + either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing + @throws SQLException + if a database access error occurs. */ long executeUpdate() raises (SQLException); //------------------------------------------------------------------------- @@ -106,17 +119,30 @@ interface XPreparedStatement: com::sun::star::uno::XInterface /** executes any kind of SQL statement. - <p>Some prepared statements return multiple results; the execute + <p> + Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean execute() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XPreparedStatement::getConnection - /** returns the <code>Connection</code> object - that produced this <code>Statement</code> object. + /** returns the + <type scope="com::sun::star::sdbc">Connection</type> + object + that produced this + <type scope="com::sun::star::sdbc">Statement</type> + object. + @returns + the Connection object + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -127,6 +153,12 @@ interface XPreparedStatement: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XRef.idl b/offapi/com/sun/star/sdbc/XRef.idl index 976644d01ed7..42571162d56c 100644 --- a/offapi/com/sun/star/sdbc/XRef.idl +++ b/offapi/com/sun/star/sdbc/XRef.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRef.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,6 +84,10 @@ interface XRef: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XRef::getBaseTypeName /** gets the fully-qualified SQL structured type name of the referenced item. + @returns + the base type name + @throws SQLException + if a database access error occurs. */ string getBaseTypeName() raises (SQLException); }; @@ -94,6 +98,12 @@ interface XRef: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XResultSet.idl b/offapi/com/sun/star/sdbc/XResultSet.idl index 3644365a7e58..12d7f83b2ccc 100644 --- a/offapi/com/sun/star/sdbc/XResultSet.idl +++ b/offapi/com/sun/star/sdbc/XResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,13 +75,18 @@ interface XStatement; // DocMerge from xml: interface com::sun::star::sdbc::XResultSet -/** provides the navigation on a table of data. A ResultSet - object is usually generated by executing a Statement. +/** provides the navigation on a table of data. A + <type scope="com::sun::star::sdbc">ResultSet</type> + object is usually generated by executing a + <type scope="com::sun::star::sdbc">Statement</type> + . - <p>A ResultSet maintains a cursor pointing to its current row of + <p> + A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. - The 'next' method moves the cursor to the next row.</p> + The 'next' method moves the cursor to the next row. + </p> */ interface XResultSet: com::sun::star::uno::XInterface { @@ -91,14 +96,21 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor down one row from its current position. - <p>A ResultSet cursor is initially positioned before the first row; the + <p> + A ResultSet cursor is initially positioned before the first row; the first call to next makes the first row the current row; the second call makes the second row the current row, and so on. </p> <p>If an input stream is open for the current row, a call - to the method <code>moveNext</code> will implicitly close it. + to the method + <code>next</code> + will implicitly close it. The ResultSet's warning chain is cleared when a new row is read. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean next() raises (SQLException); //------------------------------------------------------------------------- @@ -106,6 +118,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isBeforeFirst /** indicates whether the cursor is before the first row in the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isBeforeFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -113,12 +129,20 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isAfterLast /** indicates whether the cursor is after the last row in the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isAfterLast() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::isFirst /** indicates whether the cursor is on the first row of the result set. + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -127,10 +151,19 @@ interface XResultSet: com::sun::star::uno::XInterface /** indicates whether the cursor is on the last row of the result set. - <p>Note: Calling the method <code>isAtLast</code> may be expensive - because the SDBC driver might need to fetch ahead one row in order + <p> + <B> + Note: + </B> + Calling the method + <code>isAtLast</code> + may be expensive because the SDBC driver might need to fetch ahead one row in order to determine whether the current row is the last row in the result set. </p> + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isLast() raises (SQLException); //------------------------------------------------------------------------- @@ -138,6 +171,8 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::beforeFirst /** moves the cursor to the front of the result set, just before the first row. Has no effect if the result set contains no rows. + @throws SQLException + if a database access error occurs. */ void beforeFirst() raises (SQLException); //------------------------------------------------------------------------- @@ -145,18 +180,28 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::afterLast /** moves the cursor to the end of the result set, just after the last row. Has no effect if the result set contains no rows. + @throws SQLException + if a database access error occurs. */ void afterLast() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::first /** moves the cursor to the first row in the result set. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean first() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::last /** moves the cursor to the last row in the result set. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean last() raises (SQLException); //------------------------------------------------------------------------- @@ -164,6 +209,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getRow /** retrieves the current row number. The first row is number 1, the second number 2, and so on. + @returns + the current position + @throws SQLException + if a database access error occurs. */ long getRow() raises (SQLException); //------------------------------------------------------------------------- @@ -172,24 +221,34 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the given row number in the result set. - <p>If the row number is positive, the cursor moves to + <p> + If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on. </p> - <p>If the given row number is negative, the cursor moves to + <p> + If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, calling - <code>moveToPosition(-1)</code> positions the - cursor on the last row, <code>moveToPosition(-2)</code> indicates the - next-to-last row, and so on. + <code>absolute(-1)</code> + positions the + cursor on the last row, + <code>absolute(-2)</code> + indicates the next-to-last row, and so on. </p> - <p>An attempt to position the cursor beyond the first/last row in + <p> + An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before/after the first/last row, respectively. </p> - <p>Note: Calling <code>moveToPosition(1)</code> is the same - as calling <code>moveToFirst()</code>. + <p> + Note: Calling + <code>absolute(1)</code> + is the same + as calling + <member scope="com::sun::star::sdbc">XResultSet::first()</member> + . Calling <code>moveToPosition(-1)</code> is the same as calling <code>moveToLast()</code>. </p> @@ -204,16 +263,26 @@ interface XResultSet: com::sun::star::uno::XInterface <p> Attempting to move beyond the first/last row in the result set positions the cursor before/after - the first/last row. Calling <code>moveRelative(0)</code> is valid, but does - not change the cursor position. - + the first/last row. Calling + <code>relative(0)</code> + is valid, but does not change the cursor position. </p> - <p>Note: Calling <code>moveRelative(1)</code> - is different from calling <code>moveNext()</code> - because is makes sense to call <code>moveNext()</code> when there is - no current row, for example, when the cursor is positioned before + <p> + Note: Calling + <code>relative(1)</code> + is different from calling + <member scope="com::sun::star::sdbc">XResultSet::next()</member> + because is makes sense to call + <code>next()</code> + when there is no current row, for example, when the cursor is positioned before the first row or after the last row of the result set. </p> + @param rows + how many rows should be moved relative to the current row + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean relative([in]long rows) raises (SQLException); //------------------------------------------------------------------------- @@ -222,10 +291,19 @@ interface XResultSet: com::sun::star::uno::XInterface /** moves the cursor to the previous row in the result set. - <p>Note: <code>previous()</code> is not the same as - <code>relative(-1)</code> because it - makes sense to call <code>previous()</code> when there is no current row. + <p> + Note: + <code>previous()</code> + is not the same as + <code>relative(-1)</code> + because it makes sense to call + <code>previous()</code> + when there is no current row. </p> + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean previous() raises (SQLException); //------------------------------------------------------------------------- @@ -233,19 +311,29 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::refreshRow /** refreshes the current row with its most recent value in the database. Cannot be called when on the insert row. - The <code>refreshRow</code> method provides a way for an application to + The + <code>refreshRow</code> + method provides a way for an application to explicitly tell the SDBC driver to refetch a row(s) from the - database. An application may want to call <code>refreshRow</code> when - caching or prefetching is being done by the SDBC driver to + database. An application may want to call + <code>refreshRow</code> + when caching or prefetching is being done by the SDBC driver to fetch the latest value of a row from the database. The SDBC driver may actually refresh multiple rows at once if the fetch size is greater than one. All values are refetched subject to the transaction isolation - level and cursor sensitivity. If <code>refreshRow</code> is called after - calling <code>updateXXX</code>, but before calling <code>updateRow</code>, - then the updates made to the row are lost. - Calling the method <code>refreshRow</code> frequently will likely - slow performance. + level and cursor sensitivity. If + <code>refreshRow</code> + is called after calling + <code>updateXXX</code> + , but before calling + <member scope="com::sun::star::sdbc">XResultSet::updateRow()</member> + , then the updates made to the row are lost. + Calling the method + <code>refreshRow</code> + frequently will likely slow performance. + @throws SQLException + if a database access error occurs. */ void refreshRow() raises (SQLException); //------------------------------------------------------------------------- @@ -253,6 +341,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowUpdated /** indicates whether the current row has been updated. The value returned depends on whether or not the result set can detect updates. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowUpdated() raises (SQLException); //------------------------------------------------------------------------- @@ -260,6 +352,10 @@ interface XResultSet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSet::rowInserted /** indicates whether the current row has had an insertion. The value returned depends on whether or not the result set can detect visible inserts. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowInserted() raises (SQLException); //------------------------------------------------------------------------- @@ -269,14 +365,26 @@ interface XResultSet: com::sun::star::uno::XInterface a visible "hole" in a result set. This method can be used to detect holes in a result set. The value returned depends on whether or not the result set can detect deletions. + @returns + <TRUE/> if successful + @throws SQLException + if a database access error occurs. */ boolean rowDeleted() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSet::getStatement - /** returns the Statement that produced this <code>ResultSet</code> object. - If the result set was generated some other way, such as by an - <code>XDatabaseMetaData</code> method, this method returns <NULL/>. + /** returns the Statement that produced this + <type scope="com::sun::star::sdbc">ResultSet</type> + object. If the result set was generated some other way, such as by an + <type scope="com::sun::star::sdbc">XDatabaseMetaData</type> + method, this method returns + <NULL/> + . + @returns + the statement object + @throws SQLException + if a database access error occurs. */ com::sun::star::uno::XInterface getStatement() raises (SQLException); }; @@ -287,6 +395,12 @@ interface XResultSet: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl index a0510c511aed..692e8598f092 100644 --- a/offapi/com/sun/star/sdbc/XResultSetMetaData.idl +++ b/offapi/com/sun/star/sdbc/XResultSetMetaData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetMetaData.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,48 +81,94 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnCount /** returns the number of columns in this ResultSet. + @returns + the column count + @throws SQLException + if a database access error occurs. */ long getColumnCount() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isAutoIncrement /** indicates whether the column is automatically numbered, thus read-only. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isAutoIncrement([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCaseSensitive /** indicates whether a column's case matters. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCaseSensitive([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSearchable /** indicates whether the column can be used in a where clause. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isSearchable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isCurrency /** indicates whether the column is a cash value. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isCurrency([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isNullable /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ long isNullable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isSigned /** indicates whether values in the column are signed numbers. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isSigned([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnDisplaySize /** indicates the column's normal max width in chars. + @param column + the first column is 1, the second is 2, + @returns + the normal maximum number of characters allowed as the width of the designated column + @throws SQLException + if a database access error occurs. */ long getColumnDisplaySize([in]long column) raises (SQLException); //------------------------------------------------------------------------- @@ -130,80 +176,159 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnLabel /** gets the suggested column title for use in printouts and displays. + @param column + the first column is 1, the second is 2, + @returns + the suggested column title + @throws SQLException + if a database access error occurs. */ string getColumnLabel([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnName /** gets a column's name. + @param column + the first column is 1, the second is 2, + @returns + the column name + @throws SQLException + if a database access error occurs. */ string getColumnName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getSchemaName /** gets a column's table's schema. + @param column + the first column is 1, the second is 2, + @returns + the schema name + @throws SQLException + if a database access error occurs. */ string getSchemaName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getPrecision /** gets a column's number of decimal digits. + @param column + the first column is 1, the second is 2, + @returns + precision + @throws SQLException + if a database access error occurs. */ long getPrecision([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getScale /** gets a column's number of digits to right of the decimal point. + @param column + the first column is 1, the second is 2, + @returns + scale + @throws SQLException + if a database access error occurs. */ long getScale([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getTableName /** gets a column's table name. + @param column + the first column is 1, the second is 2, + @returns + the table name + @throws SQLException + if a database access error occurs. */ string getTableName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getCatalogName /** gets a column's table's catalog name. + @param column + the first column is 1, the second is 2, + @returns + the catalog name + @throws SQLException + if a database access error occurs. */ string getCatalogName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnType /** retrieves a column's SQL type. + @param column + the first column is 1, the second is 2, + @returns + the column type + @throws SQLException + if a database access error occurs. */ long getColumnType([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnTypeName /** retrieves a column's database-specific type name. + @param column + the first column is 1, the second is 2, + @returns + the type name + @throws SQLException + if a database access error occurs. */ string getColumnTypeName([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isReadOnly /** indicates whether a column is definitely not writable. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isReadOnly([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isWritable /** indicates whether it is possible for a write on the column to succeed. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isWritable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::isDefinitelyWritable /** indicates whether a write on the column will definitely succeed. + @param column + the first column is 1, the second is 2, + @returns + <TRUE/> if so + @throws SQLException + if a database access error occurs. */ boolean isDefinitelyWritable([in]long column) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaData::getColumnServiceName /** returns the fully-qualified name of the service whose instances - are manufactured if the method <code>ResultSet.getObject</code> + are manufactured if the method + <member scope="com::sun::star::sdbc">XResultSet::.getObject()</member> is called to retrieve a value from the column. + @param column + the first column is 1, the second is 2, + @returns + the service name + @throws SQLException + if a database access error occurs. */ string getColumnServiceName([in]long column) raises (SQLException); }; @@ -214,6 +339,12 @@ interface XResultSetMetaData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl index 8478a96bf86d..b0effe103d37 100644 --- a/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl +++ b/offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetMetaDataSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,15 +78,24 @@ interface XResultSetMetaData; /** provides access to the meta data of a result set. - <p>The number, types, and properties of a ResultSet's columns are - provided by the ResultSetMetaData object returned by the getMetaData - method.</p> + <p> + The number, types, and properties of a ResultSet's columns are + provided by the + <type scope="com::sun::star::sdbc">ResultSetMetaData</type> + object returned by the + <member scope="com::sun::star::sdbc">XResultSetMetaDataSupplier::getMetaData()</member> + method. + </p> */ interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XResultSetMetaDataSupplier::getMetaData /** retrieves the number, types, and properties of a ResultSet's columns. + @returns + the meta data of the ResultSet. + @throws SQLException + if a database access error occurs. */ XResultSetMetaData getMetaData() raises (SQLException); }; @@ -97,6 +106,12 @@ interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XResultSetUpdate.idl b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl index 9fad57c602e2..16967b5cb5fa 100644 --- a/offapi/com/sun/star/sdbc/XResultSetUpdate.idl +++ b/offapi/com/sun/star/sdbc/XResultSetUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultSetUpdate.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,6 +83,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::insertRow /** inserts the contents of the insert row into the result set and the database. Must be on the insert row when this method is called. + @throws SQLException + if a database access error occurs. */ void insertRow() raises (SQLException); //------------------------------------------------------------------------- @@ -90,6 +92,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::updateRow /** updates the underlying database with the new contents of the current row. Cannot be called when on the insert row. + @throws SQLException + if a database access error occurs. */ void updateRow() raises (SQLException); //------------------------------------------------------------------------- @@ -97,6 +101,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XResultSetUpdate::deleteRow /** deletes the current row from the result set and the underlying database. Cannot be called when on the insert row. + @throws SQLException + if a database access error occurs. */ void deleteRow() raises (SQLException); //------------------------------------------------------------------------- @@ -105,12 +111,18 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /** cancels the updates made to a row. - <p>This method may be called after calling an - <code>updateXXX</code> method(s) and before calling <code>updateRow</code> + <p> + This method may be called after calling an + <code>updateXXX</code> + method(s) and before calling + <member scope="com::sun::star::sdbc">XResultSetUpdate::updateRow()</member> to rollback the updates made to a row. If no updates have been made or - <code>updateRow</code> has already been called, then this method has no + <code>updateRow</code> + has already been called, then this method has no effect. </p> + @throws SQLException + if a database access error occurs. */ void cancelRowUpdates() raises (SQLException); //------------------------------------------------------------------------- @@ -120,19 +132,35 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface remembered while the cursor is positioned on the insert row. - <p> The insert row is a special row associated with an updatable + <p> + The insert row is a special row associated with an updatable result set. It is essentially a buffer where a new row may - be constructed by calling the <code>updateXXX</code> methods prior to + be constructed by calling the + <code>updateXXX</code> + methods prior to inserting the row into the result set. </p> - <p>Only the <code>updateXXX</code>, <code>getXXX</code>, - and <code>insertRow</code> methods may be + <p> + Only the + <code>updateXXX</code> + , + <code>getXXX</code> + , + and + <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow()</member> + methods may be called when the cursor is on the insert row. All of the columns in a result set must be given a value each time this method is - called before calling <code>insertRow</code>. - The method <code>updateXXX</code> must be called before a - <code>getXXX</code> method can be called on a column value. + called before calling + <code>insertRow</code> + . The method + <code>updateXXX</code> + must be called before a + <code>getXXX</code> + method can be called on a column value. </p> + @throws SQLException + if a database access error occurs. */ void moveToInsertRow() raises (SQLException); //------------------------------------------------------------------------- @@ -141,6 +169,8 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /** moves the cursor to the remembered cursor position, usually the current row. This method has no effect if the cursor is not on the insert row. + @throws SQLException + if a database access error occurs. */ void moveToCurrentRow() raises (SQLException); }; @@ -151,6 +181,12 @@ interface XResultSetUpdate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRow.idl b/offapi/com/sun/star/sdbc/XRow.idl index 08493625cd81..77e413d88b62 100644 --- a/offapi/com/sun/star/sdbc/XRow.idl +++ b/offapi/com/sun/star/sdbc/XRow.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRow.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,7 +99,9 @@ interface XClob; // DocMerge from xml: interface com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow /** is used to access data which is collected in a row. - All methods raise a SQLException if a database access error occurs. + All methods raise a + <type scope="com::sun::star::sdbc">SQLException</type> + if a database access error occurs. */ interface XRow: com::sun::star::uno::XInterface { @@ -110,54 +112,107 @@ interface XRow: com::sun::star::uno::XInterface Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL. + + @returns + <TRUE/> if last column read was SQL NULL and <FALSE/> otherwise + @throws SQLException + if a database access error occurs. */ boolean wasNull() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getString /** gets the value of a column in the current row as a string. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ string getString([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBoolean /** gets the value of a column in the current row as boolean. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ boolean getBoolean([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getByte /** get the value of a column in the current row as a byte. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ byte getByte([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getShort /** gets the value of a column in the current row as a short. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ short getShort([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getInt /** get the value of a column in the current row as an integer. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ long getInt([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getLong /** get the value of a column in the current row as a long. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ hyper getLong([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getFloat /** gets the value of a column in the current row as a float. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ float getFloat([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDouble /** gets the value of a column in the current row as a double. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ double getDouble([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- @@ -177,6 +232,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDate /** gets the value of a column in the current row as a date object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Date getDate([in]long columnIndex) raises (SQLException); @@ -184,6 +245,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTime /** gets the value of a column in the current row as a time object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Time getTime([in]long columnIndex) raises (SQLException); @@ -191,6 +258,12 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTimestamp /** gets the value of a column in the current row as a datetime object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::util::DateTime getTimestamp([in]long columnIndex) raises (SQLException); @@ -207,10 +280,17 @@ interface XRow: com::sun::star::uno::XInterface <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> is called whether there is data available or not. </p> + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex) raises (SQLException); @@ -227,10 +307,17 @@ interface XRow: com::sun::star::uno::XInterface <b>Note:</b> All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a - stream may return 0 when the method <code>available</code> + stream may return 0 when the method + <member scope="com::sun::star::io">XInputStream::available()</member> is called whether there is data available or not. </p> + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex) raises (SQLException); @@ -238,9 +325,18 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getObject /** returns the value of a column in the current row as an object. - This method uses the given <code>Map</code> object - for the custom mapping of the SQL structure or distinct type + This method uses the given + <code>Map</code> + object for the custom mapping of the SQL structure or distinct type that is being retrieved. + @param columnIndex + the first column is 1, the second is 2, + @param typeMap + the map of types which should be used to get the column value + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ any getObject([in]long columnIndex, [in]com::sun::star::container::XNameAccess typeMap) @@ -249,24 +345,52 @@ interface XRow: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getRef /** gets a REF(&lt;structured-type&gt;) column value from the current row. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XRef getRef([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBlob /** gets a BLOB value in the current row. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XBlob getBlob([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getClob - /** gets a CLOB value in the current row of this <code>ResultSet</code> object. + /** gets a CLOB value in the current row of this + <code>ResultSet</code> + object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XClob getClob([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getArray - /** gets a SQL ARRAY value from the current row of this <code>ResultSet</code> object. + /** gets a SQL ARRAY value from the current row of this + <code>ResultSet</code> + object. + @param columnIndex + the first column is 1, the second is 2, + @returns + the column value; if the value is SQL NULL, the result is null + @throws SQLException + if a database access error occurs. */ XArray getArray([in]long columnIndex) raises (SQLException); }; @@ -277,6 +401,12 @@ interface XRow: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/10/16 06:40:03 oj #76791# documentation added diff --git a/offapi/com/sun/star/sdbc/XRowSet.idl b/offapi/com/sun/star/sdbc/XRowSet.idl index 4a483e460bae..8b2199b152e1 100644 --- a/offapi/com/sun/star/sdbc/XRowSet.idl +++ b/offapi/com/sun/star/sdbc/XRowSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,9 +78,11 @@ interface XConnection; - <p>The XRowSet interface is unique in that it is intended to be + <p> + The XRowSet interface is unique in that it is intended to be a software layer on top of an SDBC driver. Implementations of the - RowSet interface can be provided by anyone.</p> + RowSet interface can be provided by anyone. + </p> */ interface XRowSet: XResultSet { @@ -89,6 +91,9 @@ interface XRowSet: XResultSet // DocMerge from xml: method com::sun::star::sdbc::XRowSet::execute /** populates a row set with data. The description of the data source and other important information for filling the row set with data. + + @throws SQLException + if a database access error occurs. */ void execute() raises (SQLException); //------------------------------------------------------------------------- @@ -96,12 +101,16 @@ interface XRowSet: XResultSet // DocMerge from xml: method com::sun::star::sdbc::XRowSet::addRowSetListener /** adds the specified listener to receive the events "cursorMoved", "rowChanged", and "rowSetChanged". + @param listener + the listener which should be registered */ [oneway] void addRowSetListener([in]XRowSetListener listener ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XRowSet::removeRowSetListener /** removes the specified listener. + @param listener + the listener which should be registered */ [oneway] void removeRowSetListener([in]XRowSetListener listener ); }; @@ -112,6 +121,12 @@ interface XRowSet: XResultSet /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRowSetListener.idl b/offapi/com/sun/star/sdbc/XRowSetListener.idl index 097029184cfa..8b28d0288c26 100644 --- a/offapi/com/sun/star/sdbc/XRowSetListener.idl +++ b/offapi/com/sun/star/sdbc/XRowSetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowSetListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,12 +77,16 @@ interface XRowSetListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::cursorMoved /** is called when a rowset's cursor is moved. + @param event + contains information about the event */ [oneway] void cursorMoved([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowChanged /** is called when a row is inserted, updated, or deleted. + @param event + contains information about the event */ [oneway] void rowChanged([in]com::sun::star::lang::EventObject event); //------------------------------------------------------------------------- @@ -90,6 +94,8 @@ interface XRowSetListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::sdbc::XRowSetListener::rowSetChanged /** is called when the row set has changed, or in other words, when the row set has been reexecuted. + @param event + contains information about the event */ [oneway] void rowSetChanged([in]com::sun::star::lang::EventObject event); }; @@ -100,6 +106,12 @@ interface XRowSetListener: com::sun::star::lang::XEventListener /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XRowUpdate.idl b/offapi/com/sun/star/sdbc/XRowUpdate.idl index 9990097072d2..fcb797b55f6c 100644 --- a/offapi/com/sun/star/sdbc/XRowUpdate.idl +++ b/offapi/com/sun/star/sdbc/XRowUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowUpdate.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,66 +96,130 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNull /** gives a nullable column a null value. + @param columnIndex + the position of the column + @throws SQLException + if a database access error occurs. */ void updateNull([in]long columnIndex) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBoolean /** updates a column with a boolean value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateBoolean([in]long columnIndex, [in]boolean x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateByte /** updates a column with a byte value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateByte([in]long columnIndex, [in]byte x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateShort /** updates a column with a short value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateShort([in]long columnIndex, [in]short x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateInt /** updates a column with an long value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateInt([in]long columnIndex, [in]long x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateLong /** updates a column with a hyper value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateLong([in]long columnIndex, [in]hyper x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateFloat /** updates a column with a float value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateFloat([in]long columnIndex, [in]float x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDouble /** updates a column with a double value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateDouble([in]long columnIndex, [in]double x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateString /** updates a column with a string value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateString([in]long columnIndex, [in]string x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBytes /** updates a column with a byte array value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateBytes([in]long columnIndex, [in]sequence<byte> x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateDate /** updates a column with a date value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateDate([in]long columnIndex, [in]com::sun::star::util::Date x) raises (SQLException); @@ -163,6 +227,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTime /** updates a column with a time value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateTime([in]long columnIndex, [in]com::sun::star::util::Time x) raises (SQLException); @@ -170,6 +240,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateTimestamp /** updates a column with a timestamp value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateTimestamp([in]long columnIndex, [in]com::sun::star::util::DateTime x) @@ -178,6 +254,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateBinaryStream /** updates a column with a stream value. + @param columnIndex + the position of the column + @param x + the new column value + @param length + how much data should be read out of the stream + @throws SQLException + if a database access error occurs. */ void updateBinaryStream([in]long columnIndex, [in]com::sun::star::io::XInputStream x, @@ -186,6 +270,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateCharacterStream /** updates a column with a stream value. + @param columnIndex + the position of the column + @param x + the new column value + @param length + how much data should be read out of the stream + @throws SQLException + if a database access error occurs. */ void updateCharacterStream([in]long columnIndex, [in]com::sun::star::io::XInputStream x, @@ -194,6 +286,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateObject /** updates a column with an object value. + @param columnIndex + the position of the column + @param x + the new column value + @throws SQLException + if a database access error occurs. */ void updateObject([in]long columnIndex, [in]any x) raises (SQLException); @@ -201,6 +299,14 @@ interface XRowUpdate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XRowUpdate::updateNumericObject /** updates a column with an object value. + @param columnIndex + the position of the column + @param x + the new column value + @param scale + defines the scale which should be used to write the numeric value + @throws SQLException + if a database access error occurs. */ void updateNumericObject([in]long columnIndex, [in]any x, [in]long scale) raises (SQLException); @@ -212,6 +318,12 @@ interface XRowUpdate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XSQLData.idl b/offapi/com/sun/star/sdbc/XSQLData.idl index ef3a8cc855ed..01194a5c99ae 100644 --- a/offapi/com/sun/star/sdbc/XSQLData.idl +++ b/offapi/com/sun/star/sdbc/XSQLData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLData.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,8 @@ interface XSQLOutput; registered in a type mapping. It is expected that this interface will normally be implemented by a tool. The methods in this interface are called by the driver and are never called by a programmer - directly.</p> + directly. + </p> */ interface XSQLData: com::sun::star::uno::XInterface { @@ -94,9 +95,14 @@ interface XSQLData: com::sun::star::uno::XInterface that this object represents. - <p>This method is called by the SDBC driver to get the name of the + <p> + This method is called by the SDBC driver to get the name of the UDT instance that is being mapped to this instance of SQLData. </p> + @returns + the name of the SQL type. + @throws SQLException + if a database access error occurs. */ string getSQLTypeName() raises (SQLException); @@ -106,23 +112,39 @@ interface XSQLData: com::sun::star::uno::XInterface /** populates this object with data read from the database. - <p>The implementation of the method must follow this protocol:<br> + <p> + The implementation of the method must follow this protocol: + <br/> It must read each of the attributes or elements of the SQL type from the given input stream. This is done by calling a method of the input stream to read each item, in the order that they appear in the SQL definition - of the type. The method <code>readSQL</code> then - assigns the data to appropriate fields or elements (of this - or other objects).<br> - Specifically, it must call the appropriate <code>XSQLInput.readXXX</code> + of the type. The method + <code>readSQL</code> + then assigns the data to appropriate fields or elements (of this + or other objects). + <br/> + Specifically, it must call the appropriate + <code>XSQLInput.readXXX</code> method(s) to do the following: for a Distinct Type, read its single data element; for a Structured Type, read a value for each attribute of the SQL type. </p> - <p> The SDBC driver initializes the input stream with a type map + <p> + The SDBC driver initializes the input stream with a type map before calling this method, which is used by the appropriate - <code>SQLInput.readXXX</code> method on the stream. - </p>@see com::sun::star::sdbc::XSQLInput + <code>SQLInput.readXXX</code> + method on the stream. + </p> + + @param stream + the input SQL data stream + @param typeName + the SQL type of the value on the data stream + @throws SQLException + if a database access error occurs. + + @see com::sun::star::sdbc::XSQLInput */ void readSQL([in]XSQLInput stream, [in]string typeName) raises (SQLException); @@ -132,15 +154,23 @@ interface XSQLData: com::sun::star::uno::XInterface /** writes this object to the given SQL data stream. - <p>The implementation of the method must follow this protocol:<br> + <p> + The implementation of the method must follow this protocol: + <br/> It must write each of the attributes of the SQL type to the given output stream. This is done by calling a method of the output stream to write each item, in the order that they appear in the SQL definition of the type. - Specifically, it must call the appropriate <code>XSQLOutput.writeXXX</code> + Specifically, it must call the appropriate + <code>XSQLOutput.writeXXX</code> method(s) to do the following:<br> for a Distinct Type, write its single data element; for a Structured Type, write a value for each attribute of the SQL type. - </p>@see com::sun::star::sdbc::XSQLOutput + </p> + @param stream + the output SQL data stream + @throws SQLException + if a database access error occurs. + @see com::sun::star::sdbc::XSQLOutput */ void writeSQL([in]XSQLOutput stream) raises (SQLException); }; @@ -151,6 +181,12 @@ interface XSQLData: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XSQLInput.idl b/offapi/com/sun/star/sdbc/XSQLInput.idl index 55ceb20feb12..2cc680d5478f 100644 --- a/offapi/com/sun/star/sdbc/XSQLInput.idl +++ b/offapi/com/sun/star/sdbc/XSQLInput.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLInput.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -98,105 +98,170 @@ interface XClob; instance of a SQL structured or distinct type. - <p>This interface, used only for custom mapping, is used by the driver + <p> + This interface, used only for custom mapping, is used by the driver behind the scenes, and a programmer never directly invokes - <code>SQLInput</code> methods. + <code>SQLInput</code> + methods. </p> - <p>When the method <code>getObject</code> is called with an - object of a service implementing the interface <code>SQLData</code>, - the SDBC driver calls the method <code>XSQLData.getSQLType</code> + <p> + When the method + <code>getObject</code> + is called with an object of a service implementing the interface + <code>SQLData</code> + , the SDBC driver calls the method + <member scope="com::sun::star::sdbc">XSQLData::getSQLType()</member> to determine the SQL type of the user-defined type (UDT) being custom mapped. - The driver creates an instance of <code>XSQLInput</code>, + The driver creates an instance of + <type scope="com::sun::star::sdbc">XSQLInput</type> + , populating it with the attributes of the UDT. The driver then passes the input - stream to the method <code>XSQLData.readSQL</code>, which in turn - calls the <code>XSQLInput.readXXX</code> methods in its implementation for - reading the attributes from the input stream.</p> + stream to the method + <member scope="com::sun::star::sdbc">XSQLData::readSQL()</member> + , which in turn calls the + <code>XSQLInput.readXXX</code> + methods in its implementation for reading the attributes from the input stream. + </p> */ interface XSQLInput: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readString /** reads the next attribute in the stream as string. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ string readString() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBoolean /** reads the next attribute in the stream as boolean. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ boolean readBoolean() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readByte /** reads the next attribute in the stream as byte. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ byte readByte() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readShort /** reads the next attribute in the stream as short. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ short readShort() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readInt /** reads the next attribute in the stream as long. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ long readInt() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readLong /** reads the next attribute in the stream as hyper. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ hyper readLong() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readFloat /** reads the next attribute in the stream as float. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ float readFloat() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDouble /** reads the next attribute in the stream as double. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ double readDouble() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from idl: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBytes /** reads the next attribute in the stream as sequence of bytes. - @throws SQLException - if a database access error occurs + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ sequence<byte> readBytes() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readDate /** reads the next attribute in the stream as date. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Date readDate() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTime /** reads the next attribute in the stream as time. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::Time readTime() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readTimestamp /** reads the next attribute in the stream as datetime. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::util::DateTime readTimestamp() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBinaryStream /** reads the next attribute in the stream as sequence of bytes. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream readBinaryStream() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readCharacterStream /** reads the next attribute in the stream as a unicode string. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ com::sun::star::io::XInputStream readCharacterStream() raises (SQLException); //------------------------------------------------------------------------- @@ -205,50 +270,78 @@ interface XSQLInput: com::sun::star::uno::XInterface /** returns the datum at the head of the stream as an any. - <p>The actual type of the any returned is determined by the default + <p> + The actual type of the any returned is determined by the default type mapping, and any customizations present in this stream's type map. - <br>A type map is registered with the stream by the SDBC driver before the + <br/> + A type map is registered with the stream by the SDBC driver before the stream is passed to the application. - <br>When the datum at the head of the stream is a SQL NULL, + <br/> + When the datum at the head of the stream is a SQL NULL, the method returns <void/>. If the datum is a SQL structured or distinct type, it determines the SQL type of the datum at the head of the stream, constructs an object of the appropriate service, and calls the method - <code>XSQLData.readSQL</code> on that object, which reads additional data + <member scope="com::sun::star::sdbc">XSQLData::readSQL()</member> + on that object, which reads additional data from the stream using the protocol described for that method. </p> + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ any readObject() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readRef /** reads a REF(&lt;structured-type&gt;) from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XRef readRef() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readBlob /** reads a BLOB from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XBlob readBlob() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readClob /** reads a CLOB from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XClob readClob() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::readArray /** reads an array from the stream. + @returns + the attribute; if the value is SQL NULL, return null. + @throws SQLException + if a database access error occurs. */ XArray readArray() raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLInput::wasNull /** determines whether the last value read was null. + @returns + <TRUE/> if the most recently gotten SQL value was null; otherwise, <FALSE/> + @throws SQLException + if a database access error occurs. */ boolean wasNull() raises (SQLException); }; @@ -259,6 +352,12 @@ interface XSQLInput: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XSQLOutput.idl b/offapi/com/sun/star/sdbc/XSQLOutput.idl index d9609b315a8b..f34fe44a11e8 100644 --- a/offapi/com/sun/star/sdbc/XSQLOutput.idl +++ b/offapi/com/sun/star/sdbc/XSQLOutput.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSQLOutput.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -102,89 +102,146 @@ interface XSQLData; by a programmer. - <p>When an object of a class implementing interface <code>XSQLData</code> is - passed as an argument to a SQL statement, the JDBC driver calls - <code>SQLData.getSQLType</code> to determine the kind of SQL datum being - passed to the database. - <br>The driver then creates an instance of <code>XSQLOutput</code> and - passes it to the method <code>SQLData.writeSQL</code>. - The method <code>writeSQL</code> in turn calls the - appropriate <code>SQLOutput.writeXXX</code> methods - to write data from the <code>SQLData</code> object to - the <code>SQLOutput</code> output stream as the - representation of a SQL user-defined type.</p> + <p> + When an object of a class implementing interface + <type scope="com::sun::star::sdbc">XSQLData</type> + is passed as an argument to a SQL statement, the JDBC driver calls + <member scope="com::sun::star::sdbc">SQLData::getSQLType()</member> + to determine the kind of SQL datum being passed to the database. + <br/> + The driver then creates an instance of + <code>XSQLOutput</code> + and passes it to the method + <member scope="com::sun::star::sdbc">XSQLData::writeSQL()</member> + . The method + <code>writeSQL</code> + in turn calls the appropriate + <code>XSQLOutput.writeXXX</code> + methods to write data from the + <type scope="com::sun::star::sdbc">XSQLData</type> + object to the + <code>XSQLOutput</code> + output stream as the representation of a SQL user-defined type.</p> */ interface XSQLOutput: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeString /** writes the next attribute to the stream as a string. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeString([in]string x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBoolean /** writes the next attribute to the stream as boolean. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBoolean([in]boolean x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeByte /** writes the next attribute to the stream as byte. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeByte([in]byte x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeShort /** writes the next attribute to the stream as short. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeShort([in]short x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeInt /** writes the next attribute to the stream as long. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeInt([in]long x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeLong /** writes the next attribute to the stream as hyper. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeLong([in]hyper x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeFloat /** writes the next attribute to the stream as float. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeFloat([in]float x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDouble /** writes the next attribute to the stream as double. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeDouble([in]double x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBytes /** writes the next attribute to the stream as byte sequence. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBytes([in]sequence<byte> x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDate /** writes the next attribute to the stream as a date. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeDate([in]com::sun::star::util::Date x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTime /** writes the next attribute to the stream as a time. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeTime([in]com::sun::star::util::Time x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTimestamp /** writes the next attribute to the stream as a datetime. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeTimestamp([in]com::sun::star::util::DateTime x) raises (SQLException); @@ -193,6 +250,10 @@ interface XSQLOutput: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBinaryStream /** writes the next attribute to the stream as a stream of uninterpreted bytes. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBinaryStream([in]com::sun::star::io::XInputStream x) raises (SQLException); @@ -200,6 +261,10 @@ interface XSQLOutput: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeCharacterStream /** writes the next attribute to the stream as a stream of unicode string. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeCharacterStream([in]com::sun::star::io::XInputStream x) raises (SQLException); @@ -210,49 +275,83 @@ interface XSQLOutput: com::sun::star::uno::XInterface <code>XSQLData</code> object. - <p>When the <code>XSQLData</code> object is <NULL/>, this - method writes an SQL NULL to the stream. - Otherwise, it calls the <code>SQLData.writeSQL</code> + <p + >When the + <code>XSQLData</code> + object is + <NULL/> + , this method writes an SQL NULL to the stream. + Otherwise, it calls the + <member scope="com::sun::star::sdbc">XSQLData::writeSQL()</member> method of the given object, which writes the object's attributes to the stream. - The implementation of the method <code>XSQLData.writeSQL</code> - calls the appropriate <code>XSQLOutput.writeXXX</code> method(s) - for writing each of the object's attributes in order. - <br>The attributes must be read from an <code>XSQLInput</code> - input stream and written to an <code>XSQLOutput</code> + The implementation of the method + <code>XSQLData::writeSQL()</code> + calls the appropriate + <code>XSQLOutput.writeXXX</code> + method(s) for writing each of the object's attributes in order. + <br/> + The attributes must be read from an + <type scope="com::sun::star::sdbc">XSQLInput</type> + input stream and written to an + <code>XSQLOutput</code> output stream in the same order in which they were listed in the SQL definition of the user-defined type. </p> + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeObject([in]XSQLData x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeRef /** writes a REF(&lt;structured-type&gt;) to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeRef([in]XRef x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBlob /** writes a BLOB to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeBlob([in]XBlob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeClob /** writes a CLOB to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeClob([in]XClob x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeStruct /** writes a structured-type to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeStruct([in]XStruct x) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeArray /** writes an array to the stream. + @param x + the value to pass to the database. + @throws SQLException + if a database access error occurs. */ void writeArray([in]XArray x) raises (SQLException); }; @@ -263,6 +362,12 @@ interface XSQLOutput: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed diff --git a/offapi/com/sun/star/sdbc/XStatement.idl b/offapi/com/sun/star/sdbc/XStatement.idl index 5094f6ad7524..5e975a305a74 100644 --- a/offapi/com/sun/star/sdbc/XStatement.idl +++ b/offapi/com/sun/star/sdbc/XStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatement.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,17 +81,27 @@ interface XResultSet; - <p>Only one ResultSet per Statement can be open at any point in + <p> + Only one ResultSet per Statement can be open at any point in time; therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by - different Statements. All statement <code>execute</code> methods implicitly - close a statement's current ResultSet if an open one exists.</p> + different Statements. All statement + <code>execute</code> + methods implicitly + close a statement's current ResultSet if an open one exists. + </p> */ interface XStatement: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbc::XStatement::executeQuery /** executes a SQL statement that returns a single ResultSet. + @param sql + the SQL statement which should be executed + @returns + a ResultSet that contains the data produced by the query; never <NULL/> + @throws SQLException + if a database access error occurs. */ XResultSet executeQuery([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -100,6 +110,13 @@ interface XStatement: com::sun::star::uno::XInterface /** executes an SQL INSERT, UPDATE, or DELETE statement. In addition, SQL statements that return nothing, such as SQL DDL statements, can be executed. + + @param sql + a SQL INSERT, UPDATE or DELETE statement or a SQL statement that returns nothing + @returns + either the row count for INSERT, UPDATE or DELETE or 0 for SQL statements that return nothing + @throws SQLException + if a database access error occurs. */ long executeUpdate([in]string sql) raises (SQLException); //------------------------------------------------------------------------- @@ -108,25 +125,49 @@ interface XStatement: com::sun::star::uno::XInterface /** executes a SQL statement that may return multiple results. - <p>Under some (uncommon) situations a single SQL statement may return + <p> + Under some (uncommon) situations a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string. The navigation through multiple results is covered by <type scope="com::sun::star::sdbc">XMultipleResults</type>. </p> - <p>The <code>execute</code> method executes a SQL statement and indicates - the form of the first result. You can then use <code>getResultSet</code> or - <code>getUpdateCount</code> to retrieve the result, and - <code>getMoreResults</code> to move to any subsequent result(s). + <p> + The + <code>execute</code> + method executes a SQL statement and indicates + the form of the first result. You can then use + <member scope="com::sun::star::sdbc">XStatement::getResultSet()</member> + or + <member scope="com::sun::star::sdbc">XStatement::getUpdateCount()</member> + to retrieve the result, and + <member scope="com::sun::star::sdbc">XStatement::getMoreResults()</member> + to move to any subsequent result(s). </p> + + @param sql + any SQL statement + @returns + <TRUE/> if the next result is a ResultSet; <FALSE/> if it is an update count or there are no more results + @throws SQLException + if a database access error occurs. */ boolean execute([in]string sql) raises (SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbc::XStatement::getConnection - /** returns the <code>Connection</code> object - that produced this <code>Statement</code> object. + /** returns the + <type scope="com::sun::star::sdbc">Connection</type> + object + that produced this + <code>Statement</code> + object. + @returns + the connection that produced this statement + + @throws SQLException + if a database access error occurs. */ XConnection getConnection() raises (SQLException); }; @@ -137,6 +178,12 @@ interface XStatement: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbc/XStruct.idl b/offapi/com/sun/star/sdbc/XStruct.idl index 1f9c527c6dc6..5f652d769613 100644 --- a/offapi/com/sun/star/sdbc/XStruct.idl +++ b/offapi/com/sun/star/sdbc/XStruct.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStruct.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,17 +80,29 @@ interface XNameAccess; /** is used for the standard mapping for a SQL structured type. - <p>A <code>Struct</code> object contains a value for each attribute + <p> + A + <code>Struct</code> + object contains a value for each attribute of the SQL structured type that it represents. - By default, an instance of <code>Struct</code> is valid as long as the - application has a reference to it.</p> + By default, an instance of + <code>Struct</code> + is valid as long as the + application has a reference to it. + </p> */ interface XStruct: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XStruct::getSQLTypeName /** retrieves the SQL type name of the SQL structured type - that this <code>Struct</code> object represents. + that this + <code>Struct</code> + object represents. + @returns + the name of the SQL type. + @throws SQLException + if a database access error occurs. */ string getSQLTypeName() raises (SQLException); @@ -98,15 +110,24 @@ interface XStruct: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XStruct::getAttributes /** produces the ordered values of the attributes of the SQL - structured type that this <code>Struct</code> object represents. - <p>This method uses the given type map for customizations of the type + structured type that this + <code>Struct</code> + object represents. + <p> + This method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches or - the given type map is <NULL/>, the structured type that this - <code>Struct</code> object represents, the driver uses + the given type map is + <NULL/> + , the structured type that this + <code>Struct</code> + object represents, the driver uses the connection type mapping. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code>is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @returns @@ -124,6 +145,12 @@ interface XStruct: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 08:58:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:35 mi moved from api diff --git a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl index dc6380e3690c..e5cf1d18c939 100644 --- a/offapi/com/sun/star/sdbc/XWarningsSupplier.idl +++ b/offapi/com/sun/star/sdbc/XWarningsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XWarningsSupplier.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:46:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,8 @@ // DocMerge from xml: interface com::sun::star::sdbc::XWarningsSupplier /** should be implemented of objects which may report warnings or non critical - errors .@see com::sun::star::sdbc::SQLWarning + errors. + @see com::sun::star::sdbc::SQLWarning */ interface XWarningsSupplier: com::sun::star::uno::XInterface { @@ -84,13 +85,15 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface /** returns the first warning reported by calls on an object that supports the usage of warnings. - - <p> <b>Note:</b> Subsequent warnings will be chained to this - SQLWarning. - + <type scope="com::sun::star::sdbc">SQLWarning</type> + . </p> + @returns + the warnings + @throws SQLException + if a database access error occurs. */ any getWarnings() raises (SQLException); @@ -98,9 +101,13 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::XWarningsSupplier::clearWarnings /** clears all warnings reported for the object implementing the interface. - After a call to this method, the method <code>getWarnings</code> - returns <void/> until a new warning is - reported for the object. + After a call to this method, the method + <member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member> + returns + <void/> + until a new warning is reported for the object. + @throws SQLException + if a database access error occurs. */ void clearWarnings() raises (SQLException); }; @@ -111,6 +118,12 @@ interface XWarningsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.6 2001/11/01 16:46:46 mi + proofreading and corrections from Richard Holt + Revision 1.5 2001/03/16 16:41:35 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/Column.idl b/offapi/com/sun/star/sdbcx/Column.idl index e0a75959d593..8a385cf3ec5f 100644 --- a/offapi/com/sun/star/sdbcx/Column.idl +++ b/offapi/com/sun/star/sdbcx/Column.idl @@ -2,9 +2,9 @@ * * $RCSfile: Column.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,7 +81,7 @@ service Column */ [optional] interface XDataDescriptorFactory; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -92,7 +92,9 @@ service Column // DocMerge from xml: property com::sun::star::sdbcx::Column::Type - /** is the <type scope="com::sun::star::sdbc">DataType</type> of the column. + /** is the + <type scope="com::sun::star::sdbc">DataType</type> + of the column. */ [readonly, property] long Type; @@ -100,6 +102,9 @@ service Column // DocMerge from xml: property com::sun::star::sdbcx::Column::TypeName /** is the type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned. + <b> + Note: + </b> May be empty. */ [readonly, property] string TypeName; @@ -118,13 +123,15 @@ service Column // DocMerge from xml: property com::sun::star::sdbcx::Column::IsNullable - /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue + /** indicates the nullability of values in the designated column. + @see com::sun::star::sdbc::ColumnValue */ [readonly, property] long IsNullable; // DocMerge from xml: property com::sun::star::sdbcx::Column::IsAutoIncrement - /** indicates whether the column is automatically numbered, thus read-only.@see com::sun::star::sdbc::ColumnValue + /** indicates whether the column is automatically numbered, thus read-only. + @see com::sun::star::sdbc::ColumnValue */ [readonly, property] boolean IsAutoIncrement; @@ -168,6 +175,15 @@ service Column /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 09:36:17 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/01/23 10:08:31 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/ColumnDescriptor.idl b/offapi/com/sun/star/sdbcx/ColumnDescriptor.idl index 3562b3e0aef1..76b50a8b090d 100644 --- a/offapi/com/sun/star/sdbcx/ColumnDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/ColumnDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ColumnDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: oj $ $Date: 2002-07-24 10:53:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,8 +70,9 @@ // DocMerge from xml: service com::sun::star::sdbcx::ColumnDescriptor /** describes the common properties of a database column. Could be used for the creation - of a database column within a table.@see com::sun::star::sdbcx::Column - @see com::sun::star::sdbcx::Table + of a database columns within a table. + @see com::sun::star::sdbcx::Column + @see com::sun::star::sdbcx::Table */ service ColumnDescriptor { @@ -80,7 +81,9 @@ service ColumnDescriptor // DocMerge from xml: property com::sun::star::sdbcx::ColumnDescriptor::Type - /** is the <type scope="com::sun::star::sdbc">DataType</type> of the column. + /** is the + <type scope="com::sun::star::sdbc">DataType</type> + of the column. */ [property] long Type; @@ -106,13 +109,15 @@ service ColumnDescriptor // DocMerge from xml: property com::sun::star::sdbcx::ColumnDescriptor::IsNullable - /** indicates the nullability of values in the designated column.@see com::sun::star::sdbc::ColumnValue + /** indicates the nullability of values in the designated column. + @see com::sun::star::sdbc::ColumnValue */ [property] long IsNullable; // DocMerge from xml: property com::sun::star::sdbcx::ColumnDescriptor::IsAutoIncrement - /** indicates whether the column is automatically numbered, thus read-only.@see com::sun::star::sdbc::ColumnValue + /** indicates whether the column is automatically numbered, thus read-only. + @see com::sun::star::sdbc::ColumnValue */ [property] boolean IsAutoIncrement; @@ -144,20 +149,4 @@ service ColumnDescriptor }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:39 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:43 hjs - initial import - - Revision 1.3 2000/09/11 11:52:44 mi - documentation merged from XML - - Revision 1.1 2000/06/05 13:03:39 dg - new Services - - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbcx/Container.idl b/offapi/com/sun/star/sdbcx/Container.idl index 5199f50a5332..31caac2a60d0 100644 --- a/offapi/com/sun/star/sdbcx/Container.idl +++ b/offapi/com/sun/star/sdbcx/Container.idl @@ -2,9 +2,9 @@ * * $RCSfile: Container.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,34 +83,38 @@ interface XDrop; container must support access to its elements by the element's name or by the element's position. - <p>Simple enumeration must be supported as well. + <p> + Simple enumeration must be supported as well. </p> - <p>To reflect the changes with the underlying database, a refresh mechanism + <p> + To reflect the changes with the underlying database, a refresh mechanism needs to be supported. </p> - <p>A container may support the possibility to add new elements or to drop + <p> + A container may support the possibility to add new elements or to drop existing elements. Additions are always done by descriptors which define the - properties of the new element.</p> + properties of the new element. + </p> */ service Container { - // DocMerge: empty anyway + // gives access to the elements by name. interface com::sun::star::container::XNameAccess; - // DocMerge: empty anyway + // gives access to the elements by index. interface com::sun::star::container::XIndexAccess; - // DocMerge: empty anyway + // used to create an enumeration of the elements. interface com::sun::star::container::XEnumerationAccess; // DocMerge from xml: service com::sun::star::container::com::sun::star::util::com::sun::star::sdbcx::Container: interface com::sun::star::util::XRefreshable - /** is optional for implementation + /** is optional for implementation. Used to reflect changes. */ [optional] interface com::sun::star::util::XRefreshable; // DocMerge from xml: service com::sun::star::container::com::sun::star::util::com::sun::star::sdbcx::Container: interface com::sun::star::container::com::sun::star::util::com::sun::star::sdbcx::XDataDescriptorFactory - /** optional for implementation. + /** optional for implementation. Allows to create descriptor elements which then could be used to append new elements. */ [optional] interface XDataDescriptorFactory; @@ -133,6 +137,15 @@ service Container /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:32 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl b/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl index 8da63c402389..c0e4ddb0cf73 100644 --- a/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl +++ b/offapi/com/sun/star/sdbcx/DatabaseDefinition.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseDefinition.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,19 +74,23 @@ interface XGroupsSupplier; databases, and to control the access rights on database objects. - <p>It may be implemented by a database driver provider, to encapsulate the + <p> + It may be implemented by a database driver provider, to encapsulate the complexity of data definition, and to give a common way for data definition as the DDL of most DBMS's differs. </p> - <p>At least, the access to the tables of a database should be implemented. + <p> + At least, the access to the tables of a database should be implemented. The implementation of other known database objects like views is optional. </p> - <p>To control the access rights of users, there is the possibility to - implement objects like users and groups.</p> + <p> + To control the access rights of users, there is the possibility to + implement objects like users and groups. + </p> */ service DatabaseDefinition { - // DocMerge: empty anyway + // gives access to the tables. interface XTablesSupplier; // DocMerge from xml: service com::sun::star::sdbcx::DatabaseDefinition: interface com::sun::star::sdbcx::XViewsSupplier @@ -111,6 +115,15 @@ service DatabaseDefinition /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:33 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/Descriptor.idl b/offapi/com/sun/star/sdbcx/Descriptor.idl index 7078b3f75316..6d195b419f46 100644 --- a/offapi/com/sun/star/sdbcx/Descriptor.idl +++ b/offapi/com/sun/star/sdbcx/Descriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: Descriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,17 +73,18 @@ <p> A descriptor is commonly created by the container of a specific object, such as, tables or views. - After the the creation of the descriptor the properties have to be filled. + After the creation of the descriptor the properties have to be filled. Afterwards, you append the descriptor to the container and the container creates a new object based - on the informations of the descriptor. + on the informations of the descriptor. The descriptor can be used to create serveral objects. </p> - <p>A descriptor containes at least the informations of the name of an object. - - </p>@see com::sun::star::sdbcx::XAppend; + <p> + A descriptor containes at least the informations of the name of an object. + </p> + @see com::sun::star::sdbcx::XAppend; */ service Descriptor { - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -99,6 +100,15 @@ service Descriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.4.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/Driver.idl b/offapi/com/sun/star/sdbcx/Driver.idl index af8e5b6d0d37..cdd8b5c17a97 100644 --- a/offapi/com/sun/star/sdbcx/Driver.idl +++ b/offapi/com/sun/star/sdbcx/Driver.idl @@ -2,9 +2,9 @@ * * $RCSfile: Driver.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: rt $ $Date: 2002-09-25 11:07:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,14 @@ interface XDropCatalog; // DocMerge from xml: service com::sun::star::sdbcx::Driver -/** extends the service <type scope="com::sun::star::sdbc">Driver</type> by - beans for data definition. +/** extends the service + <type scope="com::sun::star::sdbc">Driver</type> + by beans for data definition. <p> This service is optional for each driver. Its purpose is to define a common way for database definition, as the DDL differs between most DBMS. -</p><p> +</p> +<p> Definition and deletion of database catalogs can't be defined in a common manner for DBMS, but it should be possible to hide much of the complexity of creation and deletion of catalogs. Each driver could provide methods to @@ -90,7 +92,9 @@ service Driver // DocMerge: empty anyway service com::sun::star::sdbc::Driver; - // DocMerge: empty anyway + /** used to get access to the catalog. + @see Catalog + */ interface XDataDefinitionSupplier; @@ -109,34 +113,4 @@ service Driver }; }; }; }; -/*=========================================================================== - $Log: not supported by cvs2svn $ - Revision 1.6 2002/09/24 12:42:32 oj - #103660# correct interface name XDatabaseDefinitionSupplier - - Revision 1.5 2001/10/25 15:35:32 mi - proofreading and corrections from Richard Holt - - Revision 1.4 2001/01/23 10:08:33 mi - optional interfaces now marked as [optional] instead of just a prosa description of this fact - - Revision 1.3 2000/11/08 12:43:39 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:43 hjs - initial import - - Revision 1.5 2000/09/11 11:52:44 mi - documentation merged from XML - - Revision 1.3 2000/05/24 11:07:47 dg - wrong interface in service definition used - - Revision 1.2 1999/12/20 16:26:13 dg - #70278# new package name - - Revision 1.1 1999/11/24 08:42:07 dg - new StarDataDefinitionBeans - -===========================================================================*/ #endif diff --git a/offapi/com/sun/star/sdbcx/Group.idl b/offapi/com/sun/star/sdbcx/Group.idl index f2acf0b25039..38341c83aeb1 100644 --- a/offapi/com/sun/star/sdbcx/Group.idl +++ b/offapi/com/sun/star/sdbcx/Group.idl @@ -2,9 +2,9 @@ * * $RCSfile: Group.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,18 +77,20 @@ interface XAuthorizable; */ service Group { - // DocMerge: empty anyway + /** gives access to the users which contains to this group. + */ interface XUsersSupplier; - // DocMerge: empty anyway + /** shows the access rights of this group. + */ interface XAuthorizable; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from xml: property com::sun::star::sdbcx::Group::Name - /** is the name of the view. + /** is the name of the group. */ [readonly, property] string Name; }; @@ -99,6 +101,15 @@ service Group /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.3.24.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:43 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/Index.idl b/offapi/com/sun/star/sdbcx/Index.idl index 0c08a2e0149e..009e3d3a30e1 100644 --- a/offapi/com/sun/star/sdbcx/Index.idl +++ b/offapi/com/sun/star/sdbcx/Index.idl @@ -2,9 +2,9 @@ * * $RCSfile: Index.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,12 +74,13 @@ interface XDataDescriptorFactory; // DocMerge from xml: service com::sun::star::sdbcx::Index /** is used to specify the index for a database table. It refers to one or more columns of a table. - - <p> - <b>Note:</b> + <b> + Note: + </b> All properties and columns of an index could by modified before they are appended - to a table. In that case the service is a data descriptor.</p> + to a table. In that case the service is a data descriptor. + </p> */ service Index { @@ -95,7 +96,7 @@ service Index */ interface XColumnsSupplier; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -135,6 +136,15 @@ service Index /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/01/23 10:08:33 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/IndexDescriptor.idl b/offapi/com/sun/star/sdbcx/IndexDescriptor.idl index b9ab4290cf18..626c702cc5ad 100644 --- a/offapi/com/sun/star/sdbcx/IndexDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/IndexDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ interface XColumnsSupplier; // DocMerge from xml: service com::sun::star::sdbcx::IndexDescriptor /** is used to define a new index for a database table. -@see com::sun::star::sdbcx::Index + @see com::sun::star::sdbcx::Index */ service IndexDescriptor { @@ -110,6 +110,12 @@ service IndexDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/Key.idl b/offapi/com/sun/star/sdbcx/Key.idl index af71eaf052c7..3a1ab2b98895 100644 --- a/offapi/com/sun/star/sdbcx/Key.idl +++ b/offapi/com/sun/star/sdbcx/Key.idl @@ -2,9 +2,9 @@ * * $RCSfile: Key.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,18 +88,19 @@ service Key */ interface XColumnsSupplier; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; // DocMerge from idl: property com::sun::star::sdbcx::Key::Name - /** is the name of the column + /** is the name of the key */ [readonly, property] string Name; // DocMerge from xml: property com::sun::star::sdbcx::Key::Type - /** indicates the type of the key.@see com::sun::star::sdbcx::KeyType + /** indicates the type of the key. + @see com::sun::star::sdbcx::KeyType */ [readonly, property] long Type; @@ -112,13 +113,15 @@ service Key // DocMerge from xml: property com::sun::star::sdbcx::Key::UpdateRule - /** is the rule which is applied for updates; only used for foreign keys.@see com::sun::star::sdbc::KeyRule; + /** is the rule which is applied for updates; only used for foreign keys. + @see com::sun::star::sdbc::KeyRule; */ [readonly, property] long UpdateRule; // DocMerge from xml: property com::sun::star::sdbcx::Key::DeleteRule - /** is the rule which is applied for deletions; only used for foreign keys.@see com::sun::star::sdbc::KeyRule; + /** is the rule which is applied for deletions; only used for foreign keys. + @see com::sun::star::sdbc::KeyRule; */ [readonly, property] long DeleteRule; }; @@ -129,6 +132,15 @@ service Key /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:33 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/KeyColumn.idl b/offapi/com/sun/star/sdbcx/KeyColumn.idl index 5a1d515da23d..7c28cf4c2589 100644 --- a/offapi/com/sun/star/sdbcx/KeyColumn.idl +++ b/offapi/com/sun/star/sdbcx/KeyColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyColumn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,8 @@ service KeyColumn { service Column; - /** is the name of a reference column out of the referenced table. */ + /** is the name of a reference column out of the referenced table. + */ [readonly, property] string RelatedColumn; }; diff --git a/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl b/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl index 9cd763100d0e..80f7d8c255f9 100644 --- a/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/KeyColumnDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyColumnDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,8 @@ // DocMerge from xml: service com::sun::star::sdbcx::KeyColumnDescriptor /** adds a property to specify the referenced column. This is used to specify - foreign keys.@see com::sun::star::sdbcx::KeyColumn + foreign keys. + @see com::sun::star::sdbcx::KeyColumn */ service KeyColumnDescriptor { @@ -90,6 +91,12 @@ service KeyColumnDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/KeyDescriptor.idl b/offapi/com/sun/star/sdbcx/KeyDescriptor.idl index 8e4a2b97ef89..7a864b8a2d5b 100644 --- a/offapi/com/sun/star/sdbcx/KeyDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/KeyDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: KeyDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,24 +78,26 @@ service Key { service Descriptor; - /** access to the contained key columns. */ + /** access to the contained key columns. + */ interface XColumnsSupplier; /** indicates the type of the key. - @see com::sun::star::sdbcx::KeyType + @see com::sun::star::sdbcx::KeyType */ [property] long Type; - /** is the name of the referenced table, only used for foreign keys. */ + /** is the name of the referenced table, only used for foreign keys. + */ [property] string ReferencedTable; /** is the rule which is applied for updates; only used for foreign keys. - @see com::sun::star::sdbc::KeyRule; + @see com::sun::star::sdbc::KeyRule; */ [property] long UpdateRule; /** is the rule which is applied for deletions; only used for foreign keys. - @see com::sun::star::sdbc::KeyRule; + @see com::sun::star::sdbc::KeyRule; */ [property] long DeleteRule; }; diff --git a/offapi/com/sun/star/sdbcx/PreparedStatement.idl b/offapi/com/sun/star/sdbcx/PreparedStatement.idl index 5d7e26a3773d..d0202d05e2ba 100644 --- a/offapi/com/sun/star/sdbcx/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbcx/PreparedStatement.idl @@ -2,9 +2,9 @@ * * $RCSfile: PreparedStatement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,18 +68,20 @@ module com { module sun { module star { module sdbcx { /** - extends the definition of the service -<type scope="com::sun::star::sdbc">PreparedStatement</type> - with a flag for the usage of bookmarks. - @see ResultSet - @see XRowLocate + extends the definition of the service + <type scope="com::sun::star::sdbc">PreparedStatement</type> + with a flag for the usage of bookmarks. + @see ResultSet + @see XRowLocate */ service Statement { service com::sun::star::sdbc::PreparedStatement; /** returns if a resultset should allow the navigation with bookmarks - or not. The default is <FALSE/>. + or not. The default is + <FALSE/> + . */ [property] boolean UseBookmarks; }; diff --git a/offapi/com/sun/star/sdbcx/ReferenceColumn.idl b/offapi/com/sun/star/sdbcx/ReferenceColumn.idl index 8eb97c0b6508..70a14ec8c5ba 100644 --- a/offapi/com/sun/star/sdbcx/ReferenceColumn.idl +++ b/offapi/com/sun/star/sdbcx/ReferenceColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: ReferenceColumn.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,7 @@ // DocMerge from xml: service com::sun::star::sdbcx::ReferenceColumn -/** adds an property to specify the referenced column. This is used to specify +/** adds a property to specify the referenced column. This is used to specify foreign keys. */ service ReferenceColumn @@ -91,6 +91,12 @@ service ReferenceColumn /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:44 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/Statement.idl b/offapi/com/sun/star/sdbcx/Statement.idl index ac63d8e952a4..e5394b1bedc4 100644 --- a/offapi/com/sun/star/sdbcx/Statement.idl +++ b/offapi/com/sun/star/sdbcx/Statement.idl @@ -2,9 +2,9 @@ * * $RCSfile: Statement.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,9 @@ // DocMerge from xml: service com::sun::star::sdbcx::Statement -/** extends the definition of the service <type scope="com::sun::star::sdbc">Statement</type> with a flag for the usage of bookmarks. +/** extends the definition of the service + <type scope="com::sun::star::sdbc">Statement</type> + with a flag for the usage of bookmarks. @see ResultSet @see XRowLocate */ @@ -80,8 +82,12 @@ service Statement // DocMerge from xml: property com::sun::star::sdbcx::Statement::UseBookmarks - /** returns <TRUE/> if a resultset should allow navigation with bookmarks - or not. The default is <FALSE/>. + /** returns + <TRUE/> + if a resultset should allow navigation with bookmarks or not. + The default is + <FALSE/> + . */ [property] boolean UseBookmarks; }; @@ -92,6 +98,12 @@ service Statement /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2000/12/14 12:53:40 mi <true></true> -> <TRUE/> and same with FALSE diff --git a/offapi/com/sun/star/sdbcx/Table.idl b/offapi/com/sun/star/sdbcx/Table.idl index cad07c230997..af3755b5b1d9 100644 --- a/offapi/com/sun/star/sdbcx/Table.idl +++ b/offapi/com/sun/star/sdbcx/Table.idl @@ -2,9 +2,9 @@ * * $RCSfile: Table.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,14 +79,20 @@ interface XAlterTable; /** used to specify a table in a database. A table is described by its name and one or more columns. - <p>In addition, it may contain indexes to improve the performance in + <p> + In addition, it may contain indexes to improve the performance in the retrieval of the table's data and keys, and to define semantic rules for the table. - </p><p> - <b>Note:</b> All properties and columns of a table could by modified before + </p> + <p> + <b> + Note: + </b> + All properties and columns of a table could by modified before it is appended to a database. In that case, the service is in fact a descriptor. On existing tables, a user might alter columns, add or delete columns, indexes, and keys depending on the capabilities of the database and on - the user's privileges.</p> + the user's privileges. + </p> @see com::sun::star::sdbc::XDatabaseMetaData @see com::sun::star::sdbcx::Privilege @@ -95,7 +101,7 @@ service Table { // DocMerge from xml: service com::sun::star::sdbcx::Table: interface com::sun::star::sdbcx::XDataDescriptorFactory - /** optional, could be used to copy an index. + /** optional, could be used to copy an table. */ [optional] interface XDataDescriptorFactory; @@ -129,7 +135,7 @@ service Table */ [optional] interface XAlterTable; - // DocMerge: empty anyway + // gives access to the properties interface com::sun::star::beans::XPropertySet; @@ -173,6 +179,15 @@ service Table /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:34 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/TableDescriptor.idl b/offapi/com/sun/star/sdbcx/TableDescriptor.idl index 9d3dedda71d0..9bc93a3c8537 100644 --- a/offapi/com/sun/star/sdbcx/TableDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/TableDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,14 @@ interface XKeysSupplier; /** is used to define a table of a database. A table is described by its name and one or more columns and the keys for semantic rules. - <p>In addition, it may contain indexes to improve the performance in - retrieving the tables data and keys, and to define semantic rules for the table. - - </p>@see com::sun::star::sdbcx::Table + <p> + In addition, it may contain keys, and to define semantic rules for the table. + <b> + Note: + </b> + Indexes can only be appended when the table is already appended at the database. + </p> + @see com::sun::star::sdbcx::Table */ service TableDescriptor { @@ -122,6 +126,12 @@ service TableDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 09:37:12 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:34 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/User.idl b/offapi/com/sun/star/sdbcx/User.idl index 2454b266498f..b23c7a0bef86 100644 --- a/offapi/com/sun/star/sdbcx/User.idl +++ b/offapi/com/sun/star/sdbcx/User.idl @@ -2,9 +2,9 @@ * * $RCSfile: User.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ interface XUser; */ service User { - // DocMerge: empty anyway + // used to change the password. interface XUser; // DocMerge from xml: service com::sun::star::sdbcx::User: interface com::sun::star::sdbcx::XGroupsSupplier @@ -86,12 +86,12 @@ service User */ [optional] interface XGroupsSupplier; - // DocMerge: empty anyway + // gives access to the properties interface com::sun::star::beans::XPropertySet; // DocMerge from xml: property com::sun::star::sdbcx::User::Name - /** is the name of the view. + /** is the name of the user. */ [readonly, property] string Name; }; @@ -102,6 +102,15 @@ service User /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/01/23 10:08:35 mi optional interfaces now marked as [optional] instead of just a prosa description of this fact diff --git a/offapi/com/sun/star/sdbcx/UserDescriptor.idl b/offapi/com/sun/star/sdbcx/UserDescriptor.idl index 0ea6488573b1..713e61e807cd 100644 --- a/offapi/com/sun/star/sdbcx/UserDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/UserDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: UserDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,8 @@ // DocMerge from xml: service com::sun::star::sdbcx::UserDescriptor -/** is used to create a new user in a database.@see com::sun::star::sdbcx::User +/** is used to create a new user in a database. + @see com::sun::star::sdbcx::User */ service UserDescriptor { @@ -89,6 +90,12 @@ service UserDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:44 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/View.idl b/offapi/com/sun/star/sdbcx/View.idl index 269b04da3ef1..ae72667364dd 100644 --- a/offapi/com/sun/star/sdbcx/View.idl +++ b/offapi/com/sun/star/sdbcx/View.idl @@ -2,9 +2,9 @@ * * $RCSfile: View.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,11 +74,15 @@ interface XRename; /** is used to specify views on data. A view object is only used for creation and deletion. Inspecting the command of a view is normally not supported. - - <p>If a view is going to be added to a database, the view must have a unique + <p> + If a view is going to be added to a database, the view must have a unique name within the view and the table container, as it can be used like a table. + <b> + Note: + </b> After addition, both the containers for views and the container for tables must - contain an element for the view.</p> + contain an element for the view. + </p> */ service View { @@ -88,7 +92,7 @@ service View */ [optional] interface XRename; - // DocMerge: empty anyway + // gives access to the properties. interface com::sun::star::beans::XPropertySet; @@ -119,7 +123,8 @@ service View // DocMerge from xml: property com::sun::star::sdbcx::View::CheckOption - /** indicates if a check option should be used for the view.@see com::sun::star::sdbcx::CheckOption + /** indicates if a check option should be used for the view. + @see com::sun::star::sdbcx::CheckOption */ [readonly, property] long CheckOption; }; @@ -130,6 +135,15 @@ service View /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.20.2 2002/02/18 12:57:56 oj + #97563# parameter,return value and exception description + + Revision 1.4.20.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/01/23 10:08:35 mi + optional interfaces now marked as [optional] instead of just a prosa description of this fact + Revision 1.3 2000/11/08 12:43:39 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/ViewDescriptor.idl b/offapi/com/sun/star/sdbcx/ViewDescriptor.idl index e5004dd192ef..f2810afb6ab6 100644 --- a/offapi/com/sun/star/sdbcx/ViewDescriptor.idl +++ b/offapi/com/sun/star/sdbcx/ViewDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ViewDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,8 @@ // DocMerge from xml: service com::sun::star::sdbcx::ViewDescriptor -/** is used to define a new view for a database.@see com::sun::star::sdbcx::View +/** is used to define a new view for a database. + @see com::sun::star::sdbcx::View */ service ViewDescriptor { @@ -98,7 +99,8 @@ service ViewDescriptor // DocMerge from xml: property com::sun::star::sdbcx::ViewDescriptor::CheckOption - /** indicates if a check option should be used for the view.@see com::sun::star::sdbcx::CheckOption + /** indicates if a check option should be used for the view. + @see com::sun::star::sdbcx::CheckOption */ [property] long CheckOption; }; @@ -109,6 +111,12 @@ service ViewDescriptor /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.3 2000/11/08 12:43:39 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:44 hjs initial import diff --git a/offapi/com/sun/star/sdbcx/XAlterTable.idl b/offapi/com/sun/star/sdbcx/XAlterTable.idl index 8ba8c1227d50..627a9ffcb6ba 100644 --- a/offapi/com/sun/star/sdbcx/XAlterTable.idl +++ b/offapi/com/sun/star/sdbcx/XAlterTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAlterTable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,9 +91,18 @@ interface XAlterTable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XAlterTable::alterColumnByName /** is intended to alter an existing column identified by its name. - This operation must be atomar. - -<!-- JRH: My apologies, but what is 'atomar'? Please add, ", i.e., xxx xx xxxx". -->*/ + This operation must be atomar. Atomar means that the operation must be done inone step. + <b> + Note: + </b> + Atomar is nower days the wrong word, because we know that there exists smaller elements than atoms. + @param colName + the column name which to alter + @param descriptor + the new descriptor for the new column + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ void alterColumnByName([in]string colName, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, @@ -103,8 +112,13 @@ interface XAlterTable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XAlterTable::alterColumnByIndex /** is intended to alter an existing column identified by its position. This operation must be atomar. - -<!-- JRH: atomar? --> */ + @param index + the position of the column to alter + @param descriptor + the new descriptor for the new column + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ void alterColumnByIndex([in]long index, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, @@ -117,6 +131,12 @@ interface XAlterTable: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XAppend.idl b/offapi/com/sun/star/sdbcx/XAppend.idl index d5010b944d04..a562c85235db 100644 --- a/offapi/com/sun/star/sdbcx/XAppend.idl +++ b/offapi/com/sun/star/sdbcx/XAppend.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAppend.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,6 +88,14 @@ interface XAppend: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XAppend::appendByDescriptor /** creates a new object using the given descriptor and appends it to the related container. + <b> + Note: + </b> + The descriptor will not be changed and can be used again to append another object. + @param descriptor + the descriptor which should be serve to append a new object + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void appendByDescriptor([in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, @@ -100,6 +108,12 @@ interface XAppend: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XAuthorizable.idl b/offapi/com/sun/star/sdbcx/XAuthorizable.idl index 771e02495784..c9ba47ea424e 100644 --- a/offapi/com/sun/star/sdbcx/XAuthorizable.idl +++ b/offapi/com/sun/star/sdbcx/XAuthorizable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAuthorizable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,12 +74,22 @@ // DocMerge from xml: interface com::sun::star::sdbcx::XAuthorizable /** is used for accessing and setting the permissions of a user for a database object. + @see com::sun::star::sdbcx::PrivilegeObject */ interface XAuthorizable: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::getPrivileges /** retrieves the permissions for a specific object. + @param objName + the name of the object + @param objType + a value of + <type scope="com::sun::star::sdbcx">PrivilegeObject</Type> + @returns + the privileges + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ long getPrivileges([in]string objName, [in]long objType) raises (com::sun::star::sdbc::SQLException); @@ -88,6 +98,15 @@ interface XAuthorizable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::getGrantablePrivileges /** retrieves the permissions for a specific object, which could be granted to other users and groups. + @param objName + the name of the object + @param objType + a value of + <type scope="com::sun::star::sdbcx">PrivilegeObject</Type> + @returns + the grant privileges + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ long getGrantablePrivileges([in]string objName, [in]long objType) raises (com::sun::star::sdbc::SQLException); @@ -95,6 +114,13 @@ interface XAuthorizable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::grantPrivileges /** adds additional permissions for a specific object. + @param objName + the name of the object + @param objType + a value of + <type scope="com::sun::star::sdbcx">PrivilegeObject</Type> + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void grantPrivileges([in]string objName, [in]long objType, [in]long objPrivileges) raises @@ -103,6 +129,13 @@ interface XAuthorizable: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::revokePrivileges /** removes permissions for a specific object from a group or user. + @param objName + the name of the object + @param objType + a value of + <type scope="com::sun::star::sdbcx">PrivilegeObject</Type> + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void revokePrivileges([in]string objName, [in]long objType, [in]long objPrivileges) raises @@ -115,6 +148,12 @@ interface XAuthorizable: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XColumnsSupplier.idl b/offapi/com/sun/star/sdbcx/XColumnsSupplier.idl index ce93fe17153d..1d2dda11670f 100644 --- a/offapi/com/sun/star/sdbcx/XColumnsSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XColumnsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XColumnsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,6 +85,8 @@ interface XColumnsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XColumnsSupplier::getColumns /** returns the container of columns. + @rerurns + the columns */ com::sun::star::container::XNameAccess getColumns(); }; @@ -95,6 +97,12 @@ interface XColumnsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XCreateCatalog.idl b/offapi/com/sun/star/sdbcx/XCreateCatalog.idl index d6636a4a38af..34083b25a6db 100644 --- a/offapi/com/sun/star/sdbcx/XCreateCatalog.idl +++ b/offapi/com/sun/star/sdbcx/XCreateCatalog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCreateCatalog.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,6 +89,12 @@ interface XCreateCatalog: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XCreateCatalog::createCatalog /** creates the catolog by using a sequence of property values. The kind of properties depends on the provider. + + @param info + driver specific information + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + */ void createCatalog([in]sequence<com::sun::star::beans::PropertyValue> info) raises (com::sun::star::sdbc::SQLException, @@ -101,6 +107,12 @@ interface XCreateCatalog: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl b/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl index a4aab6dec502..28fda5506ec8 100644 --- a/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataDefinitionSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,6 +90,12 @@ interface XDataDefinitionSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdbcx::XDataDefinitionSupplier::getDataDefinitionByConnection /** returns at least the container of tables related to the given connection. + @param connection + the related connection + @returns + the container + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ XTablesSupplier getDataDefinitionByConnection( [in]com::sun::star::sdbc::XConnection connection) @@ -98,6 +104,15 @@ interface XDataDefinitionSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbc::com::sun::star::sdbcx::XDataDefinitionSupplier::getDataDefinitionByURL /** returns at least the container of tables related to the given Database URL. + @param url + a database url of the form sdbc:subprotocol:subname + @param info + a list of arbitrary string tag/value pairs as connection arguments; + normally at least a "user" and "password" property should be included + @returns + the container + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ XTablesSupplier getDataDefinitionByURL( [in]string url, @@ -111,6 +126,12 @@ interface XDataDefinitionSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDataDescriptorFactory.idl b/offapi/com/sun/star/sdbcx/XDataDescriptorFactory.idl index bd05e03ede07..80b5296d0419 100644 --- a/offapi/com/sun/star/sdbcx/XDataDescriptorFactory.idl +++ b/offapi/com/sun/star/sdbcx/XDataDescriptorFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataDescriptorFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,9 @@ interface XDataDescriptorFactory: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::com::sun::star::sdbcx::XDataDescriptorFactory::createDataDescriptor /** returns a descriptor of a definition object. + @returns + the descriptor for that kind of objects + @see com::sun::star::Container */ com::sun::star::beans::XPropertySet createDataDescriptor(); }; @@ -89,6 +92,12 @@ interface XDataDescriptorFactory: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDeleteRows.idl b/offapi/com/sun/star/sdbcx/XDeleteRows.idl index dfadf60d703f..d1b589d754cf 100644 --- a/offapi/com/sun/star/sdbcx/XDeleteRows.idl +++ b/offapi/com/sun/star/sdbcx/XDeleteRows.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDeleteRows.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,7 @@ interface XDeleteRows: com::sun::star::uno::XInterface an array of update counts containing one element for each row. The array is ordered according to the order in which bookmarks were given. - @throws SQLException + @throws com::sun::star::sdbc::SQLException if a fatal error occurs, for intance, the connection gets lost if bookmarks are used which do not belong to the according result set. */ @@ -100,6 +100,12 @@ interface XDeleteRows: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XDrop.idl b/offapi/com/sun/star/sdbcx/XDrop.idl index 94b3e999320c..d6e1021aaf1b 100644 --- a/offapi/com/sun/star/sdbcx/XDrop.idl +++ b/offapi/com/sun/star/sdbcx/XDrop.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDrop.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,6 +88,10 @@ interface XDrop: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XDrop::dropByName /** drops an object of the related container identified by its name. + @param elementName + the name of the element to be dropped + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void dropByName([in]string elementName) raises (com::sun::star::sdbc::SQLException, @@ -96,6 +100,10 @@ interface XDrop: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XDrop::dropByIndex /** drops an object of the related container identified by its position. + @param index + the position of the element to be dropped + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void dropByIndex([in]long index) raises (com::sun::star::sdbc::SQLException, com::sun::star::lang::IndexOutOfBoundsException); @@ -107,6 +115,12 @@ interface XDrop: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XDropCatalog.idl b/offapi/com/sun/star/sdbcx/XDropCatalog.idl index f35e5633627a..4a1ca1495d27 100644 --- a/offapi/com/sun/star/sdbcx/XDropCatalog.idl +++ b/offapi/com/sun/star/sdbcx/XDropCatalog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDropCatalog.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,6 +90,12 @@ interface XDropCatalog: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XDropCatalog::dropCatalog /** drops a catalog identified by its name. + @param catalogName + the catalog name + @param info + driver specific information + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void dropCatalog([in]string catalogName, [in]sequence<com::sun::star::beans::PropertyValue> info) @@ -103,6 +109,12 @@ interface XDropCatalog: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl b/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl index 4baab7bb93d4..564ff2d9772d 100644 --- a/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XGroupsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGroupsSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XGroupsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XGroupsSupplier::getGroups /** returns the container of groups. + @returns + the groups */ com::sun::star::container::XNameAccess getGroups(); }; @@ -91,6 +93,12 @@ interface XGroupsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl b/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl index 5c947bbde528..26351c90dd6a 100644 --- a/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XIndexesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XIndexesSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XIndexesSupplier::getIndexes /** returns the container of indexes. + @returns + the indexes */ com::sun::star::container::XNameAccess getIndexes(); }; @@ -91,6 +93,12 @@ interface XIndexesSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XKeysSupplier.idl b/offapi/com/sun/star/sdbcx/XKeysSupplier.idl index 3b48c4ba7f70..c392aefcfa66 100644 --- a/offapi/com/sun/star/sdbcx/XKeysSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XKeysSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XKeysSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XKeysSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XKeysSupplier::getKeys /** returns the container of keys. + @returns + the keys */ com::sun::star::container::XIndexAccess getKeys(); }; @@ -91,6 +93,12 @@ interface XKeysSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XRename.idl b/offapi/com/sun/star/sdbcx/XRename.idl index 6a59247fd5ba..b0be06b0c904 100644 --- a/offapi/com/sun/star/sdbcx/XRename.idl +++ b/offapi/com/sun/star/sdbcx/XRename.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRename.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,8 @@ module com { module sun { module star { module sdbcx { // DocMerge from xml: interface com::sun::star::sdbcx::XRename -/** supports the renaming of definition objects.<br> +/** supports the renaming of definition objects. + <br/> This is a very desirable feature which is not supported by all databases. There is no standard SQL statement provided for this feature. @@ -86,6 +87,10 @@ interface XRename: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XRename::rename /** is intended to alter the name of a object. + @param newName + the new name + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void rename([in]string newName) raises (com::sun::star::sdbc::SQLException, @@ -98,6 +103,12 @@ interface XRename: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XRowLocate.idl b/offapi/com/sun/star/sdbcx/XRowLocate.idl index d329791e3555..f2da684a30f8 100644 --- a/offapi/com/sun/star/sdbcx/XRowLocate.idl +++ b/offapi/com/sun/star/sdbcx/XRowLocate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRowLocate.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,22 @@ /** is used to identify rows within a result set and to find rows by a bookmark. - <p>Bookmarks are only valid in the scope of the current result set and + <p> + Bookmarks are only valid in the scope of the current result set and are not interchangeable between result sets. A bookmark could be a complex data structure, so it could not be compared in a safe way. Because of that, a provider - has to implement the compare method for bookmarks.</p> + has to implement the compare method for bookmarks. + </p> */ interface XRowLocate: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::sdbcx::XRowLocate::getBookmark /** returns the bookmark of the current row of a result set. + @returns + the current bookmark + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ any getBookmark() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- @@ -93,12 +99,19 @@ interface XRowLocate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XRowLocate::moveToBookmark /** moves the cursor to the row identified by an valid bookmark. - - <p> If the bookmark could not be located, a result set will be positioned - after the last record.<br> + <p> + If the bookmark could not be located, a result set will be positioned + after the last record. + <br/> If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> + @param bookmark + the bookmark where to move + @returns + <TRUE/> if successful + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ boolean moveToBookmark([in]any bookmark) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- @@ -108,11 +121,21 @@ interface XRowLocate: com::sun::star::uno::XInterface starting at a given bookmark position. - <p>If the bookmark could not be located, a result set will be positioned - after the last record.<br> + <p> + If the bookmark could not be located, a result set will be positioned + after the last record. + <br/> If the bookmark is invalid, or not generated by the current result set, then the behaviour is not defined, even an abnormal termination is possible. </p> + @param bookmark + the bookmark where to move + @param rows + count of rows move relative to the bookmark + @returns + <TRUE/> if successful + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ boolean moveRelativeToBookmark([in]any bookmark, [in]long rows) raises (com::sun::star::sdbc::SQLException); @@ -121,26 +144,48 @@ interface XRowLocate: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XRowLocate::compareBookmarks /** compares two bookmarks and returns an indication of their relative values. - <p> The bookmarks must apply to the same ResultSet. You cannot reliably compare bookmarks from different ResultSets, even if they were created from - the same source or statement. <br> + the same source or statement. + <br/> A bookmark that is not valid, or incorrectly formed, will cause an exception. - </p>@see com::sun::star::sdbcx::CompareBookmark + </p> + @param first + the first bookmark + @param second + the second bookmark + @returns + a value of <type scope="com::sun::star::sdbcx">CompareBookmark</Type> + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + + @see com::sun::star::sdbcx::CompareBookmark + */ long compareBookmarks([in]any first, [in]any second) raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbcx::XRowLocate::hasOrderedBookmarks - /** determines whether the bookmarks of a result set are ordered or not.@see com::sun::star::sdbc::CompareBookmark + /** determines whether the bookmarks of a result set are ordered or not. + @returns + <TRUE/> if so + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. + @see com::sun::star::sdbc::CompareBookmark */ boolean hasOrderedBookmarks() raises (com::sun::star::sdbc::SQLException); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::sdbcx::XRowLocate::hashBookmark /** returns the hash value for a specified bookmark. + @param bookmark + the bookmark to hash + @returns + the hashed value + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ long hashBookmark([in]any bookmark) raises (com::sun::star::sdbc::SQLException); }; @@ -151,6 +196,12 @@ interface XRowLocate: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XTablesSupplier.idl b/offapi/com/sun/star/sdbcx/XTablesSupplier.idl index bab3531da04d..4705fef57716 100644 --- a/offapi/com/sun/star/sdbcx/XTablesSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XTablesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTablesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XTablesSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XTablesSupplier::getTables /** returns the container of tables. + @returns + the tables */ com::sun::star::container::XNameAccess getTables(); }; @@ -91,6 +93,12 @@ interface XTablesSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XUser.idl b/offapi/com/sun/star/sdbcx/XUser.idl index 95e04de1c19a..2dfec102091f 100644 --- a/offapi/com/sun/star/sdbcx/XUser.idl +++ b/offapi/com/sun/star/sdbcx/XUser.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUser.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,6 +75,12 @@ interface XUser: XAuthorizable // DocMerge from xml: method com::sun::star::sdbcx::XUser::changePassword /** allows modifying a user password. + @param oldPassword + the old password to be reset + @param newPassword + the new password + @throws com::sun::star::sdbc::SQLException + if a database access error occurs. */ void changePassword([in]string oldPassword, [in]string newPassword) raises (com::sun::star::sdbc::SQLException); @@ -86,6 +92,12 @@ interface XUser: XAuthorizable /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/sdbcx/XUsersSupplier.idl b/offapi/com/sun/star/sdbcx/XUsersSupplier.idl index 1f1c90bcd5c1..a2f4d5136236 100644 --- a/offapi/com/sun/star/sdbcx/XUsersSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XUsersSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUsersSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,6 +85,8 @@ interface XUsersSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XUsersSupplier::getUsers /** returns the container of users. + @returns + the users */ com::sun::star::container::XNameAccess getUsers(); }; @@ -95,6 +97,12 @@ interface XUsersSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:43:40 mi moved from api diff --git a/offapi/com/sun/star/sdbcx/XViewsSupplier.idl b/offapi/com/sun/star/sdbcx/XViewsSupplier.idl index f6aec70ceef7..7ef7dcd76b5f 100644 --- a/offapi/com/sun/star/sdbcx/XViewsSupplier.idl +++ b/offapi/com/sun/star/sdbcx/XViewsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewsSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-10-25 15:35:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,6 +81,8 @@ interface XViewsSupplier: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::sdbcx::XViewsSupplier::getViews /** returns the container of views. + @returns + the views */ com::sun::star::container::XNameAccess getViews(); }; @@ -91,6 +93,12 @@ interface XViewsSupplier: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/02/18 10:00:22 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/10/25 15:35:32 mi + proofreading and corrections from Richard Holt + Revision 1.4 2001/03/16 16:41:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/offapi/com/sun/star/setup/ActionType.idl b/offapi/com/sun/star/setup/ActionType.idl index 0698e2151a76..884f2d6d0563 100644 --- a/offapi/com/sun/star/setup/ActionType.idl +++ b/offapi/com/sun/star/setup/ActionType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ActionType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,54 +61,39 @@ #ifndef __com_sun_star_setup_ActionType_idl__ #define __com_sun_star_setup_ActionType_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated enum ActionType { - // DocMerge: empty anyway INVALID, - // DocMerge: empty anyway DOWNLOAD, - // DocMerge: empty anyway MAKEDIR, - // DocMerge: empty anyway DELETEDIR, - // DocMerge: empty anyway COPYFILE, - // DocMerge: empty anyway UNZIPFILE, - // DocMerge: empty anyway DELETEFILE, - // DocMerge: empty anyway MAKEFOLDER, - // DocMerge: empty anyway MAKEFOLDERITEM, - // DocMerge: empty anyway DELETEFOLDER, - // DocMerge: empty anyway DELETEFOLDERITEM, - // DocMerge: empty anyway PROFILEITEM, - // DocMerge: empty anyway FONT, - // DocMerge: empty anyway CREATESHORTCUT, - // DocMerge: empty anyway WINREGISTRY }; }; }; }; }; diff --git a/offapi/com/sun/star/setup/BaseAction.idl b/offapi/com/sun/star/setup/BaseAction.idl index 7a75ab4c7c97..1ac5a9021801 100644 --- a/offapi/com/sun/star/setup/BaseAction.idl +++ b/offapi/com/sun/star/setup/BaseAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: BaseAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/ActionType.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/CopyFileAction.idl b/offapi/com/sun/star/setup/CopyFileAction.idl index 301c342d30dc..87118cf60b73 100644 --- a/offapi/com/sun/star/setup/CopyFileAction.idl +++ b/offapi/com/sun/star/setup/CopyFileAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: CopyFileAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2001-09-07 07:03:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,9 +69,9 @@ #include <com/sun/star/util/DateTime.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct CopyFileAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/DeleteDirAction.idl b/offapi/com/sun/star/setup/DeleteDirAction.idl index 810f5bf4b976..2ff624d0ce34 100644 --- a/offapi/com/sun/star/setup/DeleteDirAction.idl +++ b/offapi/com/sun/star/setup/DeleteDirAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeleteDirAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct DeleteDirAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/DeleteFileAction.idl b/offapi/com/sun/star/setup/DeleteFileAction.idl index 657d11529acf..7bc0c5237648 100644 --- a/offapi/com/sun/star/setup/DeleteFileAction.idl +++ b/offapi/com/sun/star/setup/DeleteFileAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeleteFileAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2001-09-07 07:03:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,9 +69,9 @@ #include <com/sun/star/util/DateTime.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct DeleteFileAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/DeleteFolderAction.idl b/offapi/com/sun/star/setup/DeleteFolderAction.idl index 4fdea01f308e..a32f5186c91d 100644 --- a/offapi/com/sun/star/setup/DeleteFolderAction.idl +++ b/offapi/com/sun/star/setup/DeleteFolderAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeleteFolderAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct DeleteFolderAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/DeleteFolderItemAction.idl b/offapi/com/sun/star/setup/DeleteFolderItemAction.idl index 6f5c6217b26a..c64dbd48d3d6 100644 --- a/offapi/com/sun/star/setup/DeleteFolderItemAction.idl +++ b/offapi/com/sun/star/setup/DeleteFolderItemAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: DeleteFolderItemAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct DeleteFolderItemAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/DownloadAction.idl b/offapi/com/sun/star/setup/DownloadAction.idl index 9b11900c487d..197c146e5e54 100644 --- a/offapi/com/sun/star/setup/DownloadAction.idl +++ b/offapi/com/sun/star/setup/DownloadAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: DownloadAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct DownloadAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/FontAction.idl b/offapi/com/sun/star/setup/FontAction.idl index ebba4cdd2779..4c8ed1df2576 100644 --- a/offapi/com/sun/star/setup/FontAction.idl +++ b/offapi/com/sun/star/setup/FontAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: FontAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct FontAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/InstallEnvironment.idl b/offapi/com/sun/star/setup/InstallEnvironment.idl index a7f037613da7..9e772e8ce9a2 100644 --- a/offapi/com/sun/star/setup/InstallEnvironment.idl +++ b/offapi/com/sun/star/setup/InstallEnvironment.idl @@ -2,9 +2,9 @@ * * $RCSfile: InstallEnvironment.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2000-11-27 10:03:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/ModuleState.idl> #include <com/sun/star/setup/InstallType.idl> - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct InstallEnvironment { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/InstallResponse.idl b/offapi/com/sun/star/setup/InstallResponse.idl index ef16aba191d4..3f397173745a 100644 --- a/offapi/com/sun/star/setup/InstallResponse.idl +++ b/offapi/com/sun/star/setup/InstallResponse.idl @@ -2,9 +2,9 @@ * * $RCSfile: InstallResponse.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_InstallResponse_idl__ #define __com_sun_star_setup_InstallResponse_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated enum ResponseErrorCode { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/InstallType.idl b/offapi/com/sun/star/setup/InstallType.idl index fca886df69e3..29f83cf144f5 100644 --- a/offapi/com/sun/star/setup/InstallType.idl +++ b/offapi/com/sun/star/setup/InstallType.idl @@ -2,9 +2,9 @@ * * $RCSfile: InstallType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2000-11-16 14:06:55 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,7 +63,7 @@ module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated enum InstallType { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/MakeDirAction.idl b/offapi/com/sun/star/setup/MakeDirAction.idl index d22693aa6df8..6998cb9fa42a 100644 --- a/offapi/com/sun/star/setup/MakeDirAction.idl +++ b/offapi/com/sun/star/setup/MakeDirAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: MakeDirAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct MakeDirAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/MakeFolderAction.idl b/offapi/com/sun/star/setup/MakeFolderAction.idl index 59e45f346584..d7d5ed8284b1 100644 --- a/offapi/com/sun/star/setup/MakeFolderAction.idl +++ b/offapi/com/sun/star/setup/MakeFolderAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: MakeFolderAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct MakeFolderAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/MakeFolderItemAction.idl b/offapi/com/sun/star/setup/MakeFolderItemAction.idl index 34f778888044..b51b7ce072c8 100644 --- a/offapi/com/sun/star/setup/MakeFolderItemAction.idl +++ b/offapi/com/sun/star/setup/MakeFolderItemAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: MakeFolderItemAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct MakeFolderItemAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/MakeShortcutAction.idl b/offapi/com/sun/star/setup/MakeShortcutAction.idl index d6ab0ed47272..0284422a34b2 100644 --- a/offapi/com/sun/star/setup/MakeShortcutAction.idl +++ b/offapi/com/sun/star/setup/MakeShortcutAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: MakeShortcutAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct MakeShortcutAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/MirrorEntry.idl b/offapi/com/sun/star/setup/MirrorEntry.idl index f1b71c742801..14f8fd5378ba 100644 --- a/offapi/com/sun/star/setup/MirrorEntry.idl +++ b/offapi/com/sun/star/setup/MirrorEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: MirrorEntry.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_MirrorEntry_idl__ #define __com_sun_star_setup_MirrorEntry_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct MirrorEntry { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/ModuleInfo.idl b/offapi/com/sun/star/setup/ModuleInfo.idl index c0965365854e..8a5a59cf459d 100644 --- a/offapi/com/sun/star/setup/ModuleInfo.idl +++ b/offapi/com/sun/star/setup/ModuleInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: ModuleInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_ModuleInfo_idl__ #define __com_sun_star_setup_ModuleInfo_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct ModuleInfo { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/ModuleState.idl b/offapi/com/sun/star/setup/ModuleState.idl index c776591ff754..0c4fd9dd216e 100644 --- a/offapi/com/sun/star/setup/ModuleState.idl +++ b/offapi/com/sun/star/setup/ModuleState.idl @@ -2,9 +2,9 @@ * * $RCSfile: ModuleState.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_ModuleState_idl__ #define __com_sun_star_setup_ModuleState_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct ModuleState { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/OSType.idl b/offapi/com/sun/star/setup/OSType.idl index 5524fece9280..702dc04d870c 100644 --- a/offapi/com/sun/star/setup/OSType.idl +++ b/offapi/com/sun/star/setup/OSType.idl @@ -2,9 +2,9 @@ * * $RCSfile: OSType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2000-12-18 15:34:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_OSType_idl__ #define __com_sun_star_setup_OSType_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated enum OSType { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/ProfileItemAction.idl b/offapi/com/sun/star/setup/ProfileItemAction.idl index 481e59253d38..fd9d4b9eabb1 100644 --- a/offapi/com/sun/star/setup/ProfileItemAction.idl +++ b/offapi/com/sun/star/setup/ProfileItemAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProfileItemAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct ProfileItemAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/Setup.idl b/offapi/com/sun/star/setup/Setup.idl index d3d538f8f5f5..81d5406b4922 100644 --- a/offapi/com/sun/star/setup/Setup.idl +++ b/offapi/com/sun/star/setup/Setup.idl @@ -2,9 +2,9 @@ * * $RCSfile: Setup.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,9 +67,9 @@ #include <com/sun/star/lang/XServiceInfo.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated service Setup { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/SizeInfo.idl b/offapi/com/sun/star/setup/SizeInfo.idl index b8fab0b65325..152b73ab6cfa 100644 --- a/offapi/com/sun/star/setup/SizeInfo.idl +++ b/offapi/com/sun/star/setup/SizeInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: SizeInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:34 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_SizeInfo_idl__ #define __com_sun_star_setup_SizeInfo_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct SizeInfo { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/UnzipAction.idl b/offapi/com/sun/star/setup/UnzipAction.idl index 370e11bf6c16..f146d6410cec 100644 --- a/offapi/com/sun/star/setup/UnzipAction.idl +++ b/offapi/com/sun/star/setup/UnzipAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnzipAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: ok $ $Date: 2001-09-07 07:03:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,9 +69,9 @@ #include <com/sun/star/util/DateTime.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct UnzipAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/UpdateType.idl b/offapi/com/sun/star/setup/UpdateType.idl index 14468fefeb86..2994d6714d08 100644 --- a/offapi/com/sun/star/setup/UpdateType.idl +++ b/offapi/com/sun/star/setup/UpdateType.idl @@ -2,9 +2,9 @@ * * $RCSfile: UpdateType.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: ok $ $Date: 2000-11-16 14:05:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,9 +61,9 @@ #ifndef __com_sun_star_setup_UpdateType_idl__ #define __com_sun_star_setup_UpdateType_idl__ - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated enum UpdateType { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/VersionIdentifier.idl b/offapi/com/sun/star/setup/VersionIdentifier.idl index 3e57ff0a9c7d..979b53487a4e 100644 --- a/offapi/com/sun/star/setup/VersionIdentifier.idl +++ b/offapi/com/sun/star/setup/VersionIdentifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: VersionIdentifier.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,9 +63,9 @@ #include <com/sun/star/setup/OSType.idl> - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct VersionIdentifier { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/WindowsRegistryAction.idl b/offapi/com/sun/star/setup/WindowsRegistryAction.idl index 45b50e87097d..70bea7a54c87 100644 --- a/offapi/com/sun/star/setup/WindowsRegistryAction.idl +++ b/offapi/com/sun/star/setup/WindowsRegistryAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: WindowsRegistryAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,9 +65,9 @@ #include <com/sun/star/setup/BaseAction.idl> #endif - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated struct WindowsRegistryAction: BaseAction { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/setup/XSetup.idl b/offapi/com/sun/star/setup/XSetup.idl index 7ece89b17da6..8e54a4061fa8 100644 --- a/offapi/com/sun/star/setup/XSetup.idl +++ b/offapi/com/sun/star/setup/XSetup.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSetup.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: ok $ $Date: 2001-11-06 08:51:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:36 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,9 +74,9 @@ #include <com/sun/star/setup/SizeInfo.idl> #include <com/sun/star/setup/MirrorEntry.idl> - module com { module sun { module star { module setup { +module com { module sun { module star { module setup { -// DocMerge: empty anyway +/// @deprecated interface XSetup: com::sun::star::uno::XInterface { // DocMerge: empty anyway diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index 8322f8405f57..02f793601022 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -2,9 +2,9 @@ * * $RCSfile: AddIn.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: nn $ $Date: 2001-02-19 19:52:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_AddIn_idl__ #define __com_sun_star_sheet_AddIn_idl__ @@ -73,19 +74,15 @@ #include <com/sun/star/sheet/XCompatibilityNames.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::AddIn /** is the base for AddIn services that supply functions which can be called by other components. - - <p>Any AddIn implementation must implement a service describing its specific set of functions. That service must contain the <type>AddIn</type> service, and the @@ -95,112 +92,70 @@ must describe the individual functions.</p> <p>Each AddIn function can take parameters of the following types:</p> + <dl> - <dt> - <atom>long</atom> - </dt> - <dd>for integer values. - </dd> - <dt> - <atom>double</atom> - </dt> - <dd>for floating point values. - </dd> - <dt> - <atom>string</atom> - </dt> - <dd>for text strings. - </dd> - <dt> - <atom>long[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of integer values. - </dd> - <dt> - <atom>double[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of floating point values. - </dd> - <dt> - <atom>string[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of text strings. - </dd> - <dt> - <atom>any[][]</atom> - </dt> - <dd>for (two-dimensional) arrays of mixed contents. - Each <atom>any</atom> will contain a <atom>double</atom> - or a <atom>string</atom>, depending on the data. - </dd> - <dt> - <atom>any</atom> - </dt> - <dd>Depending on the data, a <atom>double</atom>, - a <atom>string</atom>, or an - <atom>any[][]</atom> - will be passed. If no argument is specified in the - function call, <void/> will be passed. This allows - for optional parameters. - </dd> - <dt> - <type scope="com::sun::star::table">XCellRange</type> - </dt> - <dd>for a <type scope="com::sun::star::table">XCellRange</type> - interface to the source data. - </dd> - <dt> - <type scope="com::sun::star::beans">XPropertySet</type> - </dt> + <dt><atom>long</atom></dt> + <dd>for integer values.</dd> + + <dt><atom>double</atom></dt> + <dd>for floating point values.</dd> + + <dt><atom>string</atom></dt> + <dd>for text strings.</dd> + + <dt><atom>long[][]</atom></dt> + <dd>for (two-dimensional) arrays of integer values.</dd> + + <dt><atom>double[][]</atom></dt> + <dd>for (two-dimensional) arrays of floating point values.</dd> + + <dt><atom>string[][]</atom></dt> + <dd>for (two-dimensional) arrays of text strings.</dd> + + <dt><atom>any[][]</atom></dt> + <dd>for (two-dimensional) arrays of mixed contents. Each <atom>any</atom> + will contain a <atom>double</atom> or a <atom>string</atom>, depending on + the data.</dd> + + <dt><atom>any</atom></dt> + <dd>Depending on the data, a <atom>double</atom>, a <atom>string</atom>, + or an <atom>any[][]</atom> will be passed. If no argument is specified in + the function call, <void/> will be passed. This allows for optional + parameters.</dd> + + <dt><type scope="com::sun::star::table">XCellRange</type></dt> + <dd>for a <type scope="com::sun::star::table">XCellRange</type> interface + to the source data.</dd> + + <dt><type scope="com::sun::star::beans">XPropertySet</type></dt> <dd>for a <type scope="com::sun::star::beans">XPropertySet</type> - interface to the <type>SpreadsheetDocument</type> - making the function call. Only one parameter of this type - is allowed in each function. It can be used to query - document settings like - <member>SpreadsheetDocumentSettings::NullDate</member>. - </dd> - <dt> - <atom>any[]</atom> - </dt> - <dd>for varying parameters. Only the last parameter of a - function may have this type. It will be filled with the - remaining arguments of the function call that were not - used for the previous parameters. Each element of the - sequence will be filled as in the case of - <atom>any</atom> above. - </dd> + interface to the <type>SpreadsheetDocument</type> making the function + call. Only one parameter of this type is allowed in each function. It + can be used to query document settings like + <member>SpreadsheetDocumentSettings::NullDate</member>.</dd> + + <dt><atom>any[]</atom></dt> + <dd>for varying parameters. Only the last parameter of a function may + have this type. It will be filled with the remaining arguments of the + function call that were not used for the previous parameters. Each + element of the sequence will be filled as in the case of <atom>any</atom> + above.</dd> </dl> <p>Each AddIn function must have one of the following return types:</p> + <ul> - <li> - <atom>long</atom> - </li> - <li> - <atom>double</atom> - </li> - <li> - <atom>string</atom> - </li> - <li> - <atom>long[][]</atom> - </li> - <li> - <atom>double[][]</atom> - </li> - <li> - <atom>string[][]</atom> - </li> - <li> - <atom>any[][]</atom> - </li> - <li> - <type>XVolatileResult</type> - </li> - <li> - <atom>any</atom> - </li> + <li><atom>long</atom></li> + <li><atom>double</atom></li> + <li><atom>string</atom></li> + <li><atom>long[][]</atom></li> + <li><atom>double[][]</atom></li> + <li><atom>string[][]</atom></li> + <li><atom>any[][]</atom></li> + <li><type>XVolatileResult</type></li> + <li><atom>any</atom></li> </ul> + <p>The sequences must contain arrays as described above for the parameter types. An <type>XVolatileResult</type> return value must contain an object @@ -211,14 +166,22 @@ */ service AddIn { - // DocMerge: empty anyway + // ------------------------------------------------------------------------ + + /** contains a method that returns the service name of the add-in. + */ interface com::sun::star::lang::XServiceName; - // DocMerge: empty anyway + // ------------------------------------------------------------------------ + + /** provides access to function descriptions and localized names + and descriptions. + */ interface com::sun::star::sheet::XAddIn; - /** This optional interface gives access to compatibility names for - the functions. + // ------------------------------------------------------------------------ + + /** provides access to compatibility names for the functions. */ [optional] interface com::sun::star::sheet::XCompatibilityNames; }; @@ -227,33 +190,5 @@ service AddIn }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/19 13:59:41 mi - syntax errors in documentation fixed - - Revision 1.4 2000/12/19 13:13:17 mi - no dim='[][]' anymore for new document generator - - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.2 2000/10/05 12:51:28 mi - sequences presentation in documentation as attribute dim=[] - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/Border.idl b/offapi/com/sun/star/sheet/Border.idl index 3f1af5edfbad..adb6f4d9d1f1 100644 --- a/offapi/com/sun/star/sheet/Border.idl +++ b/offapi/com/sun/star/sheet/Border.idl @@ -2,9 +2,9 @@ * * $RCSfile: Border.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,41 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_Border_idl__ #define __com_sun_star_sheet_Border_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::Border -/** selects one of the four borders of a cell range. +/** is used to select one of the four borders of a cell range. */ enum Border { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::Border::TOP - /** The top border. + /** selects the top border. */ TOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::Border::BOTTOM - /** The bottom border. + /** selects the bottom border. */ BOTTOM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::Border::RIGHT - /** The right border. + /** selects the right border. */ RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::Border::LEFT - /** The left border. + /** selects the left border. */ LEFT @@ -107,18 +102,5 @@ enum Border }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotation.idl b/offapi/com/sun/star/sheet/CellAnnotation.idl index 62a540853471..a2011c8aa704 100644 --- a/offapi/com/sun/star/sheet/CellAnnotation.idl +++ b/offapi/com/sun/star/sheet/CellAnnotation.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAnnotation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,56 +58,60 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellAnnotation_idl__ #define __com_sun_star_sheet_CellAnnotation_idl__ -#ifndef __com_sun_star_text_XText_idl__ -#include <com/sun/star/text/XText.idl> -#endif - #ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ #include <com/sun/star/sheet/XSheetAnnotation.idl> #endif +#ifndef __com_sun_star_container_XChild_idl__ +#include <com/sun/star/container/XChild.idl> +#endif + +#ifndef __com_sun_star_text_XSimpleText_idl__ +#include <com/sun/star/text/XSimpleText.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellAnnotation -/** an annotation of a cell. +/** represents a cell annotation object attached to a spreadsheet cell. + + @see com::sun::star::sheet::SheetCell */ service CellAnnotation { - // DocMerge: empty anyway - interface com::sun::star::text::XSimpleText; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides methods to query data of the annotation + and to show and hide it. + */ interface com::sun::star::sheet::XSheetAnnotation; -}; + //------------------------------------------------------------------------- -//============================================================================= - -}; }; }; }; + /** provides access to the parent of this object. -/*============================================================================= + <p>The parent of a cell annotation is the cell that contains it.</p> + */ + interface com::sun::star::container::XChild; - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.4 2000/09/11 11:52:47 mi - documentation merged from XML + /** provides access to the text contents of the annotation. + */ + interface com::sun::star::text::XSimpleText; - Revision 1.2 2000/01/28 16:24:53 mi - #72213# XSimpleText +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotations.idl b/offapi/com/sun/star/sheet/CellAnnotations.idl index 29552e34c736..f6eadf1f22a8 100644 --- a/offapi/com/sun/star/sheet/CellAnnotations.idl +++ b/offapi/com/sun/star/sheet/CellAnnotations.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAnnotations.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellAnnotations_idl__ #define __com_sun_star_sheet_CellAnnotations_idl__ @@ -65,39 +66,44 @@ #include <com/sun/star/sheet/XSheetAnnotations.idl> #endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellAnnotations -/** a collection of cell annotations. +/** represents a collection of cell annotations. + + @see com::sun::star::sheet::Spreadsheet */ service CellAnnotations { - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetAnnotations; + //------------------------------------------------------------------------- -}; + /** provides methods to access cell annotations via index and to + insert and remove annotations. -//============================================================================= + @see com::sun::star::sheet::CellAnnotation + */ + interface com::sun::star::sheet::XSheetAnnotations; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** creates an enumeration of all cell annotations. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + @see com::sun::star::sheet::CellAnnotationsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl b/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl new file mode 100644 index 000000000000..1cd3fc08d519 --- /dev/null +++ b/offapi/com/sun/star/sheet/CellAnnotationsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: CellAnnotationsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_CellAnnotationsEnumeration_idl__ +#define __com_sun_star_sheet_CellAnnotationsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell annotations in a spreadsheet document. + + @see com::sun::star::sheet::CellAnnotations + */ +service CellAnnotationsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell annotations in the enumeration. + + @see com::sun::star::sheet::CellAnnotation + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLink.idl b/offapi/com/sun/star/sheet/CellAreaLink.idl index 659c281b68f8..f74be4ebc1ee 100644 --- a/offapi/com/sun/star/sheet/CellAreaLink.idl +++ b/offapi/com/sun/star/sheet/CellAreaLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAreaLink.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dr $ $Date: 2001-04-05 10:01:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellAreaLink_idl__ #define __com_sun_star_sheet_CellAreaLink_idl__ @@ -73,54 +74,62 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellAreaLink -/** a linked cell range. +/** represents a linked cell range. + + <p>A linked cell range is a range which is linked to an equal-sized + range in an external document. The contents of the external range is + copied into the range of this document.</p> + + @see com::sun::star::sheet::CellAreaLinks */ service CellAreaLink { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to change the settings of the linked cell range. + */ interface com::sun::star::sheet::XAreaLink; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to reload the external data. + */ interface com::sun::star::util::XRefreshable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //======================================================================== - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::Url /** specifies the URL of the source document. */ [property] string Url; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::Filter - /** specifies the name of the filter needed - to load the source document. + /** specifies the name of the filter used to load the source document. */ [property] string Filter; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::CellAreaLink::FilterOptions - /** specifies the filter options needed - to load the source document. + /** specifies the filter options needed to load the source document. */ [property] string FilterOptions; //------------------------------------------------------------------------- - /** specifies the delay time between - two refresh actions in seconds. + /** specifies the delay time between two refresh actions in seconds. */ [property] long RefreshDelay; @@ -130,27 +139,5 @@ service CellAreaLink }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLinks.idl b/offapi/com/sun/star/sheet/CellAreaLinks.idl index 669034a8c920..24226701de87 100644 --- a/offapi/com/sun/star/sheet/CellAreaLinks.idl +++ b/offapi/com/sun/star/sheet/CellAreaLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellAreaLinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,60 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellAreaLinks_idl__ #define __com_sun_star_sheet_CellAreaLinks_idl__ #ifndef __com_sun_star_sheet_XAreaLinks_idl__ #include <com/sun/star/sheet/XAreaLinks.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellAreaLinks -/** a collection of area links. +/** represents a collection of area links. + + @see com::sun::star::sheet::CellAreaLink + @see com::sun::star::sheet::SpreadsheetDocument */ service CellAreaLinks { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access via index to a collection of area links and inserting + and removing area links. + */ interface com::sun::star::sheet::XAreaLinks; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides access to the area links via index. -}; }; }; }; + @see com::sun::star::sheet::CellAreaLink -/*============================================================================= + */ + interface com::sun::star::container::XIndexAccess; - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML + /** creates an enumeration of all area links. - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + @see com::sun::star::sheet::CellAreaLinksEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl b/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl new file mode 100644 index 000000000000..97af914380fd --- /dev/null +++ b/offapi/com/sun/star/sheet/CellAreaLinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: CellAreaLinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:41 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_CellAreaLinksEnumeration_idl__ +#define __com_sun_star_sheet_CellAreaLinksEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell area links. + + @see com::sun::star::sheet::CellAreaLink + */ +service CellAreaLinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell area links in the enumeration. + + @see com::sun::star::sheet::CellAreaLink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/CellDeleteMode.idl b/offapi/com/sun/star/sheet/CellDeleteMode.idl index 5032ff7af8d9..0d0326e11340 100644 --- a/offapi/com/sun/star/sheet/CellDeleteMode.idl +++ b/offapi/com/sun/star/sheet/CellDeleteMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellDeleteMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,46 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellDeleteMode_idl__ #define __com_sun_star_sheet_CellDeleteMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::CellDeleteMode -/** used to specify how cells are moved when cells are - deleted. +/** is used to specify how remaining cells are moved when cells are deleted. */ enum CellDeleteMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::NONE /** no cells are moved. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::UP /** the cells below the deleted cells are moved up. */ UP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::LEFT /** the cells to the right of the deleted cells are moved left. */ LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::ROWS /** entire rows below the deleted cells are moved up. */ ROWS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellDeleteMode::COLUMNS /** entire columns to the right of the deleted cells are moved left. */ COLUMNS @@ -115,18 +108,5 @@ enum CellDeleteMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellFlags.idl b/offapi/com/sun/star/sheet/CellFlags.idl index 66a27dd6a1ff..3e603f924fdb 100644 --- a/offapi/com/sun/star/sheet/CellFlags.idl +++ b/offapi/com/sun/star/sheet/CellFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFlags.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,87 +58,77 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellFlags_idl__ #define __com_sun_star_sheet_CellFlags_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::CellFlags /** These constants select different types of cell contents. - <P>The values can be combined. - They are used to insert, copy, or delete contents.</P> + <P>The values can be combined. They are used to insert, copy, or + delete contents.</P> */ constants CellFlags { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::VALUE - /** This value selects constant numeric values that are not formatted - as dates or times. + /** selects constant numeric values that are not formatted + as dates or times. */ const long VALUE = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::DATETIME - /** This value selects constant numeric values that have a date or time - number format. + /** selects constant numeric values that have a date or time + number format. */ const long DATETIME = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::STRING - /** This value selects constant strings. + /** selects constant strings. */ const long STRING = 4; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::ANNOTATION - /** This value selects cell annotations. + /** selects cell annotations. */ const long ANNOTATION = 8; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::FORMULA - /** This value selects formulas. + /** selects formulas. */ const long FORMULA = 16; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::HARDATTR - /** This value selects all explicit formatting, but not the - formatting which is applied implicitly through style sheets. + /** selects all explicit formatting, but not the formatting which is + applied implicitly through style sheets. */ const long HARDATTR = 32; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::STYLES - /** This value selects cell styles. + /** selects cell styles. */ const long STYLES = 64; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::OBJECTS - /** This value selects drawing objects. + /** selects drawing objects. */ const long OBJECTS = 128; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::CellFlags::EDITATTR - /** This value selects formatting within parts of the cell contents. + /** selects formatting within parts of the cell contents. */ const long EDITATTR = 256; @@ -148,21 +138,5 @@ constants CellFlags }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellFormatRanges.idl b/offapi/com/sun/star/sheet/CellFormatRanges.idl index 6d9fc8f82ecb..6d338ca4b575 100644 --- a/offapi/com/sun/star/sheet/CellFormatRanges.idl +++ b/offapi/com/sun/star/sheet/CellFormatRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFormatRanges.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,52 +58,56 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellFormatRanges_idl__ #define __com_sun_star_sheet_CellFormatRanges_idl__ +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + #ifndef __com_sun_star_container_XEnumerationAccess_idl__ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellFormatRanges -/** provides access to ranges with different formatting.@see com::sun::star::sheet::CellFormatRangesEnumeration +/** represents a collection of equal-formatted cell ranges. + + <p>All cells inside a cell range of this collection have the same + formatting attributes.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges + @see com::sun::star::sheet::UniqueCellFormatRanges */ service CellFormatRanges { - // DocMerge: empty anyway - interface com::sun::star::container::XEnumerationAccess; + //------------------------------------------------------------------------- -}; + /** provides methods to access the contained cell ranges by index. -//============================================================================= + @see com::sun::star::sheet::SheetCellRange + */ + interface com::sun::star::container::XIndexAccess; -}; }; }; }; - -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api + /** creates an enumeration of all cell ranges. - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + @see com::sun::star::sheet::CellFormatRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl b/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl index f247c8be344a..4379d8612a61 100644 --- a/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl +++ b/offapi/com/sun/star/sheet/CellFormatRangesEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellFormatRangesEnumeration.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ #define __com_sun_star_sheet_CellFormatRangesEnumeration_idl__ @@ -65,19 +66,24 @@ #include <com/sun/star/container/XEnumeration.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellFormatRangesEnumeration -/** enumerates ranges with different formatting. +/** represents an enumeration of equal-formatted cell ranges. + + @see com::sun::star::sheet::CellFormatRanges */ service CellFormatRangesEnumeration { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the cell ranges in the enumeration. + + @see com::sun::star::sheet::SheetCellRange + */ interface com::sun::star::container::XEnumeration; }; @@ -86,18 +92,5 @@ service CellFormatRangesEnumeration }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellInsertMode.idl b/offapi/com/sun/star/sheet/CellInsertMode.idl index 5f4a4ae19740..0017de738850 100644 --- a/offapi/com/sun/star/sheet/CellInsertMode.idl +++ b/offapi/com/sun/star/sheet/CellInsertMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellInsertMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,46 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellInsertMode_idl__ #define __com_sun_star_sheet_CellInsertMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::CellInsertMode -/** is used to specify how cells are moved when new cells are - inserted. +/** is used to specify how cells are moved when new cells are inserted. */ enum CellInsertMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::NONE /** no cells are moved. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::DOWN /** the cells below the inserted cells are moved down. */ DOWN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::RIGHT /** the cells to the right of the inserted cells are moved right. */ RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::ROWS /** entire rows below the inserted cells are moved down. */ ROWS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::CellInsertMode::COLUMNS /** entire columns to the right of the inserted cells are moved right. */ COLUMNS @@ -115,18 +108,5 @@ enum CellInsertMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/Cells.idl b/offapi/com/sun/star/sheet/Cells.idl index 3c048298bfe0..132b0830a57d 100644 --- a/offapi/com/sun/star/sheet/Cells.idl +++ b/offapi/com/sun/star/sheet/Cells.idl @@ -2,9 +2,9 @@ * * $RCSfile: Cells.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_Cells_idl__ #define __com_sun_star_sheet_Cells_idl__ @@ -65,19 +66,24 @@ #include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::Cells -/** provides access to single cells.@see com::sun::star::sheet::CellsEnumeration +/** represents a collection of used cells in a spreadsheet document. + + @see com::sun::star::sheet::SheetCell */ service Cells { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** creates an enumeration of all used cells. + + @see com::sun::star::sheet::CellsEnumeration + */ interface com::sun::star::container::XEnumerationAccess; }; @@ -86,24 +92,5 @@ service Cells }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:47 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/CellsEnumeration.idl b/offapi/com/sun/star/sheet/CellsEnumeration.idl index 3a9adae679f8..7be87a64b729 100644 --- a/offapi/com/sun/star/sheet/CellsEnumeration.idl +++ b/offapi/com/sun/star/sheet/CellsEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellsEnumeration.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_CellsEnumeration_idl__ #define __com_sun_star_sheet_CellsEnumeration_idl__ @@ -65,19 +66,24 @@ #include <com/sun/star/container/XEnumeration.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::CellsEnumeration -/** enumerates all cells. +/** represents an enumeration of spreadsheet cells. + + @see com::sun::star::sheet::Cells */ service CellsEnumeration { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the cells in the enumeration. + + @see com::sun::star::sheet::SheetCell + */ interface com::sun::star::container::XEnumeration; }; @@ -86,18 +92,5 @@ service CellsEnumeration }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/ConditionOperator.idl b/offapi/com/sun/star/sheet/ConditionOperator.idl index 0ad04ff4af34..35bb1922a387 100644 --- a/offapi/com/sun/star/sheet/ConditionOperator.idl +++ b/offapi/com/sun/star/sheet/ConditionOperator.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConditionOperator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,87 +58,76 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_ConditionOperator_idl__ #define __com_sun_star_sheet_ConditionOperator_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::ConditionOperator /** is used to specify the type of <type>XSheetCondition</type>. */ enum ConditionOperator { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NONE /** no condition is specified. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::EQUAL /** value has to be equal to the specified value. */ EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NOT_EQUAL /** the value must not be equal to the specified value. */ NOT_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::GREATER /** the value has to be greater than the specified value. */ GREATER, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::GREATER_EQUAL /** the value has to be greater than or equal to the specified value. */ GREATER_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::LESS /** the value has to be less than the specified value. */ LESS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::LESS_EQUAL /** the value has to be less than or equal to the specified value. */ LESS_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::BETWEEN /** the value has to be between the two specified values. */ BETWEEN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::NOT_BETWEEN /** the value has to be outside of the two specified values. */ NOT_BETWEEN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ConditionOperator::FORMULA /** the specified formula has to give a non-zero result. */ FORMULA @@ -149,18 +138,5 @@ enum ConditionOperator }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl b/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl index 69b6e27c0445..10124a77f94b 100644 --- a/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl +++ b/offapi/com/sun/star/sheet/ConsolidationDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConsolidationDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_ConsolidationDescriptor_idl__ #define __com_sun_star_sheet_ConsolidationDescriptor_idl__ @@ -65,19 +66,23 @@ #include <com/sun/star/sheet/XConsolidationDescriptor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::ConsolidationDescriptor -/** a description of how data are consolidated. +/** contains all settings of a data consolidation in a spreadsheet + document. + + @see com::sun::star::sheet::XConsolidatable */ service ConsolidationDescriptor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +/** provides methods to access the settings of the descriptor. + */ interface com::sun::star::sheet::XConsolidationDescriptor; }; @@ -86,18 +91,5 @@ service ConsolidationDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DDELink.idl b/offapi/com/sun/star/sheet/DDELink.idl index 746723a6a611..6722495ba5fb 100644 --- a/offapi/com/sun/star/sheet/DDELink.idl +++ b/offapi/com/sun/star/sheet/DDELink.idl @@ -2,9 +2,9 @@ * * $RCSfile: DDELink.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DDELink_idl__ #define __com_sun_star_sheet_DDELink_idl__ @@ -73,25 +74,36 @@ #include <com/sun/star/util/XRefreshable.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DDELink -/** a DDE link. +/** represents a DDE link. + + <p>A DDE link controls the results of a DDE spreadsheet formula.</p> */ service DDELink { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the DDE link. + + <p>A DDE link has the form <const>Application|Topic!Item</const>.</p> + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to change the settings of the DDE link. + */ interface com::sun::star::sheet::XDDELink; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to reload the external linked data. + */ interface com::sun::star::util::XRefreshable; }; @@ -100,18 +112,5 @@ service DDELink }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DDELinks.idl b/offapi/com/sun/star/sheet/DDELinks.idl index 06a6d987207c..6c1d375b6420 100644 --- a/offapi/com/sun/star/sheet/DDELinks.idl +++ b/offapi/com/sun/star/sheet/DDELinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: DDELinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,64 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DDELinks_idl__ #define __com_sun_star_sheet_DDELinks_idl__ #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DDELinks -/** a collection of DDE links. +/** represents a collection of DDE links. + + @see com::sun::star::sheet::DDELink + @see com::sun::star::sheet::SpreadsheetDocument */ service DDELinks { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the DDE links via the DDE link string. + + <p>A DDE link has the form <const>Application|Topic!Item</const>.</p> + */ interface com::sun::star::container::XNameAccess; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides access to the DDE links via index. -}; }; }; }; + @see com::sun::star::sheet::DDELink + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all DDE links. -/*============================================================================= + @see com::sun::star::sheet::DDELinksEnumeration - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DDELinksEnumeration.idl b/offapi/com/sun/star/sheet/DDELinksEnumeration.idl new file mode 100644 index 000000000000..c83d899794bc --- /dev/null +++ b/offapi/com/sun/star/sheet/DDELinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DDELinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DDELinksEnumeration_idl__ +#define __com_sun_star_sheet_DDELinksEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of DDE links. + + @see com::sun::star::sheet::DDELink + */ +service DDELinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the DDE links in the enumeration. + + @see com::sun::star::sheet::DDELink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataImportMode.idl b/offapi/com/sun/star/sheet/DataImportMode.idl index 568b24f292af..24784d680e01 100644 --- a/offapi/com/sun/star/sheet/DataImportMode.idl +++ b/offapi/com/sun/star/sheet/DataImportMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataImportMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,45 +58,40 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataImportMode_idl__ #define __com_sun_star_sheet_DataImportMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::DataImportMode /** used to specify which database contents are imported. */ enum DataImportMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::NONE /** nothing is imported. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::SQL /** a SQL query string is supplied. */ SQL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::TABLE /** the name of a database table is supplied. */ TABLE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataImportMode::QUERY /** the name of a database query is supplied. */ QUERY @@ -107,18 +102,5 @@ enum DataImportMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotField.idl b/offapi/com/sun/star/sheet/DataPilotField.idl index ca2f48ebf66a..dd96f0a7604b 100644 --- a/offapi/com/sun/star/sheet/DataPilotField.idl +++ b/offapi/com/sun/star/sheet/DataPilotField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotField_idl__ #define __com_sun_star_sheet_DataPilotField_idl__ @@ -77,42 +78,47 @@ #include <com/sun/star/sheet/GeneralFunction.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotField -/** a single field in a DataPilotDescriptor. +/** represents a single field in a data pilot table. + + <p>If the data pilot table is based on a spreadsheet cell range, a + field is representred by a column of the range and is named using + the topmost cell of the column.</p> */ service DataPilotField { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the data pilot field. + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::DataPilotField::Orientation - /** this attribute specifies the orientation of the field. + /** specifies the orientation of the field. */ [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotField::Function - /** this attribute specifies the function of the field. - - + /** specifies the function used to calculate results for this field. <p>For column and row fields, this is the function for subtotals - (<const>GeneralFunction::NONE</const> = no subtotals). - For data fields, this is the function - shown in the data pilot table.</p> + (<const>GeneralFunction::NONE</const> means no subtotals). + For data fields, this is the function shown in the data pilot + table.</p> */ [property] com::sun::star::sheet::GeneralFunction Function; @@ -122,18 +128,5 @@ service DataPilotField }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl b/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl index e049299db235..31dde03269ef 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotFieldOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,46 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__ #define __com_sun_star_sheet_DataPilotFieldOrientation_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::DataPilotFieldOrientation -/** used to specify where a field in a Data Pilot Table is - laid out. +/** used to specify where a field in a data pilot table is laid out. */ enum DataPilotFieldOrientation { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::HIDDEN /** the field is not used in the table. */ HIDDEN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::COLUMN /** the field is used as a column field. */ COLUMN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::ROW /** the field is used as a row field. */ ROW, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::PAGE /** the field is used as a page field. */ PAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::DataPilotFieldOrientation::DATA /** the field is used as a data field. */ DATA @@ -115,18 +108,5 @@ enum DataPilotFieldOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFields.idl b/offapi/com/sun/star/sheet/DataPilotFields.idl index 2913d577d494..2d938cd4a257 100644 --- a/offapi/com/sun/star/sheet/DataPilotFields.idl +++ b/offapi/com/sun/star/sheet/DataPilotFields.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotFields.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,61 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotFields_idl__ #define __com_sun_star_sheet_DataPilotFields_idl__ #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotFields -/** collection of fields in a DataPilotDescriptor. +/** represents a collection of fields in a data pilot table. + + <p>If the data pilot table is based on a spreadsheet cell range, the + fields are representred by the columns of the range and are named using + the first row of the range.</p> + + @see com::sun::star::sheet::DataPilotTableDescriptor */ service DataPilotFields { - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- -}; + /** provides access to the data pilot fields in the collection via index. + */ + interface com::sun::star::container::XIndexAccess; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** creates an enumeration of all data pilot fields. -/*============================================================================= + @see com::sun::star::sheet::DataPilotFieldsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + //------------------------------------------------------------------------- + + /** provides access to the data pilot fields in the collection via name. + */ + interface com::sun::star::container::XNameAccess; - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl new file mode 100644 index 000000000000..fd2c66d50c50 --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotFieldsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DataPilotFieldsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:45 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DataPilotFieldsEnumeration_idl__ +#define __com_sun_star_sheet_DataPilotFieldsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of data pilot fieldss. + + @see com::sun::star::sheet::DataPilotField + */ +service DataPilotFieldsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the data pilot fields in the enumeration. + + @see com::sun::star::sheet::DataPilotField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSource.idl b/offapi/com/sun/star/sheet/DataPilotSource.idl index 81ccd1d99af5..e0e163066e98 100644 --- a/offapi/com/sun/star/sheet/DataPilotSource.idl +++ b/offapi/com/sun/star/sheet/DataPilotSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSource.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSource_idl__ #define __com_sun_star_sheet_DataPilotSource_idl__ @@ -77,40 +78,54 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSource -/** a data pilot source. +/** represents a data pilot source. + + <p>A component that implements this service can be used as data source + for a data pilot table in a spreadsheet document.</p> */ service DataPilotSource { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of the dimensions of the data + pilot source. + */ interface com::sun::star::sheet::XDimensionsSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** gives access to the results of the data pilot table. + */ interface com::sun::star::sheet::XDataPilotResults; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to refresh the data pilot table, that means to + read the data again from the data pilot source. + */ interface com::sun::star::util::XRefreshable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::DataPilotSource::ColumnGrand /** specifies if grand totals for the columns are inserted. */ [property] boolean ColumnGrand; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSource::RowGrand /** specifies if grand totals for the rows are inserted. */ [property] boolean RowGrand; @@ -121,18 +136,5 @@ service DataPilotSource }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl index fce8725342f3..3a780ec2fbba 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceDimension.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 13:46:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceDimension_idl__ #define __com_sun_star_sheet_DataPilotSourceDimension_idl__ @@ -89,41 +90,69 @@ #include <com/sun/star/sheet/TableFilterField.idl> #endif - //============================================================================= module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceDimension -/** a dimension in a data pilot source. +/** represents a dimension in a data pilot source. + + <p>A dimension is equivalent to a column of a cell range in a spreadsheet + used for a data pilot field.</p> + + <p>In more complex data sources, a dimension may contain several + hierarchies, which consolidate items of a complex data type, called + levels.</p> + + <p>Example: In a database, a column contains date values. This column + will be a dimension of the data pilot source. One hierarchy may contain + the 3 levels year, month, day. Another hierarchy may contain the 2 levels + year and week number.</p> + + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::DataPilotTable */ service DataPilotSourceDimension { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the dimension, i.e. used in + collections. + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of hierarchies of this dimension. + */ interface com::sun::star::sheet::XHierarchiesSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** supports duplicating the dimension. + + <p>A dimension may be used several times in a data pilot table, + i.e. as row field and data field.</p> + */ interface com::sun::star::util::XCloneable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Original - /** returns the dimension from which this dimension was cloned, - or <NULL/> if it was not cloned. + /** returns the name of the dimension from which this dimension was + cloned, or <NULL/> if it was not cloned. */ [readonly, property] com::sun::star::container::XNamed Original; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::IsDataLayoutDimension /** contains <TRUE/> if this is the dimension used to layout the different data dimensions. */ @@ -131,39 +160,35 @@ service DataPilotSourceDimension //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Orientation /** specifies where the dimension is used. */ [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Position /** specifies the position of the dimension within its orientation. */ [property] long Position; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::Function /** specifies how data are aggregated. */ [property] com::sun::star::sheet::GeneralFunction Function; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceDimension::UsedHierarchy /** specifies which hierarchy of the dimension is used. + + @see com::sun::star::sheet::DataPilotSourceHierarchies */ [property] long UsedHierarchy; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DataPilotSourceDimension::Filter - // DocMerge from idl: property com::sun::star::sheet::DataPilotSourceDimension::Filter /** specifies which values are used. */ - [property] sequence<com::sun::star::sheet::TableFilterField> Filter; + [property] sequence< com::sun::star::sheet::TableFilterField > Filter; }; @@ -171,30 +196,5 @@ service DataPilotSourceDimension }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:45 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl index 9aa7c78e64de..104a52efed08 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceDimensions.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceDimensions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceDimensions_idl__ #define __com_sun_star_sheet_DataPilotSourceDimensions_idl__ @@ -65,19 +66,24 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceDimensions -/** the collection of dimensions in a data pilot source. +/** represents the collection of dimensions in a data pilot source. + + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceDimensions { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access by name to the dimensions in the collection. + + @see com::sun::star::sheet::DataPilotSourceDimension + */ interface com::sun::star::container::XNameAccess; }; @@ -86,18 +92,5 @@ service DataPilotSourceDimensions }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl b/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl index dfa5dcd99725..c41e1adc8d8e 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceHierarchies.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceHierarchies.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:46 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ #define __com_sun_star_sheet_DataPilotSourceHierarchies_idl__ @@ -65,19 +66,26 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceHierarchies -/** the collection of hierarchies in a data pilot source dimension. +/** represents the collection of hierarchies in a data pilot source + dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceHierarchies { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access by name to the hierarchies in the collection. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + */ interface com::sun::star::container::XNameAccess; }; @@ -86,24 +94,5 @@ service DataPilotSourceHierarchies }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.2 2000/03/24 18:01:01 nn - #74032# include-defines - - Revision 1.1 2000/03/24 17:56:47 nn - #74032# Spelling error in file names corrected - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl b/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl index cf4dbf2d9400..f49fb805c8a2 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceHierarchy.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceHierarchy.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ #define __com_sun_star_sheet_DataPilotSourceHierarchy_idl__ @@ -69,22 +70,30 @@ #include <com/sun/star/sheet/XLevelsSupplier.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceHierarchy -/** a hierarchy in a data pilot source. +/** represents a hierarchy in a data pilot source dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceHierarchy { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the hierarchy, i.e. used in + collections. + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of levels of this hierarchy. + */ interface com::sun::star::sheet::XLevelsSupplier; }; @@ -93,24 +102,5 @@ service DataPilotSourceHierarchy }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.4 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.2 2000/03/24 18:01:01 nn - #74032# include-defines - - Revision 1.1 2000/03/24 17:57:03 nn - #74032# Spelling error in file names corrected - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl b/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl index 2effe15e00ed..8c27b9f4e949 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceLevel.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceLevel.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceLevel_idl__ #define __com_sun_star_sheet_DataPilotSourceLevel_idl__ @@ -81,42 +82,55 @@ #include <com/sun/star/sheet/GeneralFunction.idl> #endif - //============================================================================= module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceLevel -/** a level in a data pilot source. +/** represents a level in a data pilot source hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceLevel { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the level, i.e. used in collections. + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of members of this level. + */ interface com::sun::star::sheet::XMembersSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to a sequence of results of this level. + */ interface com::sun::star::sheet::XDataPilotMemberResults; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR DataPilotSourceLevel::SubTotals + //========================================================================= - // DocMerge from idl: property com::sun::star::sheet::DataPilotSourceLevel::SubTotals /** specifies the subtotals that are inserted for the level. + + <p>The subtotals are calculated with the members of this level.</p> */ - [property] sequence<com::sun::star::sheet::GeneralFunction> SubTotals; + [property] sequence< com::sun::star::sheet::GeneralFunction > SubTotals; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceLevel::ShowEmpty - /** specifies if empty members are shown. + /** specifies whether empty members are shown. */ [property] boolean ShowEmpty; @@ -126,24 +140,5 @@ service DataPilotSourceLevel }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl b/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl index b542c1f3804d..faec013fcaec 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceLevels.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceLevels.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceLevels_idl__ #define __com_sun_star_sheet_DataPilotSourceLevels_idl__ @@ -65,19 +66,25 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceLevels -/** the collection of levels in a data pilot source hierarchy. +/** represents the collection of levels in a data pilot source hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceLevels { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access by name to the levels in the collection. + + @see com::sun::star::sheet::DataPilotSourceLevel + */ interface com::sun::star::container::XNameAccess; }; @@ -86,18 +93,5 @@ service DataPilotSourceLevels }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceMember.idl b/offapi/com/sun/star/sheet/DataPilotSourceMember.idl index db192e4eebbc..24ce000a40d2 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceMember.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceMember.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceMember.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceMember_idl__ #define __com_sun_star_sheet_DataPilotSourceMember_idl__ @@ -69,35 +70,48 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceMember -/** a field in a data pilot source. +/** represents a member in a data pilot source level. + + <p>Members are the data items that will appear in a data pilot table + as row headers and column headers of the data range (if used in + row or column dimensions), or to calculate the values of the + data range (if used in data dimensions).</p> + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceMember { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the member. + + <p>This may be the textual representation of a numerical value.</p> + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceMember::IsVisible - /** specifies if the member is visible. + /** specifies whether the member is visible. */ [property] boolean IsVisible; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DataPilotSourceMember::ShowDetails - /** specifies if details for the member are shown. + /** specifies whether details for the member are shown. */ [property] boolean ShowDetails; @@ -107,18 +121,5 @@ service DataPilotSourceMember }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl b/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl index 7039f2275500..3ccf86a5ee5e 100644 --- a/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl +++ b/offapi/com/sun/star/sheet/DataPilotSourceMembers.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotSourceMembers.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotSourceMembers_idl__ #define __com_sun_star_sheet_DataPilotSourceMembers_idl__ @@ -65,19 +66,25 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotSourceMembers -/** the collection of fields in a data pilot source level. +/** represents the collection of members in a data pilot source level. + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ service DataPilotSourceMembers { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access by name to the members in the collection. + + @see com::sun::star::sheet::DataPilotSourceMember + */ interface com::sun::star::container::XNameAccess; }; @@ -86,18 +93,5 @@ service DataPilotSourceMembers }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTable.idl b/offapi/com/sun/star/sheet/DataPilotTable.idl index de35c425c502..7923a2ff017e 100644 --- a/offapi/com/sun/star/sheet/DataPilotTable.idl +++ b/offapi/com/sun/star/sheet/DataPilotTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotTable.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,13 +58,10 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotTable_idl__ #define __com_sun_star_sheet_DataPilotTable_idl__ -#ifndef __com_sun_star_container_XNamed_idl__ -#include <com/sun/star/container/XNamed.idl> -#endif - #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ #include <com/sun/star/sheet/XDataPilotDescriptor.idl> #endif @@ -73,25 +70,26 @@ #include <com/sun/star/sheet/XDataPilotTable.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotTable -/** a data pilot table on a spreadsheet. +/** represents a data pilot table on a spreadsheet. */ service DataPilotTable { - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access to the layout settings of the data pilot table. + */ interface com::sun::star::sheet::XDataPilotDescriptor; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to control a data pilot table. + */ interface com::sun::star::sheet::XDataPilotTable; }; @@ -100,18 +98,5 @@ service DataPilotTable }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTables.idl b/offapi/com/sun/star/sheet/DataPilotTables.idl index 979b075a3f22..b5e1406a356a 100644 --- a/offapi/com/sun/star/sheet/DataPilotTables.idl +++ b/offapi/com/sun/star/sheet/DataPilotTables.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataPilotTables.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,54 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataPilotTables_idl__ #define __com_sun_star_sheet_DataPilotTables_idl__ #ifndef __com_sun_star_sheet_XDataPilotTables_idl__ #include <com/sun/star/sheet/XDataPilotTables.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DataPilotTables -/** a collection of data pilot tables. +/** represents a collection of data pilot tables. */ service DataPilotTables { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the data pilot objects in this collection. + */ interface com::sun::star::sheet::XDataPilotTables; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** creates an enumeration of all data pilot tables. -}; }; }; }; + @see com::sun::star::sheet::DataPilotTablesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- -/*============================================================================= + /** provides methods to access the contained data pilot tables by index. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + @see com::sun::star::sheet::DataPilotTable + */ + interface com::sun::star::container::XIndexAccess; - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl new file mode 100644 index 000000000000..aec0e94b9d27 --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotTablesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DataPilotTablesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:48 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DataPilotTablesEnumeration_idl__ +#define __com_sun_star_sheet_DataPilotTablesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of data pilot tables. + + @see com::sun::star::sheet::DataPilotTable + */ +service DataPilotTablesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the data pilot tables in the enumeration. + + @see com::sun::star::sheet::DataPilotTable + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/DataResult.idl b/offapi/com/sun/star/sheet/DataResult.idl index aa60ef2f5370..41fd2e08aa15 100644 --- a/offapi/com/sun/star/sheet/DataResult.idl +++ b/offapi/com/sun/star/sheet/DataResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,30 +58,31 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataResult_idl__ #define __com_sun_star_sheet_DataResult_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::DataResult -/** structure describes a result. +/** contains the result of one element in the data pilot data array. + + @see com::sun::star::sheet::XDataPilotResults */ struct DataResult { - // DocMerge from xml: field com::sun::star::sheet::DataResult::Flags - /** field contains flags. + /** contains boolean flags describing the result. + + @see com::sun::star::sheet::DataResultFlags */ long Flags; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::DataResult::Value - /** field contains the value. + /** contains the result value. */ double Value; @@ -91,18 +92,5 @@ struct DataResult }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DataResultFlags.idl b/offapi/com/sun/star/sheet/DataResultFlags.idl index 6b640511689a..fe285f56c517 100644 --- a/offapi/com/sun/star/sheet/DataResultFlags.idl +++ b/offapi/com/sun/star/sheet/DataResultFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataResultFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,39 +58,37 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DataResultFlags_idl__ #define __com_sun_star_sheet_DataResultFlags_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::DataResultFlags -/** These constants give information about elements in - data pilot results. +/** used to specify the result type of one element in the data pilot + data array. + + @see com::sun::star::sheet::DataResult */ constants DataResultFlags { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::HASDATA /** The element contains data. */ const long HASDATA = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::SUBTOTAL /** The element contains a subtotal. */ const long SUBTOTAL = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::DataResultFlags::ERROR /** The element has an error. */ const long ERROR = 4; @@ -101,18 +99,5 @@ constants DataResultFlags }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl index c87f680a0286..67aeb36e3876 100644 --- a/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl +++ b/offapi/com/sun/star/sheet/DatabaseImportDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseImportDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DatabaseImportDescriptor_idl__ #define __com_sun_star_sheet_DatabaseImportDescriptor_idl__ @@ -65,42 +66,35 @@ #include <com/sun/star/sheet/DataImportMode.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DatabaseImportDescriptor -/** a description of how data from an external database is +/** represents a description of how data from an external database is imported. + + @see com::sun::star::sheet::XDatabaseRange */ service DatabaseImportDescriptor { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::SourceType - /** this attribute enables importing and specifies from what - type of source data is imported. + /** enables importing and specifies from what type of source data is + imported. */ [property] com::sun::star::sheet::DataImportMode SourceType; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::DatabaseName - /** this attribute specifies the name of the database from which - data is imported. + /** specifies the name of the database from which data is imported. */ [property] string DatabaseName; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DatabaseImportDescriptor::SourceObject - /** this attribute specifies the table, query, or statement from - which data is imported. - - + /** specifies the table, query, or statement from which data is imported. <p>The meaning of this is determined by the <member>DatabaseImportDescriptor::SourceType</member> attribute.</p> @@ -113,24 +107,5 @@ service DatabaseImportDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRange.idl b/offapi/com/sun/star/sheet/DatabaseRange.idl index c482f7150c38..43d9e3cde372 100644 --- a/offapi/com/sun/star/sheet/DatabaseRange.idl +++ b/offapi/com/sun/star/sheet/DatabaseRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DatabaseRange_idl__ #define __com_sun_star_sheet_DatabaseRange_idl__ @@ -77,51 +78,64 @@ #include <com/sun/star/container/XNamed.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DatabaseRange -/** a database range. +/** represents a database range in a spreadsheet document. + + <p>A database range is a name for a cell range that also stores filtering, + sorting, subtotal and data import settings and options.</p> + + @see com::sun::star::sheet::DatabaseRanges */ service DatabaseRange { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the settings of the database range. + */ interface com::sun::star::sheet::XDatabaseRange; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the cell range object referred by this named range. + */ interface com::sun::star::sheet::XCellRangeReferrer; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the database range. + */ interface com::sun::star::container::XNamed; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::MoveCells - /** if this property is set, columns or rows are inserted or deleted - when the size of the range is changed by an update operation. + /** specifies whether columns or rows are inserted or deleted when the + size of the range is changed by an update operation. */ [property] boolean MoveCells; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::KeepFormats - /** if this property is set, cell formats are extended - when the size of the range is changed by an update operation. + /** specifies whether cell formats are extended when the size of the + range is changed by an update operation. */ [property] boolean KeepFormats; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::StripData - /** if this property is set, the cell contents within the database - range are left out when the document is saved. + /** specifies whether cell contents within the database range are left + out when the document is saved. */ [property] boolean StripData; @@ -131,18 +145,5 @@ service DatabaseRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRanges.idl b/offapi/com/sun/star/sheet/DatabaseRanges.idl index b6adbdeafc14..6cd3923a0f3f 100644 --- a/offapi/com/sun/star/sheet/DatabaseRanges.idl +++ b/offapi/com/sun/star/sheet/DatabaseRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,60 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_DatabaseRanges_idl__ #define __com_sun_star_sheet_DatabaseRanges_idl__ -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> -#endif - #ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ #include <com/sun/star/sheet/XDatabaseRanges.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::DatabaseRanges -/** a collection of database ranges. +/** represents a collection of database ranges in a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service DatabaseRanges { - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access to the database ranges and to insert and remove them. + */ interface com::sun::star::sheet::XDatabaseRanges; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** creates an enumeration of all database ranges. -}; }; }; }; + @see com::sun::star::sheet::DatabaseRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the database ranges in the collection via index. -/*============================================================================= + @see com::sun::star::sheet::DatabaseRange - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + */ + interface com::sun::star::container::XIndexAccess; - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl b/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl new file mode 100644 index 000000000000..4633a06f3d8c --- /dev/null +++ b/offapi/com/sun/star/sheet/DatabaseRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: DatabaseRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DatabaseRangesEnumeration_idl__ +#define __com_sun_star_sheet_DatabaseRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of database ranges. + + @see com::sun::star::sheet::DatabaseRange + */ +service DatabaseRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the database ranges in the enumeration. + + @see com::sun::star::sheet::DatabaseRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FillDateMode.idl b/offapi/com/sun/star/sheet/FillDateMode.idl index 50b4325e3a4c..f2e42a71d2d6 100644 --- a/offapi/com/sun/star/sheet/FillDateMode.idl +++ b/offapi/com/sun/star/sheet/FillDateMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillDateMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,48 +58,44 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FillDateMode_idl__ #define __com_sun_star_sheet_FillDateMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::FillDateMode -/** are used to specify how an arithmetic date series is - calculated. +/** used to specify how an arithmetic date series is calculated. + + @see com::sun::star::sheet::FillMode */ enum FillDateMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_DAY /** for every new value a single day is added. */ FILL_DATE_DAY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_WEEKDAY - /** for evey new value a single day is added, but Saturdays and Sundays - are skipped. + /** for evey new value a single day is added, but Saturdays and + Sundays are skipped. */ FILL_DATE_WEEKDAY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_MONTH - /** for every new value one month is added. + /** for every new value one month is added (day keeps unchanged). */ FILL_DATE_MONTH, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDateMode::FILL_DATE_YEAR - /** for every new value one year is added. + /** for every new value one year is added (day and month keep unchanged). */ FILL_DATE_YEAR @@ -109,18 +105,5 @@ enum FillDateMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:48 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FillDirection.idl b/offapi/com/sun/star/sheet/FillDirection.idl index cb6144ccc827..782824a461b9 100644 --- a/offapi/com/sun/star/sheet/FillDirection.idl +++ b/offapi/com/sun/star/sheet/FillDirection.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillDirection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,41 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FillDirection_idl__ #define __com_sun_star_sheet_FillDirection_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::FillDirection -/** values are used to specify the direction of filling cells, for example, with - a series. +/** used to specify the direction of filling cells, for example, + with a series. */ enum FillDirection { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_BOTTOM /** specifies that rows are filled from top to bottom. */ TO_BOTTOM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_RIGHT /** specifies that columns are filled from left to right. */ TO_RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_TOP /** specifies that rows are filled from bottom to top. */ TO_TOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillDirection::TO_LEFT /** specifies that columns are filled from right to left. */ TO_LEFT @@ -108,21 +103,5 @@ enum FillDirection }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FillMode.idl b/offapi/com/sun/star/sheet/FillMode.idl index 84a8ea31a542..5df274696f68 100644 --- a/offapi/com/sun/star/sheet/FillMode.idl +++ b/offapi/com/sun/star/sheet/FillMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: FillMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,78 +58,61 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FillMode_idl__ #define __com_sun_star_sheet_FillMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::FillMode -/** used to specify the series used to fill cells. +/** used to specify the series type used to fill cells. */ enum FillMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillMode::SIMPLE /** specifies a constant series. - - <p>All cells are filled with the same value.</p> */ SIMPLE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillMode::LINEAR - /** this constant specifies an arithmetic series. - - + /** specifies an arithmetic series. <p>Cell by cell, the value used to fill the cells is increased - by an additive value. - </p> + by an additive value.</p> */ LINEAR, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillMode::GROWTH /** specifies a geometric series. - - <p>Cell by cell, the value used to fill the cells is multiplied - by a specified value. - </p> + by a specified value.</p> */ GROWTH, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillMode::DATE /** specifies an arithmetic series for date values. - - <p>Cell by cell, the value used to fill the cells is increased - by a specified number of days. - </p> + by a specified number of days</p> + + @see com::sun::star::sheet::FillDateMode */ DATE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FillMode::AUTO /** specifies the use of a user-defined list. - - <p>The cells are filled using a user-defined series.</p> */ AUTO @@ -140,18 +123,5 @@ enum FillMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FilterConnection.idl b/offapi/com/sun/star/sheet/FilterConnection.idl index 8e5fe3ef6521..b5d97ca68ea5 100644 --- a/offapi/com/sun/star/sheet/FilterConnection.idl +++ b/offapi/com/sun/star/sheet/FilterConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilterConnection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,32 +58,29 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FilterConnection_idl__ #define __com_sun_star_sheet_FilterConnection_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::FilterConnection -/** used to specify how two conditions in a filter - descriptor are connected. +/** used to specify how two conditions in a filter descriptor are + connected. */ enum FilterConnection { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterConnection::AND /** both conditions have to be fulfilled. */ AND, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterConnection::OR /** at least one of the conditions has to be fulfilled. */ OR @@ -94,18 +91,5 @@ enum FilterConnection }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FilterOperator.idl b/offapi/com/sun/star/sheet/FilterOperator.idl index a39fe96a6a7f..3d5e965ce581 100644 --- a/offapi/com/sun/star/sheet/FilterOperator.idl +++ b/offapi/com/sun/star/sheet/FilterOperator.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilterOperator.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,105 +58,89 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FilterOperator_idl__ #define __com_sun_star_sheet_FilterOperator_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::FilterOperator -/** specifies the type of a single condition in a - filter descriptor. +/** specifies the type of a single condition in a filter descriptor. */ enum FilterOperator { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::EMPTY /** selects empty entries. */ EMPTY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::NOT_EMPTY /** selects non-empty entries. */ NOT_EMPTY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::EQUAL /** value has to be equal to the specified value. */ EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::NOT_EQUAL - /** value has to be unequal to the specified value. + /** value must not be equal to the specified value. */ NOT_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::GREATER /** value has to be greater than the specified value. */ GREATER, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::GREATER_EQUAL /** value has to be greater than or equal to the specified value. */ GREATER_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::LESS /** value has to be less than the specified value. */ LESS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::LESS_EQUAL /** value has to be less than or equal to the specified value. */ LESS_EQUAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::TOP_VALUES /** selects a specified number of entries with the greatest values. */ TOP_VALUES, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::TOP_PERCENT - /** selects a specified percentage of entries with the greatest - values. + /** selects a specified percentage of entries with the greatest values. */ TOP_PERCENT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::BOTTOM_VALUES /** selects a specified number of entries with the lowest values. */ BOTTOM_VALUES, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::FilterOperator::BOTTOM_PERCENT - /** This selects a specified percentage of entries with the lowest - values. + /** selects a specified percentage of entries with the lowest values. */ BOTTOM_PERCENT @@ -166,18 +150,5 @@ enum FilterOperator }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FormulaResult.idl b/offapi/com/sun/star/sheet/FormulaResult.idl index 3180eb8a55bf..a649ba99eb1c 100644 --- a/offapi/com/sun/star/sheet/FormulaResult.idl +++ b/offapi/com/sun/star/sheet/FormulaResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: FormulaResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,39 +58,35 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FormulaResult_idl__ #define __com_sun_star_sheet_FormulaResult_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::FormulaResult -/** These constants select different result types of cell formulas. +/** used to select different result types of cell formulas. */ constants FormulaResult { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::VALUE - /** This selects numeric results. + /** selects numeric results. */ const long VALUE = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::STRING - /** This selects non-numeric results. + /** selects non-numeric results. */ const long STRING = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::FormulaResult::ERROR - /** This selects errors. + /** selects errors. */ const long ERROR = 4; @@ -100,18 +96,5 @@ constants FormulaResult }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FunctionAccess.idl b/offapi/com/sun/star/sheet/FunctionAccess.idl index 0e9f748f7938..f2c8ba1436b1 100644 --- a/offapi/com/sun/star/sheet/FunctionAccess.idl +++ b/offapi/com/sun/star/sheet/FunctionAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,17 +58,21 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FunctionAccess_idl__ #define __com_sun_star_sheet_FunctionAccess_idl__ +#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ +#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> +#endif + #ifndef __com_sun_star_sheet_XFunctionAccess_idl__ #include <com/sun/star/sheet/XFunctionAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= @@ -76,7 +80,19 @@ */ service FunctionAccess { + //------------------------------------------------------------------------- + + /** contributes properties to control the behaviour of some functions + (i.e. NullDate, IgnoreCase, RegularExpressions). + */ + service com::sun::star::sheet::SpreadsheetDocumentSettings; + + //------------------------------------------------------------------------- + + /** provides calculating the result of a spreadsheet function. + */ interface com::sun::star::sheet::XFunctionAccess; + }; //============================================================================= diff --git a/offapi/com/sun/star/sheet/FunctionArgument.idl b/offapi/com/sun/star/sheet/FunctionArgument.idl index d147ec005a78..a1364d769f8d 100644 --- a/offapi/com/sun/star/sheet/FunctionArgument.idl +++ b/offapi/com/sun/star/sheet/FunctionArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionArgument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,38 +58,38 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FunctionArgument_idl__ #define __com_sun_star_sheet_FunctionArgument_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::FunctionArgument -/** contains the description of a single argument within a - <type>FunctionDescription</type>. +/** contains the description of a single argument within a spreadsheet + function. + + @see com::sun::star::sheet::FunctionDescription */ struct FunctionArgument { - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::Name + //------------------------------------------------------------------------- + /** the name of the argument. */ string Name; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::Description /** a description of the argument. */ string Description; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::FunctionArgument::IsOptional - /** if the argument is optional. + /** determines whether the argument is optional. */ boolean IsOptional; @@ -99,24 +99,5 @@ struct FunctionArgument }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FunctionCategory.idl b/offapi/com/sun/star/sheet/FunctionCategory.idl new file mode 100644 index 000000000000..cf23f9ceb8f7 --- /dev/null +++ b/offapi/com/sun/star/sheet/FunctionCategory.idl @@ -0,0 +1,150 @@ +/************************************************************************* + * + * $RCSfile: FunctionCategory.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:51 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_FunctionCategory_idl__ +#define __com_sun_star_sheet_FunctionCategory_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the category of a spreadsheet function. + */ +constants FunctionCategory +{ + //------------------------------------------------------------------------- + + /** specifies a database function. + */ + const long DATABASE = 1; + + //------------------------------------------------------------------------- + + /** specifies a function that calculates with dates and/or times. + */ + const long DATETIME = 2; + + //------------------------------------------------------------------------- + + /** specifies a financial function. + */ + const long FINANCIAL = 3; + + //------------------------------------------------------------------------- + + /** specifies a function that returns information about the cell, + the cell contents or the current formula. + */ + const long INFORMATION = 4; + + //------------------------------------------------------------------------- + + /** specifies a boolean function. + */ + const long LOGICAL = 5; + + //------------------------------------------------------------------------- + + /** specifies a common mathematical function + */ + const long MATHEMATICAL = 6; + + //------------------------------------------------------------------------- + + /** specifies a matrix function. + */ + const long MATRIX = 7; + + //------------------------------------------------------------------------- + + /** specifies a statistical function + */ + const long STATISTICAL = 8; + + //------------------------------------------------------------------------- + + /** specifies a function that returns information using the spreadsheet + contents or specific cell positions. + */ + const long SPREADSHEET = 9; + + //------------------------------------------------------------------------- + + /** specifies a text function. + */ + const long TEXT = 10; + + //------------------------------------------------------------------------- + + /** specifies a common add-in function. + */ + const long ADDIN = 11; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescription.idl b/offapi/com/sun/star/sheet/FunctionDescription.idl index c4b5b620544c..11fa0591bddd 100644 --- a/offapi/com/sun/star/sheet/FunctionDescription.idl +++ b/offapi/com/sun/star/sheet/FunctionDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionDescription.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FunctionDescription_idl__ #define __com_sun_star_sheet_FunctionDescription_idl__ @@ -65,53 +66,52 @@ #include <com/sun/star/sheet/FunctionArgument.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::FunctionDescription -/** a description of a function. +/** collects all properties used to describe a function. + + @see com::sun::star::sheet::FunctionDescriptions */ service FunctionDescription { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Id /** returns the function's unique identifier. + + @see com::sun::star::sheet::XFunctionDescriptions */ [readonly, property] long Id; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Category /** returns the function's category. + + @see com::sun::star::sheet::FunctionCategory */ [readonly, property] long Category; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Name - /** returns the function's name. + /** returns the localized function's name. */ [readonly, property] string Name; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::FunctionDescription::Description - /** returns a description of the function. + /** returns a localized description of the function. */ [readonly, property] string Description; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FunctionDescription::Arguments - // DocMerge from idl: property com::sun::star::sheet::FunctionDescription::Arguments - /** returns a sequence of descriptions of the function's arguments. + /** returns a sequence of localized descriptions of the function's + arguments (in the order specified by the function). */ - [readonly, property] sequence<com::sun::star::sheet::FunctionArgument> Arguments; + [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments; }; @@ -119,27 +119,5 @@ service FunctionDescription }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.6 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.4 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.3 2000/02/21 16:18:07 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:53 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl b/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl new file mode 100644 index 000000000000..dc47eee347b7 --- /dev/null +++ b/offapi/com/sun/star/sheet/FunctionDescriptionEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: FunctionDescriptionEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_FunctionDescriptionEnumeration_idl__ +#define __com_sun_star_sheet_FunctionDescriptionEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of Function Descriptions. + + @see com::sun::star::sheet::FunctionDescription + */ +service FunctionDescriptionEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the Function Descriptions in the enumeration. + + @see com::sun::star::sheet::FunctionDescription + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/FunctionDescriptions.idl b/offapi/com/sun/star/sheet/FunctionDescriptions.idl index 8f071e48e0bd..971ef20b35eb 100644 --- a/offapi/com/sun/star/sheet/FunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/FunctionDescriptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: FunctionDescriptions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_FunctionDescriptions_idl__ #define __com_sun_star_sheet_FunctionDescriptions_idl__ @@ -68,43 +69,57 @@ #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::FunctionDescriptions -/** a list of function descriptions. +/** represents a collection of function descriptions for all built-in + functions as well as add-in functions available in the spreadsheet + application. + + <p>All container access methods return a sequence of + <type scope="com::sun::star::beans">PropertyValue</type> structs. + The properties contained in the sequence are collected in the + service <type>FunctionDescription</type>.</p> */ service FunctionDescriptions { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the property sequence of a function description + via function index or identifier. + */ interface com::sun::star::sheet::XFunctionDescriptions; - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- -}; + /** provides access to the property sequence of a function description + via function name. -//============================================================================= + <p>The localized uppercase name of the function has to be used + here.</p> + */ + interface com::sun::star::container::XNameAccess; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** creates an enumeration of all function descriptions. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + @see com::sun::star::sheet::FunctionDescriptionEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/GeneralFunction.idl b/offapi/com/sun/star/sheet/GeneralFunction.idl index 801d399bc520..22c54f3ed37e 100644 --- a/offapi/com/sun/star/sheet/GeneralFunction.idl +++ b/offapi/com/sun/star/sheet/GeneralFunction.idl @@ -2,9 +2,9 @@ * * $RCSfile: GeneralFunction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,108 +58,96 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_GeneralFunction_idl__ #define __com_sun_star_sheet_GeneralFunction_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::GeneralFunction /** used to specify a function to be calculated from values. */ enum GeneralFunction { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::NONE /** nothing is calculated. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::AUTO /** function is determined automatically. + + <p>If the values are all numerical, SUM is used, otherwise COUNT.</p> */ AUTO, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::SUM /** sum of all numerical values is calculated. */ SUM, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::COUNT /** all values, including non-numerical values, are counted. */ COUNT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::AVERAGE /** average of all numerical values is calculated. */ AVERAGE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::MAX /** maximum value of all numerical values is calculated. */ MAX, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::MIN /** minimum value of all numerical values is calculated. */ MIN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::PRODUCT /** product of all numerical values is calculated. */ PRODUCT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::COUNTNUMS /** numerical values are counted. */ COUNTNUMS, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::STDEV /** standard deviation is calculated based on a sample. */ STDEV, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::STDEVP /** standard deviation is calculated based on the entire population. */ STDEVP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::VAR /** variance is calculated based on a sample. */ VAR, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::GeneralFunction::VARP /** variance is calculated based on the entire population. */ VARP @@ -170,18 +158,5 @@ enum GeneralFunction }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/GlobalSheetSettings.idl b/offapi/com/sun/star/sheet/GlobalSheetSettings.idl index 9c66891d4376..ab7b471441aa 100644 --- a/offapi/com/sun/star/sheet/GlobalSheetSettings.idl +++ b/offapi/com/sun/star/sheet/GlobalSheetSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: GlobalSheetSettings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_GlobalSheetSettings_idl__ #define __com_sun_star_sheet_GlobalSheetSettings_idl__ @@ -65,150 +66,161 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::GlobalSheetSettings -/** the settings for all spreadsheets. +/** contributes properties to access the settings for all spreadsheets of + a spreadsheet document. */ service GlobalSheetSettings { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MoveSelection - /** if this property is set, the cursor is moved after entering into - cells. + /** specifies whether the cursor is moved after entering into cells. */ [property] boolean MoveSelection; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MoveDirection - /** contains the direction the cursor is moved after - entering cells. + /** contains the direction the cursor moves after entering cells. + + @see com::sun::star::sheet::MoveDirection */ [property] short MoveDirection; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::EnterEdit - /** if this property is set, the enter key can be used to start editing - a cell. + /** specifies whether the enter key can be used to start editing a cell. */ [property] boolean EnterEdit; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::ExtendFormat - /** if this property is set, cell formatting is extended when entering - data. + /** specifies whether cell formatting is extended when entering data. */ [property] boolean ExtendFormat; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::RangeFinder - /** if this property is set, ranges are highlighted on the sheet when + /** specifies whether ranges are highlighted on the sheet when editing a formula. */ [property] boolean RangeFinder; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::ExpandReferences - /** if this property is set, formula references are extended when cells + /** specifies whether formula references are extended when cells are inserted below or to the right of them. */ [property] boolean ExpandReferences; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::MarkHeader - /** if this property is set, the current selection is highlighted in + /** specifies whether the current selection is highlighted in column and row headers. */ [property] boolean MarkHeader; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::UseTabCol - /** if this property is set, the enter key moves the cursor to the - column it was in before using the tab key to change columns. + /** specifies whether the enter key moves the cursor to the column + it was in before using the tab key to change columns. */ [property] boolean UseTabCol; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::Metric /** contains the metric for all spreadsheet documents. + + @see com::sun::star::util::MeasureUnit */ [property] short Metric; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::Scale - /** contains the default scale for new spreadsheet - documents. + /** contains the default scale for new spreadsheet documents + (in percent). + + <p>There are several special values:</p> + <p>-1 = Optimal width</p> + <p>-2 = Show whole page</p> + <p>-3 = Page width</p> */ [property] short Scale; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::DoAutoComplete - /** enables automatic completion of text in a cell. + /** specifies whether automatic completion of text in a cell is used. */ [property] boolean DoAutoComplete; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::GlobalSheetSettings::StatusBarFunction - /** contains the function that is displayed in the - status bar. + /** contains the function that is displayed in the status bar. + + @see com::sun::star::sheet::StatusBarFunction */ [property] short StatusBarFunction; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR GlobalSheetSettings::UserLists - // DocMerge from idl: property com::sun::star::sheet::GlobalSheetSettings::UserLists - /** contains the string lists used for sorting and - filling. - <P>Each string contains the members of a list, separated by - commas.</P> + /** contains the string lists used for sorting and filling. + + <p>Each string contains the members of a list, separated by + commas.</p> */ - [property] sequence<string> UserLists; + [property] sequence< string > UserLists; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** specifies the update mode for external linked data. -}; }; }; }; + <p>0 = always</p> + <p>1 = never</p> + <p>2 = on demand</p> + */ + [optional, property] short LinkUpdateMode; -/*============================================================================= + //------------------------------------------------------------------------- + + /** specifies whether all sheets or only selected sheets are printed. + */ + [optional, property] boolean PrintAllSheets; + + //------------------------------------------------------------------------- + + /** specifies whether empty pages are printed. + */ + [optional, property] boolean PrintEmptyPages; + + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + /** specifies whether printer metrics are used for display. + */ + [optional, property] boolean UsePrinterMetrics; - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML + //------------------------------------------------------------------------- - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added + /** specifies whether a warning is shown before replacing cells + (i.e. when pasting from clipboard). + */ + [optional, property] boolean ReplaceCellsWarning; - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/GoalResult.idl b/offapi/com/sun/star/sheet/GoalResult.idl index adc6c336e0f1..aeb8c4c2f82f 100644 --- a/offapi/com/sun/star/sheet/GoalResult.idl +++ b/offapi/com/sun/star/sheet/GoalResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: GoalResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,29 +58,26 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_GoalResult_idl__ #define __com_sun_star_sheet_GoalResult_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::GoalResult /** is the result of a goal seek operation. */ struct GoalResult { - // DocMerge from xml: field com::sun::star::sheet::GoalResult::Divergence /** the amount by which the result changed in the last iteration. */ double Divergence; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::GoalResult::Result /** the resulting value. */ double Result; @@ -91,18 +88,5 @@ struct GoalResult }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/HeaderFooterContent.idl b/offapi/com/sun/star/sheet/HeaderFooterContent.idl index 3410dbc275bf..d627102567a4 100644 --- a/offapi/com/sun/star/sheet/HeaderFooterContent.idl +++ b/offapi/com/sun/star/sheet/HeaderFooterContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HeaderFooterContent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_HeaderFooterContent_idl__ #define __com_sun_star_sheet_HeaderFooterContent_idl__ @@ -65,19 +66,22 @@ #include <com/sun/star/sheet/XHeaderFooterContent.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::HeaderFooterContent -/** the content of a header or footer in a page format. +/** represents the contents of a header or footer line in a page style. + + @see com::sun::star::sheet::TablePageStyle */ service HeaderFooterContent { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the text parts of the header or footer line. + */ interface com::sun::star::sheet::XHeaderFooterContent; }; @@ -86,18 +90,5 @@ service HeaderFooterContent }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/LabelRange.idl b/offapi/com/sun/star/sheet/LabelRange.idl index c447c939b737..00de4449852a 100644 --- a/offapi/com/sun/star/sheet/LabelRange.idl +++ b/offapi/com/sun/star/sheet/LabelRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: LabelRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_LabelRange_idl__ #define __com_sun_star_sheet_LabelRange_idl__ @@ -65,19 +66,23 @@ #include <com/sun/star/sheet/XLabelRange.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::LabelRange -/** a label range. +/** represents a cell area that contains labels and values related to the + labels. + + <p>Label ranges can be used in formulas to refer to cells in cell + ranges with row or column titles. The formula uses the cell value that + is related to the specified row or column title.</p> */ service LabelRange { - // DocMerge: empty anyway + /** provides access to the settings of a label range. + */ interface com::sun::star::sheet::XLabelRange; }; @@ -86,18 +91,5 @@ service LabelRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/LabelRanges.idl b/offapi/com/sun/star/sheet/LabelRanges.idl index 8af17f6bda5a..2ce134a063f9 100644 --- a/offapi/com/sun/star/sheet/LabelRanges.idl +++ b/offapi/com/sun/star/sheet/LabelRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: LabelRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_LabelRanges_idl__ #define __com_sun_star_sheet_LabelRanges_idl__ @@ -68,43 +69,53 @@ #ifndef __com_sun_star_sheet_XLabelRanges_idl__ #include <com/sun/star/sheet/XLabelRanges.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::LabelRanges -/** a collection of label ranges. +/** represents a collection of label ranges in a spreadsheet document. + + @see com::sun::star::sheet::LabelRange + @see com::sun::star::sheet::SpreadsheetDocument */ service LabelRanges { - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides methods to access the members of the label range collection + and to insert and remove them. + */ interface com::sun::star::sheet::XLabelRanges; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides access to the label ranges via index. -}; }; }; }; + @see com::sun::star::sheet::LabelRange -/*============================================================================= + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all label ranges. + + @see com::sun::star::sheet::LabelRangesEnumeration - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl b/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl new file mode 100644 index 000000000000..07f8b864b08f --- /dev/null +++ b/offapi/com/sun/star/sheet/LabelRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: LabelRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_LabelRangesEnumeration_idl__ +#define __com_sun_star_sheet_LabelRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of label ranges. + + @see com::sun::star::sheet::LabelRange + */ +service LabelRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the label ranges in the enumeration. + + @see com::sun::star::sheet::LabelRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/LocalizedName.idl b/offapi/com/sun/star/sheet/LocalizedName.idl index 8d0ac4211986..590ed7ced684 100644 --- a/offapi/com/sun/star/sheet/LocalizedName.idl +++ b/offapi/com/sun/star/sheet/LocalizedName.idl @@ -2,9 +2,9 @@ * * $RCSfile: LocalizedName.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: nn $ $Date: 2001-02-19 19:52:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_LocalizedName_idl__ #define __com_sun_star_sheet_LocalizedName_idl__ @@ -65,21 +66,28 @@ #include <com/sun/star/lang/Locale.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= /** A name that is valid for a specified locale. + + @see com::sun::star::sheet::XCompatibilityNames */ struct LocalizedName { - /// The locale for which this name is valid. + // ------------------------------------------------------------------------ + + /** The locale for which this name is valid. + */ ::com::sun::star::lang::Locale Locale; - /// The name itself. + // ------------------------------------------------------------------------ + + /** The name itself. + */ string Name; }; diff --git a/offapi/com/sun/star/sheet/MemberResult.idl b/offapi/com/sun/star/sheet/MemberResult.idl index 0dbe0a63c868..13fef0d206c3 100644 --- a/offapi/com/sun/star/sheet/MemberResult.idl +++ b/offapi/com/sun/star/sheet/MemberResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: MemberResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,37 +58,37 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_MemberResult_idl__ #define __com_sun_star_sheet_MemberResult_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::MemberResult -/** describes a result. +/** describes a result of a DataPilot member. + + @see com::sun::star::sheet::XDataPilotMemberResults */ struct MemberResult { - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Name /** the internal name of the field. */ string Name; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Caption /** the visible name of the field. */ string Caption; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::MemberResult::Flags - /** field contains flags. + /** contains flags describing the result. + + @see com::sun::star::sheet::MemberResultFlags */ long Flags; @@ -98,24 +98,5 @@ struct MemberResult }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/MemberResultFlags.idl b/offapi/com/sun/star/sheet/MemberResultFlags.idl index 7de2576a2de7..6e4d2e3abdc6 100644 --- a/offapi/com/sun/star/sheet/MemberResultFlags.idl +++ b/offapi/com/sun/star/sheet/MemberResultFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: MemberResultFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,39 +58,34 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_MemberResultFlags_idl__ #define __com_sun_star_sheet_MemberResultFlags_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::MemberResultFlags -/** These constants give information about elements in - data pilot member results. +/** used to give information about elements in data pilot member results. */ constants MemberResultFlags { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::HASMEMBER /** The element contains a member. */ const long HASMEMBER = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::SUBTOTAL /** The element contains a subtotal. */ const long SUBTOTAL = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::MemberResultFlags::CONTINUE /** The element is a continuation of the previous one. */ const long CONTINUE = 4; @@ -101,18 +96,5 @@ constants MemberResultFlags }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/MoveDirection.idl b/offapi/com/sun/star/sheet/MoveDirection.idl new file mode 100644 index 000000000000..79e69bac8497 --- /dev/null +++ b/offapi/com/sun/star/sheet/MoveDirection.idl @@ -0,0 +1,107 @@ +/************************************************************************* + * + * $RCSfile: MoveDirection.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_MoveDirection_idl__ +#define __com_sun_star_sheet_MoveDirection_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the direction of moving the current selection i.e. + after a cell has been left with Enter. + */ +constants MoveDirection +{ + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell down. + */ + const short DOWN = 0; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell right. + */ + const short RIGHT = 1; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell up. + */ + const short UP = 2; + + //------------------------------------------------------------------------- + + /** specifies that the selection moves one cell left. + */ + const short LEFT = 3; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/NamedRange.idl b/offapi/com/sun/star/sheet/NamedRange.idl index 5e14d75684ef..68491a076d99 100644 --- a/offapi/com/sun/star/sheet/NamedRange.idl +++ b/offapi/com/sun/star/sheet/NamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_NamedRange_idl__ #define __com_sun_star_sheet_NamedRange_idl__ @@ -73,25 +74,34 @@ #include <com/sun/star/sheet/XCellRangeReferrer.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::NamedRange -/** a range which can be addressed by a name. +/** represents a named range in a spreadsheet document. + + <p>In fact a named range is a named formula expression. A cell range + address is one possible content of a named range.</p> + + @see com::sun::star::sheet::NamedRanges */ service NamedRange { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the settings of the named range. + */ interface com::sun::star::sheet::XNamedRange; - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; + //------------------------------------------------------------------------- + + /** provides access to the cell range object referred by this named range. - // DocMerge: empty anyway + <p>This works only, if the named range contains a single cell range + address.</p> + */ interface com::sun::star::sheet::XCellRangeReferrer; }; @@ -100,18 +110,5 @@ service NamedRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/NamedRangeFlag.idl b/offapi/com/sun/star/sheet/NamedRangeFlag.idl index fd933aa1350e..da133f81955b 100644 --- a/offapi/com/sun/star/sheet/NamedRangeFlag.idl +++ b/offapi/com/sun/star/sheet/NamedRangeFlag.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRangeFlag.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,45 +58,40 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_NamedRangeFlag_idl__ #define __com_sun_star_sheet_NamedRangeFlag_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::NamedRangeFlag -/** These constants are used to specify the purpose of a named range. +/** used to specify the purpose of a named range. */ constants NamedRangeFlag { //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::FILTER_CRITERIA /** The range contains filter criteria. */ const long FILTER_CRITERIA = 1; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::PRINT_AREA /** The range can be used as a print range. */ const long PRINT_AREA = 2; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::COLUMN_HEADER /** The range can be used as column headers for printing. */ const long COLUMN_HEADER = 4; //------------------------------------------------------------------------- - // DocMerge from idl: value com::sun::star::sheet::NamedRangeFlag::ROW_HEADER /** The range can be used as row headers for printing. */ const long ROW_HEADER = 8; @@ -107,18 +102,5 @@ constants NamedRangeFlag }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/NamedRanges.idl b/offapi/com/sun/star/sheet/NamedRanges.idl index 0d30a4167a80..c8fbb888488b 100644 --- a/offapi/com/sun/star/sheet/NamedRanges.idl +++ b/offapi/com/sun/star/sheet/NamedRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamedRanges.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_NamedRanges_idl__ #define __com_sun_star_sheet_NamedRanges_idl__ @@ -68,43 +69,57 @@ #ifndef __com_sun_star_sheet_XNamedRanges_idl__ #include <com/sun/star/sheet/XNamedRanges.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::NamedRanges -/** a collection of named ranges. +/** represents a collection of named ranges in a spreadsheet document. + + <p>In fact a named range is a named formula expression. A cell range + address is one possible content of a named range.</p> + + @see com::sun::star::sheet::SpreadsheetDocument */ service NamedRanges { - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access to the named ranges and to insert and remove them. + */ interface com::sun::star::sheet::XNamedRanges; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides access to the named ranges via index. -}; }; }; }; + @see com::sun::star::sheet::NamedRange + + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all named ranges. -/*============================================================================= + @see com::sun::star::sheet::NamedRangesEnumeration - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl b/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl new file mode 100644 index 000000000000..48de73b0527d --- /dev/null +++ b/offapi/com/sun/star/sheet/NamedRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: NamedRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_NamedRangesEnumeration_idl__ +#define __com_sun_star_sheet_NamedRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of named ranges. + + @see com::sun::star::sheet::NamedRange + */ +service NamedRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the named ranges in the enumeration. + + @see com::sun::star::sheet::NamedRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/PasteOperation.idl b/offapi/com/sun/star/sheet/PasteOperation.idl index 03ffd97ca4e7..70a9fc94c33b 100644 --- a/offapi/com/sun/star/sheet/PasteOperation.idl +++ b/offapi/com/sun/star/sheet/PasteOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasteOperation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,47 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_PasteOperation_idl__ #define __com_sun_star_sheet_PasteOperation_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::PasteOperation -/** used to specify which operations are carried out when - pasting cell values into a cell range. +/** used to specify which operations are carried out when pasting cell + values into a cell range. */ enum PasteOperation { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::NONE /** new values are used without changes. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::ADD /** old and new values are added. */ ADD, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::SUBTRACT /** new values are subtracted from the old values. */ SUBTRACT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::MULTIPLY /** old and new values are multiplied. */ MULTIPLY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::PasteOperation::DIVIDE /** new values are divided by the new values. */ DIVIDE @@ -115,18 +109,5 @@ enum PasteOperation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl index 6ea0d4014c42..9267a74c9919 100644 --- a/offapi/com/sun/star/sheet/RangeSelectionArguments.idl +++ b/offapi/com/sun/star/sheet/RangeSelectionArguments.idl @@ -2,9 +2,9 @@ * * $RCSfile: RangeSelectionArguments.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,6 +68,8 @@ //============================================================================= /** contains the arguments for starting the range selection. + + @see com::sun::star::sheet::XRangeSelection */ service RangeSelectionArguments { diff --git a/offapi/com/sun/star/sheet/RangeSelectionEvent.idl b/offapi/com/sun/star/sheet/RangeSelectionEvent.idl index 7676a22b5f60..a284dca0fa42 100644 --- a/offapi/com/sun/star/sheet/RangeSelectionEvent.idl +++ b/offapi/com/sun/star/sheet/RangeSelectionEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: RangeSelectionEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: nn $ $Date: 2000-11-09 19:50:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,9 @@ //============================================================================= /** specifies an event from range selection. + + @see com::sun::star::sheet::XRangeSelectionListener + @see com::sun::star::sheet::XRangeSelectionChangeListener */ struct RangeSelectionEvent: com::sun::star::lang::EventObject { diff --git a/offapi/com/sun/star/sheet/RecentFunctions.idl b/offapi/com/sun/star/sheet/RecentFunctions.idl index 136ff8469d77..75561a266e37 100644 --- a/offapi/com/sun/star/sheet/RecentFunctions.idl +++ b/offapi/com/sun/star/sheet/RecentFunctions.idl @@ -2,9 +2,9 @@ * * $RCSfile: RecentFunctions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_RecentFunctions_idl__ #define __com_sun_star_sheet_RecentFunctions_idl__ @@ -65,19 +66,20 @@ #include <com/sun/star/sheet/XRecentFunctions.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::RecentFunctions -/** the list of recently used functions. +/** contains the list of recently used spreadsheet functions. */ service RecentFunctions { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the list of recently used spreadsheet functions. + */ interface com::sun::star::sheet::XRecentFunctions; }; @@ -86,18 +88,5 @@ service RecentFunctions }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/ResultEvent.idl b/offapi/com/sun/star/sheet/ResultEvent.idl index 26685aad434a..27d42a5158ff 100644 --- a/offapi/com/sun/star/sheet/ResultEvent.idl +++ b/offapi/com/sun/star/sheet/ResultEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ResultEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_ResultEvent_idl__ #define __com_sun_star_sheet_ResultEvent_idl__ @@ -65,25 +66,22 @@ #include <com/sun/star/lang/EventObject.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::ResultEvent -/** contains the new value of a volatile result. +/** contains the new value of a volatile function result. + + @see com::sun::star::sheet::XVolatileResult */ struct ResultEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::ResultEvent::Value /** contains the value. - - <p>This can be any of the possible return types described for the <type>AddIn</type> service, except <type>XVolatileResult</type>.</p> */ @@ -95,18 +93,5 @@ struct ResultEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/Scenarios.idl b/offapi/com/sun/star/sheet/Scenarios.idl index 392a02c292e5..e9d5e78f350f 100644 --- a/offapi/com/sun/star/sheet/Scenarios.idl +++ b/offapi/com/sun/star/sheet/Scenarios.idl @@ -2,9 +2,9 @@ * * $RCSfile: Scenarios.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: nn $ $Date: 2001-02-16 10:15:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,49 +58,58 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_Scenarios_idl__ #define __com_sun_star_sheet_Scenarios_idl__ #ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ #include <com/sun/star/sheet/XScenariosSupplier.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::Scenarios -/** a collection of scenarios. +/** represents a collection of scenarios. */ service Scenarios { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access via name to the scenarios in the collection. + */ interface com::sun::star::sheet::XScenarios; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** creates an enumeration of scenarios. -}; }; }; }; + @see com::sun::star::sheet::ScenariosEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- -/*============================================================================= + /** provides access to the scenarios in the collection via index. - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + @see com::sun::star::sheet::Spreadsheet - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + */ + interface com::sun::star::container::XIndexAccess; - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/ScenariosEnumeration.idl b/offapi/com/sun/star/sheet/ScenariosEnumeration.idl new file mode 100644 index 000000000000..b4eed4bbe550 --- /dev/null +++ b/offapi/com/sun/star/sheet/ScenariosEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: ScenariosEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:57 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_ScenariosEnumeration_idl__ +#define __com_sun_star_sheet_ScenariosEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of scenarios. + + @see com::sun::star::sheet::Spreadsheet + */ +service ScenariosEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the scenarios in the enumeration. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetCell.idl b/offapi/com/sun/star/sheet/SheetCell.idl index dc8a88e3885b..93599071c853 100644 --- a/offapi/com/sun/star/sheet/SheetCell.idl +++ b/offapi/com/sun/star/sheet/SheetCell.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCell.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,82 +58,271 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCell_idl__ #define __com_sun_star_sheet_SheetCell_idl__ + #ifndef __com_sun_star_table_Cell_idl__ #include <com/sun/star/table/Cell.idl> #endif -#ifndef __com_sun_star_sheet_XCellAddressable_idl__ -#include <com/sun/star/sheet/XCellAddressable.idl> +#ifndef __com_sun_star_text_Text_idl__ +#include <com/sun/star/text/Text.idl> #endif #ifndef __com_sun_star_style_CharacterProperties_idl__ #include <com/sun/star/style/CharacterProperties.idl> #endif +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + #ifndef __com_sun_star_style_ParagraphProperties_idl__ #include <com/sun/star/style/ParagraphProperties.idl> #endif +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + #ifndef __com_sun_star_document_XActionLockable_idl__ #include <com/sun/star/document/XActionLockable.idl> #endif +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> +#endif + +#ifndef __com_sun_star_table_XColumnRowRange_idl__ +#include <com/sun/star/table/XColumnRowRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellAddressable_idl__ +#include <com/sun/star/sheet/XCellAddressable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ +#include <com/sun/star/sheet/XSheetAnnotationAnchor.idl> +#endif + +#ifndef __com_sun_star_text_XTextFieldsSupplier_idl__ +#include <com/sun/star/text/XTextFieldsSupplier.idl> +#endif + + +#ifndef __com_sun_star_awt_Point_idl__ +#include <com/sun/star/awt/Point.idl> +#endif + +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCell -/** a cell which can be addressed. +/** represents a single addressable cell in a spreadsheet document. */ service SheetCell { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides basic cell handling and contributes common cell + formatting properties. + */ service com::sun::star::table::Cell; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides handling of formatted text cells. + */ + service com::sun::star::text::Text; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Western text. + */ service com::sun::star::style::CharacterProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Asian text. + */ + service com::sun::star::style::CharacterPropertiesAsian; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Complex text. + */ + service com::sun::star::style::CharacterPropertiesComplex; + + //------------------------------------------------------------------------- + + /** contributes properties for paragraph formatting. + */ service com::sun::star::style::ParagraphProperties; - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellAddressable; + //------------------------------------------------------------------------- - /** locks the update between XCell and XText + /** provides interfaces to find cells with specific properties. + */ + service com::sun::star::sheet::SheetRangesQuery; + + //========================================================================= + + /** provides methods to lock and unlock the update between + <type scope="com::sun::star::table">XCell</type> and + <type scope="com::sun::star::text">XText</type>. */ interface com::sun::star::document::XActionLockable; -}; -//============================================================================= + //------------------------------------------------------------------------- -}; }; }; }; + /** provides "Find & Replace" functionality. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + interface com::sun::star::util::XReplaceable; + + //------------------------------------------------------------------------- + + /** provides modifying the cell indentation. + */ + interface com::sun::star::util::XIndent; + + //------------------------------------------------------------------------- + + /** provides access to the collections of columns and rows. + */ + interface com::sun::star::table::XColumnRowRange; + + //------------------------------------------------------------------------- + + /** provides access to the cell address of this cell. + */ + interface com::sun::star::sheet::XCellAddressable; + + //------------------------------------------------------------------------- + + /** provides access to the annotation attached to this cell. + */ + interface com::sun::star::sheet::XSheetAnnotationAnchor; + + //------------------------------------------------------------------------- + + /** provides access to the text fields used in this cell. + */ + interface com::sun::star::text::XTextFieldsSupplier; + + //========================================================================= + + /** contains the position of this cell in the sheet (in 1/100 mm). + + <p>This property contains the absolute position in the whole + sheet, not the position in the visible area.</p> + */ + [readonly, property] com::sun::star::awt::Point Position; + + //------------------------------------------------------------------------- + + /** contains the size of this cell (in 1/100 mm). + */ + [readonly, property] com::sun::star::awt::Size Size; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.4 2001/06/12 12:46:36 sab - #79771#; XActionLockable added + /** contains the formula string with localized function names. - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + <p>This property can also be used to set a new localized formula.</p> + */ + [optional, property] string FormulaLocal; - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.4 2000/09/11 11:52:49 mi - documentation merged from XML + /** contains the result type of a formula. - Revision 1.2 2000/08/02 10:28:00 mi - CharacterProperties and ParagraphProperties (were in table/Cell... before) + @see com::sun::star::sheet::FormulaResult + */ + [readonly, property] long FormulaResultType; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + //------------------------------------------------------------------------- + /** contains the conditional formatting settings for this cell. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell, + using localized formulas. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; + + //------------------------------------------------------------------------- + + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellCursor.idl b/offapi/com/sun/star/sheet/SheetCellCursor.idl index ab8a5665b69f..2ddb46284347 100644 --- a/offapi/com/sun/star/sheet/SheetCellCursor.idl +++ b/offapi/com/sun/star/sheet/SheetCellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellCursor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCellCursor_idl__ #define __com_sun_star_sheet_SheetCellCursor_idl__ @@ -77,28 +78,42 @@ #include <com/sun/star/sheet/XUsedAreaCursor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCellCursor -/** a cursor in a spreadsheet. +/** represents a cursor in a spreadsheet. + + <p>A cursor is a cell range which provides additional methods to move + through the table (i.e. to find specific cell ranges).</p> */ service SheetCellCursor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides common methods to control the position of the cursor. + */ service com::sun::star::table::CellCursor; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides the complete functionality of a cell range in a spreadsheet + document. + */ service com::sun::star::sheet::SheetCellRange; - // DocMerge: empty anyway + //========================================================================= + + /** provides advanced methods to control the position of the cursor. + */ interface com::sun::star::sheet::XSheetCellCursor; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to find the used area of the entire sheet. + */ interface com::sun::star::sheet::XUsedAreaCursor; }; @@ -107,18 +122,5 @@ service SheetCellCursor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRange.idl b/offapi/com/sun/star/sheet/SheetCellRange.idl index 756925d603d9..a9fc1e3e1c14 100644 --- a/offapi/com/sun/star/sheet/SheetCellRange.idl +++ b/offapi/com/sun/star/sheet/SheetCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellRange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,21 +58,64 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCellRange_idl__ #define __com_sun_star_sheet_SheetCellRange_idl__ + +#ifndef __com_sun_star_table_CellRange_idl__ +#include <com/sun/star/table/CellRange.idl> +#endif + +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + #ifndef __com_sun_star_util_XMergeable_idl__ #include <com/sun/star/util/XMergeable.idl> #endif -#ifndef __com_sun_star_table_CellRange_idl__ -#include <com/sun/star/table/CellRange.idl> +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> #endif #ifndef __com_sun_star_table_XColumnRowRange_idl__ #include <com/sun/star/table/XColumnRowRange.idl> #endif +#ifndef __com_sun_star_table_XAutoFormattable_idl__ +#include <com/sun/star/table/XAutoFormattable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetCellRange_idl__ +#include <com/sun/star/sheet/XSheetCellRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellRangeData_idl__ +#include <com/sun/star/sheet/XCellRangeData.idl> +#endif + #ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ #include <com/sun/star/sheet/XCellRangeAddressable.idl> #endif @@ -81,6 +124,47 @@ #include <com/sun/star/sheet/XSheetOperation.idl> #endif +#ifndef __com_sun_star_sheet_XCellSeries_idl__ +#include <com/sun/star/sheet/XCellSeries.idl> +#endif + +#ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__ +#include <com/sun/star/sheet/XArrayFormulaRange.idl> +#endif + +#ifndef __com_sun_star_sheet_XMultipleOperation_idl__ +#include <com/sun/star/sheet/XMultipleOperation.idl> +#endif + +#ifndef __com_sun_star_util_XSortable_idl__ +#include <com/sun/star/util/XSortable.idl> +#endif + +#ifndef __com_sun_star_util_XImportable_idl__ +#include <com/sun/star/util/XImportable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__ +#include <com/sun/star/sheet/XSubTotalCalculatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetFilterableEx_idl__ +#include <com/sun/star/sheet/XSheetFilterableEx.idl> +#endif + +#ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ +#include <com/sun/star/sheet/XCellFormatRangesSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ +#include <com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl> +#endif + +#ifndef __com_sun_star_chart_XChartDataArray_idl__ +#include <com/sun/star/chart/XChartDataArray.idl> +#endif + + #ifndef __com_sun_star_awt_Point_idl__ #include <com/sun/star/awt/Point.idl> #endif @@ -89,110 +173,255 @@ #include <com/sun/star/awt/Size.idl> #endif -#ifndef __com_sun_star_style_CharacterProperties_idl__ -#include <com/sun/star/style/CharacterProperties.idl> -#endif - -#ifndef __com_sun_star_style_ParagraphProperties_idl__ -#include <com/sun/star/style/ParagraphProperties.idl> +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> #endif -#ifndef __com_sun_star_chart_XChartData_idl__ -#include <com/sun/star/chart/XChartData.idl> +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> #endif //============================================================================= - module com { module sun { module star { module sheet { - -interface XArrayFormulaRange; +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCellRange -/** an extension of the CellRange service for use - in spreadsheet documents.@see com::sun::star::table::CellRange +/** represents a rectangular range of cells in a spreadsheet document. + + <p>This service is an extension of the CellRange service for use + in spreadsheet documents.</p> */ service SheetCellRange { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides basic handling of cell ranges and contributes common cell + formatting properties. + */ service com::sun::star::table::CellRange; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Western text. + */ service com::sun::star::style::CharacterProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Asian text. + */ + service com::sun::star::style::CharacterPropertiesAsian; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Complex text. + */ + service com::sun::star::style::CharacterPropertiesComplex; + + //------------------------------------------------------------------------- + + /** contributes properties for paragraph formatting. + */ service com::sun::star::style::ParagraphProperties; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides interfaces to find cells with specific properties. + */ + service com::sun::star::sheet::SheetRangesQuery; + + //========================================================================= + + /** provides "Find & Replace" functionality. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + interface com::sun::star::util::XReplaceable; + + //------------------------------------------------------------------------- + + /** provides merging and unmerging the cells of this cell range. + */ interface com::sun::star::util::XMergeable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides modifying the cell indentation. + */ + interface com::sun::star::util::XIndent; + + //------------------------------------------------------------------------- + + /** provides access to the collections of columns and rows. + */ interface com::sun::star::table::XColumnRowRange; - // DocMerge: empty anyway - interface com::sun::star::sheet::XArrayFormulaRange; + //------------------------------------------------------------------------- + + /** provides applying an AutoFormat to the cell range. + */ + interface com::sun::star::table::XAutoFormattable; + + //------------------------------------------------------------------------- + + /** provides access to the spreadsheet that contains this cell range. + */ + interface com::sun::star::sheet::XSheetCellRange; + + //------------------------------------------------------------------------- + + /** provides simultaneous access to the contents of all cells. + */ + interface com::sun::star::sheet::XCellRangeData; + + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access to the cell range address of this range. + */ interface com::sun::star::sheet::XCellRangeAddressable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides computation of a value based on the contents of all + cells of this range and to clear specific cells. + */ interface com::sun::star::sheet::XSheetOperation; - /** offers the cell range for a chart. Makes it possible to learn - about changes in the cell values. */ - interface com::sun::star::chart::XChartData; + //------------------------------------------------------------------------- + + /** provides filling out the cell range automatically with values based + on a start value, step count and fill mode. + */ + interface com::sun::star::sheet::XCellSeries; + + //------------------------------------------------------------------------- + + /** provides handling of array formulas. + */ + interface com::sun::star::sheet::XArrayFormulaRange; + + //------------------------------------------------------------------------- + + /** provides access to the Multiple Operations feature. + */ + interface com::sun::star::sheet::XMultipleOperation; + + //------------------------------------------------------------------------- + + /** provides sorting functionality. + */ + interface com::sun::star::util::XSortable; + + //------------------------------------------------------------------------- + + /** provides functionality to import data from external data sources. + */ + interface com::sun::star::util::XImportable; + + //------------------------------------------------------------------------- + + /** provides calculating SubTotal values in this range. + */ + interface com::sun::star::sheet::XSubTotalCalculatable; + + //------------------------------------------------------------------------- + + /** provides filtering the contents of this range. + */ + interface com::sun::star::sheet::XSheetFilterableEx; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetCellRange::Position - /** contains the position of the range on the sheet. + /** provide access to a collection of equal-formatted cell ranges. + */ + interface com::sun::star::sheet::XCellFormatRangesSupplier; + + //------------------------------------------------------------------------- + + /** provide access to a collection of equal-formatted cell ranges. + */ + interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier; + + //------------------------------------------------------------------------- + + /** provides modifying the source data cells of a chart and makes + it possible to learn about changes in the cell values. + */ + interface com::sun::star::chart::XChartDataArray; + + //========================================================================= + + /** contains the position of the top left cell of this range in + the sheet (in 1/100 mm). + + <p>This property contains the absolute position in the whole + sheet, not the position in the visible area.</p> */ [readonly, property] com::sun::star::awt::Point Position; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetCellRange::Size - /** contains the size of the range. + /** contains the size of this range (in 1/100 mm). */ [readonly, property] com::sun::star::awt::Size Size; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** contains the conditional formatting settings for this cell. -}; }; }; }; + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> -/*============================================================================= + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/21 11:28:28 mi - XChartData is accessible, documentation was missing + //------------------------------------------------------------------------- - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator + /** contains the conditional formatting settings for this cell, + using localized formulas. - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; - Revision 1.1.1.1 2000/09/18 23:35:47 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML + /** contains the data validation settings for this cell. - Revision 1.3 2000/08/02 10:28:00 mi - CharacterProperties and ParagraphProperties (were in table/Cell... before) + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> - Revision 1.2 2000/02/09 15:07:24 mi - #72869# get/setCellStyle moved to CellProperties + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + //------------------------------------------------------------------------- + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRanges.idl b/offapi/com/sun/star/sheet/SheetCellRanges.idl index cd59c50d318e..8b220ffa54d4 100644 --- a/offapi/com/sun/star/sheet/SheetCellRanges.idl +++ b/offapi/com/sun/star/sheet/SheetCellRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetCellRanges.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2001-07-06 11:48:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,27 +58,58 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetCellRanges_idl__ #define __com_sun_star_sheet_SheetCellRanges_idl__ + #ifndef __com_sun_star_table_CellProperties_idl__ #include <com/sun/star/table/CellProperties.idl> #endif -#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ -#include <com/sun/star/sheet/XSheetCellRangeContainer.idl> +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ +#include <com/sun/star/sheet/SheetRangesQuery.idl> +#endif + + +#ifndef __com_sun_star_util_XReplaceable_idl__ +#include <com/sun/star/util/XReplaceable.idl> +#endif + +#ifndef __com_sun_star_util_XIndent_idl__ +#include <com/sun/star/util/XIndent.idl> #endif #ifndef __com_sun_star_sheet_XSheetOperation_idl__ #include <com/sun/star/sheet/XSheetOperation.idl> #endif -#ifndef __com_sun_star_container_XEnumerationAccess_idl__ -#include <com/sun/star/container/XEnumerationAccess.idl> +#ifndef __com_sun_star_chart_XChartDataArray_idl__ +#include <com/sun/star/chart/XChartDataArray.idl> #endif -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> +#ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ +#include <com/sun/star/sheet/XSheetCellRangeContainer.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif #ifndef __com_sun_star_container_XNameContainer_idl__ @@ -86,56 +117,170 @@ #endif +#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ +#include <com/sun/star/sheet/XSheetConditionalEntries.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetCellRanges -/** a collection of cell ranges. +/** represents a collection of cell ranges in a spreadsheet document. + + @see com::sun::star::sheet::SheetCellRange */ service SheetCellRanges { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes common cell formatting properties. + */ service com::sun::star::table::CellProperties; - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCellRangeContainer; + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Western text. + */ + service com::sun::star::style::CharacterProperties; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Asian text. + */ + service com::sun::star::style::CharacterPropertiesAsian; + + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** contributes properties for character formatting of Complex text. + */ + service com::sun::star::style::CharacterPropertiesComplex; + + //------------------------------------------------------------------------- + + /** contributes properties for paragraph formatting. + */ + service com::sun::star::style::ParagraphProperties; + + //------------------------------------------------------------------------- + + /** provides interfaces to find cells with specific properties. + */ + service com::sun::star::sheet::SheetRangesQuery; + + //========================================================================= + + /** provides "Find & Replace" functionality. + + <p>The property + <member scope="com::sun::star::util">SearchDescriptor::SearchWords</member> + has a different meaning in spreadsheets: If set to <TRUE/>, the + spreadsheet searches for cells containing the serch text only.</p> + */ + interface com::sun::star::util::XReplaceable; + + //------------------------------------------------------------------------- + + /** provides modifying the cell indentation. + */ + interface com::sun::star::util::XIndent; + + //------------------------------------------------------------------------- + + /** provides computation of a value based on the contents of all + cells of this range and to clear specific cells. + */ interface com::sun::star::sheet::XSheetOperation; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides modifying the source data cells of a chart and makes + it possible to learn about changes in the cell values. + */ + interface com::sun::star::chart::XChartDataArray; + + //------------------------------------------------------------------------- + + /** provides methods to access cell ranges via index and to add and + remove cell ranges. + */ + interface com::sun::star::sheet::XSheetCellRangeContainer; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all cell ranges. + + @see com::sun::star::sheet::SheetCellRangesEnumeration + */ interface com::sun::star::container::XEnumerationAccess; - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access of the cell ranges via an user-defined name. + + <p>Later the range can be found, replaced or removed using that + name.</p> + */ interface com::sun::star::container::XNameContainer; -}; + //========================================================================= -//============================================================================= + /** contains the conditional formatting settings for this cell. -}; }; }; }; + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormat; + + //------------------------------------------------------------------------- + + /** contains the conditional formatting settings for this cell, + using localized formulas. + + <p>After a conditional format has been changed it has to be + reinserted into the property set.</p> + + @see com::sun::star::sheet::TableConditionalFormat + */ + [optional, property] com::sun::star::sheet::XSheetConditionalEntries + ConditionalFormatLocal; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + /** contains the data validation settings for this cell. - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML + @see com::sun::star::sheet::TableValidation + */ + [property] com::sun::star::beans::XPropertySet Validation; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + //------------------------------------------------------------------------- + /** contains the data validation settings for this cell, + using localized formulas. + + <p>After the data validation settings have been changed the + validation has to be reinserted into the property set.</p> + + @see com::sun::star::sheet::TableValidation + */ + [optional, property] com::sun::star::beans::XPropertySet ValidationLocal; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl b/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl new file mode 100644 index 000000000000..7afee309f625 --- /dev/null +++ b/offapi/com/sun/star/sheet/SheetCellRangesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SheetCellRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:07:58 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SheetCellRangesEnumeration_idl__ +#define __com_sun_star_sheet_SheetCellRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of cell ranges in a spreadsheet document. + + @see com::sun::star::sheet::SheetCellRanges + */ +service SheetCellRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell ranges in the enumeration. + + @see com::sun::star::sheet::SheetCellRange + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl index 0fc54460e441..ecaac6ccbeb9 100644 --- a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetFilterDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetFilterDescriptor_idl__ #define __com_sun_star_sheet_SheetFilterDescriptor_idl__ @@ -77,102 +78,97 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetFilterDescriptor -/** a description of how a cell range is to be filtered. +/** represents a description of how a cell range is to be filtered. + + <p>The descriptor contains properties and a collection of filter + conditions (filter fields) which control the behaviour of a filter + operation.</p> */ service SheetFilterDescriptor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of filter fields. + */ interface com::sun::star::sheet::XSheetFilterDescriptor; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::IsCaseSensitive + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::IsCaseSensitive /** specifies if the case of letters is important when comparing entries. */ [property] boolean IsCaseSensitive; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SkipDuplicates - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SkipDuplicates /** specifies if duplicate entries are left out of the result. */ [property] boolean SkipDuplicates; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::UseRegularExpressions - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::UseRegularExpressions /** specifies if the <member>TableFilterField::StringValue</member> strings are interpreted as regular expressions. */ [property] boolean UseRegularExpressions; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetFilterDescriptor::SaveOutputPosition - - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::SaveOutputPosition - /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> position is saved - for future calls. - + /** specifies if the <member>SheetFilterDescriptor::OutputPosition</member> + position is saved for future calls. - <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + <p>This is only used if + <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ [property] boolean SaveOutputPosition; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::Orientation /** specifies if columns or rows are filtered. */ [property] com::sun::star::table::TableOrientation Orientation; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::ContainsHeader - /** specifies if the first row (or column) - contains headers which should not be filtered. + /** specifies if the first row (or column) contains headers which should + not be filtered. */ [property] boolean ContainsHeader; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::CopyOutputData - /** specifies if the filtered data should - be copied to another position in the document. + /** specifies if the filtered data should be copied to another position + in the document. */ [property] boolean CopyOutputData; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::OutputPosition - /** specifies the position where filtered data - are to be copied. + /** specifies the position where filtered data are to be copied. - - - <p>This is only used if <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> + <p>This is only used if + <member>SheetFilterDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetFilterDescriptor::MaxFieldCount - /** returns the maximum number of filter fields - in the descriptor. + /** returns the maximum number of filter fields in the descriptor. + + <p>This read-only property indicates the maximum count of fields the + current implementation supports.</p> */ [readonly, property] long MaxFieldCount; @@ -182,27 +178,5 @@ service SheetFilterDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetLink.idl b/offapi/com/sun/star/sheet/SheetLink.idl index 85a58fb772d8..e3e14c4429a5 100644 --- a/offapi/com/sun/star/sheet/SheetLink.idl +++ b/offapi/com/sun/star/sheet/SheetLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLink.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetLink_idl__ #define __com_sun_star_sheet_SheetLink_idl__ @@ -73,47 +74,62 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetLink -/** a sheet link. +/** represents a sheet link. + + <p>A sheet link contains the source data of linked sheets, i.e. the + URL and sheet name of the external document.</p> + + <p>To create a linked sheet, the sheet which will be used as linked + sheet has to exist already. The method + <member>XSheetLinkable::link</member> creates a <type>SheetLink</type> + object in the document's <type>SheetLinks</type> collection and links + the sheet to the specified external sheet.</p> */ service SheetLink { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the name of the linked document. + + <p>This name is equal to the <const>Url</const> property.</p> + */ interface com::sun::star::container::XNamed; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to reload the external data. + */ interface com::sun::star::util::XRefreshable; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::SheetLink::Url /** specifies the URL of the source document. */ [property] string Url; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetLink::Filter - /** specifies the name of the filter needed - to load the source document. + /** specifies the name of the filter needed to load the source + document. */ [property] string Filter; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetLink::FilterOptions - /** specifies the filter options needed - to load the source document. + /** specifies the filter options needed to load the source document. */ [property] string FilterOptions; @@ -123,24 +139,5 @@ service SheetLink }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetLinkMode.idl b/offapi/com/sun/star/sheet/SheetLinkMode.idl index 6e266990ca4d..7047fc8272c8 100644 --- a/offapi/com/sun/star/sheet/SheetLinkMode.idl +++ b/offapi/com/sun/star/sheet/SheetLinkMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLinkMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,38 +58,38 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetLinkMode_idl__ #define __com_sun_star_sheet_SheetLinkMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::SheetLinkMode /** used to specify how a sheet is linked to another sheet. + + @see com::sun::star::sheet::SheetLinks + @see com::sun::star::sheet::SheetLink + @see com::sun::star::sheet::XSheetLinkable */ enum SheetLinkMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::NONE /** sheet is not linked. */ NONE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::NORMAL - /** all contents are copied. + /** all contents (values and formulas) are copied. */ NORMAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::SheetLinkMode::VALUE /** instead of using formulas, the result values are copied. */ VALUE @@ -100,18 +100,5 @@ enum SheetLinkMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetLinks.idl b/offapi/com/sun/star/sheet/SheetLinks.idl index bf3c08cfb01a..f08a3395ad68 100644 --- a/offapi/com/sun/star/sheet/SheetLinks.idl +++ b/offapi/com/sun/star/sheet/SheetLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetLinks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:07:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,66 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetLinks_idl__ #define __com_sun_star_sheet_SheetLinks_idl__ +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetLinks -/** a collection of sheet links. +/** represents a collection of sheet links. + + @see com::sun::star::sheet::SheetLink + @see com::sun::star::sheet::SpreadsheetDocument */ service SheetLinks { - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- -}; + /** provides access to the sheet links via index. -//============================================================================= + @see com::sun::star::sheet::SheetLink -}; }; }; }; + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- -/*============================================================================= + /** provides access to the sheet links using the name of the linked + document. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + @see com::sun::star::sheet::SheetLink - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML + */ + interface com::sun::star::container::XNameAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all sheet links. + + @see com::sun::star::sheet::SheetLinksEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +}; +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl b/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl new file mode 100644 index 000000000000..807fe0bdbc03 --- /dev/null +++ b/offapi/com/sun/star/sheet/SheetLinksEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SheetLinksEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SheetLinksEnumeration_idl__ +#define __com_sun_star_sheet_SheetLinkssEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of sheet links. + + @see com::sun::star::sheet::SheetLink + */ +service SheetLinksEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the sheet links in the enumeration. + + @see com::sun::star::sheet::SheetLink + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SheetRangesQuery.idl b/offapi/com/sun/star/sheet/SheetRangesQuery.idl index 8fb23668e159..0eed4141fa43 100644 --- a/offapi/com/sun/star/sheet/SheetRangesQuery.idl +++ b/offapi/com/sun/star/sheet/SheetRangesQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetRangesQuery.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SheetRangesQuery_idl__ #define __com_sun_star_sheet_SheetRangesQuery_idl__ @@ -69,22 +70,26 @@ #include <com/sun/star/sheet/XFormulaQuery.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetRangesQuery -/** makes it possible to query for cells. +/** provides interfaces to find cells with specific properties. */ service SheetRangesQuery { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to query for cell ranges with specific contents. + */ interface com::sun::star::sheet::XCellRangesQuery; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to find dependent cells of formula cells. + */ interface com::sun::star::sheet::XFormulaQuery; }; @@ -93,18 +98,5 @@ service SheetRangesQuery }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl index fea34a978565..c7dd6c28aa49 100644 --- a/offapi/com/sun/star/sheet/SheetSortDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetSortDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SheetSortDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-03-14 16:31:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,60 +75,54 @@ module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SheetSortDescriptor /** a description of how a cell range is to be sorted. + + <p>This service extends the <type scope="com::sun::star::util">SortDescriptor</type> + service with spreadsheet specific properties.</p> */ service SheetSortDescriptor { + //------------------------------------------------------------------------- + + /** provides common sorting properties. + */ service com::sun::star::util::SortDescriptor; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::BindFormatsToContent + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::BindFormatsToContent /** specifies if cell formats are moved with the contents they belong to. */ [property] boolean BindFormatsToContent; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::IsUserListEnabled - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::IsUserListEnabled /** specifies if a user defined sorting list is used. */ [property] boolean IsUserListEnabled; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::UserListIndex - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::UserListIndex /** specifies which user defined sorting list is used. - - - <p>This is only used if <member>SheetSortDescriptor::IsUserListEnabled</member> - is <TRUE/>.</p> + <p>This property is only used, if + <member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p> */ [property] long UserListIndex; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::CopyOutputData - /** specifies if the sorted data should be - copied to another position in the document. + /** specifies if the sorted data should be copied to another + position in the document. */ [property] boolean CopyOutputData; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::OutputPosition - /** specifies the position where sorted data - are to be copied. - + /** specifies the position where sorted data are to be copied. - - <p>This is only used if UseOutputPosition is <TRUE/>.</p> + <p>This property is only used, if + <member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p> */ [property] com::sun::star::table::CellAddress OutputPosition; @@ -138,30 +132,5 @@ service SheetSortDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/Spreadsheet.idl b/offapi/com/sun/star/sheet/Spreadsheet.idl index f4d9f673a41a..882474f1325b 100644 --- a/offapi/com/sun/star/sheet/Spreadsheet.idl +++ b/offapi/com/sun/star/sheet/Spreadsheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: Spreadsheet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_Spreadsheet_idl__ #define __com_sun_star_sheet_Spreadsheet_idl__ @@ -73,114 +74,187 @@ #include <com/sun/star/container/XNamed.idl> #endif -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> +#ifndef __com_sun_star_util_XProtectable_idl__ +#include <com/sun/star/util/XProtectable.idl> #endif -#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ -#include <com/sun/star/sheet/XSheetPageBreak.idl> +#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ +#include <com/sun/star/sheet/XDataPilotTablesSupplier.idl> #endif -#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ -#include <com/sun/star/sheet/XCellRangeMovement.idl> +#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ +#include <com/sun/star/sheet/XScenariosSupplier.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ +#include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl> +#endif + +#ifndef __com_sun_star_drawing_XDrawPageSupplier_idl__ +#include <com/sun/star/drawing/XDrawPageSupplier.idl> #endif #ifndef __com_sun_star_table_XTableChartsSupplier_idl__ #include <com/sun/star/table/XTableChartsSupplier.idl> #endif -#ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ -#include <com/sun/star/sheet/XDataPilotTablesSupplier.idl> +#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ +#include <com/sun/star/sheet/XCellRangeMovement.idl> #endif -#ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ -#include <com/sun/star/sheet/XScenariosSupplier.idl> +#ifndef __com_sun_star_sheet_XPrintAreas_idl__ +#include <com/sun/star/sheet/XPrintAreas.idl> #endif -#ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ -#include <com/sun/star/sheet/XSheetAnnotationsSupplier.idl> +#ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ +#include <com/sun/star/sheet/XSheetPageBreak.idl> #endif +#ifndef __com_sun_star_sheet_XScenario_idl__ +#include <com/sun/star/sheet/XScenario.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetOutline_idl__ +#include <com/sun/star/sheet/XSheetOutline.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetAuditing_idl__ +#include <com/sun/star/sheet/XSheetAuditing.idl> +#endif + +#ifndef __com_sun_star_sheet_XSheetLinkable_idl__ +#include <com/sun/star/sheet/XSheetLinkable.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::Spreadsheet -/** a 2-dimensional sheet of cells. +/** represents a complete spreadsheet in a spreadsheet document. + + <p>This service extents the service SheetCellRange. A spreadsheet is + nothing else than a cell range with extended functionality.</p> + + @see com::sun::star::sheet::SpreadsheetDocument */ service Spreadsheet { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides functionality for cell range handling. + */ service com::sun::star::sheet::SheetCellRange; - // DocMerge: empty anyway + //========================================================================= + + /** provides methods to create a cell cursor. + */ interface com::sun::star::sheet::XSpreadsheet; - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; + /** provides accessing the spreadsheet name. + */ + interface com::sun::star::container::XNamed; - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetPageBreak; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - interface com::sun::star::sheet::XCellRangeMovement; + /** provides methods to protect and unprotect the sheet contents. + */ + interface com::sun::star::util::XProtectable; - // DocMerge: empty anyway - interface com::sun::star::table::XTableChartsSupplier; + //------------------------------------------------------------------------- - // DocMerge: empty anyway + /** provides access to the collection of DataPilot tables. + */ interface com::sun::star::sheet::XDataPilotTablesSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of scenarios. + */ interface com::sun::star::sheet::XScenariosSupplier; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of annotations. + */ interface com::sun::star::sheet::XSheetAnnotationsSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::Spreadsheet::IsVisible - /** specifies if the sheet is visible. + /** provides access to the draw page of this spreadsheet. */ - [readonly, property] boolean IsVisible; + interface com::sun::star::drawing::XDrawPageSupplier; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::Spreadsheet::PageStyle - /** specifies the page style of the sheet. + /** provides access to the collection of chart objects. */ - [readonly, property] string PageStyle; + interface com::sun::star::table::XTableChartsSupplier; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides methods to move cell ranges inside the spreadsheet or to + other spreadsheets in this document. + */ + interface com::sun::star::sheet::XCellRangeMovement; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** provides access to the print area settings of this sheet. + */ + interface com::sun::star::sheet::XPrintAreas; - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.5 2000/09/11 11:52:49 mi - documentation merged from XML + /** provides access to the page breaks of this sheet. + */ + interface com::sun::star::sheet::XSheetPageBreak; - Revision 1.3 2000/02/21 16:18:08 mi - string documentation from stardiv...*.idl-files + //------------------------------------------------------------------------- - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked + /** provides methods for a scenario sheet. + */ + interface com::sun::star::sheet::XScenario; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new + //------------------------------------------------------------------------- + /** provides access to row and column outline settings. + */ + interface com::sun::star::sheet::XSheetOutline; + + //------------------------------------------------------------------------- + + /** provides access to the auditing (detective) functionality. + */ + interface com::sun::star::sheet::XSheetAuditing; + + //------------------------------------------------------------------------- + + /** provides methods for a linked sheet. + */ + interface com::sun::star::sheet::XSheetLinkable; + + //========================================================================= + + /** specifies if the sheet is visible. + */ + [readonly, property] boolean IsVisible; + + //------------------------------------------------------------------------- + + /** specifies the page style of the sheet. + */ + [readonly, property] string PageStyle; + +}; + +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocument.idl b/offapi/com/sun/star/sheet/SpreadsheetDocument.idl index cc03ce2e1d77..07874bc39b0a 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocument.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetDocument.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2001-09-28 10:34:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,28 +58,71 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SpreadsheetDocument_idl__ #define __com_sun_star_sheet_SpreadsheetDocument_idl__ -#ifndef __com_sun_star_lang_XComponent_idl__ -#include <com/sun/star/lang/XComponent.idl> +#ifndef __com_sun_star_document_OfficeDocument_idl__ +#include <com/sun/star/document/OfficeDocument.idl> +#endif + +#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ +#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> +#endif + + +#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__ +#include <com/sun/star/lang/XMultiServiceFactory.idl> #endif #ifndef __com_sun_star_frame_XModel_idl__ #include <com/sun/star/frame/XModel.idl> #endif +#ifndef __com_sun_star_document_XActionLockable_idl__ +#include <com/sun/star/document/XActionLockable.idl> +#endif + +#ifndef __com_sun_star_document_XLinkTargetSupplier_idl__ +#include <com/sun/star/document/XLinkTargetSupplier.idl> +#endif + +#ifndef __com_sun_star_util_XProtectable_idl__ +#include <com/sun/star/util/XProtectable.idl> +#endif + #ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ #include <com/sun/star/sheet/XSpreadsheetDocument.idl> #endif +#ifndef __com_sun_star_sheet_XCalculatable_idl__ +#include <com/sun/star/sheet/XCalculatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XDocumentAuditing_idl__ +#include <com/sun/star/sheet/XDocumentAuditing.idl> +#endif + +#ifndef __com_sun_star_sheet_XConsolidatable_idl__ +#include <com/sun/star/sheet/XConsolidatable.idl> +#endif + +#ifndef __com_sun_star_sheet_XGoalSeek_idl__ +#include <com/sun/star/sheet/XGoalSeek.idl> +#endif + +#ifndef __com_sun_star_drawing_XDrawPagesSupplier_idl__ +#include <com/sun/star/drawing/XDrawPagesSupplier.idl> +#endif + +#ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__ +#include <com/sun/star/style/XStyleFamiliesSupplier.idl> +#endif + #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__ #include <com/sun/star/util/XNumberFormatsSupplier.idl> #endif -#ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ -#include <com/sun/star/sheet/SpreadsheetDocumentSettings.idl> -#endif #ifndef __com_sun_star_sheet_XNamedRanges_idl__ #include <com/sun/star/sheet/XNamedRanges.idl> @@ -101,92 +144,155 @@ #include <com/sun/star/sheet/XAreaLinks.idl> #endif -#ifndef __com_sun_star_document_OfficeDocument_idl__ -#include <com/sun/star/document/OfficeDocument.idl> -#endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetDocument -/** a model component which consists of some - settings and one or more spreadsheets. +/** represents a model component which consists of some settings and + one or more spreadsheets. */ service SpreadsheetDocument { - // DocMerge: empty anyway - interface com::sun::star::lang::XComponent; + //------------------------------------------------------------------------- + + /** common service for all types of documents. + */ + service com::sun::star::document::OfficeDocument; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** contributes spreadsheet document specific properties. + */ + service com::sun::star::sheet::SpreadsheetDocumentSettings; + + //========================================================================= + + /** provides methods to create instances of several spreadsheet + services. + */ + interface com::sun::star::lang::XMultiServiceFactory; + + //------------------------------------------------------------------------- + + /** provides common methods for a document model. + + <p>This interface is derived from + <type scope="com::sun::star::lang">XComponent</type>.</p> + */ interface com::sun::star::frame::XModel; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to control the automatic update of cell contents. + */ + interface com::sun::star::document::XActionLockable; + + //------------------------------------------------------------------------- + + /** provides access to the collection of link targets available in + the document. + */ + interface com::sun::star::document::XLinkTargetSupplier; + + //------------------------------------------------------------------------- + + /** provides methods to protect and unprotect the document. + */ + interface com::sun::star::util::XProtectable; + + //------------------------------------------------------------------------- + + /** provides access to the collection of spreadsheets. + */ interface com::sun::star::sheet::XSpreadsheetDocument; - // DocMerge: empty anyway - interface com::sun::star::util::XNumberFormatsSupplier; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - service com::sun::star::sheet::SpreadsheetDocumentSettings; + /** controls the recalculation settings of the document. + */ + interface com::sun::star::sheet::XCalculatable; - service com::sun::star::document::OfficeDocument; + //------------------------------------------------------------------------- + + /** provides a method to refresh all auditing arrows. + */ + interface com::sun::star::sheet::XDocumentAuditing; + + //------------------------------------------------------------------------- + + /** provides methods to perform a data consolidation. + */ + interface com::sun::star::sheet::XConsolidatable; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::NamedRanges - /** contains the collection of named ranges in the - document. + /** provides a method to perform a goal seek. + */ + interface com::sun::star::sheet::XGoalSeek; + + //------------------------------------------------------------------------- + + /** provides access to the collection of draw pages of this document. + */ + interface com::sun::star::drawing::XDrawPagesSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of style families. + + <p>A spreadsheet document contains 2 families of styles: + "PageStyles" and "CellStyles".</p> + */ + interface com::sun::star::style::XStyleFamiliesSupplier; + + //------------------------------------------------------------------------- + + /** provides access to the collection of number formats contained in + the document. + */ + interface com::sun::star::util::XNumberFormatsSupplier; + + //========================================================================= + + /** contains the collection of named ranges in the document. */ [readonly, property] com::sun::star::sheet::XNamedRanges NamedRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::DatabaseRanges - /** contains the collection of database ranges in the - document. + /** contains the collection of database ranges in the document. */ [readonly, property] com::sun::star::sheet::XDatabaseRanges DatabaseRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::ColumnLabelRanges - /** contains the collection of column label ranges - in the document. + /** contains the collection of column label ranges in the document. */ [readonly, property] com::sun::star::sheet::XLabelRanges ColumnLabelRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::RowLabelRanges - /** contains the collection of row label ranges - in the document. + /** contains the collection of row label ranges in the document. */ [readonly, property] com::sun::star::sheet::XLabelRanges RowLabelRanges; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::SheetLinks - /** contains the collection of sheet links - in the document. + /** contains the collection of sheet links in the document. */ [readonly, property] com::sun::star::container::XNameAccess SheetLinks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::AreaLinks - /** contains the collection of area links - in the document. + /** contains the collection of area links in the document. */ [readonly, property] com::sun::star::sheet::XAreaLinks AreaLinks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocument::DDELinks - /** contains the collection of DDE links - in the document. + /** contains the collection of DDE links in the document. */ [readonly, property] com::sun::star::container::XNameAccess DDELinks; @@ -196,27 +302,5 @@ service SpreadsheetDocument }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/10 09:02:36 mi - #78530# SpreadsheetDocument exports XNumberFormatsSupplier instead of XNumberFormatter - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.4 2000/09/11 11:52:49 mi - documentation merged from XML - - Revision 1.2 1999/11/18 11:49:58 mi - XComponent now in module lang - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl index fca2d815539e..83862748a084 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDocumentSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetDocumentSettings.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ #define __com_sun_star_sheet_SpreadsheetDocumentSettings_idl__ @@ -73,167 +74,164 @@ #include <com/sun/star/i18n/XForbiddenCharacters.idl> #endif +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetDocumentSettings -/** keep the configuration - which is global for all views of a spreadsheet document. +/** contributes properties to control the configuration which is global + for all views of a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service SpreadsheetDocumentSettings { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IsIterationEnabled /** enables iterated calculation of circular references. */ [property] boolean IsIterationEnabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IterationCount - /** specifies how many iterations are carried out if - iteration is enabled. + /** specifies how many iterations are carried out. + + <p>This setting is only used, if iteration is enabled using + <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> */ [property] long IterationCount; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IterationEpsilon - /** if iteration is enabled, this property specifies the point at - which a change in results will stop the iteration. - - + /** specifies the point at which a change in results will stop + the iteration. <p>More exactly it specifies a difference in the change of the result between two iterations. If the result difference is less than or equal to this epsilon-value, the iteration - is stopped. + is stopped.</p> - </p> - <p>only applied when iteration is enabled by + <p>This setting is only used, if iteration is enabled using <member>SpreadsheetDocumentSettings::IsIterationEnabled</member>.</p> */ [property] double IterationEpsilon; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::StandardDecimals - /** specifies the number of decimals in the default - number format. + /** specifies the number of decimals in the default number format. */ [property] short StandardDecimals; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::NullDate - /** specifies the date that is represented by the value - zero. + /** specifies the date that is represented by the value zero. */ [property] com::sun::star::util::Date NullDate; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::DefaultTabStop /** specifies the width of default tabulators. */ [property] short DefaultTabStop; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::IgnoreCase - /** specifies if upper and lower cases are treated as equal + /** specifies whether upper and lower cases are treated as equal when comparing cells. */ [property] boolean IgnoreCase; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::CalcAsShown - /** if this property is set, calculations are performed with the rounded - values displayed in cells instead of the internal values. + /** specifies whether calculations are performed with the rounded + values displayed in cells (set to <TRUE/>) instead of the + internal values (set to <FALSE/>). */ [property] boolean CalcAsShown; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::MatchWholeCell - /** if this property is set, filter criteria must match entire cell - contents. + /** specifies whether filter criteria must match entire cell contents. */ [property] boolean MatchWholeCell; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::SpellOnline /** enables online spell checking. */ [property] boolean SpellOnline; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetDocumentSettings::LookUpLabels - /** if this property is set, column or row labels are looked up from + /** specifies whether column or row labels are looked up from anywhere on the sheet. + + <p>Explicitly defined label ranges are used even if this property + is set to <FALSE/>.</p> + + @see com::sun::star::sheet::LabelRanges */ [property] boolean LookUpLabels; //------------------------------------------------------------------------- - /** if this property is set, regular expressions in formulas are enabled, + /** specifies whether regular expressions in formulas are enabled, e.g., for functions which look up spreadsheet contents. */ [property] boolean RegularExpressions; //------------------------------------------------------------------------- - /** This property gives the XForbiddenCharacters. + /** contains the interface XForbiddenCharacters. */ - [readonly, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; + [readonly, optional, property] com::sun::star::i18n::XForbiddenCharacters ForbiddenCharacters; //------------------------------------------------------------------------- - /** If this property is set the document has DrawPages. Use this property - to find out, whether the document has DrawPages or not, because the - getDrawPage method on the XDrawPageSupplier and the getDrawPages method - on the XDrawPagesSupplier always creates the DrawPages - if there are none; and this is very slow and needs more memory. + /** If this property is set the document has DrawPages. Use this + property to find out, whether the document has DrawPages or not, + because the getDrawPage method on the XDrawPageSupplier and the + getDrawPages method on the XDrawPagesSupplier always creates the + DrawPages if there are none; and this is very slow and needs more + memory. */ - [readonly, property] boolean HasDrawPages; + [readonly, optional, property] boolean HasDrawPages; -}; - -//============================================================================= - -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** contains the standard document language for Western text. + */ + [optional, property] com::sun::star::lang::Locale CharLocale; - $Log: not supported by cvs2svn $ - Revision 1.5 2001/07/26 07:01:04 sab - #90139#; property HasDrawPages and ForbiddenCharacters added + //------------------------------------------------------------------------- - Revision 1.4 2001/05/15 18:09:59 er - #78323# new document settings property RegularExpressions + /** contains the standard document language for Asian text. + */ + [optional, property] com::sun::star::lang::Locale CharLocaleAsian; - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + //------------------------------------------------------------------------- - Revision 1.1.1.1 2000/09/18 23:35:46 hjs - initial import + /** contains the standard document language for Complex text. + */ + [optional, property] com::sun::star::lang::Locale CharLocaleComplex; - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetView.idl b/offapi/com/sun/star/sheet/SpreadsheetView.idl index 9f2abefe977b..642faa1f6152 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetView.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetView.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: nn $ $Date: 2001-01-10 11:26:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,10 +61,18 @@ #ifndef __com_sun_star_sheet_SpreadsheetView_idl__ #define __com_sun_star_sheet_SpreadsheetView_idl__ +#ifndef __com_sun_star_frame_Controller_idl__ +#include <com/sun/star/frame/Controller.idl> +#endif + #ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ #include <com/sun/star/sheet/SpreadsheetViewSettings.idl> #endif +#ifndef __com_sun_star_sheet_SpreadsheetViewPane_idl__ +#include <com/sun/star/sheet/SpreadsheetViewPane.idl> +#endif + #ifndef __com_sun_star_sheet_XSpreadsheetView_idl__ #include <com/sun/star/sheet/XSpreadsheetView.idl> #endif @@ -85,6 +93,13 @@ #include <com/sun/star/sheet/XViewFreezable.idl> #endif +#ifndef __com_sun_star_sheet_XRangeSelection_idl__ +#include <com/sun/star/sheet/XRangeSelection.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif //============================================================================= @@ -92,50 +107,65 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetView -/** a view of a spreadsheet document. +/** represents a view of a spreadsheet document. */ service SpreadsheetView { - // DocMerge: empty anyway + /** provides the integration into the framework. + */ + service com::sun::star::frame::Controller; + + /** provides the view's settings. + */ service com::sun::star::sheet::SpreadsheetViewSettings; - // DocMerge: empty anyway + /** provides direct access to the view's active pane. + */ + service com::sun::star::sheet::SpreadsheetViewPane; + + /** provides access to the active sheet in the view. + */ interface com::sun::star::sheet::XSpreadsheetView; - // DocMerge: empty anyway + /** provides access to the collection of view panes. + */ interface com::sun::star::container::XIndexAccess; - // DocMerge: empty anyway + /** creates an enumeration of view panes. + + @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration + + */ + interface com::sun::star::container::XEnumerationAccess; + + /** provides access to the view's selection. + <p>The selection in a spreadsheet view can be a + <type scope="com::sun::star::sheet">SheetCell</type>, + <type scope="com::sun::star::sheet">SheetCellRange</type>, + <type scope="com::sun::star::sheet">SheetCellRanges</type>, + <type scope="com::sun::star::drawing">Shape</type> or + <type scope="com::sun::star::drawing">Shapes</type> object. + </p> + */ interface com::sun::star::view::XSelectionSupplier; - // DocMerge: empty anyway + /** allows to split the view. + */ interface com::sun::star::sheet::XViewSplitable; - // DocMerge: empty anyway + /** allows to freeze columns and rows of the view. + */ interface com::sun::star::sheet::XViewFreezable; + /** allows to let the user interactively select a cell range. + */ + interface com::sun::star::sheet::XRangeSelection; + }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl b/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl index 5c763a247319..bab9b1b4c324 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetViewPane.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetViewPane.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,6 +69,10 @@ #include <com/sun/star/sheet/XCellRangeReferrer.idl> #endif +#ifndef __com_sun_star_view_XControlAccess_idl__ +#include <com/sun/star/view/XControlAccess.idl> +#endif + //============================================================================= @@ -76,35 +80,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetViewPane -/** a single pane in a view of a spreadsheet document. +/** represents a single pane in a view of a spreadsheet document. */ service SpreadsheetViewPane { - // DocMerge: empty anyway + /** allows to control which cells are shown in the view pane. + */ interface com::sun::star::sheet::XViewPane; - // DocMerge: empty anyway + /** gives direct access to the cell range object for the visible range. + */ interface com::sun::star::sheet::XCellRangeReferrer; + /** provides access to a control model's control for the view pane. + */ + [optional] interface com::sun::star::view::XControlAccess; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl b/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl new file mode 100644 index 000000000000..168a1ed73455 --- /dev/null +++ b/offapi/com/sun/star/sheet/SpreadsheetViewPanesEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SpreadsheetViewPanesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SpreadsheetViewPanesEnumeration_idl__ +#define __com_sun_star_sheet_SpreadsheetViewPanesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of spreadsheet view panes. + + @see com::sun::star::sheet::SpreadsheetViewPane + */ +service SpreadsheetViewPanesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheet view panes in the enumeration. + + @see com::sun::star::sheet::SpreadsheetViewPane + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl b/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl index 5d91d36d89ca..2544d44c5cb6 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetViewSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SpreadsheetViewSettings.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sab $ $Date: 2002-10-02 14:50:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__ #define __com_sun_star_sheet_SpreadsheetViewSettings_idl__ @@ -65,97 +66,84 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SpreadsheetViewSettings -/** settings which are specific to each view of a spreadsheet - document. +/** contains settings which are specific to each view of a spreadsheet */ service SpreadsheetViewSettings { - // DocMerge: empty anyway + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowFormulas - /** if this property is set, formulas are displayed instead of their + /** controls whether formulas are displayed instead of their results. */ [property] boolean ShowFormulas; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowZeroValues /** enables display of zero-values. */ [property] boolean ShowZeroValues; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::IsValueHighlightingEnabled - /** if this property is set, strings, values, and formulas are + /** controls whether strings, values, and formulas are displayed in different colors. */ [property] boolean IsValueHighlightingEnabled; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowNotes - /** if this property is set, a marker is shown for notes in cells. + /** controls whether a marker is shown for notes in cells. */ [property] boolean ShowNotes; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasVerticalScrollBar /** enables the vertical scroll bar of the view. */ [property] boolean HasVerticalScrollBar; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasHorizontalScrollBar /** enables the horizontal scroll bar of the view. */ [property] boolean HasHorizontalScrollBar; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasSheetTabs /** enables the sheet tabs of the view. */ [property] boolean HasSheetTabs; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::IsOutlineSymbolsSet /** enables the display of outline symbols. */ [property] boolean IsOutlineSymbolsSet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HasColumnRowHeaders /** enables the column and row headers of the view. */ [property] boolean HasColumnRowHeaders; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowGrid /** enables the display of the cell grid. */ [property] boolean ShowGrid; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::GridColor /** specifies the color in which the cell grid is displayed. */ @@ -163,7 +151,6 @@ service SpreadsheetViewSettings //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowHelpLines /** enables display of help lines when moving drawing objects. */ @@ -171,7 +158,6 @@ service SpreadsheetViewSettings //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowAnchor /** enables display of anchor symbols when drawing objects are selected. */ @@ -179,14 +165,12 @@ service SpreadsheetViewSettings //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowPageBreaks /** enables display of page breaks. */ [property] boolean ShowPageBreaks; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::SolidHandles /** enables solid (colored) handles when drawing objects are selected. */ @@ -194,28 +178,24 @@ service SpreadsheetViewSettings //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowObjects /** enables display of embedded objects in the view. */ [property] short ShowObjects; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowCharts /** enables the display of charts in the view. */ [property] short ShowCharts; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::ShowDrawing /** enables the display of drawing objects in the view. */ [property] short ShowDrawing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SpreadsheetViewSettings::HideSpellMarks /** disables the display of marks from online spelling. */ [property] boolean HideSpellMarks; @@ -233,28 +213,11 @@ service SpreadsheetViewSettings <member scope="com::sun::star::view::DocumentZoomType">BY_VALUE</member>. */ [property] short ZoomValue; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/Spreadsheets.idl b/offapi/com/sun/star/sheet/Spreadsheets.idl index 0334e1f9661a..eeec4683d0f5 100644 --- a/offapi/com/sun/star/sheet/Spreadsheets.idl +++ b/offapi/com/sun/star/sheet/Spreadsheets.idl @@ -2,9 +2,9 @@ * * $RCSfile: Spreadsheets.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_Spreadsheets_idl__ #define __com_sun_star_sheet_Spreadsheets_idl__ @@ -69,49 +70,52 @@ #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 sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::Spreadsheets -/** the collection of spreadsheets in a spreadsheet document. +/** represents the collection of spreadsheets in a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetDocument */ service Spreadsheets { - // DocMerge: empty anyway - interface com::sun::star::sheet::XSpreadsheets; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + /** provides methods to access the spreadsheets by name and to insert, + copy, remove and rearrange spreadsheets. - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::sheet::XSpreadsheets; -}; + //------------------------------------------------------------------------- -//============================================================================= + /** provides methods to access the spreadsheets by index. -}; }; }; }; + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XIndexAccess; -/*============================================================================= + //------------------------------------------------------------------------- - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + /** creates an enumeration of all spreadsheets. - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML + @see com::sun::star::sheet::SpreadsheetsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +}; +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl b/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl new file mode 100644 index 000000000000..2f1da05b86ef --- /dev/null +++ b/offapi/com/sun/star/sheet/SpreadsheetsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SpreadsheetsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SpreadsheetsEnumeration_idl__ +#define __com_sun_star_sheet_SpreadsheetsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of spreadsheets in a spreadsheet document. + + @see com::sun::star::sheet::Spreadsheets + */ +service SpreadsheetsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the spreadsheets in the enumeration. + + @see com::sun::star::sheet::Spreadsheet + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/StatusBarFunction.idl b/offapi/com/sun/star/sheet/StatusBarFunction.idl new file mode 100644 index 000000000000..2d31d164cf13 --- /dev/null +++ b/offapi/com/sun/star/sheet/StatusBarFunction.idl @@ -0,0 +1,125 @@ +/************************************************************************* + * + * $RCSfile: StatusBarFunction.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_StatusBarFunction_idl__ +#define __com_sun_star_sheet_StatusBarFunction_idl__ + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** used to specify the function used to calculate a result in the + spreadsheet's status bar. + */ +constants StatusBarFunction +{ + //------------------------------------------------------------------------- + + /** nothing is calculated. + */ + const short NONE = 0; + + //------------------------------------------------------------------------- + + /** average of all numerical values is calculated. + */ + const short AVERAGE = 1; + + //------------------------------------------------------------------------- + + /** all values, including non-numerical values, are counted. + */ + const short COUNTNUMS = 2; + + //------------------------------------------------------------------------- + + /** numerical values are counted. + */ + const short COUNT = 3; + + //------------------------------------------------------------------------- + + /** maximum value of all numerical values is calculated. + */ + const short MAX = 4; + + //------------------------------------------------------------------------- + + /** minimum value of all numerical values is calculated. + */ + const short MIN = 5; + + //------------------------------------------------------------------------- + + /** sum of all numerical values is calculated. + */ + const short SUM = 9; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/SubTotalColumn.idl b/offapi/com/sun/star/sheet/SubTotalColumn.idl index 6c5238b51f50..f793bcd0095e 100644 --- a/offapi/com/sun/star/sheet/SubTotalColumn.idl +++ b/offapi/com/sun/star/sheet/SubTotalColumn.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalColumn.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SubTotalColumn_idl__ #define __com_sun_star_sheet_SubTotalColumn_idl__ @@ -65,28 +66,27 @@ #include <com/sun/star/sheet/GeneralFunction.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::SubTotalColumn -/** describes how a single data column is treated when - creating subtotals. +/** describes how a single data column is treated when creating subtotals. + + @see com::sun::star::sheet::SubTotalDescriptor */ struct SubTotalColumn { - // DocMerge from xml: field com::sun::star::sheet::SubTotalColumn::Column - /** the index of the column. + //------------------------------------------------------------------------- + + /** the index of the column inside the source data area. */ long Column; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::SubTotalColumn::Function - /** what kind of subtotals are calculated. + /** specifies what kind of subtotals are calculated. */ com::sun::star::sheet::GeneralFunction Function; @@ -96,18 +96,5 @@ struct SubTotalColumn }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl index 27e7f877d1ce..1a482562c0a7 100644 --- a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__ #define __com_sun_star_sheet_SubTotalDescriptor_idl__ @@ -68,83 +69,108 @@ #ifndef __com_sun_star_beans_XPropertySet_idl__ #include <com/sun/star/beans/XPropertySet.idl> #endif - +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SubTotalDescriptor -/** This is a description of how subtotals are created. +/** represents a description of how subtotals are created. + + <p>The descriptor contains properties and a collection of subtotal fields + which control the behaviour of operation.</p> */ service SubTotalDescriptor { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the collection of subtotal fields. + */ interface com::sun::star::sheet::XSubTotalDescriptor; - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; + //------------------------------------------------------------------------- + + /** creates an enumeration of all sub total fields. + + @see com::sun::star::sheet::SubTotalFieldsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::InsertPageBreaks - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::InsertPageBreaks + /** provides access to the sub total fields in the collection via index. + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + +//! service PropertySet + /** procides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + /** specifies if page breaks are inserted after each group change. */ [property] boolean InsertPageBreaks; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::IsCaseSensitive - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::IsCaseSensitive /** specifies if the case of letters is important when comparing entries. */ [property] boolean IsCaseSensitive; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::EnableUserSortList - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::EnableUserSortList /** specifies if a user defined sorting list is used. */ [property] boolean EnableUserSortList; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::UserSortListIndex - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::UserSortListIndex /** specifies which user defined sorting list is used. - - - <p>This is only used if <member>SubTotalDescriptor::EnableUserSortList</member> + <p>This property is only used if + <member>SubTotalDescriptor::EnableUserSortList</member> is <TRUE/>.</p> */ [property] long UserSortListIndex; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SubTotalDescriptor::BindFormatsToContent - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::BindFormatsToContent - /** specifies if cell formats are moved with the contents - they belong to. + /** specifies if cell formats are moved with the contents they belong to. */ [property] boolean BindFormatsToContent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::SortAscending - /** specifies the sorting order if Sort is set to <TRUE/>. + /** specifies if the contents of the fields will be sorted to groups + while performing a subtotal operation. + */ + [property] boolean EnableSort; + + //------------------------------------------------------------------------- + + /** specifies the sorting order if + <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>. */ [property] boolean SortAscending; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::SubTotalDescriptor::MaxFieldCount - /** returns the maximum number of subtotal fields - the descriptor can hold. + /** returns the maximum number of subtotal fields the descriptor can + hold. + + <p>This read-only property indicates the maximum count of fields the + current implementation supports.</p> */ [readonly, property] long MaxFieldCount; @@ -154,27 +180,5 @@ service SubTotalDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SubTotalField.idl b/offapi/com/sun/star/sheet/SubTotalField.idl index fe957d4a5f34..f69eccbb6286 100644 --- a/offapi/com/sun/star/sheet/SubTotalField.idl +++ b/offapi/com/sun/star/sheet/SubTotalField.idl @@ -2,9 +2,9 @@ * * $RCSfile: SubTotalField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_SubTotalField_idl__ #define __com_sun_star_sheet_SubTotalField_idl__ @@ -65,19 +66,25 @@ #include <com/sun/star/sheet/XSubTotalField.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::SubTotalField -/** a single field in a SubTotalDescriptor. +/** represents a single field in a subtotal descriptor. + + <p>A subtotal field contains all columns for which subtotal values + will be calculated and the column used to create subtotal groups. + + @see com::sun::star::sheet::SubTotalDescriptor */ service SubTotalField { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides access to the settings of the subtotal field. + */ interface com::sun::star::sheet::XSubTotalField; }; @@ -86,18 +93,5 @@ service SubTotalField }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl b/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl new file mode 100644 index 000000000000..7a40f393763f --- /dev/null +++ b/offapi/com/sun/star/sheet/SubTotalFieldsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: SubTotalFieldsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_SubTotalFieldsEnumeration_idl__ +#define __com_sun_star_sheet_SubTotalFieldsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of sub total fields. + + @see com::sun::star::sheet::SubTotalField + */ +service SubTotalFieldsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the sub total fields in the enumeration. + + @see com::sun::star::sheet::SubTotalField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormat.idl b/offapi/com/sun/star/sheet/TableAutoFormat.idl index ae995e4f0521..a7deff9bd961 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormat.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableAutoFormat_idl__ #define __com_sun_star_sheet_TableAutoFormat_idl__ @@ -65,6 +66,10 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + #ifndef __com_sun_star_container_XNamed_idl__ #include <com/sun/star/container/XNamed.idl> #endif @@ -73,75 +78,90 @@ #include <com/sun/star/beans/XPropertySet.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TableAutoFormat -/** an autoformat for tables. +/** represents an AutoFormat, containing exactly 16 AutoFormat fields. + + <p>Each of the 16 fields contain formatting properties for a table + cell at a specific position in the AutoFormat range. The rows of the + range are divided into a header row, a footer row and 2 data rows + (repeated in turn between header and footer row). The columns are + divided similar. This results in 16 different types of cells in the + range. The AutoFormats are numbered row by row, then column by column.</p> + + @see com::sun::star::sheet::TableAutoFormatField */ service TableAutoFormat { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** provides methods to access the AutoFormat fields via index. + + @see com::sun::star::sheet::TableAutoFormatField + */ interface com::sun::star::container::XIndexAccess; - // DocMerge: empty anyway - interface com::sun::star::container::XNamed; + //------------------------------------------------------------------------- - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; + /** creates an enumeration of all 16 AutoFormat fields. + + @see com::sun::star::sheet::TableAutoFormatEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeFont - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeFont - /** specifies if the font settings from the fields should be used. + /** provides methods to access the name of the AutoFormat. + */ + interface com::sun::star::container::XNamed; + + //========================================================================= + + /** specifies whether the font settings from the fields are used. */ [property] boolean IncludeFont; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeJustify - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeJustify - /** specifies if the justification settings from the fields - should be used. + /** specifies whether the justification settings from the fields + are used. */ [property] boolean IncludeJustify; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeBorder - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeBorder - /** specifies if the border settings from the fields should be used. + /** specifies whether the border settings from the fields are used. */ [property] boolean IncludeBorder; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeBackground - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeBackground - /** specifies if the background settings from the fields should be used. + /** specifies whether the background settings from the fields are used. */ [property] boolean IncludeBackground; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeNumberFormat - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeNumberFormat - /** specifies if the number format settings from the fields - should be used. + /** specifies whether the number format settings from the fields + are used. */ [property] boolean IncludeNumberFormat; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR TableAutoFormat::IncludeWidthAndHeight - // DocMerge from xml: property com::sun::star::sheet::TableAutoFormat::IncludeWidthAndHeight - /** specifies if the column widths and row heights should be updated - after applying the format. + /** specifies whether the column widths and row heights should be + updated after applying the format. */ [property] boolean IncludeWidthAndHeight; @@ -151,24 +171,5 @@ service TableAutoFormat }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl b/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl new file mode 100644 index 000000000000..8515062662ce --- /dev/null +++ b/offapi/com/sun/star/sheet/TableAutoFormatEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableAutoFormatEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:04 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableAutoFormatEnumeration_idl__ +#define __com_sun_star_sheet_TableAutoFormatEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of AutoFormat fields in an AutoFormat. + + @see com::sun::star::sheet::TableAutoFormat + */ +service TableAutoFormatEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the AutoFormat fields in the enumeration. + + @see com::sun::star::sheet::TableAutoFormatField + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatField.idl b/offapi/com/sun/star/sheet/TableAutoFormatField.idl index 812a0dfdad10..330a415902fe 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormatField.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormatField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormatField.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dr $ $Date: 2001-11-14 15:11:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableAutoFormatField_idl__ #define __com_sun_star_sheet_TableAutoFormatField_idl__ @@ -89,17 +90,22 @@ #include <com/sun/star/table/CellOrientation.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** a single field in a TableAutoFormat. +/** represents a field in an AutoFormat. A field contains all cell + properties for a specific position in an AutoFormat. */ service TableAutoFormatField { + //------------------------------------------------------------------------- + +//! service com::sun::star::beans::PropertySet; + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- @@ -252,8 +258,10 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** is <TRUE/> if the cell background is transparent - and the <member>TableAutoFormatField::CellBackColor</member> value is not used. + /** is <TRUE/> if the cell background is transparent. + + <p>In this case the <member>TableAutoFormatField::CellBackColor</member> + value is not used.</p> */ [property] boolean IsCellBackgroundTransparent; @@ -283,7 +291,8 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** contains the orientation of the cell contents (i.e. top-to-bottom or stacked). + /** contains the orientation of the cell contents + (i.e. top-to-bottom or stacked). */ [optional, property] com::sun::star::table::CellOrientation Orientation; @@ -301,25 +310,29 @@ service TableAutoFormatField //------------------------------------------------------------------------- - /** contains the margin between cell contents and top border in 1/100 mm. + /** contains the margin between cell contents and top border + (in 1/100 mm). */ [optional, property] long ParaTopMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and bottom border in 1/100 mm. + /** contains the margin between cell contents and bottom border + (in 1/100 mm). */ [optional, property] long ParaBottomMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and left border in 1/100 mm. + /** contains the margin between cell contents and left border + (in 1/100 mm). */ [optional, property] long ParaLeftMargin; //------------------------------------------------------------------------- - /** contains the margin between cell contents and right border in 1/100 mm. + /** contains the margin between cell contents and right border + (in 1/100 mm). */ [optional, property] long ParaRightMargin; @@ -332,3 +345,4 @@ service TableAutoFormatField //============================================================================= #endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormats.idl b/offapi/com/sun/star/sheet/TableAutoFormats.idl index 4e59762d6073..7e060786932b 100644 --- a/offapi/com/sun/star/sheet/TableAutoFormats.idl +++ b/offapi/com/sun/star/sheet/TableAutoFormats.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableAutoFormats.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,53 +58,62 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableAutoFormats_idl__ #define __com_sun_star_sheet_TableAutoFormats_idl__ #ifndef __com_sun_star_container_XNameContainer_idl__ #include <com/sun/star/container/XNameContainer.idl> #endif - -#ifndef __com_sun_star_container_XNameAccess_idl__ -#include <com/sun/star/container/XNameAccess.idl> +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TableAutoFormats -/** a list of table autoformats. +/** represents the collection of AutoFormats. + + <p>There is only one instance of this collection, containing all + AutoFormats usable in spreadsheet and text tables.</p> */ service TableAutoFormats { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access, insert and remove AutoFormats via name. + + @see com::sun::star::sheet::TableAutoFormat + */ interface com::sun::star::container::XNameContainer; - // DocMerge: empty anyway - interface com::sun::star::container::XNameAccess; + //------------------------------------------------------------------------- -}; + /** provides methods to access AutoFormats via index. -//============================================================================= + @see com::sun::star::sheet::TableAutoFormat + */ + interface com::sun::star::container::XIndexAccess; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** creates an enumeration of all AutoFormats. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import + @see com::sun::star::sheet::TableAutoFormatEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl b/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl new file mode 100644 index 000000000000..9dc872689659 --- /dev/null +++ b/offapi/com/sun/star/sheet/TableAutoFormatsEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableAutoFormatsEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:05 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableAutoFormatsEnumeration_idl__ +#define __com_sun_star_sheet_TableAutoFormatsEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of AutoFormats. + + @see com::sun::star::sheet::TableAutoFormats + */ +service TableAutoFormatsEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the AutoFormats in the enumeration. + + @see com::sun::star::sheet::TableAutoFormat + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableCellStyle.idl b/offapi/com/sun/star/sheet/TableCellStyle.idl new file mode 100644 index 000000000000..41d5fc4bdb50 --- /dev/null +++ b/offapi/com/sun/star/sheet/TableCellStyle.idl @@ -0,0 +1,146 @@ +/************************************************************************* + * + * $RCSfile: TableCellStyle.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:06 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableCellStyle_idl__ +#define __com_sun_star_sheet_TableCellStyle_idl__ + +#ifndef __com_sun_star_table_CellProperties_idl__ +#include <com/sun/star/table/CellProperties.idl> +#endif + +#ifndef __com_sun_star_style_CellStyle_idl__ +#include <com/sun/star/style/CellStyle.idl> +#endif + +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif + +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif + +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** contains the properties of a table cell style. + + <p>This service extends the service + <type scope="com::sun::star::style">CellStyle</type> with spreadsheet + specific properties.</p> + */ +service TableCellStyle +{ + //------------------------------------------------------------------------- + + /** contributes cell specific properties. + */ + service com::sun::star::table::CellProperties; + + //------------------------------------------------------------------------- + + /** is the base service for table cells. + */ + service com::sun::star::style::CellStyle; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Western text. + */ + service com::sun::star::style::CharacterProperties; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Asian text. + */ + service com::sun::star::style::CharacterPropertiesAsian; + + //------------------------------------------------------------------------- + + /** contributes properties for character formatting of Complex text. + */ + service com::sun::star::style::CharacterPropertiesComplex; + + //------------------------------------------------------------------------- + + /** contributes properties for paragraph formatting. + */ + service com::sun::star::style::ParagraphProperties; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalEntry.idl b/offapi/com/sun/star/sheet/TableConditionalEntry.idl index f2d658aae5c1..8ba0901da147 100644 --- a/offapi/com/sun/star/sheet/TableConditionalEntry.idl +++ b/offapi/com/sun/star/sheet/TableConditionalEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableConditionalEntry.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableConditionalEntry_idl__ #define __com_sun_star_sheet_TableConditionalEntry_idl__ @@ -69,22 +70,28 @@ #include <com/sun/star/sheet/XSheetConditionalEntry.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TableConditionalEntry -/** a single entry in a TableConditionalFormat object. +/** represents a single condition in a conditional format. + + @see com::sun::star::sheet::TableConditionalFormat */ service TableConditionalEntry { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the settings of this condition. + */ interface com::sun::star::sheet::XSheetCondition; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the cell style name for this condition. + */ interface com::sun::star::sheet::XSheetConditionalEntry; }; @@ -93,18 +100,5 @@ service TableConditionalEntry }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl b/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl new file mode 100644 index 000000000000..4ea01e81a612 --- /dev/null +++ b/offapi/com/sun/star/sheet/TableConditionalEntryEnumeration.idl @@ -0,0 +1,96 @@ +/************************************************************************* + * + * $RCSfile: TableConditionalEntryEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:07 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_TableConditionalEntryEnumeration_idl__ +#define __com_sun_star_sheet_TableConditionalEntryEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of conditional entries. + + @see com::sun::star::sheet::TableConditionalEntry + */ +service TableConditionalEntryEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the conditional entries in the enumeration. + + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/TableConditionalFormat.idl b/offapi/com/sun/star/sheet/TableConditionalFormat.idl index e892fe0302f3..6039209a3ff1 100644 --- a/offapi/com/sun/star/sheet/TableConditionalFormat.idl +++ b/offapi/com/sun/star/sheet/TableConditionalFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableConditionalFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableConditionalFormat_idl__ #define __com_sun_star_sheet_TableConditionalFormat_idl__ @@ -68,50 +69,69 @@ #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif - -#ifndef __com_sun_star_container_XIndexAccess_idl__ -#include <com/sun/star/container/XIndexAccess.idl> +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TableConditionalFormat -/** the conditional formatting for a cell or cell range. +/** represents a collection of conditional formatting settings for a + cell or cell range. + + <p>The style of the first fulfilled condition (in index order) will + be applied to the cell(s).</p> + + @see com::sun::star::sheet::SheetCell + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ service TableConditionalFormat { - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to insert and remove conditions and to access + the condition via index. + + @see com::sun::star::sheet::TableConditionalEntry + */ interface com::sun::star::sheet::XSheetConditionalEntries; - // DocMerge: empty anyway + //------------------------------------------------------------------------- + + /** provides methods to access the condition via name. + + <p>The name of a condition is "Entry", followed by its index + (i.e. Entry0, Entry1, ...).</p> + + @see com::sun::star::sheet::TableConditionalEntry + */ interface com::sun::star::container::XNameAccess; - // DocMerge: empty anyway - interface com::sun::star::container::XIndexAccess; + //------------------------------------------------------------------------- -}; + /** creates an enumeration of all conditional entries. -//============================================================================= + @see com::sun::star::sheet::TableConditionalEntryEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; -}; }; }; }; + //------------------------------------------------------------------------- -/*============================================================================= + /** provides methods to access the contained conditional entries by index. - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import + @see com::sun::star::sheet::TableConditionalEntry + */ + interface com::sun::star::container::XIndexAccess; - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableFilterField.idl b/offapi/com/sun/star/sheet/TableFilterField.idl index 00941cf50753..9453525826d7 100644 --- a/offapi/com/sun/star/sheet/TableFilterField.idl +++ b/offapi/com/sun/star/sheet/TableFilterField.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableFilterField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableFilterField_idl__ #define __com_sun_star_sheet_TableFilterField_idl__ @@ -69,56 +70,51 @@ #include <com/sun/star/sheet/FilterOperator.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::TableFilterField /** describes a single condition in a filter descriptor. + + @see com::sun::star::sheet::SheetFilterDescriptor */ struct TableFilterField { - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Connection - /** specifies how the condition is connected to the previous - condition. + //------------------------------------------------------------------------- + + /** specifies how the condition is connected to the previous condition. */ com::sun::star::sheet::FilterConnection Connection; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Field /** specifies which field (column) is used for the condition. */ long Field; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::Operator /** specifies the type of the condition. */ com::sun::star::sheet::FilterOperator Operator; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::IsNumeric - /** selects whether the <member>TableFilterField::NumericValue</member> or the - <member>TableFilterField::StringValue</member> is used. + /** selects whether the <member>TableFilterField::NumericValue</member> + or the <member>TableFilterField::StringValue</member> is used. */ boolean IsNumeric; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::NumericValue /** specifies a numeric value for the condition. */ double NumericValue; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TableFilterField::StringValue /** specifies a string value for the condition. */ string StringValue; @@ -129,24 +125,5 @@ struct TableFilterField }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:09 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableOperationMode.idl b/offapi/com/sun/star/sheet/TableOperationMode.idl index 466d95f28519..ae0830071521 100644 --- a/offapi/com/sun/star/sheet/TableOperationMode.idl +++ b/offapi/com/sun/star/sheet/TableOperationMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableOperationMode.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,17 +58,16 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableOperationMode_idl__ #define __com_sun_star_sheet_TableOperationMode_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::TableOperationMode /** used to specify if a table operation is applied to columns, rows, or both columns and rows. */ @@ -76,22 +75,28 @@ enum TableOperationMode { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::COLUMN /** is applied to the columns. + + <p>In this mode, the column contains values and the row + contains formulas.</p> */ COLUMN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::ROW /** is applied to the rows. + + <p>In this mode, the row contains values and the column + contains formulas.</p> */ ROW, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::TableOperationMode::BOTH /** is applied to rows and columns. + + <p>In this mode, the row and the column contain values. A formula + using both row and column values is specified separately.</p> */ BOTH @@ -101,18 +106,5 @@ enum TableOperationMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TablePageBreakData.idl b/offapi/com/sun/star/sheet/TablePageBreakData.idl index 9fa6e1295b12..4edf2babb80d 100644 --- a/offapi/com/sun/star/sheet/TablePageBreakData.idl +++ b/offapi/com/sun/star/sheet/TablePageBreakData.idl @@ -2,9 +2,9 @@ * * $RCSfile: TablePageBreakData.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,31 +58,31 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TablePageBreakData_idl__ #define __com_sun_star_sheet_TablePageBreakData_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: struct com::sun::star::sheet::TablePageBreakData -/** describes a page break. +/** describes a page break in a spreadsheet. + + @see com::sun::star::sheet::XSheetPageBreak */ struct TablePageBreakData { - // DocMerge from xml: field com::sun::star::sheet::TablePageBreakData::Position - /** the position of the page break. + //------------------------------------------------------------------------- + + /** the position (column or row index) of the page break. */ long Position; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sheet::TablePageBreakData::ManualBreak - /** is <TRUE/> for a manual page break, - <FALSE/> for an automatic one. + /** is <TRUE/> for a manual page break, <FALSE/> for an automatic one. */ boolean ManualBreak; @@ -92,21 +92,5 @@ struct TablePageBreakData }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TablePageStyle.idl b/offapi/com/sun/star/sheet/TablePageStyle.idl index 734991d6cb26..70345c113192 100644 --- a/offapi/com/sun/star/sheet/TablePageStyle.idl +++ b/offapi/com/sun/star/sheet/TablePageStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: TablePageStyle.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,258 +58,174 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TablePageStyle_idl__ #define __com_sun_star_sheet_TablePageStyle_idl__ -#ifndef __com_sun_star_beans_XPropertySet_idl__ -#include <com/sun/star/beans/XPropertySet.idl> -#endif - -#ifndef __com_sun_star_table_ShadowFormat_idl__ -#include <com/sun/star/table/ShadowFormat.idl> +#ifndef __com_sun_star_style_PageStyle_idl__ +#include <com/sun/star/style/PageStyle.idl> #endif #ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ #include <com/sun/star/sheet/XHeaderFooterContent.idl> #endif - //============================================================================= module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TablePageStyle -/** a spreadsheet page format. +/** represents a page style for a spreadsheet. + + <p>This service extends the service + <type scope="com::sun::star::style">PageStyle</type> with spreadsheet + specific properties.</p> */ service TablePageStyle { - // DocMerge: empty anyway - interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::BackgroundColor - /** contains the value of the page background color. - */ - [property] long BackgroundColor; - //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::IsBackgroundTransparent - /** is <TRUE/> if the page background is transparent. + /** contains all common page style properties. */ - [property] boolean IsBackgroundTransparent; + service com::sun::star::style::PageStyle; - //------------------------------------------------------------------------- + //========================================================================= - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::ShadowFormat - /** contains the description of a shadow for the page. - */ - [property] com::sun::star::table::ShadowFormat ShadowFormat; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::CenterHorizontally - /** if set, the page is centered horizontally. + /** determines whether the table is centered horizontally on the page. */ [property] boolean CenterHorizontally; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::CenterVertically - /** if set, the page is centered vertically. + /** determines whether the table is centered vertically on the page. */ [property] boolean CenterVertically; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintAnnotations /** enables printing of cell annotations. */ [property] boolean PrintAnnotations; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintGrid /** enables printing of the cell grid. */ [property] boolean PrintGrid; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintHeaders /** enables printing of column and row headers. */ [property] boolean PrintHeaders; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintCharts /** enables printing of charts. */ [property] boolean PrintCharts; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintObjects /** enables printing of embedded objects. */ [property] boolean PrintObjects; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintDrawing /** enables printing of drawing objects. */ [property] boolean PrintDrawing; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintDownFirst - /** specifies the print order for the pages - within each sheet. - - - - <p>If <TRUE/>, the order for printing pages begins with top-to-bottom, - then continues with the next set of cell columns to the right. If - <FALSE/>, the order for printing pages begins with left-to-right, - then continues with the next set of cell rows to the bottom.</p> - */ - [property] boolean PrintDownFirst; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintFormulas - /** enables printing of formulas instead of their - results. + /** enables printing of formulas instead of their results. */ [property] boolean PrintFormulas; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::PrintZeroValues /** enables printing of zero-values. */ [property] boolean PrintZeroValues; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::LeftPageHeaderContent - /** contains the content of the header for left pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent; + /** specifies the print order for the pages within each sheet. - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::LeftPageFooterContent - /** contains the content of the footer for left pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::RightPageHeaderContent - /** contains the content of the header for right pages. + <p>If <TRUE/>, the order for printing pages begins with + top-to-bottom, then continues with the next set of cell columns + to the right. If <FALSE/>, the order for printing pages begins + with left-to-right, then continues with the next set of cell + rows to the bottom.</p> */ - [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::RightPageFooterContent - /** contains the content of the footer for right pages. - */ - [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent; + [property] boolean PrintDownFirst; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderBackgroundColor - /** contains the value of the header background color. - */ - [property] long HeaderBackgroundColor; + /** contains the content of the header for left pages. - //------------------------------------------------------------------------- + <p>After changing the header text contents, this property has to be + reinserted into the property set.</p> - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::TransparentHeaderBackground - /** is <TRUE/> if the header background is transparent. + @see com::sun::star::sheet::HeaderFooterContent */ - [property] boolean TransparentHeaderBackground; + [property] com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderShadowFormat - /** contains the description of a shadow for the header. - */ - [property] com::sun::star::table::ShadowFormat HeaderShadowFormat; + /** contains the content of the footer for left pages. - //------------------------------------------------------------------------- + <p>After changing the footer text contents, this property has to be + reinserted into the property set.</p> - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderOn - /** enables printing of page headers. + @see com::sun::star::sheet::HeaderFooterContent */ - [property] boolean HeaderOn; + [property] com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderDynamic - /** if set, the header height is adjusted for the - contents. - */ - [property] boolean HeaderDynamic; + /** contains the content of the header for right pages. - //------------------------------------------------------------------------- + <p>After changing the header text contents, this property has to be + reinserted into the property set.</p> - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::HeaderShared - /** if set, header contents are equal for left and - right pages. + @see com::sun::star::sheet::HeaderFooterContent */ - [property] boolean HeaderShared; + [property] com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterBackgroundColor - /** contains the value of the footer background color. - */ - [property] long FooterBackgroundColor; + /** contains the content of the footer for right pages. - //------------------------------------------------------------------------- + <p>After changing the footer text contents, this property has to be + reinserted into the property set.</p> - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::TransparentFooterBackground - /** is <TRUE/> if the footer background is transparent. + @see com::sun::star::sheet::HeaderFooterContent */ - [property] boolean TransparentFooterBackground; + [property] com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterShadowFormat - /** contains the description of a shadow for the footer. - */ - [property] com::sun::star::table::ShadowFormat FooterShadowFormat; + /** contains the page number applied to the first page for this sheet. - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterOn - /** enables printing of page footers. + <p>The value 0 indicates that the page numbers are continued from + the previous sheet.</p> */ - [property] boolean FooterOn; + [property] short FirstPageNumber; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterDynamic - /** if set, the footer height is adjusted for the - contents. + /** contains the scaling factor (in percent) for printing the sheet. */ - [property] boolean FooterDynamic; + [property] short PageScale; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TablePageStyle::FooterShared - /** if set, footer contents are equal for left and - right pages. + /** contains the number of pages the sheet will printed. */ - [property] boolean FooterShared; + [property] short ScaleToPages; }; @@ -317,21 +233,5 @@ service TablePageStyle }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl index 8dcb15b2d492..541460aeb982 100644 --- a/offapi/com/sun/star/sheet/TableValidation.idl +++ b/offapi/com/sun/star/sheet/TableValidation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableValidation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_TableValidation_idl__ #define __com_sun_star_sheet_TableValidation_idl__ @@ -77,113 +78,97 @@ #include <com/sun/star/sheet/ValidationAlertStyle.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::TableValidation -/** the validation settings for a cell or cell range. +/** represents the data validation settings for a cell or cell range. */ service TableValidation { - // DocMerge: empty anyway - interface com::sun::star::sheet::XSheetCondition; + //------------------------------------------------------------------------- - // DocMerge: empty anyway +//! service PropertySet + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::Type + /** provides access to the settings of the condition. + */ + interface com::sun::star::sheet::XSheetCondition; + + //========================================================================= + /** specifies the type of validation. */ [property] com::sun::star::sheet::ValidationType Type; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ShowInputMessage - /** specifies if an input message is shown when - the cursor is in a cell with these validation settings. + /** specifies if an input message is shown when the cursor is in a + cell with these validation settings. */ [property] boolean ShowInputMessage; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::InputTitle - /** specifies the title of the window showing - the input message. - - + /** specifies the title of the window showing the input message. <p>This is only used if <member>TableValidation::ShowInputMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ [property] string InputTitle; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::InputMessage /** specifies the text of the input message. - - <p>This is only used if <member>TableValidation::ShowInputMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ [property] string InputMessage; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ShowErrorMessage - /** specifies if an error message is displayed - when invalid data is entered. + /** specifies if an error message is displayed when invalid data + is entered. */ [property] boolean ShowErrorMessage; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorTitle - /** specifies the title of the window showing the - error message. - - + /** specifies the title of the window showing the error message. <p>This is only used if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ [property] string ErrorTitle; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorMessage /** specifies the text of the error message. - - <p>This is only used if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ [property] string ErrorMessage; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::IgnoreBlankCells /** specifies if blank cells should be allowed. */ [property] boolean IgnoreBlankCells; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::sheet::TableValidation::ErrorAlertStyle /** specifies the style of the error message. - - <p>This is used only if <member>TableValidation::ShowErrorMessage</member> - is <TRUE/>.</p> + is set to <TRUE/>.</p> */ [property] com::sun::star::sheet::ValidationAlertStyle ErrorAlertStyle; @@ -193,27 +178,5 @@ service TableValidation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:09 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl b/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl new file mode 100644 index 000000000000..49be61762fee --- /dev/null +++ b/offapi/com/sun/star/sheet/UniqueCellFormatRanges.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: UniqueCellFormatRanges.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_UniqueCellFormatRanges_idl__ +#define __com_sun_star_sheet_UniqueCellFormatRanges_idl__ + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a collection of equal-formatted cell range collections. + + <p>All cells inside a cell range collection (a member of this + collection) have the same formatting attributes.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges + @see com::sun::star::sheet::CellFormatRanges + */ +service UniqueCellFormatRanges +{ + //------------------------------------------------------------------------- + + /** provides methods to access the contained cell range + collections by index. + + @see com::sun::star::sheet::SheetCellRanges + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRangesEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl b/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl new file mode 100644 index 000000000000..39ac443396d5 --- /dev/null +++ b/offapi/com/sun/star/sheet/UniqueCellFormatRangesEnumeration.idl @@ -0,0 +1,97 @@ +/************************************************************************* + * + * $RCSfile: UniqueCellFormatRangesEnumeration.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:08:10 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_UniqueCellFormatRangesEnumeration_idl__ +#define __com_sun_star_sheet_UniqueCellFormatRangesEnumeration_idl__ + +#ifndef __com_sun_star_container_XEnumeration_idl__ +#include <com/sun/star/container/XEnumeration.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents an enumeration of equal-formatted cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRanges + */ +service UniqueCellFormatRangesEnumeration +{ + //------------------------------------------------------------------------- + + /** provides methods to access the cell range collections + in the enumeration. + + @see com::sun::star::sheet::SheetCellRanges + */ + interface com::sun::star::container::XEnumeration; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/sheet/ValidationAlertStyle.idl b/offapi/com/sun/star/sheet/ValidationAlertStyle.idl index affe8b7be366..cea536ef7ae6 100644 --- a/offapi/com/sun/star/sheet/ValidationAlertStyle.idl +++ b/offapi/com/sun/star/sheet/ValidationAlertStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: ValidationAlertStyle.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,47 +58,42 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_ValidationAlertStyle_idl__ #define __com_sun_star_sheet_ValidationAlertStyle_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::ValidationAlertStyle /** used to specify how invalid cell contents are treated. */ enum ValidationAlertStyle { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::STOP /** error message is shown and the change is rejected. */ STOP, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::WARNING /** warning message is shown and the user is asked whether the - change is to be accepted. + change will be accepted (defaulted to "No"). */ WARNING, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::INFO /** information message is shown and the user is asked whether the - change is to be accepted. + change will be accepted (defaulted to "Yes"). */ INFO, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationAlertStyle::MACRO /** macro is executed. */ MACRO @@ -109,18 +104,5 @@ enum ValidationAlertStyle }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/ValidationType.idl b/offapi/com/sun/star/sheet/ValidationType.idl index 8a04e600a99c..45dc5fa9ba56 100644 --- a/offapi/com/sun/star/sheet/ValidationType.idl +++ b/offapi/com/sun/star/sheet/ValidationType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ValidationType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,74 +58,64 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_ValidationType_idl__ #define __com_sun_star_sheet_ValidationType_idl__ - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: enum com::sun::star::sheet::ValidationType -/** used to specify which cell contents are treated as - valid. +/** used to specify which cell contents are treated as valid. */ enum ValidationType { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::ANY /** any cell content is valid; no conditions are used. */ ANY, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::WHOLE /** any whole number matching the specified condition is valid. */ WHOLE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::DECIMAL /** any number matching the specified condition is valid. */ DECIMAL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::DATE /** any date value matching the specified condition is valid. */ DATE, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::TIME /** any time value matching the specified condition is valid. */ TIME, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::TEXT_LEN /** string is valid if its length matches the specified condition. */ TEXT_LEN, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::LIST /** Only strings from a specified list are valid. */ LIST, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::sheet::ValidationType::CUSTOM /** The specified formula detemines which contents are valid. */ CUSTOM @@ -136,18 +126,5 @@ enum ValidationType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/VolatileResult.idl b/offapi/com/sun/star/sheet/VolatileResult.idl index a581d94f8753..ac25b6955139 100644 --- a/offapi/com/sun/star/sheet/VolatileResult.idl +++ b/offapi/com/sun/star/sheet/VolatileResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: VolatileResult.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_VolatileResult_idl__ #define __com_sun_star_sheet_VolatileResult_idl__ @@ -65,25 +66,26 @@ #include <com/sun/star/sheet/XVolatileResult.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: service com::sun::star::sheet::VolatileResult -/** a volatile result. - +/** represents a volatile function result. + <p>A volatile function result can change its value over time. The + <type>XVolatileResult</type> interface allows the addition of + listeners which are notified when the value changes.</p> - <p>A volatile result can change its value over time. - The <type>XVolatileResult</type> interface allows the addition of listeners - which are notified when the value changes.</p> + @see com::sun::star::sheet::AddIn */ service VolatileResult { - // DocMerge: empty anyway + // ------------------------------------------------------------------------ + + /** porovides handling with a volatile function result. + */ interface com::sun::star::sheet::XVolatileResult; }; @@ -92,18 +94,5 @@ service VolatileResult }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XAddIn.idl b/offapi/com/sun/star/sheet/XAddIn.idl index 697eb3e50bc3..f415a4d4ee20 100644 --- a/offapi/com/sun/star/sheet/XAddIn.idl +++ b/offapi/com/sun/star/sheet/XAddIn.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAddIn.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XAddIn_idl__ #define __com_sun_star_sheet_XAddIn_idl__ @@ -65,195 +66,187 @@ #include <com/sun/star/lang/XLocalizable.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XAddIn /** gives access to function descriptions and user-visible names. */ interface XAddIn: com::sun::star::lang::XLocalizable { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getProgrammaticFuntionName - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getProgrammaticFuntionName - /** returns the programmatic name for a specified user-visible function - name. + /** returns the internal function name for an user-visible name. + + <p>The user-visible name of a function is the name shown to the + user. It may be translated to the current language of the AddIn, + so it is never stored in files. It should be a single word and is + used when entering or displaying formulas.</p> + <p>Attention: The method name contains a spelling error. Due to + compatibility reasons the name cannot be changed.</p> + @param aDisplayName + the user-visible name of a function. + + @returns + the exact name of the method within its interface. - <p>The programmatic name must be the exact name of the method within - its interface.</p> */ string getProgrammaticFuntionName( [in] string aDisplayName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayFunctionName - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayFunctionName - /** returns the user-visible name of the function. + /** returns the user-visible function name for an internal name. + <p>The user-visible name of a function is the name shown to the + user. It may be translated to the current language of the AddIn, + so it is never stored in files. It should be a single word and is + used when entering or displaying formulas.</p> + @param aProgrammaticName + is the exact name of a method within its interface. - <p>This is the name for the function that is shown to the user. - It may be translated to the current language of the AddIn, so it - is never stored in files. It should be a single word and is used - when entering or displaying formulas.</p> + @returns + the user-visible name of the specified function. */ string getDisplayFunctionName( [in] string aProgrammaticName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getFunctionDescription - - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getFunctionDescription - /** returns the description of the function. - + /** returns the description of a function. <p>The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn.</p> + + @param aProgrammaticName + is the exact name of a method within its interface. + + @returns + the description of the specified function. */ string getFunctionDescription( [in] string aProgrammaticName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayArgumentName - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayArgumentName /** returns the user-visible name of the specified argument. - - <p>The argument name is shown to the user when prompting for arguments. It should be a single word and may be translated to the current language of the AddIn.</p> + + @param aProgrammaticFunctionName + is the exact name of a method within its interface. + + @param nArgument + the index of the argument (0-based). + + @returns + the user-visible name of the specified argument. */ - string getDisplayArgumentName( [in] string aProgrammaticFunctionName, - [in] long nArgument ); + string getDisplayArgumentName( + [in] string aProgrammaticFunctionName, + [in] long nArgument ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getArgumentDescription - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getArgumentDescription /** returns the description of the specified argument. - - <p>The argument description is shown to the user when prompting for arguments. It may be translated to the current language of the AddIn.</p> - */ - string getArgumentDescription( [in] string aProgrammaticFunctionName, - [in] long nArgument ); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getProgrammaticCategoryName + @param aProgrammaticFunctionName + is the exact name of a method within its interface. - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getProgrammaticCategoryName - /** returns the programmatic name of the category the function belongs to. + @param nArgument + the index of the argument (0-based). + @returns + the description of the specified argument. + */ + string getArgumentDescription( + [in] string aProgrammaticFunctionName, + [in] long nArgument ); + //------------------------------------------------------------------------- + + /** returns the programmatic name of the category the function + belongs to. <p>The category name is used to group similar functions together. The programmatic category name should always be in English, it is never shown to the user. It should be one of the following names if the function falls into the corresponding category.</p> + <dl> - <dt>Database - </dt> - <dd>for functions that operate with data organized in tabular - form like databases. - </dd> - <dt>Date&amp;Time - </dt> - <dd>for functions that deal with date or time values. - </dd> - <dt>Financial - </dt> - <dd>for functions that solve financial problems. - </dd> - <dt>Information - </dt> - <dd>for functions that provide information about cells. - </dd> - <dt>Logical - </dt> - <dd>for functions that deal with logical expressions. - </dd> - <dt>Mathematical - </dt> - <dd>for mathematical functions. - </dd> - <dt>Matrix - </dt> - <dd>for matrix functions. - </dd> - <dt>Statistical - </dt> - <dd>for statistical functions. - </dd> - <dt>Spreadsheet - </dt> - <dd>for functions that deal with cell ranges. - </dd> - <dt>Text - </dt> - <dd>for functions that deal with text strings. - </dd> - <dt>Add-In - </dt> - <dd>for additional functions. - </dd> - </dl> - */ - string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); + <dt>Database</dt> + <dd>for functions that operate with data organized in tabular form + like databases.</dd> - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAddIn::getDisplayCategoryName + <dt>Date&Time</dt> + <dd>for functions that deal with date or time values.</dd> - // DocMerge from xml: method com::sun::star::sheet::XAddIn::getDisplayCategoryName - /** returns the user-visible name of the category the function belongs to. + <dt>Financial</dt> + <dd>for functions that solve financial problems.</dd> + <dt>Information</dt> + <dd>for functions that provide information about cells.</dd> + <dt>Logical</dt> + <dd>for functions that deal with logical expressions.</dd> - <p>This is used when category names are shown to the user.</p> - */ - string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); + <dt>Mathematical</dt> + <dd>for mathematical functions.</dd> -}; + <dt>Matrix</dt> + <dd>for matrix functions.</dd> -//============================================================================= + <dt>Statistical</dt> + <dd>for statistical functions.</dd> -}; }; }; }; + <dt>Spreadsheet</dt> + <dd>for functions that deal with cell ranges.</dd> + + <dt>Text</dt> + <dd>for functions that deal with text strings.</dd> + + <dt>Add-In</dt> + <dd>for additional functions.</dd> + </dl> -/*============================================================================= + @param aProgrammaticFunctionName + is the exact name of a method within its interface. - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + @returns + the category name the specified function belongs to. + */ + string getProgrammaticCategoryName( [in] string aProgrammaticFunctionName ); - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import + //------------------------------------------------------------------------- - Revision 1.6 2000/09/11 11:52:50 mi - documentation merged from XML + /** returns the user-visible name of the category the function + belongs to. - Revision 1.4 2000/03/24 17:35:23 nn - #74032# documentation added + <p>This is used when category names are shown to the user.</p> - Revision 1.3 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked + @param aProgrammaticFunctionName + is the exact name of a method within its interface. - Revision 1.2 1999/12/14 11:30:35 nn - #70786# derive from XLocalizable + @returns + the user-visible category name the specified function + belongs to. + */ + string getDisplayCategoryName( [in] string aProgrammaticFunctionName ); - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +}; +//============================================================================= + +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XAreaLink.idl b/offapi/com/sun/star/sheet/XAreaLink.idl index 7d92758faf51..e990e4a28ae4 100644 --- a/offapi/com/sun/star/sheet/XAreaLink.idl +++ b/offapi/com/sun/star/sheet/XAreaLink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAreaLink.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XAreaLink_idl__ #define __com_sun_star_sheet_XAreaLink_idl__ @@ -69,57 +70,46 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XAreaLink -/** represents a linked cell range.@see com::sun::star::sheet::CellAreaLink +/** provides methods to change the settings of a linked cell range. + + @see com::sun::star::sheet::CellAreaLink */ interface XAreaLink: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XAreaLink::getSourceArea - - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::getSourceArea - /** returns the source of the range within the - source document. - + /** returns the source of the range within the source document. <p>This can be the address of a cell or range in the form - "sheet1.a1:c5", or the name of a named range or database range.</p> + "Sheet1.A1:C5", or the name of a named range or database range.</p> */ string getSourceArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::setSourceArea /** sets the source of the range within the source document. - - <p>This can be the address of a cell or range in the form - "sheet1.a1:c5", or the name of a named range or database range.</p> + "Sheet1.A1:C5", or the name of a named range or database range.</p> */ void setSourceArea( [in] string aSourceArea ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::getDestArea - /** returns the position of the linked range - in the destination document. + /** returns the position of the linked range in the destination + document. */ com::sun::star::table::CellRangeAddress getDestArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XAreaLink::setDestArea - /** sets the position of the linked range - in the destination document. + /** sets the position of the linked range in the destination document. */ void setDestArea( [in] com::sun::star::table::CellRangeAddress aDestArea ); @@ -129,33 +119,5 @@ interface XAreaLink: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:54 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XAreaLinks.idl b/offapi/com/sun/star/sheet/XAreaLinks.idl index 8dd60a3e1c2f..1d7818986807 100644 --- a/offapi/com/sun/star/sheet/XAreaLinks.idl +++ b/offapi/com/sun/star/sheet/XAreaLinks.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAreaLinks.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XAreaLinks_idl__ #define __com_sun_star_sheet_XAreaLinks_idl__ @@ -69,22 +70,42 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XAreaLinks -/** represents a collection of area links.@see com::sun::star::sheet::CellAreaLinks +/** provides access via index to a collection of area links and inserting + and removing area links. + + @see com::sun::star::sheet::CellAreaLinks + @see com::sun::star::sheet::CellAreaLink */ interface XAreaLinks: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XAreaLinks::insertAtPosition /** creates an area link and adds it to the collection. + + @param aDestPos + the address of the first cell of the range inside the current + document. + + @param aFileName + the URL of the source document. + + @param aSourceArea + the name of the range in the source document. + + <p>This can be the address of a cell or range in the form + "Sheet1.A1:C5", or the name of a named range or database range.</p> + + @param aFilter + the name of the filter used to load the source document. + + @param aFilterOptions + optional filter options for the specified filter. */ void insertAtPosition( [in] com::sun::star::table::CellAddress aDestPos, [in] string aFileName, @@ -94,7 +115,6 @@ interface XAreaLinks: com::sun::star::container::XIndexAccess //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XAreaLinks::removeByIndex /** removes an area link from the collection. */ void removeByIndex( [in] long nIndex ); @@ -105,27 +125,5 @@ interface XAreaLinks: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XArrayFormulaRange.idl b/offapi/com/sun/star/sheet/XArrayFormulaRange.idl index 72240e1c7f97..b4b62cf1722f 100644 --- a/offapi/com/sun/star/sheet/XArrayFormulaRange.idl +++ b/offapi/com/sun/star/sheet/XArrayFormulaRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArrayFormulaRange.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XArrayFormulaRange_idl__ #define __com_sun_star_sheet_XArrayFormulaRange_idl__ @@ -65,40 +66,30 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XArrayFormulaRange -/** represents something (such as a cell range) that - can contain an array formula. +/** provides handling of array formulas in a cell range. */ interface XArrayFormulaRange: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XArrayFormulaRange::getArrayFormula - - // DocMerge from xml: method com::sun::star::sheet::XArrayFormulaRange::getArrayFormula - /** returns the array formula of the range. - - - <p>If the range does not contain an array formula, - an empty string is returned.</p> + /** returns the array formula of the range or an empty string, if the + range does not contain an array formula. */ string getArrayFormula(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XArrayFormulaRange::setArrayFormula - /** sets the array formula of the range. - + /** applies the array formula to the entire cell range. - - <p>Setting this to an empty string erases the array formula.</p> + @param aFormula + the formula that will be applied as array formula. Passing an + empty string erases an existing array formula. */ void setArrayFormula( [in] string aFormula ); @@ -108,27 +99,5 @@ interface XArrayFormulaRange: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCalculatable.idl b/offapi/com/sun/star/sheet/XCalculatable.idl index 1fe517e6d682..d0b0754cf3ba 100644 --- a/offapi/com/sun/star/sheet/XCalculatable.idl +++ b/offapi/com/sun/star/sheet/XCalculatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCalculatable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCalculatable_idl__ #define __com_sun_star_sheet_XCalculatable_idl__ @@ -65,25 +66,20 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCalculatable /** represents something that can recalculate. */ interface XCalculatable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::calculate /** recalculates all dirty cells. - - <p>This calculates all formula cells which have not yet been calculated after their precedents have changed.</p> */ @@ -91,36 +87,35 @@ interface XCalculatable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::calculateAll /** recalculates all cells. */ void calculateAll(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::isAutomaticCalculationEnabled - /** returns <TRUE/> if automatic calculation is enabled. + /** returns whether automatic calculation is enabled. + <p>With automatic calculation, each formula cell is recalculated + whenever its value is needed after its precedents have changed. + The value is needed if the cell is displayed or used in another + calculation.</p> - - <p>With automatic calculation, each formula cell is - recalculated whenever its value is needed after its - precedents have changed. The value is needed if the - cell is displayed or used in another calculation.</p> + @returns + <TRUE/>, if automatic calculation is enabled. */ boolean isAutomaticCalculationEnabled(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCalculatable::enableAutomaticCalculation /** enables automatic calculation. + <p>With automatic calculation, each formula cell is recalculated + whenever its value is needed after its precedents have changed. + The value is needed if the cell is displayed or used in another + calculation.</p> - - <p>With automatic calculation, each formula cell is - recalculated whenever its value is needed after its - precedents have changed. The value is needed if the - cell is displayed or used in another calculation.</p> + @param bEnabled + <TRUE/> to enable automatic calculation, <FALSE/> to disable. */ [oneway] void enableAutomaticCalculation( [in] boolean bEnabled ); @@ -130,24 +125,5 @@ interface XCalculatable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellAddressable.idl b/offapi/com/sun/star/sheet/XCellAddressable.idl index 23f075c4f54e..f0aa6594e2a5 100644 --- a/offapi/com/sun/star/sheet/XCellAddressable.idl +++ b/offapi/com/sun/star/sheet/XCellAddressable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellAddressable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellAddressable_idl__ #define __com_sun_star_sheet_XCellAddressable_idl__ @@ -69,23 +70,23 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellAddressable -/** represents a cell which can be addressed with - a <type scope="com::sun::star::table">CellAddress</type>. +/** represents a cell which can be addressed with a + <type scope="com::sun::star::table">CellAddress</type>. */ interface XCellAddressable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellAddressable::getCellAddress - /** returns the position of the cell in the document. + /** returns the address of the cell in the spreadsheet document. + + <p>The <type scope="com::sun::star::table">CellAddress</type> + can be used to address the cell within its document.</p> */ com::sun::star::table::CellAddress getCellAddress(); @@ -95,24 +96,5 @@ interface XCellAddressable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.4 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl b/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl index 0c453fd3f08f..33947ff29dc1 100644 --- a/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl +++ b/offapi/com/sun/star/sheet/XCellFormatRangesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellFormatRangesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ #define __com_sun_star_sheet_XCellFormatRangesSupplier_idl__ @@ -69,22 +70,32 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellFormatRangesSupplier -/** provides a collection of cell formats. +/** provides access to a collection of equal-formatted cell ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XCellFormatRangesSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellFormatRangesSupplier::getCellFormatRanges - /** returns the collection of cell formats.@see com::sun::star::sheet::CellFormatRanges + /** returns a collection of equal-formatted cell ranges. + + <p>Each cell of the original range is contained in one of the + ranges (even unformatted cells). If there is a non-rectangular + equal-formatted cell area, it will be split into several + rectangular ranges.</p> + + @returns + the collection of equal-formatted cell ranges. + + @see com::sun::star::sheet::CellFormatRanges */ com::sun::star::container::XIndexAccess getCellFormatRanges(); @@ -94,27 +105,5 @@ interface XCellFormatRangesSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:48 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl index 376845b16a5e..6c9599961adc 100644 --- a/offapi/com/sun/star/sheet/XCellRangeAddressable.idl +++ b/offapi/com/sun/star/sheet/XCellRangeAddressable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeAddressable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellRangeAddressable_idl__ #define __com_sun_star_sheet_XCellRangeAddressable_idl__ @@ -69,25 +70,20 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellRangeAddressable -/** represents a cell range which can be addressed with - a CellRangeAddress. +/** represents a cell which can be addressed with a + <type scope="com::sun::star::table">CellRangeAddress</type>. */ interface XCellRangeAddressable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeAddressable::getRangeAddress - /** returns the address of the range. - - + /** returns the address of the cell range in the spreadsheet document. <p>The <type scope="com::sun::star::table">CellRangeAddress</type> can be used to address the range within its document.</p> @@ -100,21 +96,5 @@ interface XCellRangeAddressable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeData.idl b/offapi/com/sun/star/sheet/XCellRangeData.idl index ffd2c1669026..e989c59937ed 100644 --- a/offapi/com/sun/star/sheet/XCellRangeData.idl +++ b/offapi/com/sun/star/sheet/XCellRangeData.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeData.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: tl $ $Date: 2002-04-29 10:09:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,17 +65,14 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= /** allows to get and set an array of data from a cell range. - * - * <p>The outer sequence represents the rows and the inner sequence - * the columns of the array.</p> + <p>The outer sequence represents the rows and the inner sequence + the columns of the array.</p> */ interface XCellRangeData: com::sun::star::uno::XInterface @@ -89,22 +86,18 @@ interface XCellRangeData: com::sun::star::uno::XInterface /** fills the cell range with values from an array. - <p>The size of the array must be the same as the size of - the cell range. - Each element of the array must contain a <atom>double</atom> + <p>The size of the array must be the same as the size of the cell + range. Each element of the array must contain a <atom>double</atom> or a <atom>string</atom>.</p> - <p>If the size of the array is different from the current - size a <type scope="com::sun::star::uno">RuntimeException</type> - is thrown.</p> + @throws <type scope="com::sun::star::uno">RuntimeException</type> + If the size of the array is different from the current size. */ void setDataArray( [in] sequence< sequence< any > > aArray ); }; //============================================================================= - }; }; }; }; - #endif diff --git a/offapi/com/sun/star/sheet/XCellRangeMovement.idl b/offapi/com/sun/star/sheet/XCellRangeMovement.idl index 87d324b18f1c..aca8860b7864 100644 --- a/offapi/com/sun/star/sheet/XCellRangeMovement.idl +++ b/offapi/com/sun/star/sheet/XCellRangeMovement.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeMovement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellRangeMovement_idl__ #define __com_sun_star_sheet_XCellRangeMovement_idl__ @@ -81,53 +82,78 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellRangeMovement -/** has functions for moving ranges of cells in a sheet. +/** provides methods for moving ranges of cells in a sheet. */ interface XCellRangeMovement: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::insertCells /** inserts cells, moving other cells down or right. + <p>Non-empty cells cannot be moved off the sheet.</p> + @param aRange + the cell range in which empty cells will be inserted. - <p>Non-empty cells cannot be moved off the sheet.</p> + @param nMode + describes how to move existing cells. */ - void insertCells( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::sheet::CellInsertMode nMode ); + void insertCells( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::sheet::CellInsertMode nMode ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::removeRange /** deletes cells, moving other cells up or left. + + @param aRange + the cell range to remove. + + @param nMode + describes how to move following cells. */ - void removeRange( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::sheet::CellDeleteMode nMode ); + void removeRange( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::sheet::CellDeleteMode nMode ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::moveRange /** moves a cell range to another position in the document. + + <p>After copying the contents of the cell range, all cells + will be cleared.</p> + + @param aDestination + the address of the top left cell of the destination range. + + @param aSource + the cell range which will be copied. */ - void moveRange( [in] com::sun::star::table::CellAddress aDestination, - [in] com::sun::star::table::CellRangeAddress aSource ); + void moveRange( + [in] com::sun::star::table::CellAddress aDestination, + [in] com::sun::star::table::CellRangeAddress aSource ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeMovement::copyRange /** copies a cell range to another position in the document. + + <p>The source cell range keeps unchanged.</p> + + @param aDestination + the address of the top left cell of the destination range. + + @param aSource + the cell range which will be copied. */ - void copyRange( [in] com::sun::star::table::CellAddress aDestination, - [in] com::sun::star::table::CellRangeAddress aSource ); + void copyRange( + [in] com::sun::star::table::CellAddress aDestination, + [in] com::sun::star::table::CellRangeAddress aSource ); }; @@ -135,21 +161,5 @@ interface XCellRangeMovement: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellRangeReferrer.idl b/offapi/com/sun/star/sheet/XCellRangeReferrer.idl index 753543ff8ab9..36bc20de7586 100644 --- a/offapi/com/sun/star/sheet/XCellRangeReferrer.idl +++ b/offapi/com/sun/star/sheet/XCellRangeReferrer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangeReferrer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__ #define __com_sun_star_sheet_XCellRangeReferrer_idl__ @@ -69,26 +70,25 @@ #include <com/sun/star/table/XCellRange.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellRangeReferrer -/** allows direct access to the cells in a named range or - to the cells which are visible in a view, without the need to get the - document object first.@see com::sun::star::sheet::NamedRange - @see com::sun::star::sheet::DatabaseRange - @see com::sun::star::sheet::SpreadsheetViewPane +/** allows direct access to the cells in a named range or to the cells + which are visible in a view, without the need to get the document + object first. + + @see com::sun::star::sheet::NamedRange + @see com::sun::star::sheet::DatabaseRange + @see com::sun::star::sheet::SpreadsheetViewPane */ interface XCellRangeReferrer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangeReferrer::getReferredCells - /** returns the cell range that is represented. + /** returns the cell range object that is represented. */ com::sun::star::table::XCellRange getReferredCells(); @@ -98,27 +98,5 @@ interface XCellRangeReferrer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellRangesQuery.idl b/offapi/com/sun/star/sheet/XCellRangesQuery.idl index c2fd2fe7f7b8..2e010f3ba61f 100644 --- a/offapi/com/sun/star/sheet/XCellRangesQuery.idl +++ b/offapi/com/sun/star/sheet/XCellRangesQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRangesQuery.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellRangesQuery_idl__ #define __com_sun_star_sheet_XCellRangesQuery_idl__ @@ -77,108 +78,123 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellRangesQuery -/** provides methods to invoke queries on cells.@see com::sun::star::sheet::SheetRangesQuery +/** provides methods to query for cell ranges with specific contents. + + <p>All methods return a collection of cell ranges.</p> + + @see com::sun::star::sheet::SheetRangesQuery + @see com::sun::star::sheet::SheetCellRanges */ interface XCellRangesQuery: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryVisibleCells - /** points the cursor to only the visible (not hidden) - cells of those to which it currently points. + /** queries all visible cells. + + @returns + the visible (not hidden) cells of the current cell range(s). */ com::sun::star::sheet::XSheetCellRanges queryVisibleCells(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryEmptyCells - /** collapses the cursor to the empty cells within the range to which it is currently pointing. + /** queries all empty cells. - - - <p>After this operation the cursor only contains the empty cells - out of those which it pointed before.</p> + @returns + the empty cells of the current cell range(s). */ com::sun::star::sheet::XSheetCellRanges queryEmptyCells(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryContentCells - /** collapses the cursor to the cells with the specified content type - within the range to which it is currently pointing. - + /** queries all cells with the specified content type(s). + @param nContentFlags + a combination of <type>CellFlags</type> flags. - <p>After this operation, the cursor only contains cells with the specified - content type out of those which it pointed before. + <p>Attention: Despite the <type>CellFlags</type> flags are + <atom>long</atom> values, this method expects a <atom>short</atom> + parameter. - </p> + @returns + all cells of the current cell range(s) with the specified + content type(s). */ - com::sun::star::sheet::XSheetCellRanges queryContentCells( [in] short nContentFlags ); + com::sun::star::sheet::XSheetCellRanges queryContentCells( + [in] short nContentFlags ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryFormulaCells - /** queries all cells with a specified result type. + /** queries all formula cells with the specified result type. + @param nResultFlags + a combination of <type>FormulaResult</type> flags. - - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by the - formula cells containing results of a specified type</p>. + @returns + all formula cells of the current cell range(s) with the + specified result type(s). */ - com::sun::star::sheet::XSheetCellRanges queryFormulaCells( [in] long nResultFlags ); + com::sun::star::sheet::XSheetCellRanges queryFormulaCells( + [in] long nResultFlags ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryColumnDifferences - /** queries all cells which have a different value in - a specified row. + /** queries all cells with different values in a specified row. + <p>This method takes each column of the current cell range(s) and + compares all cells with the cell in the specified row. All cells + which are different to this comparison cell will be returned.</p> + @param aCompare + contains a cell address with the row index used for comparison. + Only this row index is of interest. - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which have a different value in the same column of the - specified row.</p> + @returns + all cells of the current cell range(s) which are different + to the comparison cell of each column. */ - com::sun::star::sheet::XSheetCellRanges queryColumnDifferences( [in] com::sun::star::table::CellAddress aCompare ); + com::sun::star::sheet::XSheetCellRanges queryColumnDifferences( + [in] com::sun::star::table::CellAddress aCompare ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryRowDifferences - /** queries all cells which have a different value in - a specified column. + /** queries all cells with different values in a specified column. + <p>This method takes each row of the current cell range(s) and + compares all cells with the cell in the specified column. All cells + which are different to this comparison cell will be returned.</p> + @param aCompare + contains a cell address with the column index used for + comparison. Only this column index is of interest. - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which have a different value in the same row of the - specified column.</p> + @returns + all cells of the current cell range(s) which are different + to the comparison cell of each row. */ - com::sun::star::sheet::XSheetCellRanges queryRowDifferences( [in] com::sun::star::table::CellAddress aCompare ); + com::sun::star::sheet::XSheetCellRanges queryRowDifferences( + [in] com::sun::star::table::CellAddress aCompare ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellRangesQuery::queryIntersection - /** intersects the cursor with the specified cell range. + /** intersects the current cell range(s) with the specified cell range. + @param aRange + contains the cell range for intersection. + @return + all cells of the current cell range(s) which are contained + in the passed cell range. - <p>The set of cells to which the cursor is currently pointing - will be collapsed into a subset. This subset is specified by all - cells which are also in the specified range.</p> */ - com::sun::star::sheet::XSheetCellRanges queryIntersection( [in] com::sun::star::table::CellRangeAddress aRange ); + com::sun::star::sheet::XSheetCellRanges queryIntersection( + [in] com::sun::star::table::CellRangeAddress aRange ); }; @@ -186,30 +202,5 @@ interface XCellRangesQuery: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.4 2000/09/11 11:52:50 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:33 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCellSeries.idl b/offapi/com/sun/star/sheet/XCellSeries.idl index 3488e6137b54..1aa90930f7e7 100644 --- a/offapi/com/sun/star/sheet/XCellSeries.idl +++ b/offapi/com/sun/star/sheet/XCellSeries.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellSeries.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCellSeries_idl__ #define __com_sun_star_sheet_XCellSeries_idl__ @@ -77,60 +78,67 @@ #include <com/sun/star/sheet/FillDateMode.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XCellSeries -/** represents a cell range that can be filled with a - series. +/** provides methods to fill out a cell range automatically with values + based on a start value, step count and fill mode. + + @see com::sun::star::sheet::SheetCellRange */ interface XCellSeries: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XCellSeries::fillSeries - /** fills the cells in the range. - */ - void fillSeries( [in] com::sun::star::sheet::FillDirection nFillDirection, - [in] com::sun::star::sheet::FillMode nFillMode, - [in] com::sun::star::sheet::FillDateMode nFillDateMode, - [in] double fStep, - [in] double fEndValue ); + /** fills all cells in the range based on the specified settings. - //------------------------------------------------------------------------- + @param nFillDirection + specifies the direction to fill the rows/columns of the range. - // DocMerge from xml: method com::sun::star::sheet::XCellSeries::fillAuto - /** fills the cells in the range in a way that is specified by - the first cells in the range. - */ - void fillAuto( [in] com::sun::star::sheet::FillDirection nFillDirection, - [in] long nSourceCount ); + @param nFillMode + specifies the type of the series. -}; + @param nFillDateMode + specifies the calculation mode for date values. -//============================================================================= + @param fStep + contains the value used to increase/decrease the series values. -}; }; }; }; + @param fEndValue + contains the threshold value on which the calculation of the + current series stops. + */ + void fillSeries( + [in] com::sun::star::sheet::FillDirection nFillDirection, + [in] com::sun::star::sheet::FillMode nFillMode, + [in] com::sun::star::sheet::FillDateMode nFillDateMode, + [in] double fStep, + [in] double fEndValue ); + + //------------------------------------------------------------------------- -/*============================================================================= + /** fills all cells in the range in a way that is specified by the + first cell(s) in the range. - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api + @param nFillDirection + specifies the direction to fill the rows/columns of the range. - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import + @param nSourceCount + contains the number of cells in each row/column used to + constitute the fill algorithm. + */ + void fillAuto( + [in] com::sun::star::sheet::FillDirection nFillDirection, + [in] long nSourceCount ); - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XCompatibilityNames.idl b/offapi/com/sun/star/sheet/XCompatibilityNames.idl index 251d2804196a..c0811b902578 100644 --- a/offapi/com/sun/star/sheet/XCompatibilityNames.idl +++ b/offapi/com/sun/star/sheet/XCompatibilityNames.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCompatibilityNames.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XCompatibilityNames_idl__ #define __com_sun_star_sheet_XCompatibilityNames_idl__ @@ -65,33 +66,46 @@ #include <com/sun/star/sheet/LocalizedName.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** gives access to an AddIn's compatibility names. +/** gives access to the sequence of compatibility names for an Addin + function. */ interface XCompatibilityNames: com::sun::star::uno::XInterface { - /** returns the compatibility names of the function. + /** returns the compatibility names of the specified function. + + <p>Compatibility names are localized names of AddIn functions that + are used to import files from other applications.</p> + + <p>If on import a localized function name is read, this list of + compatibility names is used to find the internal name of the + function. The current locale may differ from the locale used in + the imported file, so the method + <member>XAddIn::getProgrammaticFuntionName</member> cannot be used + here.</p> + + <p>The order inside the sequence of compatibility names is used to + prioritize the names. Initially the first compatibility name of + each function is compared to the imported name (each function may + provide a sequence of compatibility names - the first entry of all + sequences is used). If no entry is equal, the second entry of each + sequence is used and so on.</p> - <p>The compatibility names are used for import and export to other - applications. They may be locale-dependent. - The default name for each locale must be the first for that locale. - The first entry in the sequence must be for the default - locale (used for a locale that is not in the list). - If a function doesn't have any compatibility names, - the returned sequence is empty.</p> + <p>If a locale is not present in the sequence of compatibility names, + the first entry of the sequence is used. So the method should return + a sequence which contains first the entry representing the current + locale.<TRUE/></p> -<!-- JRH: Needs rewriting to clarify. --> -<!-- Editor: The sentence "The default name for each locale must be the first - for that locale" is confusing --> -<!-- Editor: Maybe an example would help. --> + @param aProgrammaticName + is the exact name of a method within its interface. */ - sequence<LocalizedName> getCompatibilityNames( [in] string aProgrammaticName ); + sequence< com::sun::star::sheet::LocalizedName > + getCompatibilityNames( [in] string aProgrammaticName ); }; //============================================================================= diff --git a/offapi/com/sun/star/sheet/XConsolidatable.idl b/offapi/com/sun/star/sheet/XConsolidatable.idl index 4810367bda37..cc2053049f39 100644 --- a/offapi/com/sun/star/sheet/XConsolidatable.idl +++ b/offapi/com/sun/star/sheet/XConsolidatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConsolidatable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XConsolidatable_idl__ #define __com_sun_star_sheet_XConsolidatable_idl__ @@ -69,28 +70,16 @@ #include <com/sun/star/sheet/XConsolidationDescriptor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XConsolidatable -/** represents a spreadsheet document that can - consolidate ranges. - - - - - - - - - - - +/** provides methods to consolidate ranges in a spreadsheet document. + <p>Consolidation combines the cells of multiple cell ranges, using a + specific function.</p> @deprecated */ @@ -98,17 +87,29 @@ interface XConsolidatable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidatable::createConsolidationDescriptor /** creates a consolidation descriptor. + + @param bEmpty + <TRUE/> leaves the descriptor empty, <FALSE/> fills it with + the settings from the last consolidation action. + + @see com::sun::star::sheet::ConsolidationDescriptor */ - com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor( [in] boolean bEmpty ); + com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor( + [in] boolean bEmpty ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidatable::consolidate - /** consolidates data from several cell ranges. + /** consolidates data from several cell ranges, using the settings + in the passed descriptor. + + @param xDescriptor + the descriptor used to perform the consolidation. + + @see com::sun::star::sheet::ConsolidationDescriptor */ - void consolidate( [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor ); + void consolidate( + [in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor ); }; @@ -116,21 +117,5 @@ interface XConsolidatable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl b/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl index c5eaae7d9587..6d77069776a3 100644 --- a/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl +++ b/offapi/com/sun/star/sheet/XConsolidationDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConsolidationDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__ #define __com_sun_star_sheet_XConsolidationDescriptor_idl__ @@ -77,117 +78,99 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XConsolidationDescriptor -/** represents a description of how to consolidate multiple - cell ranges. - - - +/** provides access to the settings of a consolidation descriptor. + @deprecated - - - @deprecated@see com::sun::star::sheet::ConsolidationDescriptor + @see com::sun::star::sheet::ConsolidationDescriptor */ interface XConsolidationDescriptor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getFunction /** returns the function by which the ranges are consolidated. */ com::sun::star::sheet::GeneralFunction getFunction(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setFunction /** sets the function by which the ranges are consolidated. */ void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XConsolidationDescriptor::getSources - // DocMerge from idl: method com::sun::star::sheet::XConsolidationDescriptor::getSources /** returns the cell ranges which are consolidated. */ - sequence<com::sun::star::table::CellRangeAddress> getSources(); + sequence< com::sun::star::table::CellRangeAddress > getSources(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setSources /** sets the cell ranges which are consolidated. */ - void setSources( [in] sequence<com::sun::star::table::CellRangeAddress> aSources ); + void setSources( + [in] sequence< com::sun::star::table::CellRangeAddress > aSources ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getStartOutputPosition - /** returns the position in the document where the - consolidated data are copied. + /** returns the position of the top left cell of the cell range where + the consolidated data are copied. */ com::sun::star::table::CellAddress getStartOutputPosition(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setStartOutputPosition - /** sets the position in the document where the - consolidated data are copied. + /** sets the position of the top left cell of the cell range + where the consolidated data are copied. */ - void setStartOutputPosition( [in] com::sun::star::table::CellAddress aStartOutputPosition ); + void setStartOutputPosition( + [in] com::sun::star::table::CellAddress aStartOutputPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getUseColumnHeaders - /** returns whether column headers from the cell ranges - are used to find matching data or not. + /** returns, whether column headers from the cell ranges are used to + find matching data or not. */ boolean getUseColumnHeaders(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setUseColumnHeaders - /** specifies if column headers from the cell ranges - are used to find matching data. + /** specifies if column headers from the cell ranges are used to find + matching data. */ void setUseColumnHeaders( [in] boolean bUseColumnHeaders ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getUseRowHeaders - /** returns whether row headers from the cell ranges - are used to find matching data or not. + /** returns, whether row headers from the cell ranges are used to + find matching data or not. */ boolean getUseRowHeaders(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setUseRowHeaders - /** specifies if row headers from the cell ranges - are used to find matching data. + /** specifies if row headers from the cell ranges are used to find + matching data. */ void setUseRowHeaders( [in] boolean bUseRowHeaders ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::getInsertLinks - /** returns whether links to the original data - are inserted in the output area or not. + /** returns, whether links to the original data are inserted in the + output area or not. */ boolean getInsertLinks(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XConsolidationDescriptor::setInsertLinks - /** specifies if links to the original data - are inserted in the output area. + /** specifies if links to the original data are inserted in the + output area. */ void setInsertLinks( [in] boolean bInsertLinks ); @@ -197,33 +180,5 @@ interface XConsolidationDescriptor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDDELink.idl b/offapi/com/sun/star/sheet/XDDELink.idl index e7769b8825f4..e043693e073e 100644 --- a/offapi/com/sun/star/sheet/XDDELink.idl +++ b/offapi/com/sun/star/sheet/XDDELink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDDELink.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDDELink_idl__ #define __com_sun_star_sheet_XDDELink_idl__ @@ -65,47 +66,35 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDDELink -/** represents a DDE link. - - - +/** provides methods to change the settings of a DDE link. + @deprecated - - - @deprecated@see com::sun::star::sheet::DDELink + @see com::sun::star::sheet::DDELink */ interface XDDELink: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getApplication - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getApplication /** returns the application from which data are requested (the DDE server application). */ string getApplication(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getTopic - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getTopic /** returns the DDE topic from which data are requested. */ string getTopic(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDDELink::getItem - // DocMerge from xml: method com::sun::star::sheet::XDDELink::getItem /** returns the DDE item from which data are requested. */ string getItem(); @@ -116,33 +105,5 @@ interface XDDELink: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl index 3f994e6239ff..c4941471d24d 100644 --- a/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl +++ b/offapi/com/sun/star/sheet/XDataPilotDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ #define __com_sun_star_sheet_XDataPilotDescriptor_idl__ @@ -77,106 +78,99 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotDescriptor -/** represents a description of a data pilot table.@see com::sun::star::sheet::DataPilotDescriptor - @see com::sun::star::sheet::DataPilotTable +/** provides access to the layout settings of a data pilot table. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XNamed</type> which provides + access to the name of the data pilot table used i.e. in collections.</p> + + @see com::sun::star::sheet::DataPilotDescriptor + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotDescriptor: com::sun::star::container::XNamed { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotDescriptor::getTag - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getTag - /** returns an additional string stored in the - data pilot table. + /** returns an additional string stored in the data pilot table. */ string getTag(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::setTag - /** sets an additional string stored in the - data pilot table. + /** sets an additional string stored in the data pilot table. */ void setTag( [in] string aTag ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getSourceRange - /** returns the cell range containing the data - for the data pilot table. + /** returns the cell range containing the data for the data pilot table. */ com::sun::star::table::CellRangeAddress getSourceRange(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::setSourceRange - /** sets the cell range containing the - data for the data pilot table. + /** sets the cell range containing the data for the data pilot table. */ - void setSourceRange( [in] com::sun::star::table::CellRangeAddress aSourceRange ); + void setSourceRange( + [in] com::sun::star::table::CellRangeAddress aSourceRange ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getFilterDescriptor - /** returns the filter descriptor specifying - which data from the source cell range are used for the - data pilot table. + /** returns the filter descriptor specifying which data from the + source cell range are used for the data pilot table. */ com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getDataPilotFields - /** returns the collection of all the data - pilot fields. + /** returns the collection of all the data pilot fields. */ com::sun::star::container::XIndexAccess getDataPilotFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getColumnFields - /** returns the collection of the data pilot - fields used as column fields. + /** returns the collection of the data pilot fields used as column fields. + + @see com::sun::star::sheet::DataPilotFields */ com::sun::star::container::XIndexAccess getColumnFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getRowFields - /** returns the collection of the data pilot - fields used as row fields. + /** returns the collection of the data pilot fields used as row fields. + + @see com::sun::star::sheet::DataPilotFields */ com::sun::star::container::XIndexAccess getRowFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getPageFields - /** returns the collection of the data pilot - fields used as page fields. + /** returns the collection of the data pilot fields used as page fields. + + @see com::sun::star::sheet::DataPilotFields */ com::sun::star::container::XIndexAccess getPageFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getDataFields - /** returns the collection of the data pilot - fields used as data fields. + /** returns the collection of the data pilot fields used as data fields. + + @see com::sun::star::sheet::DataPilotFields */ com::sun::star::container::XIndexAccess getDataFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotDescriptor::getHiddenFields - /** returns the collection of the data pilot - fields not used as column, row, page, or data fields. + /** returns the collection of the data pilot fields not used as + column, row, page, or data fields. + + @see com::sun::star::sheet::DataPilotFields */ com::sun::star::container::XIndexAccess getHiddenFields(); @@ -186,33 +180,5 @@ interface XDataPilotDescriptor: com::sun::star::container::XNamed }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl b/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl index 41befcff25c2..66f221b114a2 100644 --- a/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl +++ b/offapi/com/sun/star/sheet/XDataPilotMemberResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotMemberResults.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotMemberResults_idl__ #define __com_sun_star_sheet_XDataPilotMemberResults_idl__ @@ -69,25 +70,29 @@ #include <com/sun/star/sheet/MemberResult.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotMemberResults -/** gives access to member results. +/** provides access to a sequence of results of a data pilot source level. + + <p>These results are used to fill the data area for the level in a data + pilot table.</p> + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::XDataPilotResults */ interface XDataPilotMemberResults: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotMemberResults::getResults - // DocMerge from idl: method com::sun::star::sheet::XDataPilotMemberResults::getResults - /** returns the member results. + /** returns the sequence of results for the regarding data pilot + source level. */ - sequence<com::sun::star::sheet::MemberResult> getResults(); + sequence< com::sun::star::sheet::MemberResult > getResults(); }; @@ -95,27 +100,5 @@ interface XDataPilotMemberResults: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotResults.idl b/offapi/com/sun/star/sheet/XDataPilotResults.idl index b0894950c38e..3867c735d4db 100644 --- a/offapi/com/sun/star/sheet/XDataPilotResults.idl +++ b/offapi/com/sun/star/sheet/XDataPilotResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotResults.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotResults_idl__ #define __com_sun_star_sheet_XDataPilotResults_idl__ @@ -71,22 +72,27 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotResults -/** gives access to results. +/** provides access to a table of results of a data pilot source. + + <p>These results are used to fill the data area of a data pilot table.</p> + + @see com::sun::star::sheet::DataPilotSource + @see com::sun::star::sheet::XDataPilotMemberResults */ interface XDataPilotResults: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDataPilotResults::getResults - // DocMerge from idl: method com::sun::star::sheet::XDataPilotResults::getResults /** returns the result array. + + <p>The outer sequence contains the value rows. The inner sequences + contain the values for one row.</p> */ - sequence< sequence<DataResult> > getResults(); + sequence< sequence< DataResult > > getResults(); }; @@ -94,27 +100,5 @@ interface XDataPilotResults: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTable.idl b/offapi/com/sun/star/sheet/XDataPilotTable.idl index 54bf0222a568..83afcf606d1a 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTable.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotTable_idl__ #define __com_sun_star_sheet_XDataPilotTable_idl__ @@ -69,32 +70,30 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotTable -/** represents a data pilot table which has already - been created.@see com::sun::star::sheet::DataPilotTable +/** provides methods to control a data pilot table which has already + been created. + + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotTable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTable::getOutputRange - /** returns the address of the cell range that - contains the data pilot table. + /** returns the address of the cell range that contains the data + pilot table. */ com::sun::star::table::CellRangeAddress getOutputRange(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTable::refresh - /** recreates the data pilot table with current - data from the source cell range. + /** recreates the data pilot table with current data from the source + cell range. */ void refresh(); @@ -104,27 +103,5 @@ interface XDataPilotTable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:49 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTables.idl b/offapi/com/sun/star/sheet/XDataPilotTables.idl index fd74ca5b173d..1a4987702895 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTables.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTables.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTables.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotTables_idl__ #define __com_sun_star_sheet_XDataPilotTables_idl__ @@ -73,39 +74,59 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotTables -/** represents a collection of data pilot tables.@see com::sun::star::sheet::DataPilotTables +/** provides access to the data pilot tables via name and inserting and + removing data pilot tables. + + <p>This interface extends the interface + <type scope="com::sun::star::container">XNameAccess</type> which provides + access to existing data pilot tables in the collection.</p> + + @see com::sun::star::sheet::DataPilotTables + @see com::sun::star::sheet::DataPilotTable */ interface XDataPilotTables: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::createDataPilotDescriptor - /** creates a data pilot descriptor which can - be used with addTable(). + /** creates a data pilot descriptor. + + <p>This descriptor can be used with + <member>XDataPilotTables::addTable</member>.</p> + + @see com::sun::star::sheet::DataPilotTableDescriptor */ com::sun::star::sheet::XDataPilotDescriptor createDataPilotDescriptor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::insertNewByName /** creates a new data pilot table and adds it to the collection. + + @param aName + the name of the data pilot table used in the collection. + + @param aAoutputAddress + the top left cell of the location of the data pilot table in + the spreadsheet document. + + @param xDescriptor + the descriptor containing the settings of the data pilot table. + + @see com::sun::star::sheet::DataPilotTableDescriptor */ - void insertNewByName( [in] string aName, - [in] com::sun::star::table::CellAddress aOutputAddress, - [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor ); + void insertNewByName( + [in] string aName, + [in] com::sun::star::table::CellAddress aOutputAddress, + [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTables::removeByName - /** deletes a data pilot table. + /** deletes a data pilot table from the collection. */ void removeByName( [in] string aName ); @@ -115,27 +136,5 @@ interface XDataPilotTables: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl b/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl index dfd806d80888..0869bfb00337 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTablesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataPilotTablesSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ #define __com_sun_star_sheet_XDataPilotTablesSupplier_idl__ @@ -69,22 +70,23 @@ #include <com/sun/star/sheet/XDataPilotTables.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDataPilotTablesSupplier -/** grants access to a collection of data pilot tables.@see com::sun::star::sheet::Spreadsheet +/** grants access to a collection of data pilot tables. + + @see com::sun::star::sheet::Spreadsheet */ interface XDataPilotTablesSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDataPilotTablesSupplier::getDataPilotTables - /** returns the collection of data pilot tables.@see DataPilotTables + /** Returns the collection of data pilot tables. + + @see com::sun::star::sheet::DataPilotTables */ com::sun::star::sheet::XDataPilotTables getDataPilotTables(); @@ -94,27 +96,5 @@ interface XDataPilotTablesSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDatabaseRange.idl b/offapi/com/sun/star/sheet/XDatabaseRange.idl index e1512ae39186..e9680027cd71 100644 --- a/offapi/com/sun/star/sheet/XDatabaseRange.idl +++ b/offapi/com/sun/star/sheet/XDatabaseRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseRange.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDatabaseRange_idl__ #define __com_sun_star_sheet_XDatabaseRange_idl__ @@ -81,81 +82,72 @@ #include <com/sun/star/sheet/XSubTotalDescriptor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDatabaseRange -/** represents a cell range for which data operations are defined.@see com::sun::star::sheet::DatabaseRange +/** provides access to the settings and options of a database range. + + @see com::sun::star::sheet::DatabaseRange */ interface XDatabaseRange: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getDataArea - /** returns the data area of the database range. + /** returns the data area of the database range in the + spreadsheet document. */ com::sun::star::table::CellRangeAddress getDataArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::setDataArea /** sets the data area of the database range. */ void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDatabaseRange::getSortDescriptor - // DocMerge from idl: method com::sun::star::sheet::XDatabaseRange::getSortDescriptor - /** returns the sort descriptor stored with the - database range. + /** returns the sort descriptor stored with the database range. + + @see com::sun::star::sheet::SheetSortDescriptor */ - sequence<com::sun::star::beans::PropertyValue> getSortDescriptor(); + sequence< com::sun::star::beans::PropertyValue > getSortDescriptor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getFilterDescriptor - /** returns the filter descriptor stored with the - database range. - + /** returns the filter descriptor stored with the database range. - - <p>If the filter descriptor is modified, the new filtering - is carried out when <member>XDatabaseRange::refresh()</member> - is called.</p> + <p>If the filter descriptor is modified, the new filtering is + carried out when <member>XDatabaseRange::refresh()</member> is + called.</p> */ com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::getSubTotalDescriptor /** returns the subtotal descriptor stored with the database range. - - <p>If the subtotal descriptor is modified, the new subtotals - are inserted when <member>XDatabaseRange::refresh()</member> - is called.</p> + <p>If the subtotal descriptor is modified, the new subtotals are + inserted when <member>XDatabaseRange::refresh()</member> is + called.</p> */ com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDatabaseRange::getImportDescriptor - // DocMerge from idl: method com::sun::star::sheet::XDatabaseRange::getImportDescriptor - /** returns the <type>DatabaseImportDescriptor</type> stored with this - database range. + /** returns the database import descriptor stored with this database + range. + + @see com::sun::star::sheet::DatabaseImportDescriptor */ - sequence<com::sun::star::beans::PropertyValue> getImportDescriptor(); + sequence< com::sun::star::beans::PropertyValue > getImportDescriptor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRange::refresh - /** executes the stored import, filter, sorting, - and subtotals descriptors again. + /** executes the stored import, filter, sorting, and subtotals + descriptors again. */ void refresh(); @@ -165,36 +157,5 @@ interface XDatabaseRange: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.3 2000/10/10 09:03:09 mi - returned service specified - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDatabaseRanges.idl b/offapi/com/sun/star/sheet/XDatabaseRanges.idl index a15a8b2077b1..f39bb861cf02 100644 --- a/offapi/com/sun/star/sheet/XDatabaseRanges.idl +++ b/offapi/com/sun/star/sheet/XDatabaseRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDatabaseRanges.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDatabaseRanges_idl__ #define __com_sun_star_sheet_XDatabaseRanges_idl__ @@ -69,30 +70,28 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDatabaseRanges -/** provides functions to manage a collection of - database ranges.@see com::sun::star::sheet::DatabaseRanges +/** provides functions to manage a collection of database ranges. + + @see com::sun::star::sheet::DatabaseRanges */ interface XDatabaseRanges: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRanges::addNewByName /** adds a new database range to the collection. */ - void addNewByName( [in] string aName, - [in] com::sun::star::table::CellRangeAddress aRange ); + void addNewByName( + [in] string aName, + [in] com::sun::star::table::CellRangeAddress aRange ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDatabaseRanges::removeByName /** removes a database range from the collection. */ void removeByName( [in] string aName ); @@ -103,27 +102,5 @@ interface XDatabaseRanges: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDimensionsSupplier.idl b/offapi/com/sun/star/sheet/XDimensionsSupplier.idl index a7db53fa3b68..6238792911e6 100644 --- a/offapi/com/sun/star/sheet/XDimensionsSupplier.idl +++ b/offapi/com/sun/star/sheet/XDimensionsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDimensionsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDimensionsSupplier_idl__ #define __com_sun_star_sheet_XDimensionsSupplier_idl__ @@ -69,22 +70,23 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDimensionsSupplier -/** gives access to dimensions. +/** provides access to the collection of dimensions of a data pilot source. + + @see com::sun::star::sheet::DataPilotSource */ interface XDimensionsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDimensionsSupplier::getDimensions - /** returns the dimensions. + /** returns the collection of dimensions. + + @see com::sun::star::sheet::DataPilotSourceDimensions */ com::sun::star::container::XNameAccess getDimensions(); @@ -94,21 +96,5 @@ interface XDimensionsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XDocumentAuditing.idl b/offapi/com/sun/star/sheet/XDocumentAuditing.idl index 5415dc1e34ca..84bb198430de 100644 --- a/offapi/com/sun/star/sheet/XDocumentAuditing.idl +++ b/offapi/com/sun/star/sheet/XDocumentAuditing.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentAuditing.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XDocumentAuditing_idl__ #define __com_sun_star_sheet_XDocumentAuditing_idl__ @@ -65,28 +66,23 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XDocumentAuditing -/** represents auditing functions of a document. +/** provides auditing functions of a document. */ interface XDocumentAuditing: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XDocumentAuditing::refreshArrows - /** refreshes all existing auditing arrows on - all sheets of the document. - + /** refreshes all existing auditing arrows on all sheets of the + document. - - <p>Dependencies are marked for all the cells that were - marked before, but using current formulas.</p> + <p>Dependencies are marked for all the cells that were marked + before, but using current formulas.</p> */ void refreshArrows(); @@ -96,21 +92,5 @@ interface XDocumentAuditing: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XFillAcrossSheet.idl b/offapi/com/sun/star/sheet/XFillAcrossSheet.idl index 158899ded1b7..d96f6a3631e6 100644 --- a/offapi/com/sun/star/sheet/XFillAcrossSheet.idl +++ b/offapi/com/sun/star/sheet/XFillAcrossSheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFillAcrossSheet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XFillAcrossSheet_idl__ #define __com_sun_star_sheet_XFillAcrossSheet_idl__ @@ -72,20 +73,12 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XFillAcrossSheet -/** uno! - - - - - - @deprecated +/** @deprecated */ interface XFillAcrossSheet: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XFillAcrossSheet::fillAcrossSheets /** copies data between ranges onto different sheets in the document. */ @@ -97,21 +90,5 @@ interface XFillAcrossSheet: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XFormulaQuery.idl b/offapi/com/sun/star/sheet/XFormulaQuery.idl index d4a13d860dbf..59ebd4eb2765 100644 --- a/offapi/com/sun/star/sheet/XFormulaQuery.idl +++ b/offapi/com/sun/star/sheet/XFormulaQuery.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormulaQuery.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XFormulaQuery_idl__ #define __com_sun_star_sheet_XFormulaQuery_idl__ @@ -69,44 +70,59 @@ #include <com/sun/star/sheet/XSheetCellRanges.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XFormulaQuery /** provides methods to query cells for dependencies - in formulas.@see com::sun::star::sheet::SheetRangesQuery + in formulas. + + <p>All methods return a collection of cell ranges.</p> + + @see com::sun::star::sheet::SheetRangesQuery + @see com::sun::star::sheet::SheetCellRanges */ interface XFormulaQuery: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XFormulaQuery::queryDependents - /** points the cursor to the cells which are dependent on - the cells to which it is currently pointing. + /** queries all dependent formula cells. + <p>Dependent cells are cells containing formulas with references to + the original cell.</p> + @param bRecursive + <FALSE/> = queries cells dependent from the original range(s), + <TRUE/> = repeates query with all found cells + (finds dependents of dependents, and so on). - <p>Dependent cells are cells containing formulas with - references to the original cells.</p> + @return + all dependent cells of any formula cell of the current + cell range(s). */ - com::sun::star::sheet::XSheetCellRanges queryDependents( [in] boolean bRecursive ); + com::sun::star::sheet::XSheetCellRanges queryDependents( + [in] boolean bRecursive ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XFormulaQuery::queryPrecedents - /** points the cursor to the cells which are precedent - to the cells to which it is currently pointing. + /** queries all precedent cells. + <p>Precedent cells are cells which are referenced from a formula + cell.</p> + @param bRecursive + <FALSE/> = queries precedent cells of the original range(s), + <TRUE/> = repeates query with all found cells + (finds precedents of precedents, and so on). - <p>Precedent cells are cells which are used in formulas as - references in the original cells.</p> + @return + all precedent cells of any formula cell of the current cell + range(s). */ - com::sun::star::sheet::XSheetCellRanges queryPrecedents( [in] boolean bRecursive ); + com::sun::star::sheet::XSheetCellRanges queryPrecedents( + [in] boolean bRecursive ); }; @@ -114,27 +130,5 @@ interface XFormulaQuery: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl index 1dd05cb21ae8..408598d4f329 100644 --- a/offapi/com/sun/star/sheet/XFunctionAccess.idl +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFunctionAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XFunctionAccess_idl__ #define __com_sun_star_sheet_XFunctionAccess_idl__ @@ -73,18 +74,20 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= /** allows generic access to all spreadsheet functions. + + @see com::sun::star::sheet::FunctionAccess */ interface XFunctionAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** calls a function and returns the result of the call. @param aName @@ -93,47 +96,57 @@ interface XFunctionAccess: com::sun::star::uno::XInterface @param aArguments the arguments for the function call. <p>Each element must be of one of the following types:</p> + <dl> <dt><atom>long</atom> or <atom>double</atom></dt> <dd>for a numeric value.</dd> + <dt><atom>string</atom></dt> <dd>for a textual value.</dd> - <dt><atom">long[][]</atom> or - <atom">double[][]</atom></dt> + + <dt><atom>long[][]</atom> or <atom>double[][]</atom></dt> <dd>for an array of numeric values.</dd> + <dt><atom>string[][]</atom></dt> <dd>for an array of textual values.</dd> + <dt><atom>any[][]</atom></dt> <dd>for a mixed array, where each element must be of <void/>, - <atom>long</atom>, <atom>double</atom> or - <atom>string</atom> type.</dd> + <atom>long</atom>, <atom>double</atom> or <atom>string</atom> + type.</dd> + <dt><type scope="com::sun::star::table">XCellRange</type></dt> - <dd>for a <type>SheetCellRange</type> object - that contains the data. + <dd>for a <type>SheetCellRange</type> object that contains the + data.</dd> </dl> @returns - the result of the function call. - <p>Possible types for the result are:</p> - <dl> - <dt><void/></dt> - <dd>if no result is available.</dd> - <dt><atom>double</atom></dt> - <dd>for a numeric result.</dd> - <dt><atom>string</atom></dt> - <dd>for a textual result.</dd> - <dt><atom>any[][]</atom></dt> - <dd>for an array result, containing <atom>double</atom> and + the result of the function call. + + <p>Possible types for the result are:</p> + + <dl> + <dt><void/></dt> + <dd>if no result is available.</dd> + + <dt><atom>double</atom></dt> + <dd>for a numeric result.</dd> + + <dt><atom>string</atom></dt> + <dd>for a textual result.</dd> + + <dt><atom>any[][]</atom></dt> + <dd>for an array result, containing <atom>double</atom> and <atom>string</atom> values.</dd> - </dl> + </dl> - @throws NoSuchElementException - if the named function does not exist. + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the named function does not exist. - @throws IllegalArgumentException - if the function can not be called with these arguments. + @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> + if the function can not be called with these arguments. */ - any callFunction( [in] string aName, [in] sequence<any> aArguments ) + any callFunction( [in] string aName, [in] sequence< any > aArguments ) raises( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ); }; @@ -142,7 +155,5 @@ interface XFunctionAccess: com::sun::star::uno::XInterface }; }; }; }; - #endif - diff --git a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl index 10e03c7cbcc2..339ff1393f22 100644 --- a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFunctionDescriptions.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__ #define __com_sun_star_sheet_XFunctionDescriptions_idl__ @@ -73,30 +74,38 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XFunctionDescriptions -/** manages the list of descriptions of functions.@see com::sun::star::sheet::FunctionDescriptions +/** provides access to the property sequence of a function description + via function index or identifier. + + <p>The container access methods return a sequence of + <type scope="com::sun::star::beans">PropertyValue</type> structs. + The properties contained in the sequence are collected in the service + <type>FunctionDescription</type>.</p> + + @see com::sun::star::sheet::FunctionDescriptions */ interface XFunctionDescriptions: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XFunctionDescriptions::getById - /** finds a function description by its identifier. - @returns - the <type>FunctionDescription</type>. + /** finds a function description by the identifier of the function. + + @param nId + is the identifier of the function description (the same that + is used in the service <type>RecentFunctions</type>.</p> - @param nId - This is the identifier of the function description. + @returns + the sequence of property values (described in + <type>FunctionDescription</type>). */ - sequence<com::sun::star::beans::PropertyValue> getById( [in] long nId ) - raises( com::sun::star::lang::IllegalArgumentException ); + sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId ) + raises( com::sun::star::lang::IllegalArgumentException ); }; @@ -104,36 +113,5 @@ interface XFunctionDescriptions: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.3 2000/10/10 09:03:09 mi - returned service specified - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XGoalSeek.idl b/offapi/com/sun/star/sheet/XGoalSeek.idl index 1aa68a552fd4..1067e2900fdc 100644 --- a/offapi/com/sun/star/sheet/XGoalSeek.idl +++ b/offapi/com/sun/star/sheet/XGoalSeek.idl @@ -2,9 +2,9 @@ * * $RCSfile: XGoalSeek.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XGoalSeek_idl__ #define __com_sun_star_sheet_XGoalSeek_idl__ @@ -73,49 +74,44 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XGoalSeek -/** makes it possible to seek a goal for a cell. +/** provides seeking a goal value for a cell. */ interface XGoalSeek: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XGoalSeek::seekGoal - /** calculates a value which gives a specified result - in a formula. - */ - com::sun::star::sheet::GoalResult seekGoal( [in] com::sun::star::table::CellAddress aFormulaPosition, - [in] com::sun::star::table::CellAddress aVariablePosition, - [in] string aGoalValue ); + /** calculates a value which gives a specified result in a formula. -}; + @param aFormulaPosition + is the address of the formula cell used for the calculation. -//============================================================================= - -}; }; }; }; + @param aVariablePosition + is the address of the cell that is used in the formula as + variable. -/*============================================================================= + @param aGoalValue + is the value which should be reached during the goal seek. - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import + @returns + the result of the goal seek, including the value that results + in the specified goal, using the specified formula. + */ + com::sun::star::sheet::GoalResult seekGoal( + [in] com::sun::star::table::CellAddress aFormulaPosition, + [in] com::sun::star::table::CellAddress aVariablePosition, + [in] string aGoalValue ); - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XHeaderFooterContent.idl b/offapi/com/sun/star/sheet/XHeaderFooterContent.idl index f392c7981d20..628d3711f3f0 100644 --- a/offapi/com/sun/star/sheet/XHeaderFooterContent.idl +++ b/offapi/com/sun/star/sheet/XHeaderFooterContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHeaderFooterContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XHeaderFooterContent_idl__ #define __com_sun_star_sheet_XHeaderFooterContent_idl__ @@ -69,39 +70,43 @@ #include <com/sun/star/text/XText.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XHeaderFooterContent -/** represents the contents of a header or footer on a page.@see com::sun::star::sheet::HeaderFooterContent +/** provides access to the text contents of a header or footer on a page. + + @see com::sun::star::sheet::HeaderFooterContent + @see com::sun::star::sheet::TablePageStyle */ interface XHeaderFooterContent: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getLeftText - /** @returns - the text which is printed in the left part of the header or footer. + /** returns the text which is printed in the left part of the + header or footer. + + @see com::sun::star::text::Text */ com::sun::star::text::XText getLeftText(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getCenterText - /** @returns - the text which is printed in the center part of the header or footer. + /** returns the text which is printed in the center part of the + header or footer. + + @see com::sun::star::text::Text */ com::sun::star::text::XText getCenterText(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XHeaderFooterContent::getRightText - /** @returns - the text which is printed in the right part of the header or footer. + /** returns the text which is printed in the right part of the + header or footer. + + @see com::sun::star::text::Text */ com::sun::star::text::XText getRightText(); @@ -111,27 +116,5 @@ interface XHeaderFooterContent: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl b/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl index 63e5d8f32a24..70da495bd82a 100644 --- a/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl +++ b/offapi/com/sun/star/sheet/XHierarchiesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchiesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__ #define __com_sun_star_sheet_XHierarchiesSupplier_idl__ @@ -69,22 +70,25 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XHierarchiesSupplier -/** gives access to hierarchies. +/** provides access to the collection of hierarchies of a data pilot source + dimension. + + @see com::sun::star::sheet::DataPilotSourceDimension + @see com::sun::star::sheet::DataPilotSource */ interface XHierarchiesSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XHierarchiesSupplier::getHierarchies - /** returns the hierarchies. + /** returns the collection of hierarchies. + + @see com::sun::star::sheet::DataPilotSourceHierarchies */ com::sun::star::container::XNameAccess getHierarchies(); @@ -94,21 +98,5 @@ interface XHierarchiesSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XLabelRange.idl b/offapi/com/sun/star/sheet/XLabelRange.idl index ed8fdd776b78..6bc8234b91fb 100644 --- a/offapi/com/sun/star/sheet/XLabelRange.idl +++ b/offapi/com/sun/star/sheet/XLabelRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLabelRange.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XLabelRange_idl__ #define __com_sun_star_sheet_XLabelRange_idl__ @@ -69,52 +70,46 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XLabelRange -/** represents a cell range that contains labels. - +/** provides access to the settings of a label range in a spreadsheet + document. + <p>These can be column or row labels, depending on where they are used.</p> - <p>These can be column or row labels, depending on where they - are used.</p>@see com::sun::star::sheet::LabelRange + @see com::sun::star::sheet::LabelRange */ interface XLabelRange: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::getLabelArea - /** returns the address of the cell range that contains - the labels. + /** returns the cell range address that contains the labels. */ com::sun::star::table::CellRangeAddress getLabelArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::setLabelArea - /** sets the cell range that contains the labels. + /** sets the cell range address that contains the labels. */ - void setLabelArea( [in] com::sun::star::table::CellRangeAddress aLabelArea ); + void setLabelArea( + [in] com::sun::star::table::CellRangeAddress aLabelArea ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::getDataArea - /** returns the address of the cell range for which - the labels are valid. + /** returns the cell range address for which the labels are valid. */ com::sun::star::table::CellRangeAddress getDataArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRange::setDataArea - /** sets the cell range for which the labels are valid. + /** sets the cell range address for which the labels are valid. */ - void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea ); + void setDataArea( + [in] com::sun::star::table::CellRangeAddress aDataArea ); }; @@ -122,27 +117,5 @@ interface XLabelRange: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XLabelRanges.idl b/offapi/com/sun/star/sheet/XLabelRanges.idl index a4731e0195ea..dda10f9ff29f 100644 --- a/offapi/com/sun/star/sheet/XLabelRanges.idl +++ b/offapi/com/sun/star/sheet/XLabelRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLabelRanges.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XLabelRanges_idl__ #define __com_sun_star_sheet_XLabelRanges_idl__ @@ -69,29 +70,36 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XLabelRanges -/** represents a collection of label ranges.@see com::sun::star::sheet::LabelRanges +/** provides methods to access the members of a label range collection + and to insert and remove them. + + @see com::sun::star::sheet::LabelRanges + @see com::sun::star::sheet::LabelRange */ interface XLabelRanges: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRanges::addNew /** adds a new label range to the collection. + + @param aLabelArea + the cell range containing the titles of the label range. + + @param aDataArea + the cell range containing the values of the label range. */ - void addNew( [in] com::sun::star::table::CellRangeAddress aLabelArea, - [in] com::sun::star::table::CellRangeAddress aDataArea ); + void addNew( + [in] com::sun::star::table::CellRangeAddress aLabelArea, + [in] com::sun::star::table::CellRangeAddress aDataArea ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLabelRanges::removeByIndex /** removes a label range from the collection. */ void removeByIndex( [in] long nIndex ); @@ -102,27 +110,5 @@ interface XLabelRanges: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XLevelsSupplier.idl b/offapi/com/sun/star/sheet/XLevelsSupplier.idl index 42546d32570a..fe62536da221 100644 --- a/offapi/com/sun/star/sheet/XLevelsSupplier.idl +++ b/offapi/com/sun/star/sheet/XLevelsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLevelsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XLevelsSupplier_idl__ #define __com_sun_star_sheet_XLevelsSupplier_idl__ @@ -69,22 +70,25 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XLevelsSupplier -/** gives access to levels. +/** provides access to the collection of levels of a data pilot source + hierarchy. + + @see com::sun::star::sheet::DataPilotSourceHierarchy + @see com::sun::star::sheet::DataPilotSource */ interface XLevelsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XLevelsSupplier::getLevels - /** returns the levels. + /** returns the collection of levels. + + @see com::sun::star::sheet::DataPilotSourceLevels */ com::sun::star::container::XNameAccess getLevels(); @@ -94,21 +98,5 @@ interface XLevelsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XMembersSupplier.idl b/offapi/com/sun/star/sheet/XMembersSupplier.idl index 36943c094c08..97693112b345 100644 --- a/offapi/com/sun/star/sheet/XMembersSupplier.idl +++ b/offapi/com/sun/star/sheet/XMembersSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMembersSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XMembersSupplier_idl__ #define __com_sun_star_sheet_XMembersSupplier_idl__ @@ -69,22 +70,25 @@ #include <com/sun/star/container/XNameAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XMembersSupplier -/** gives access to members. +/** provides access to the collection of members of a data pilot source + level. + + @see com::sun::star::sheet::DataPilotSourceLevel + @see com::sun::star::sheet::DataPilotSource */ interface XMembersSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XMembersSupplier::getMembers - /** returns the members. + /** returns the collection of members. + + @see com::sun::star::sheet::DataPilotSourceMembers */ com::sun::star::container::XNameAccess getMembers(); @@ -94,21 +98,5 @@ interface XMembersSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XMultipleOperation.idl b/offapi/com/sun/star/sheet/XMultipleOperation.idl index e26d5a2c71af..286121affd04 100644 --- a/offapi/com/sun/star/sheet/XMultipleOperation.idl +++ b/offapi/com/sun/star/sheet/XMultipleOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultipleOperation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XMultipleOperation_idl__ #define __com_sun_star_sheet_XMultipleOperation_idl__ @@ -77,33 +78,53 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XMultipleOperation -/** represents something in which a table of operations can be created. +/** provides a method to apply a Multiple Operations Table to the + cell range. */ interface XMultipleOperation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XMultipleOperation::setTableOperation - /** creates a table of formulas. - - - - <p>The specified formulas are repeated, with references - to the specified cells replaced by references to values - in the first column and/or row of the range.</p> + /** creates a table of formulas (a "Multiple Operations Table"). + + <p>The specified formulas are repeated, with references to the + specified cells replaced by references to values in the first + column and/or row of the range.</p> + + @param aFormulaRange + the range that contains formula cells (modes + <const>TableOperationMode::ROW</const> or + <const>TableOperationMode::COLUMN</const>) or a single formula + cell (mode <const>TableOperationMode::BOTH</const>). + + @param nMode + specifies the calculation mode to fill the cells. + + @param aColumnCell + contains the address of the cell that is referenced by + formulas in a row (mode <const>TableOperationMode::ROW</const>) + or by the formula cell used for two value series (mode + <const>TableOperationMode::BOTH</const>). This parameter is not + used if mode is <const>TableOperationMode::COLUMN</const>. + + @param aRowCell + contains the address of the cell that is referenced by + formulas in a column (mode <const>TableOperationMode::COLUMN</const>) + or by the formula cell used for two value series (mode + <const>TableOperationMode::BOTH</const>). This parameter is not + used if mode is <const>TableOperationMode::ROW</const>. */ - void setTableOperation( [in] com::sun::star::table::CellRangeAddress aFormulaRange, - [in] com::sun::star::sheet::TableOperationMode nMode, - [in] com::sun::star::table::CellAddress aColumnCell, - [in] com::sun::star::table::CellAddress aRowCell ); + void setTableOperation( + [in] com::sun::star::table::CellRangeAddress aFormulaRange, + [in] com::sun::star::sheet::TableOperationMode nMode, + [in] com::sun::star::table::CellAddress aColumnCell, + [in] com::sun::star::table::CellAddress aRowCell ); }; @@ -111,21 +132,5 @@ interface XMultipleOperation: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XNamedRange.idl b/offapi/com/sun/star/sheet/XNamedRange.idl index 350273bf13bd..2ed187ad0bd4 100644 --- a/offapi/com/sun/star/sheet/XNamedRange.idl +++ b/offapi/com/sun/star/sheet/XNamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamedRange.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XNamedRange_idl__ #define __com_sun_star_sheet_XNamedRange_idl__ @@ -69,46 +70,39 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XNamedRange -/** represents a named range.@see com::sun::star::sheet::NamedRange +/** provides access to the settings of a named range in a spreadsheet + document. + + @see com::sun::star::sheet::NamedRange */ interface XNamedRange: com::sun::star::container::XNamed { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNamedRange::getContent - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getContent /** returns the content of the named range. - - <p>The content can be a reference to a cell or cell range - or any formula.</p> + or any formula expression.</p> */ string getContent(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setContent /** sets the content of the named range. - - <p>The content can be a reference to a cell or cell range - or any formula.</p> + or any formula expression.</p> */ void setContent( [in] string aContent ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getReferencePosition /** returns the position in the document which is used as a base for relative references in the content. */ @@ -116,29 +110,28 @@ interface XNamedRange: com::sun::star::container::XNamed //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setReferencePosition /** sets the position in the document which is used as a base for relative references in the content. */ - void setReferencePosition( [in] com::sun::star::table::CellAddress aReferencePosition ); + void setReferencePosition( + [in] com::sun::star::table::CellAddress aReferencePosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::getType /** returns the type of the named range. + + <p>This is a combination of flags as defined in + <type>NamedRangeFlags</type>.</p> */ long getType(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRange::setType /** sets the type of the named range. - - - <p>The type must be <val>0</val> or a combination of the - <type>NamedRangeFlag</type> constants and controls if the named - range is listed in dialogs prompting for special ranges.</p> + @param nType + a combination of flags that specify the type of a named range, + as defined in <type>NamedRangeFlags</type>. */ void setType( [in] long nType ); @@ -148,33 +141,5 @@ interface XNamedRange: com::sun::star::container::XNamed }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:46 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl index cdcdb70b3261..49ae610d8516 100644 --- a/offapi/com/sun/star/sheet/XNamedRanges.idl +++ b/offapi/com/sun/star/sheet/XNamedRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamedRanges.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XNamedRanges_idl__ #define __com_sun_star_sheet_XNamedRanges_idl__ @@ -77,59 +78,91 @@ #include <com/sun/star/sheet/Border.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XNamedRanges -/** represents a collection of named ranges.@see com::sun::star::sheet::NamedRanges +/** provides access to the members in a collection of named ranges and to + insert and remove them. + + @see com::sun::star::sheet::NamedRanges + @see com::sun::star::sheet::NamedRange */ interface XNamedRanges: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewByName /** adds a new named range to the collection. - */ - void addNewByName( [in] string aName, - [in] string aContent, - [in] com::sun::star::table::CellAddress aPosition, - [in] long nType ); - //------------------------------------------------------------------------- + @param aName + the new name of the named range. + + @param aContent + the formula expression. - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewFromTitles - /** creates named ranges from titles in a cell range. + <p>A cell range address is one possible content of a named + range.</p> + @param aPosition + specifies the base address for relative cell references. + @param nType + a combination of flags that specify the type of a named range, + as defined in <type>NamedRangeFlags</type>. - <p>Names for the named ranges are taken from titles in the - top or bottom row, or the left or right column of the range. + <p>This parameter will be zero for any common named range.</p> + */ + void addNewByName( + [in] string aName, + [in] string aContent, + [in] com::sun::star::table::CellAddress aPosition, + [in] long nType ); + + //------------------------------------------------------------------------- + + /** creates named cell ranges from titles in a cell range. + + <p>The names for the named ranges are taken from title cells in the + top or bottom row, or from the cells of the left or right column + of the range (depending on the parameter <const>aBorder</const>. The named ranges refer to single columns or rows in the inner part of the original range, excluding the labels.</p> + + <p>Example: The source range is A1:B3. The named ranges shall be + created using row titles. This requires <member>Border::TOP</member> + for the second parameter. The method creates two named ranges. The + name of the first is equal to the content of cell A1 and contains the + range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named + range is named using cell B1 and contains the cell range address + $Sheet.$B$2:$B$3.</p> + + @param aSource + the cell range used to create the named ranges. + + @param aBorder + specifies the location of the title cells. */ - void addNewFromTitles( [in] com::sun::star::table::CellRangeAddress aSource, - [in] com::sun::star::sheet::Border aBorder ); + void addNewFromTitles( + [in] com::sun::star::table::CellRangeAddress aSource, + [in] com::sun::star::sheet::Border aBorder ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::removeByName /** removes a named range from the collection. */ void removeByName( [in] string aName ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::outputList /** writes a list of all named ranges into the document. - - <p>The first column of the list contains the names. The second column contains the contents of the named ranges.</p> + + @param aOutputPosition + specifies the top left cell of the output range. */ void outputList( [in] com::sun::star::table::CellAddress aOutputPosition ); @@ -139,27 +172,5 @@ interface XNamedRanges: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XPrintAreas.idl b/offapi/com/sun/star/sheet/XPrintAreas.idl index 2ef3f39c7094..83e183dbebe6 100644 --- a/offapi/com/sun/star/sheet/XPrintAreas.idl +++ b/offapi/com/sun/star/sheet/XPrintAreas.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintAreas.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XPrintAreas_idl__ #define __com_sun_star_sheet_XPrintAreas_idl__ @@ -69,139 +70,124 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XPrintAreas /** represents a sheet which has print areas. - - - - - - - - - - - - @deprecated */ interface XPrintAreas: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XPrintAreas::getPrintAreas - // DocMerge from idl: method com::sun::star::sheet::XPrintAreas::getPrintAreas - /** returns the print areas of the sheet. + /** returns a sequence containing all print areas of the sheet. */ - sequence<com::sun::star::table::CellRangeAddress> getPrintAreas(); + sequence< com::sun::star::table::CellRangeAddress > getPrintAreas(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintAreas /** sets the print areas of the sheet. - - <p>If none of the sheets in a document have print areas, - the whole sheets are printed.</p> + the whole sheets are printed. If any sheet contains print areas, + other sheets without print areas are not printed.</p> + + @param aPrintAreas + a sequence containing all print areas for this sheet. */ - void setPrintAreas( [in] sequence<com::sun::star::table::CellRangeAddress> aPrintAreas ); + void setPrintAreas( [in] sequence< com::sun::star::table::CellRangeAddress > aPrintAreas ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getPrintTitleColumns - /** returns <TRUE/> if the title columns are repeated on - all subsequent print pages to the right. + /** returns, whether the title columns are repeated on all subsequent + print pages to the right. */ boolean getPrintTitleColumns(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintTitleColumns - /** specifies if the title columns are repeated on - all subsequent print pages to the right. + /** specifies whether the title columns are repeated on all subsequent + print pages to the right. + + @param bPrintTitleColumns + if <TRUE/>, title columns are repeated on each page. */ void setPrintTitleColumns( [in] boolean bPrintTitleColumns ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getTitleColumns - /** returns the range of columns which are marked as - title columns. - - + /** returns the range that is specified as title columns range. <p>Title columns can be automatically repeated on all subsequent - print pages to the right.</p> + print pages to the right, using + <member>XPrintAreas::setPrintTitleColumns</member>.</p> + + @returns + the range of columns that is specified as title columns range. */ com::sun::star::table::CellRangeAddress getTitleColumns(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setTitleColumns - /** sets the range of columns marked as title columns. + /** specifies a range of columns as title columns range. - - - <p>The rows of the - <type scope="com::sun::star::table">CellRangeAddress</type> - are ignored.</p> + <p>The rows of the passed range are ignored.</p> <p>Title columns can be automatically repeated on all subsequent - print pages to the right.</p> + print pages to the right, using + <member>XPrintAreas::setPrintTitleColumns</member>.</p> + + @param aTitleColumns + the title columns range. */ void setTitleColumns( [in] com::sun::star::table::CellRangeAddress aTitleColumns ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getPrintTitleRows - /** returns <TRUE/> if the title rows are repeated on - all subsequent print pages to the bottom. + /** returns, whether the title rows are repeated on all subsequent + print pages to the bottom. */ boolean getPrintTitleRows(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setPrintTitleRows - /** specifies if the title rows are repeated on - all subsequent print pages to the bottom. + /** specifies whether the title rows are repeated on all subsequent + print pages to the bottom. + + @param bPrintTitleRows + if <TRUE/>, title rows are repeated on each page. */ void setPrintTitleRows( [in] boolean bPrintTitleRows ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::getTitleRows - /** returns the range of rows which are marked as - title rows. - - + /** returns the range that is specified as title rows range. <p>Title rows can be automatically repeated on all subsequent - print pages to the bottom.</p> + print pages to the bootom, using + <member>XPrintAreas::setPrintTitleRows</member>.</p> + + @returns + the range of rows that is specified as title rows range. */ com::sun::star::table::CellRangeAddress getTitleRows(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XPrintAreas::setTitleRows - /** sets the range of rows marked as title rows. - + /** specifies a range of rows as title rows range. - - <p>The columns of the - <type scope="com::sun::star::table">CellRangeAddress</type> - are ignored.</p> + <p>The columns of the passed range are ignored.</p> <p>Title rows can be automatically repeated on all subsequent - print pages to the bottom.</p> + print pages to the bottom, using + <member>XPrintAreas::setPrintTitleRows</member>.</p> + + @param aTitleRows + the title rows range. */ void setTitleRows( [in] com::sun::star::table::CellRangeAddress aTitleRows ); @@ -211,30 +197,5 @@ interface XPrintAreas: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:51 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XRangeSelection.idl b/offapi/com/sun/star/sheet/XRangeSelection.idl index f592f11409ff..893279c301bd 100644 --- a/offapi/com/sun/star/sheet/XRangeSelection.idl +++ b/offapi/com/sun/star/sheet/XRangeSelection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelection.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-06-11 22:18:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,8 @@ interface XRangeSelectionChangeListener; //============================================================================= /** allows to let the user to select a cell range. + + @see com::sun::star::sheet::SpreadsheetView */ interface XRangeSelection: com::sun::star::uno::XInterface { @@ -122,7 +124,5 @@ interface XRangeSelection: com::sun::star::uno::XInterface }; }; }; }; - #endif - diff --git a/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl b/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl index ecc94482c3c9..3621b8726418 100644 --- a/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl +++ b/offapi/com/sun/star/sheet/XRangeSelectionChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelectionChangeListener.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,6 +77,8 @@ //============================================================================= /** allows notification when the selected range is changed. + + @see com::sun::star::sheet::XRangeSelection */ interface XRangeSelectionChangeListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/sheet/XRangeSelectionListener.idl b/offapi/com/sun/star/sheet/XRangeSelectionListener.idl index 1ec11694f520..3565a46e7c41 100644 --- a/offapi/com/sun/star/sheet/XRangeSelectionListener.idl +++ b/offapi/com/sun/star/sheet/XRangeSelectionListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRangeSelectionListener.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,6 +77,8 @@ //============================================================================= /** allows notification when range selection is completed or aborted. + + @see com::sun::star::sheet::XRangeSelection */ interface XRangeSelectionListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/sheet/XRecentFunctions.idl b/offapi/com/sun/star/sheet/XRecentFunctions.idl index 1d00cce31cdb..7743941c76a1 100644 --- a/offapi/com/sun/star/sheet/XRecentFunctions.idl +++ b/offapi/com/sun/star/sheet/XRecentFunctions.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRecentFunctions.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XRecentFunctions_idl__ #define __com_sun_star_sheet_XRecentFunctions_idl__ @@ -65,42 +66,44 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XRecentFunctions -/** represents a list of recently used functions.@see com::sun::star::sheet::RecentFunctions +/** provides access to a list of recently used functions. + + @see com::sun::star::sheet::RecentFunctions */ interface XRecentFunctions: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XRecentFunctions::getRecentFunctionIds - // DocMerge from idl: method com::sun::star::sheet::XRecentFunctions::getRecentFunctionIds - /** returns a sequence of those functions that were - most recently used. + /** returns a sequence of those functions that were most recently used. + + <P>The functions are represented by their identifiers.</P> - <P>The functions are represented by their identifiers.</P> + @returns + the sequence of function identifiers most recently used. */ - sequence<long> getRecentFunctionIds(); + sequence< long > getRecentFunctionIds(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XRecentFunctions::setRecentFunctionIds /** sets the list of those functions that were most recently used. <p>The functions are represented by their identifiers.</p> + + @param aRecentFunctionIds + the sequence of function identifiers most recently used. */ - void setRecentFunctionIds( [in] sequence<long> aRecentFunctionIds ); + void setRecentFunctionIds( [in] sequence< long > aRecentFunctionIds ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XRecentFunctions::getMaxRecentFunctions - /** returns the maximum number of entries that will be stored as recent functions. + /** returns the maximum number of entries that will be stored as + recently used functions. */ long getMaxRecentFunctions(); @@ -110,33 +113,5 @@ interface XRecentFunctions: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:23 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XResultListener.idl b/offapi/com/sun/star/sheet/XResultListener.idl index 942a17d44594..b6c62e608890 100644 --- a/offapi/com/sun/star/sheet/XResultListener.idl +++ b/offapi/com/sun/star/sheet/XResultListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XResultListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XResultListener_idl__ #define __com_sun_star_sheet_XResultListener_idl__ @@ -69,21 +70,20 @@ #include <com/sun/star/sheet/ResultEvent.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XResultListener -/** allows notification when new values are available. +/** allows notification when a new volatile function result is available. + + @see com::sun::star::sheet::XVolatileResult */ interface XResultListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XResultListener::modified /** is called when a new value is available. */ void modified( [in] com::sun::star::sheet::ResultEvent aEvent ); @@ -94,21 +94,5 @@ interface XResultListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XScenario.idl b/offapi/com/sun/star/sheet/XScenario.idl index 919932499cc0..0cf17b095a51 100644 --- a/offapi/com/sun/star/sheet/XScenario.idl +++ b/offapi/com/sun/star/sheet/XScenario.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenario.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,24 +72,13 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XScenario -/** represents something that can be a scenario. - - - - - - - - - - - +/** provides access to the settings of a scenario sheet. + @see com::sun::star::sheet::Spreadsheet @deprecated */ @@ -97,40 +86,33 @@ interface XScenario: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenario::getIsScenario - /** returns <TRUE/> if this is a scenario. + /** returns <TRUE/> if the current object is a scenario. */ boolean getIsScenario(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XScenario::getScenarioComment - // DocMerge from xml: method com::sun::star::sheet::XScenario::getScenarioComment /** returns the comment for the scenario. */ string getScenarioComment(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenario::setScenarioComment - /** sets the comment for the scenario. + /** sets a new comment for the scenario. */ void setScenarioComment( [in] string aScenarioComment ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenario::addRanges /** adds more ranges to the scenario. */ - void addRanges( [in] sequence<com::sun::star::table::CellRangeAddress> aRanges ); + void addRanges( + [in] sequence< com::sun::star::table::CellRangeAddress > aRanges ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenario::apply /** applies the scenario. - - <p>The contents of the scenario ranges are copied into the first non-scenario sheet which is in front of the sheet containing the scenario by itself.</p> @@ -143,30 +125,5 @@ interface XScenario: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XScenarios.idl b/offapi/com/sun/star/sheet/XScenarios.idl index f587fb3a4baf..5a0fadae4435 100644 --- a/offapi/com/sun/star/sheet/XScenarios.idl +++ b/offapi/com/sun/star/sheet/XScenarios.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenarios.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XScenarios_idl__ #define __com_sun_star_sheet_XScenarios_idl__ @@ -69,30 +70,40 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XScenarios -/** represents a collection of scenarios.@see com::sun::star::sheet::Scenarios +/** provides access via name to the scenarios in a collection and inserting + and removing scenarios. + + @see com::sun::star::sheet::Scenarios + @see com::sun::star::sheet::Spreadsheet */ interface XScenarios: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenarios::addNewByName /** creates a new scenario and adds it to the collection. + + @param aName + the name of the scenario (used i.e. for collection access). + + @param aRanges + the cell ranges contained in the scenario. + + @param aComment + the user defined comment for the scenario. */ - void addNewByName( [in] string aName, - [in] sequence<com::sun::star::table::CellRangeAddress> aRanges, - [in] string aComment ); + void addNewByName( + [in] string aName, + [in] sequence< com::sun::star::table::CellRangeAddress > aRanges, + [in] string aComment ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenarios::removeByName /** removes a scenario from the collection. */ void removeByName( [in] string aName ); @@ -103,27 +114,5 @@ interface XScenarios: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XScenariosSupplier.idl b/offapi/com/sun/star/sheet/XScenariosSupplier.idl index a55b7042065c..005455b8e61b 100644 --- a/offapi/com/sun/star/sheet/XScenariosSupplier.idl +++ b/offapi/com/sun/star/sheet/XScenariosSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScenariosSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XScenariosSupplier_idl__ #define __com_sun_star_sheet_XScenariosSupplier_idl__ @@ -69,22 +70,21 @@ #include <com/sun/star/sheet/XScenarios.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XScenariosSupplier /** provides access to a collection of scenarios. */ interface XScenariosSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XScenariosSupplier::getScenarios /** returns the collection of scenarios. + + @see com::sun::star::sheet::Scenarios */ com::sun::star::sheet::XScenarios getScenarios(); @@ -94,21 +94,5 @@ interface XScenariosSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotation.idl b/offapi/com/sun/star/sheet/XSheetAnnotation.idl index 1467872eb5b0..69860a220520 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotation.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotation.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetAnnotation_idl__ #define __com_sun_star_sheet_XSheetAnnotation_idl__ @@ -69,56 +70,48 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotation -/** represents an annotation on a sheet.@see com::sun::star::sheet::CellAnnotation +/** provides methods to query data of the annotation and to show and + hide it. + + @see com::sun::star::sheet::CellAnnotation */ interface XSheetAnnotation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getPosition - /** @returns - the position of the annotation in the document. + /** returns the position of cell in the spreadsheet document that + contains this annotation. */ com::sun::star::table::CellAddress getPosition(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetAnnotation::getAuthor - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getAuthor - /** @returns - the name of the user who last changed the annotation. + /** returns the name of the user who last changed the annotation. */ string getAuthor(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetAnnotation::getDate - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getDate - /** @returns - a formatted string for the date when the annotation was last changed. + /** returns a formatted string representing the date when the + annotation was last changed. */ string getDate(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XSheetAnnotation::getIsVisible - /** @returns - whether the annotation is permanently visible or not. + /** returns, whether the annotation is permanently visible. */ boolean getIsVisible(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotation::setIsVisible - /** specifies if the annotation is permanently visible. + /** specifies whether the annotation is permanently visible. */ void setIsVisible( [in] boolean bIsVisible ); @@ -128,33 +121,5 @@ interface XSheetAnnotation: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:55 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl b/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl index 712955d92636..7d790b6694d7 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotationAnchor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotationAnchor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ #define __com_sun_star_sheet_XSheetAnnotationAnchor_idl__ @@ -69,21 +70,21 @@ #include <com/sun/star/sheet/XSheetAnnotation.idl> #endif - //============================================================================= module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotationAnchor -/** represents the anchor of a sheet annotation. +/** provides access to a cell annotation attached to a spreadsheet cell. + + @see com::sun::star::sheet::SheetCell + @see com::sun::star::sheet::CellAnnotation */ interface XSheetAnnotationAnchor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotationAnchor::getAnnotation /** returns the annotation at this anchor. */ com::sun::star::sheet::XSheetAnnotation getAnnotation(); @@ -94,21 +95,5 @@ interface XSheetAnnotationAnchor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotations.idl b/offapi/com/sun/star/sheet/XSheetAnnotations.idl index 3b6118b872f9..4525912bc992 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotations.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotations.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotations.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetAnnotations_idl__ #define __com_sun_star_sheet_XSheetAnnotations_idl__ @@ -69,31 +70,47 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotations -/** represents a collection of annotations on a sheet.@see com::sun::star::sheet::CellAnnotations +/** provides methods to access cell annotations via index and to + insert and remove annotations. + + @see com::sun::star::sheet::CellAnnotation + @see com::sun::star::sheet::SheetCell */ interface XSheetAnnotations: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotations::insertNew - /** creates and inserts a new annotation and adds - it to the collection. + /** creates a new annotation. + + <p>This method creates a new annotation object, attaches it to the + specified cell and inserts it into the collection.</p> + + @param aPosition + contains the address of the cell thta will contain the + annotation. + + @param aText + contains the annotation text. */ - void insertNew( [in] com::sun::star::table::CellAddress aPosition, - [in] string aText ); + void insertNew( + [in] com::sun::star::table::CellAddress aPosition, + [in] string aText ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotations::removeByIndex - /** removes an annotation from the collection. + /** removes a cell annotation from the collection. + + <p>This method removes the annotation from its cell and from the + collection.</p> + + @param nIndex + is the index of the annotation in the collection. */ void removeByIndex( [in] long nIndex ); @@ -103,27 +120,5 @@ interface XSheetAnnotations: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl b/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl index 0ab0bb554898..13477036581e 100644 --- a/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl +++ b/offapi/com/sun/star/sheet/XSheetAnnotationsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAnnotationsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ #define __com_sun_star_sheet_XSheetAnnotationsSupplier_idl__ @@ -69,22 +70,21 @@ #include <com/sun/star/sheet/XSheetAnnotations.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetAnnotationsSupplier -/** enables access to a collection of annotations. +/** provides access to a collection of cell annotations. */ interface XSheetAnnotationsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAnnotationsSupplier::getAnnotations - /** returns the collection of annotations. + /** returns the collection of cell annotations. + + @see com::sun::star::sheet::CellAnnotations */ com::sun::star::sheet::XSheetAnnotations getAnnotations(); @@ -94,21 +94,5 @@ interface XSheetAnnotationsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:50 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetAuditing.idl b/offapi/com/sun/star/sheet/XSheetAuditing.idl index 630819a8b467..9a46db6a66c0 100644 --- a/offapi/com/sun/star/sheet/XSheetAuditing.idl +++ b/offapi/com/sun/star/sheet/XSheetAuditing.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetAuditing.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetAuditing_idl__ #define __com_sun_star_sheet_XSheetAuditing_idl__ @@ -69,59 +70,67 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetAuditing -/** represents auditing functions of a sheet. +/** provides methods to access auditing (detective) features in a + spreadsheet. */ interface XSheetAuditing: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::hideDependents - /** removes arrows for one level of dependents of a cell. + /** removes arrows for one level of dependents of a formula cell. + + <p>If the method is executed again for the same cell, the previous + level of dependent cells is removed.</p> + + @param aPosition + the address of the formula cell. */ boolean hideDependents( [in] com::sun::star::table::CellAddress aPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::hidePrecedents - /** removes arrows for one level of precedents of a cell. + /** removes arrows for one level of precedents of a formula cell. + + <p>If the method is executed again for the same cell, the previous + level of dependent cells is removed.</p> + + @param aPosition + the address of the formula cell. */ boolean hidePrecedents( [in] com::sun::star::table::CellAddress aPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showDependents - /** draws arrows between a cell and its dependent formulas. + /** draws arrows between a formula cell and its dependents. + <p>If the method is executed again for the same cell, the next + level of dependent cells is marked.</p> - - <p>If the method is executed again for the same cell, another level - of dependent cells is marked.</p> + @param aPosition + the address of the formula cell. */ boolean showDependents( [in] com::sun::star::table::CellAddress aPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showPrecedents /** draws arrows between a formula cell and its precedents. + <p>If the method is executed again for the same cell, the next + level of dependent cells is marked.</p> - - <p>If the method is executed again for the same cell, another level - of precedent cells is marked.</p> + @param aPosition + the address of the formula cell. */ boolean showPrecedents( [in] com::sun::star::table::CellAddress aPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showErrors /** draws arrows between a formula cell containing an error and the cells causing the error. */ @@ -129,15 +138,13 @@ interface XSheetAuditing: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::showInvalid /** marks all cells containing invalid values. */ boolean showInvalid(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetAuditing::clearArrows - /** removes all arrows. + /** removes all auditing arrows from the spreadsheet. */ void clearArrows(); @@ -147,21 +154,5 @@ interface XSheetAuditing: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellCursor.idl b/offapi/com/sun/star/sheet/XSheetCellCursor.idl index 4f54416925c9..f66f5687e405 100644 --- a/offapi/com/sun/star/sheet/XSheetCellCursor.idl +++ b/offapi/com/sun/star/sheet/XSheetCellCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCellCursor_idl__ #define __com_sun_star_sheet_XSheetCellCursor_idl__ @@ -65,25 +66,23 @@ #include <com/sun/star/sheet/XSheetCellRange.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellCursor -/** represents a cursor which can select a cell range.@see com::sun::star::sheet::SheetCellCursor +/** provides advanced methods to control the position of a cursor in a + spreadsheet. + + @see com::sun::star::sheet::SheetCellCursor */ interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToCurrentRegion - /** collapses the cursor into the region containing the cells - to which it currently points. - - + /** expands the cursor into the region containing the cells to which + it currently points. <p>A region is a cell range bounded by empty cells.</p> */ @@ -91,52 +90,52 @@ interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToCurrentArray /** collapses the cursor into the range of the array formula to which it is currently pointing. - - - <p>If the cursor does not point to a range with an array formula, it - is left unchanged.</p> + <p>To get the correct result, the top left cell of the original + cursor must point to any cell containing an array formula. + If not, the cursor is left unchanged.</p> */ void collapseToCurrentArray(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToMergedArea - /** collapses the cursor into the range of merged cells. - + /** expands the cursor to merged cell ranges. - - <p>If the cursor does not point to a range with merged cells, it + <p>Expands the current cursor range in a way so that all merged + cell ranges intersecting the current range will fit completely. + If the cursor does not point to any range with merged cells, it is left unchanged.</p> */ void collapseToMergedArea(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::expandToEntireColumns - /** expands the cursor to include the columns of - the cells to which it is currently pointing. + /** expands the cursor to include the entire columns of the cells + to which it is currently pointing. */ void expandToEntireColumns(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::expandToEntireRows - /** expands the cursor to include the rows of - the cells to which it is currently pointing. + /** expands the cursor to include the entire rows of the cells to + which it is currently pointing. */ void expandToEntireRows(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCellCursor::collapseToSize /** changes the size of a cursor range. + + <p>The top left cell of the cursor keeps unmodified. </p> + + @param nColumns + the number of columns of the new cursor range. + @param nRows + the number of rows of the new cursor range. */ - void collapseToSize( [in] long nColumns, - [in] long nRows ); + void collapseToSize( [in] long nColumns, [in] long nRows ); }; @@ -144,27 +143,5 @@ interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellRange.idl b/offapi/com/sun/star/sheet/XSheetCellRange.idl index fdb7c0f8644f..ab3cf56ced37 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRange.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRange.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCellRange_idl__ #define __com_sun_star_sheet_XSheetCellRange_idl__ @@ -67,30 +68,31 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { + +//============================================================================= interface XSpreadsheet; //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellRange -/** represents a cell range in a sheet.@see com::sun::star::sheet::SheetCellRange +/** provides access to the spreadsheet that contains a cell range. + + @see com::sun::star::sheet::SheetCellRange */ interface XSheetCellRange: com::sun::star::table::XCellRange { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRange::getSpreadsheet - /** returns the spreadsheet interface which contains - the cell range. + /** returns the spreadsheet interface which contains the cell range. - @returns - a <type>Spreadsheet</type> object. + @returns + a <type>Spreadsheet</type> object. - @see com::sun::star::sheet::SheetCellRange - @see com::sun::star::sheet::SheetCellRanges + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ - XSpreadsheet getSpreadsheet(); + com::sun::star::sheet::XSpreadsheet getSpreadsheet(); }; @@ -98,27 +100,5 @@ interface XSheetCellRange: com::sun::star::table::XCellRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl index 3c8d2768c5be..520be061510e 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRangeContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRangeContainer.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCellRangeContainer_idl__ #define __com_sun_star_sheet_XSheetCellRangeContainer_idl__ @@ -69,53 +70,86 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif -#ifndef __com_sun_star_uno_RuntimeException_idl__ -#include <com/sun/star/uno/RuntimeException.idl> -#endif - -#ifndef __com_sun_star_lang_WrappedTargetException_idl__ -#include <com/sun/star/lang/WrappedTargetException.idl> -#endif - #ifndef __com_sun_star_container_NoSuchElementException_idl__ #include <com/sun/star/container/NoSuchElementException.idl> #endif //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** represents multiple cell ranges.@see com::sun::star::sheet::SheetCellRanges +/** provides methods to access cell ranges in a collection via index and + to add and remove cell ranges. + + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges { - /** add the given range to the cell ranges. + //------------------------------------------------------------------------- + + /** adds the given range to the collection of cell ranges. + + @param aCellRangeAddress + contains the address of the new range. + @param bMergeRanges - With the second parameter is it possible to define how the range - should be added. To merge the ranges takes more time, but the memory - usage is lower. + defines how the range should be added. To merge the ranges + takes more time, but the memory usage is lower. */ - void addRangeAddress( [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, [in] boolean bMergeRanges ); + void addRangeAddress( + [in] com::sun::star::table::CellRangeAddress aCellRangeAddress, + [in] boolean bMergeRanges ); + + //------------------------------------------------------------------------- + + /** removes the given range from the collection of cell ranges. - /** remove the given range from the cell ranges + @param aCellRangeAddress + contains the address of the range to be removed. + + <p>The specified range must fit exactly to an element of the + collection. The method does not try to shorten a range.</p> + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the collection does not contain the specified range. */ - void removeRangeAddress( [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) - raises( com::sun::star::container::NoSuchElementException ); + void removeRangeAddress( + [in] com::sun::star::table::CellRangeAddress aCellRangeAddress ) + raises( com::sun::star::container::NoSuchElementException ); + + //------------------------------------------------------------------------- + + /** adds the given ranges to the collection of cell ranges. + + @param aCellRangeAddresses + contains a sequence of addresses of all new ranges. - /** add the given ranges to the cell ranges. @param bMergeRanges - With the second parameter is it possible to define how the ranges - should be added. To merge the ranges takes more time, but the memory - usage is lower. + defines how the ranges should be added. To merge the ranges + takes more time, but the memory usage is lower. */ - void addRangeAddresses( [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, [in] boolean bMergeRanges ); + void addRangeAddresses( + [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses, + [in] boolean bMergeRanges ); - /** remove the given ranges from the cell ranges. + //------------------------------------------------------------------------- + + /** removes the given ranges from the collection of cell ranges. + + @param aCellRangeAddresses + contains a sequence of addresses of all ranges to be removed. + + <p>All specified ranges must fit exactly to elements of the + collection. The method does not try to shorten ranges.</p> + + @throws <type scope="com::sun::star::container">NoSuchElementException</type> + if the collection does not contain any of the specified ranges. */ - void removeRangeAddresses( [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) - raises( com::sun::star::container::NoSuchElementException); + void removeRangeAddresses( + [in] sequence<com::sun::star::table::CellRangeAddress> aCellRangeAddresses ) + raises( com::sun::star::container::NoSuchElementException); }; @@ -124,3 +158,4 @@ interface XSheetCellRangeContainer: com::sun::star::sheet::XSheetCellRanges }; }; }; }; #endif + diff --git a/offapi/com/sun/star/sheet/XSheetCellRanges.idl b/offapi/com/sun/star/sheet/XSheetCellRanges.idl index b1ae58029b52..89ef2e5705c3 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRanges.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRanges.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCellRanges.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCellRanges_idl__ #define __com_sun_star_sheet_XSheetCellRanges_idl__ @@ -73,49 +74,45 @@ #include <com/sun/star/table/CellRangeAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetCellRanges -/** represents multiple cell ranges.@see com::sun::star::sheet::SheetCellRanges +/** provides methods to access cell ranges in a collection via index and + other helper methods. + + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetCellRanges: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRanges::getCells - /** returns the EnumerationAccess of the cells. - - @returns - the EnumerationAccess of the cells. + /** returns the collection of all used cells. - @see com::sun::star::sheet::Cells + @see com::sun::star::sheet::Cells */ com::sun::star::container::XEnumerationAccess getCells(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCellRanges::getRangeAddressesAsString - // DocMerge from xml: method com::sun::star::sheet::XSheetCellRanges::getRangeAddressesAsString - /** returns a string describing the addresses of the cell ranges. + /** creates a string with addresses of all contained cell ranges. + <p>The range addresses are separated with semicolons. For instance + the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> - <p>The string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> + @returns + a string containing the addresses of all cell ranges. */ string getRangeAddressesAsString(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCellRanges::getRangeAddresses - // DocMerge from idl: method com::sun::star::sheet::XSheetCellRanges::getRangeAddresses - /** returns the addresses of the cell ranges. + /** creates a sequence with addresses of all contained cell ranges. - @returns - the addresses. + @returns + a sequence with the addresses of all cell ranges. */ sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses(); @@ -125,36 +122,5 @@ interface XSheetCellRanges: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.6 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.4 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.3 2000/02/09 14:59:03 mi - #72869# get/setCellStyle moved to CellProperties - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetCondition.idl b/offapi/com/sun/star/sheet/XSheetCondition.idl index e8c9cc55306c..1d82029445f9 100644 --- a/offapi/com/sun/star/sheet/XSheetCondition.idl +++ b/offapi/com/sun/star/sheet/XSheetCondition.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetCondition.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetCondition_idl__ #define __com_sun_star_sheet_XSheetCondition_idl__ @@ -73,108 +74,87 @@ #include <com/sun/star/table/CellAddress.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetCondition -/** represents a condition in conditional formats or validation.@see com::sun::star::sheet::TableValidation - @see com::sun::star::sheet::TableConditionalEntry +/** provides methods to access the settings of a condition in a + conditional format or data validation. + + @see com::sun::star::sheet::TableConditionalEntry + @see com::sun::star::sheet::TableValidation */ interface XSheetCondition: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getOperator /** returns the operator in the condition. */ com::sun::star::sheet::ConditionOperator getOperator(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setOperator /** sets the operator in the condition. */ - void setOperator( [in] com::sun::star::sheet::ConditionOperator nOperator ); + void setOperator( + [in] com::sun::star::sheet::ConditionOperator nOperator ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCondition::getFormula1 - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getFormula1 - /** returns either the comparison value, which is used in - the condition, or the first value if two values are needed for - the operator. + /** returns either the comparison value, which is used in the condition, + or the first value if two values are needed for the operator. - - - <p>This can be a formula, a numeric constant, or a - string constant in quotes.</p> + @returns + a formula, a numeric constant, or a string constant in quotes. */ string getFormula1(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setFormula1 - /** sets either the comparison value, which is used in - the condition, or the first value if two values are needed for - the operator. - + /** sets either the comparison value, which is used in the condition, + or the first value if two values are needed for the operator. - - <p>This can be a formula, a numeric constant, or a - string constant in quotes.</p> + @param aFormula1 + a formula, a numeric constant, or a string constant in quotes. */ void setFormula1( [in] string aFormula1 ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetCondition::getFormula2 - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getFormula2 /** if two values are needed for the operator, this method returns the second one. - - - <p>this can be a formula, a numeric constant, or a string constant - in quotes. The operators <const>ConditionOperator::BETWEEN</const> - and <const>ConditionOperator::NOT_BETWEEN</const> need two values - each.</p> + @returns + a formula, a numeric constant, or a string constant in quotes. */ string getFormula2(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setFormula2 /** if two values are needed for the operator, this method sets the second one. - - - <p>This can be a formula, a numeric constant, or a string constant - in quotes. The operators <const>ConditionOperator::BETWEEN</const> - and <const>ConditionOperator::NOT_BETWEEN</const> need two values - each.</p> + @param aFormula2 + a formula, a numeric constant, or a string constant in quotes. */ void setFormula2( [in] string aFormula2 ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::getSourcePosition - /** returns the position in the document which - is used as a base for relative references in the formulas. + /** returns the position in the document which is used as a base for + relative references in the formulas. */ com::sun::star::table::CellAddress getSourcePosition(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetCondition::setSourcePosition - /** sets the position in the document which is used - as a base for relative references in the formulas. + /** sets the position in the document which is used as a base for + relative references in the formulas. */ - void setSourcePosition( [in] com::sun::star::table::CellAddress aSourcePosition ); + void setSourcePosition( + [in] com::sun::star::table::CellAddress aSourcePosition ); }; @@ -182,33 +162,5 @@ interface XSheetCondition: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl index 4cd835db2148..14c5da8ee60f 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetConditionalEntries.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-01 16:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__ #define __com_sun_star_sheet_XSheetConditionalEntries_idl__ @@ -69,36 +70,56 @@ #include <com/sun/star/beans/PropertyValue.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetConditionalEntries -/** the conditions of a conditional format are managed.@see com::sun::star::sheet::TableConditionalFormat +/** provides methods to add and remove conditions of a conditional format. + + @see com::sun::star::sheet::TableConditionalFormat + @see com::sun::star::sheet::TableConditionalEntry */ interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::addNew - /** adds a conditional entry to the format.@see com::sun::star::sheet::TableConditionalFormat + /** adds a conditional entry to the format. + + <p>Supported properties are:</p> + + <dl> + <dt><type>ConditionOperator</type> Operator</dt> + <dd>contains the operation to perform for this condition.</dd> + + <dt><atom>string</atom> Formula1</dt> + <dd>contains the value or formula for the operation.</dd> + + <dt><atom>string</atom> Formula2</dt> + <dd>contains the second value or formula for the operation (used with + <const>ConditionOperator::BETWEEN</const> or + <const>ConditionOperator::NOT_BERWEEN</const> operations).</dd> + + <dt><type scope="com::sun::star::table">CellAddress</type> + SourcePosition</dt> + <dd>contains the base address for relative cell references in formulas. + </dd> + </dl> + + @see com::sun::star::sheet::TableConditionalFormat */ - void addNew( [in] sequence<com::sun::star::beans::PropertyValue> aConditionalEntry ); + void addNew( [in] sequence< com::sun::star::beans::PropertyValue > aConditionalEntry ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::removeByIndex /** removes a conditional entry from the format. */ void removeByIndex( [in] long nIndex ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntries::clear - /** clears the format. + /** clears all condition entries. */ void clear(); @@ -108,30 +129,5 @@ interface XSheetConditionalEntries: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:38 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl index 145eee7f496e..137f0d14c7a8 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetConditionalEntry.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetConditionalEntry_idl__ #define __com_sun_star_sheet_XSheetConditionalEntry_idl__ @@ -65,32 +66,30 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetConditionalEntry -/** represents an entry in a conditional format.@see com::sun::star::sheet::TableConditionalEntry +/** provides methods to access the cell style name for a condition in a + conditional format. + + @see com::sun::star::sheet::TableConditionalEntry */ interface XSheetConditionalEntry: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetConditionalEntry::getStyleName - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntry::getStyleName - /** returns the name of the cell style that is used when - the condition is fulfilled. + /** returns the name of the cell style that is used when the condition + is fulfilled. */ string getStyleName(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetConditionalEntry::setStyleName - /** sets the name of the cell style that is used when - the condition is fulfilled. + /** sets the name of the cell style that is used when the condition + is fulfilled. */ void setStyleName( [in] string aStyleName ); @@ -100,33 +99,5 @@ interface XSheetConditionalEntry: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl index bf645526b06b..15b2e2f476c6 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ #define __com_sun_star_sheet_XSheetFilterDescriptor_idl__ @@ -69,32 +70,30 @@ #include <com/sun/star/sheet/TableFilterField.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterDescriptor -/** represents a description of how to filter cells.@see com::sun::star::sheet::SheetFilterDescriptor +/** provides access to a collection of filter conditions (filter fields). + + @see com::sun::star::sheet::SheetFilterDescriptor */ interface XSheetFilterDescriptor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetFilterDescriptor::getFilterFields - // DocMerge from idl: method com::sun::star::sheet::XSheetFilterDescriptor::getFilterFields - /** returns the definitions of the filter fields. + /** returns the collection of filter fields. */ - sequence<com::sun::star::sheet::TableFilterField> getFilterFields(); + sequence< com::sun::star::sheet::TableFilterField > getFilterFields(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterDescriptor::setFilterFields - /** sets the definitions of the filter fields. + /** sets a new collection of filter fields. */ - void setFilterFields( [in] sequence<com::sun::star::sheet::TableFilterField> aFilterFields ); + void setFilterFields( + [in] sequence< com::sun::star::sheet::TableFilterField > aFilterFields ); }; @@ -102,33 +101,5 @@ interface XSheetFilterDescriptor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterable.idl b/offapi/com/sun/star/sheet/XSheetFilterable.idl index 75084026de75..5c28510e7203 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterable.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetFilterable_idl__ #define __com_sun_star_sheet_XSheetFilterable_idl__ @@ -69,32 +70,40 @@ #include <com/sun/star/sheet/XSheetFilterDescriptor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterable -/** represents something that can be filtered - using an XSheetFilterDesriptor. +/** represents something that can be filtered using an XSheetFilterDesriptor. + + @see com::sun::star::sheet::XSheetFilterableEx */ interface XSheetFilterable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterable::createFilterDescriptor /** creates a filter descriptor. + + @param bEmpty + if set to <TRUE/>, creates an empty filter descriptor. If set to + <FALSE/>, fills the filter descriptor with previous settings of + the current object (i.e. a database range). */ - com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptor( [in] boolean bEmpty ); + com::sun::star::sheet::XSheetFilterDescriptor + createFilterDescriptor( [in] boolean bEmpty ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterable::filter - /** filters cells out. + /** performa a filter operation, using the settings of the passed filter + descriptor. + + @param xDescriptor + the settings for the filter operation. */ - void filter( [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor ); + void filter( + [in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor ); }; @@ -102,21 +111,5 @@ interface XSheetFilterable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetFilterableEx.idl b/offapi/com/sun/star/sheet/XSheetFilterableEx.idl index 0e2ab42928ca..03ebb064fc5e 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterableEx.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterableEx.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetFilterableEx.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,23 +72,28 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetFilterableEx -/** represents something from which criteria for filtering - can be read. +/** represents something from which criteria for filtering can be read. + + <p>In general the current object will be used only to create the + descriptor to filter another object, i.e. the advanced filter feature + in a spreadsheet.</p> + + @see com::sun::star::sheet::SheetCellRange */ interface XSheetFilterableEx: com::sun::star::sheet::XSheetFilterable { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetFilterableEx::createFilterDescriptorByObject - /** creates a filter descriptor for the specified - filterable object from the contents of this object. + /** creates a filter descriptor for the specified filterable object from + the contents of this object. */ - com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptorByObject( [in] com::sun::star::sheet::XSheetFilterable xObject ); + com::sun::star::sheet::XSheetFilterDescriptor + createFilterDescriptorByObject( + [in] com::sun::star::sheet::XSheetFilterable xObject ); }; @@ -96,21 +101,5 @@ interface XSheetFilterableEx: com::sun::star::sheet::XSheetFilterable }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetLinkable.idl b/offapi/com/sun/star/sheet/XSheetLinkable.idl index b92a2c7609cf..98b4654ee5e2 100644 --- a/offapi/com/sun/star/sheet/XSheetLinkable.idl +++ b/offapi/com/sun/star/sheet/XSheetLinkable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetLinkable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetLinkable_idl__ #define __com_sun_star_sheet_XSheetLinkable_idl__ @@ -69,27 +70,21 @@ #include <com/sun/star/sheet/SheetLinkMode.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetLinkable /** enables a sheet to refer to another sheet in a different document. + <p>To insert a sheet link, the sheet used as linked sheet has to exist + already. The method <member>XSheetLinkable::link</member> creates a + <type>SheetLink</type> object in the document's <type>SheetLinks</type> + collection and links the sheet to the specified external sheet.</p> - - - - - - - - - - + @see com::sun::star::sheet::SheetLinks + @see com::sun::star::sheet::SheetLink @deprecated */ @@ -97,76 +92,65 @@ interface XSheetLinkable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkMode - /** enables the linking of the sheet and controls - if formulas are copied. + /** returns the link mode of the spreadsheet. - - - <p>If this is <const>SheetLinkMode::NORMAL</const>, formulas - are copied. With <const>SheetLinkMode::VALUE</const>, only - results of formulas are used.</p> + <p>If the returned value is <const>SheetLinkMode::NORMAL</const>, + formulas are copied. With <const>SheetLinkMode::VALUE</const>, + only results of formulas are used.</p> */ com::sun::star::sheet::SheetLinkMode getLinkMode(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkMode - /** enables the linking of the sheet and controls - if formulas are copied. - + /** enables the linking of the sheet and controls whether formulas + are copied. + @param nLinkMode + the value specifying the link mode for this spreadsheet. - <p>If this is <const>SheetLinkMode::NORMAL</const>, formulas - are copied. With <const>SheetLinkMode::VALUE</const>, only - results of formulas are used.</p> + <p>If the value is <const>SheetLinkMode::NORMAL</const>, + formulas are copied. With <const>SheetLinkMode::VALUE</const>, + only results of formulas are used.</p> */ void setLinkMode( [in] com::sun::star::sheet::SheetLinkMode nLinkMode ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetLinkable::getLinkUrl - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkUrl /** returns the target URL of the link. */ string getLinkUrl(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkUrl /** sets the target URL of the link. - - - <p>A Sheet Link with the same file name must exist - or the link will not work.</p> + <p>A <type>SheetLink</type> object with the same file name must + exist already or the link will not work.</p> */ void setLinkUrl( [in] string aLinkUrl ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetLinkable::getLinkSheetName - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::getLinkSheetName - /** returns the sheet in the source URL. + /** returns the sheet name of the sheet in the source document. */ string getLinkSheetName(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::setLinkSheetName - /** sets the sheet in the source URL. + /** sets the name of the linked sheet in the source document. + + <p>This method sets the sheet name in the <type>SheetLink</type> + object, it does not modify the sheet name in the source document.</p> */ void setLinkSheetName( [in] string aLinkSheetName ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetLinkable::link /** links the sheet to another sheet in another document. - - - <p>A sheet link is created if it does not exist, and the - LinkMode, LinkFileName and LinkSheetName attributes are set.</p> + <p>A <type>SheetLink</type> object is created if it does not exist, + and the link mode, the URL of the linked document and the linked + sheet name are set.</p> */ void link( [in] string aUrl, [in] string aSheetName, @@ -180,27 +164,5 @@ interface XSheetLinkable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetOperation.idl b/offapi/com/sun/star/sheet/XSheetOperation.idl index c7df7ddf465d..c2c54d05d7f7 100644 --- a/offapi/com/sun/star/sheet/XSheetOperation.idl +++ b/offapi/com/sun/star/sheet/XSheetOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetOperation.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetOperation_idl__ #define __com_sun_star_sheet_XSheetOperation_idl__ @@ -73,31 +74,41 @@ #include <com/sun/star/uno/Exception.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetOperation -/** represents operations on a cell range or ranges.@see com::sun::star::sheet::SheetCellRanges +/** provides methods to execute operations on a cell range or ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XSheetOperation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOperation::computeFunction - /** computes a general function of all cells in - the ranges. + /** computes a general function based on all cells in the current + cell range(s). + + @param nFunction + is the function used to compute the result. + + @returns + the result of the calculation. */ - double computeFunction( [in] com::sun::star::sheet::GeneralFunction nFunction ) - raises( com::sun::star::uno::Exception ); + double computeFunction( + [in] com::sun::star::sheet::GeneralFunction nFunction ) + raises( com::sun::star::uno::Exception ); //! unnecessary //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOperation::clearContents - /** clears selected contents of the range. + /** clears the specified contents of the current cell range(s). + + @param nContentFlags + a combination of <type>CellFlags</type> flags selecting the + contents to be deleted. */ void clearContents( [in] long nContentFlags ); @@ -107,27 +118,4 @@ interface XSheetOperation: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sheet/XSheetOutline.idl b/offapi/com/sun/star/sheet/XSheetOutline.idl index bd34c3669266..08320c9cd6c4 100644 --- a/offapi/com/sun/star/sheet/XSheetOutline.idl +++ b/offapi/com/sun/star/sheet/XSheetOutline.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetOutline.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetOutline_idl__ #define __com_sun_star_sheet_XSheetOutline_idl__ @@ -73,74 +74,96 @@ #include <com/sun/star/table/TableOrientation.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetOutline -/** represents outlining functions of a sheet. +/** provides methods to access the outlines of a sheet. */ interface XSheetOutline: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::group /** creates an outline group. + + @param aRange + contains the range of rows or columns, depending on + the parameter nOrientation. + + @param nOrientation + the orientation of the new outline (columns or rows). */ - void group( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::table::TableOrientation nOrientation ); + void group( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::table::TableOrientation nOrientation ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::ungroup /** removes outline groups. + <p>In the specified range, all outline groups on the innermost + level are removed.</p> + @param aRange + contains the range of rows or columns, depending on + the parameter nOrientation. - <p>In the specified range, all outline groups on the innermost level - are removed.</p> + @param nOrientation + the orientation of the outlines to remove (columns or rows). */ - void ungroup( [in] com::sun::star::table::CellRangeAddress aRange, - [in] com::sun::star::table::TableOrientation nOrientation ); + void ungroup( + [in] com::sun::star::table::CellRangeAddress aRange, + [in] com::sun::star::table::TableOrientation nOrientation ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::autoOutline /** creates outline groups from formula references in a range. + + @param aRange + the cell range for which outlines are generated. */ void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::clearOutline - /** removes all outline groups on the sheet. + /** removes all outline groups from the sheet. */ void clearOutline(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::hideDetail - /** hides an outline group. + /** collapses an outline group. + + @param aRange + the cell range for which the outlines are collapsed. */ void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showDetail - /** shows an outline group. + /** reopens an outline group. + + @param aRange + the cell range for which the outlines are reopened. */ void showDetail( [in] com::sun::star::table::CellRangeAddress aRange ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showLevel - /** shows all outlined groups below a specified level. + /** shows all outlined groups below a specific level. + + @param nLevel + all outline levels from 1 to this value will be opened and + the higher levels will be closed. + + @param nOrientation + the orientation of the outlines (columns or rows). */ - void showLevel( [in] short nLevel, - [in] com::sun::star::table::TableOrientation nOrientation ); + void showLevel( + [in] short nLevel, + [in] com::sun::star::table::TableOrientation nOrientation ); }; @@ -148,24 +171,5 @@ interface XSheetOutline: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.4 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetPageBreak.idl b/offapi/com/sun/star/sheet/XSheetPageBreak.idl index 968f17d3ec6a..6ebb405e05ac 100644 --- a/offapi/com/sun/star/sheet/XSheetPageBreak.idl +++ b/offapi/com/sun/star/sheet/XSheetPageBreak.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetPageBreak.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetPageBreak_idl__ #define __com_sun_star_sheet_XSheetPageBreak_idl__ @@ -69,63 +70,50 @@ #include <com/sun/star/sheet/TablePageBreakData.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetPageBreak /** provides access to page breaks in a sheet. - - - - - - - - - - - - @deprecated */ interface XSheetPageBreak: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetPageBreak::getColumnPageBreaks - // DocMerge from idl: method com::sun::star::sheet::XSheetPageBreak::getColumnPageBreaks - /** returns a sequence of descriptions of all horizontal - page breaks on the sheet. + /** returns a sequence of descriptions of all horizontal page breaks + on the sheet. + + <P>This includes manual and automatic page breaks. To add or + remove manual breaks, use the + <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member> + property of the column.</P> - <P>This includes manual and automatic page breaks. - To add or remove manual breaks, use the - <member scope="com::sun::star::table">TableColumn::IsStartOfNewPage</member> - property of the column.</P> + @returns + a sequence of structs containing column page break data. */ - sequence<com::sun::star::sheet::TablePageBreakData> getColumnPageBreaks(); + sequence< com::sun::star::sheet::TablePageBreakData > getColumnPageBreaks(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSheetPageBreak::getRowPageBreaks - // DocMerge from idl: method com::sun::star::sheet::XSheetPageBreak::getRowPageBreaks - /** returns a sequence of descriptions of all vertical - page breaks on the sheet. + /** returns a sequence of descriptions of all vertical page breaks + on the sheet. + + <P>This includes manual and automatic page breaks. To add or + remove manual breaks, use the + <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member> + property of the row.</P> - <P>This includes manual and automatic page breaks.</P> - To add or remove manual breaks, use the - <member scope="com::sun::star::table">TableRow::IsStartOfNewPage</member> - property of the row.</P> + @returns + a sequence of structs containing row page break data. */ - sequence<com::sun::star::sheet::TablePageBreakData> getRowPageBreaks(); + sequence< com::sun::star::sheet::TablePageBreakData > getRowPageBreaks(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetPageBreak::removeAllManualPageBreaks /** removes all manual page breaks on the sheet. */ void removeAllManualPageBreaks(); @@ -136,27 +124,5 @@ interface XSheetPageBreak: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSheetPastable.idl b/offapi/com/sun/star/sheet/XSheetPastable.idl index 632d90a0873d..d1623162b5f8 100644 --- a/offapi/com/sun/star/sheet/XSheetPastable.idl +++ b/offapi/com/sun/star/sheet/XSheetPastable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSheetPastable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSheetPastable_idl__ #define __com_sun_star_sheet_XSheetPastable_idl__ @@ -81,28 +82,13 @@ #include <com/sun/star/sheet/CellInsertMode.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSheetPastable -/** represents a sheet into which contents of the clipboard - can be pasted. - - - - - - - - - - - - +/** represents a sheet into which contents of the clipboard can be pasted. @deprecated */ @@ -110,7 +96,6 @@ interface XSheetPastable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::paste /** pastes the contents of the clipboard at the specified position on the sheet. */ @@ -118,7 +103,6 @@ interface XSheetPastable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::pasteFormat /** pastes the contents of the clipboard at the specified position on the sheet, using the specified format. */ @@ -127,12 +111,9 @@ interface XSheetPastable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSheetPastable::pasteCellRange /** pastes clipboard data from a cell range into another cell range. - - <p>The contents of the clipboard must be from a cell range.</p> */ void pasteCellRange( [in] com::sun::star::table::CellRangeAddress aDestination, @@ -149,21 +130,5 @@ interface XSheetPastable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheet.idl b/offapi/com/sun/star/sheet/XSpreadsheet.idl index ffd4844aaf26..8325dec5272d 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheet.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSpreadsheet_idl__ #define __com_sun_star_sheet_XSpreadsheet_idl__ @@ -67,29 +68,37 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { + +//============================================================================= interface XSheetCellCursor; //============================================================================= -// DocMerge: empty anyway -interface XSpreadsheet: XSheetCellRange +/** provides methods to create a cell range cursor. + */ +interface XSpreadsheet: com::sun::star::sheet::XSheetCellRange { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheet::createCursor - /** creates a cell cursor.@see com::sun::star::sheet::Spreadsheet + /** creates a cell cursor including the whole spreadsheet. + + @see com::sun::star::sheet::SheetCellCursor */ - XSheetCellCursor createCursor(); + com::sun::star::sheet::XSheetCellCursor createCursor(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheet::createCursorByRange - /** creates a cell cursor to travel in - the given range context.@see com::sun::star::sheet::Spreadsheet + /** creates a cell cursor to travel in the given range context. + + @param aRange + the cell range for the cursor. + + @see com::sun::star::sheet::SheetCellCursor */ - XSheetCellCursor createCursorByRange( [in] XSheetCellRange aRange ); + com::sun::star::sheet::XSheetCellCursor createCursorByRange( + [in] com::sun::star::sheet::XSheetCellRange aRange ); }; @@ -97,27 +106,5 @@ interface XSpreadsheet: XSheetCellRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl b/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl index c5eab2604b77..44cb5c1361ed 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheetDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheetDocument.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ #define __com_sun_star_sheet_XSpreadsheetDocument_idl__ @@ -69,22 +70,23 @@ #include <com/sun/star/sheet/XSpreadsheets.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheetDocument -/** a container of spreadsheets.@see com::sun::star::sheet::SpreadsheetDocument +/** provides access to a collection of spreadsheets. + + @see com::sun::star::sheet::SpreadsheetDocument */ interface XSpreadsheetDocument: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetDocument::getSheets - /** returns the container of sheets in the document.@see Spreadsheets + /** returns the collection of sheets in the document. + + @see com::sun::star::sheet::Spreadsheets */ com::sun::star::sheet::XSpreadsheets getSheets(); @@ -94,27 +96,5 @@ interface XSpreadsheetDocument: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:51 hjs - initial import - - Revision 1.3 2000/09/11 11:52:52 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheetView.idl b/offapi/com/sun/star/sheet/XSpreadsheetView.idl index c40f260c2585..97b0cd6288e9 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheetView.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheetView.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheetView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,19 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheetView -/** the main interface of a <type>SpreadsheetView</type>. It +/** is the main interface of a <type>SpreadsheetView</type>. It manages the active sheet within this view. */ interface XSpreadsheetView: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetView::getActiveSheet /** returns the sheet that is shown in the view. */ com::sun::star::sheet::XSpreadsheet getActiveSheet(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheetView::setActiveSheet /** sets the sheet that is shown in the view. */ void setActiveSheet( [in] com::sun::star::sheet::XSpreadsheet xActiveSheet ); @@ -102,21 +99,5 @@ interface XSpreadsheetView: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSpreadsheets.idl b/offapi/com/sun/star/sheet/XSpreadsheets.idl index 30175ae999f0..85d0185459b8 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheets.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheets.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSpreadsheets.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSpreadsheets_idl__ #define __com_sun_star_sheet_XSpreadsheets_idl__ @@ -65,42 +66,56 @@ #include <com/sun/star/container/XNameContainer.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSpreadsheets -/** represents the collection of sheets in a document.@see com::sun::star::sheet::Spreadsheets +/** provides methods to access the spreadsheets by name and to insert, + copy, remove and rearrange spreadsheets. + + @see com::sun::star::sheet::Spreadsheets */ interface XSpreadsheets: com::sun::star::container::XNameContainer { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::insertNewByName /** inserts a new sheet into the collection. + + @param aName + the name of the new spreadsheet. + @param nPosition + the index of the new spreadsheet in the collection. */ - void insertNewByName( [in] string aName, - [in] short nPosition ); + void insertNewByName( [in] string aName, [in] short nPosition ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::moveByName /** moves a sheet within the collection. + + @param aName + the name of the spreadsheet to move. + @param nDestination + the new index of the spreadsheet in the collection. */ - void moveByName( [in] string aName, - [in] short nDestination ); + void moveByName( [in] string aName, [in] short nDestination ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSpreadsheets::copyByName /** copies a sheet within the collection. + + @param aName + the name of the spreadsheet to copy. + @param aCopy + the name of the copy of the spreadsheet. + @param nDestination + the index of the copy in the collection. */ - void copyByName( [in] string aName, - [in] string aCopy, - [in] short nDestination ); + void copyByName( + [in] string aName, + [in] string aCopy, + [in] short nDestination ); }; @@ -108,27 +123,5 @@ interface XSpreadsheets: com::sun::star::container::XNameContainer }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl index 840035c27910..0c3a9d0c9364 100644 --- a/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl +++ b/offapi/com/sun/star/sheet/XSubTotalCalculatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalCalculatable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSubTotalCalculatable_idl__ #define __com_sun_star_sheet_XSubTotalCalculatable_idl__ @@ -69,38 +70,52 @@ #include <com/sun/star/sheet/XSubTotalDescriptor.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalCalculatable -/** The interface contains methods to handle a SubTotaldescriptor. - The SubTotaldescriptor provides properties to set up the SubTotal function. +/** contains methods to handle a subtotal descriptor. + + <p>The subtotal descriptor provides properties to set up the subtotal + function.</p> + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalCalculatable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::createSubTotalDescriptor /** creates a subtotal descriptor. + + @param bEmpty + if set to <TRUE/>, creates an empty descriptor. If set to + <FALSE/>, fills the descriptor with previous settings of the + current object (i.e. a database range). */ - com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor( [in] boolean bEmpty ); + com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor( + [in] boolean bEmpty ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::applySubTotals - /** creates subtotals. + /** creates subtotals using the settings of the passed descriptor. + + @param xDescriptor + the subtotal descriptor with the settings used for the subtotal + operation. + + @param bReplace + if set to <TRUE/>, replaces previous subtotal results. */ - void applySubTotals( [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, - [in] boolean bReplace ); + void applySubTotals( + [in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, + [in] boolean bReplace ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalCalculatable::removeSubTotals - /** removes the subtotals. + /** removes the subtotals from the current object. */ void removeSubTotals(); @@ -110,21 +125,5 @@ interface XSubTotalCalculatable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl b/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl index bd14a887adec..77cc77dd23a5 100644 --- a/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl +++ b/offapi/com/sun/star/sheet/XSubTotalDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ #define __com_sun_star_sheet_XSubTotalDescriptor_idl__ @@ -69,30 +70,36 @@ #include <com/sun/star/sheet/SubTotalColumn.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalDescriptor -/** represents a description of how subtotals are - to be inserted.@see com::sun::star::sheet::SubTotalDescriptor +/** provides access to the collection of subtotal fields in a subtotal + descriptor. + + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalDescriptor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalDescriptor::addNew /** adds a subtotal field definition to the descriptor. + + @param aSubTotalColumns + a sequence of all columns used to calculate subtotal values. + + @param nGroupColumn + specifies which column of the source range is used to group the + contents of the source data. */ - void addNew( [in] sequence<com::sun::star::sheet::SubTotalColumn> aSubTotalColumns, - [in] long nGroupColumn ); + void addNew( + [in] sequence< com::sun::star::sheet::SubTotalColumn > aSubTotalColumns, + [in] long nGroupColumn ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalDescriptor::clear /** removes all subtotal field definitions from the descriptor. */ void clear(); @@ -103,27 +110,5 @@ interface XSubTotalDescriptor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XSubTotalField.idl b/offapi/com/sun/star/sheet/XSubTotalField.idl index fddf79fc2a73..43a4b215840c 100644 --- a/offapi/com/sun/star/sheet/XSubTotalField.idl +++ b/offapi/com/sun/star/sheet/XSubTotalField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSubTotalField.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XSubTotalField_idl__ #define __com_sun_star_sheet_XSubTotalField_idl__ @@ -69,48 +70,46 @@ #include <com/sun/star/sheet/SubTotalColumn.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XSubTotalField -/** represents a field in a subtotal descriptor.@see com::sun::star::sheet::SubTotalField +/** provides access to the settings of a field in a subtotal descriptor. + + @see com::sun::star::sheet::SubTotalField + @see com::sun::star::sheet::SubTotalDescriptor */ interface XSubTotalField: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::getGroupColumn /** returns the column by which entries are grouped. */ long getGroupColumn(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::setGroupColumn /** sets the column by which entries are grouped. */ void setGroupColumn( [in] long nGroupColumn ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XSubTotalField::getSubTotalColumns - // DocMerge from idl: method com::sun::star::sheet::XSubTotalField::getSubTotalColumns - /** returns the definitions of which columns should have - subtotals added to them. + /** returns the definitions of which columns should have subtotals + added to them. */ - sequence<com::sun::star::sheet::SubTotalColumn> getSubTotalColumns(); + sequence< com::sun::star::sheet::SubTotalColumn > getSubTotalColumns(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XSubTotalField::setSubTotalColumns - /** sets the definitions of which columns should have - subtotals added to them. + /** sets the definitions of which columns should have subtotals + added to them. */ - void setSubTotalColumns( [in] sequence<com::sun::star::sheet::SubTotalColumn> aSubTotalColumns ); + void setSubTotalColumns( + [in] sequence< com::sun::star::sheet::SubTotalColumn > + aSubTotalColumns ); }; @@ -118,33 +117,5 @@ interface XSubTotalField: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl index a8c6e567dfb3..ae0b72ff8626 100644 --- a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl +++ b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUniqueCellFormatRangesSupplier.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sab $ $Date: 2001-07-06 11:47:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ #define __com_sun_star_sheet_XUniqueCellFormatRangesSupplier_idl__ @@ -71,17 +72,33 @@ //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -/** provides a collection of cell formats. +/** provides access to a collection of collections of equal-formatted + cell ranges. + + @see com::sun::star::sheet::SheetCellRange + @see com::sun::star::sheet::SheetCellRanges */ interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface { - /** returns the collection of cell formats. - <p>Every different cell format is represented by a - <type scope="com::sun::star::sheet">SheetCellRanges</type> object.</p> + /** returns a collection of equal-formatted cell range collections. + + <p>Each cell of the original range is contained in one of the + ranges (even unformatted cells). If there is a non-rectangular + equal-formatted cell area, it will be split into several + rectangular ranges.</p> + + <p>All equal-formatted ranges are consolidated into one collection. + These collections are the members contained in a + <type>UniqueCellFormatRanges</type> collection.</p> + + @returns + the collection of equal-formatted cell range collections. + + @see com::sun::star::sheet::UniqueCellFormatRanges */ com::sun::star::container::XIndexAccess getUniqueCellFormatRanges(); }; @@ -91,3 +108,4 @@ interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInterface }; }; }; }; #endif + diff --git a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl index cca9d2e77a46..9e7f9238957f 100644 --- a/offapi/com/sun/star/sheet/XUsedAreaCursor.idl +++ b/offapi/com/sun/star/sheet/XUsedAreaCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUsedAreaCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XUsedAreaCursor_idl__ #define __com_sun_star_sheet_XUsedAreaCursor_idl__ @@ -65,30 +66,39 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XUsedAreaCursor -/** represents a cursor which can move to the start - or end of the used area of a sheet.@see com::sun::star::sheet::SheetCellCursor +/** provides methods to find the used area of the entire sheet. + + <p>The used area is the smallest cell range that contains all cells + of the spreadsheet with any contents (values, text, formulas) or + visible formatting (borders and background color).</p> + + @see com::sun::star::sheet::SheetCellCursor */ interface XUsedAreaCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XUsedAreaCursor::gotoStartOfUsedArea /** points the cursor to the start of the used area. + + @param bExpand + <TRUE/> = expands the current cursor range, + <FALSE/> = sets size of the cursor to a single cell. */ void gotoStartOfUsedArea( [in] boolean bExpand ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XUsedAreaCursor::gotoEndOfUsedArea /** points the cursor to the end of the used area. + + @param bExpand + <TRUE/> = expands the current cursor range, + <FALSE/> = sets size of the cursor to a single cell. */ void gotoEndOfUsedArea( [in] boolean bExpand ); @@ -98,27 +108,5 @@ interface XUsedAreaCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XViewFreezable.idl b/offapi/com/sun/star/sheet/XViewFreezable.idl index f0ed1672687d..91d967fdf996 100644 --- a/offapi/com/sun/star/sheet/XViewFreezable.idl +++ b/offapi/com/sun/star/sheet/XViewFreezable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewFreezable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,6 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewFreezable /** enables a <type>SpreadsheetView</type> to freeze columns and rows of the view. */ @@ -80,11 +79,8 @@ interface XViewFreezable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewFreezable::hasFrozenPanes /** returns <TRUE/> if the view has frozen panes. - - <p>Only one of <member>XViewSplitable::getIsWindowSplit()</member> and <member>XViewFreezable::hasFrozenPanes()</member> @@ -94,12 +90,9 @@ interface XViewFreezable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewFreezable::freezeAtPosition /** freezes panes with the specified number of columns and rows. - - <p>To freeze only horizontally, specify nRows as 0. To freeze only vertically, specify nColumns as 0.</p> */ @@ -112,24 +105,5 @@ interface XViewFreezable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XViewPane.idl b/offapi/com/sun/star/sheet/XViewPane.idl index 0f8c510f92cb..c7293e193cdd 100644 --- a/offapi/com/sun/star/sheet/XViewPane.idl +++ b/offapi/com/sun/star/sheet/XViewPane.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewPane.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,42 +76,38 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewPane -/** represents a pane in a view of a spreadsheet document.@see com::sun::star::sheet::SpreadsheetViewPane +/** represents a pane in a view of a spreadsheet document. + + @see com::sun::star::sheet::SpreadsheetViewPane */ interface XViewPane: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getFirstVisibleColumn /** returns the first column that is visible in the pane. */ long getFirstVisibleColumn(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::setFirstVisibleColumn /** sets the first column that is visible in the pane. */ void setFirstVisibleColumn( [in] long nFirstVisibleColumn ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getFirstVisibleRow /** returns the first row that is visible in the pane. */ long getFirstVisibleRow(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::setFirstVisibleRow /** sets the first row that is visible in the pane. */ void setFirstVisibleRow( [in] long nFirstVisibleRow ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPane::getVisibleRange /** returns the address of the cell range that consists of the cells which are visible in the pane. */ @@ -123,27 +119,5 @@ interface XViewPane: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:12 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.2 2000/10/09 14:24:58 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XViewPanesSupplier.idl b/offapi/com/sun/star/sheet/XViewPanesSupplier.idl index 4b56484f6801..e9dfa1182819 100644 --- a/offapi/com/sun/star/sheet/XViewPanesSupplier.idl +++ b/offapi/com/sun/star/sheet/XViewPanesSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewPanesSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XViewPanesSupplier_idl__ #define __com_sun_star_sheet_XViewPanesSupplier_idl__ @@ -69,21 +70,20 @@ #include <com/sun/star/container/XIndexAccess.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewPanesSupplier /** enables access to the panes in a view. + + @deprecated */ interface XViewPanesSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewPanesSupplier::getViewPanes /** returns the collection of panes in the view. */ com::sun::star::container::XIndexAccess getViewPanes(); @@ -94,21 +94,5 @@ interface XViewPanesSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XViewSplitable.idl b/offapi/com/sun/star/sheet/XViewSplitable.idl index 98c11153ea5a..f0a8f37fa6a5 100644 --- a/offapi/com/sun/star/sheet/XViewSplitable.idl +++ b/offapi/com/sun/star/sheet/XViewSplitable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewSplitable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,33 +72,17 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XViewSplitable /** enables a <type>SpreadsheetView</type> to split the view. - - - - - - - - - - - - @deprecated */ interface XViewSplitable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getIsWindowSplit /** returns <TRUE/> if the view is split into individual panes. - - <p>Only one of <member>XViewSplitable::getIsWindowSplit()</member> and <member>XViewFreezable::hasFrozenPanes()</member> @@ -108,7 +92,6 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitHorizontal /** returns the horizontal position in pixels where the view is split. */ @@ -116,7 +99,6 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitVertical /** returns the vertical position in pixels where the view is split. */ @@ -124,25 +106,20 @@ interface XViewSplitable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitColumn /** returns the column before which the view is split. */ long getSplitColumn(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::getSplitRow /** returns the row before which the view is split. */ long getSplitRow(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XViewSplitable::splitAtPosition /** splits the view at the specified position. - - <p>To split only horizontally, specify <var>nPixelY</var> as 0. To split only vertically, specify <var>nPixelX</var> as 0.</p> */ @@ -155,24 +132,5 @@ interface XViewSplitable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:40 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/XVolatileResult.idl b/offapi/com/sun/star/sheet/XVolatileResult.idl index 5a8521092be8..0295617a82ba 100644 --- a/offapi/com/sun/star/sheet/XVolatileResult.idl +++ b/offapi/com/sun/star/sheet/XVolatileResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVolatileResult.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,6 +58,7 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet_XVolatileResult_idl__ #define __com_sun_star_sheet_XVolatileResult_idl__ @@ -69,31 +70,32 @@ #include <com/sun/star/sheet/XResultListener.idl> #endif - //============================================================================= - module com { module sun { module star { module sheet { +module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from xml: interface com::sun::star::sheet::XVolatileResult -/** represents a volatile function result. +/** provides methods to handle a volatile function result. + + @see com::sun::star::sheet::VolatileResult + @see com::sun::star::sheet::ResultEvent */ interface XVolatileResult: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XVolatileResult::addResultListener /** adds a listener to be notified when a new value is available. */ - [oneway] void addResultListener( [in] com::sun::star::sheet::XResultListener aListener ); + [oneway] void addResultListener( + [in] com::sun::star::sheet::XResultListener aListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::sheet::XVolatileResult::removeResultListener /** removes the specified listener. */ - [oneway] void removeResultListener( [in] com::sun::star::sheet::XResultListener aListener ); + [oneway] void removeResultListener( + [in] com::sun::star::sheet::XResultListener aListener ); }; @@ -101,21 +103,5 @@ interface XVolatileResult: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:43:47 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.3 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/sheet/_NamedRange.idl b/offapi/com/sun/star/sheet/_NamedRange.idl index 98884f9aea83..5b0fb367505d 100644 --- a/offapi/com/sun/star/sheet/_NamedRange.idl +++ b/offapi/com/sun/star/sheet/_NamedRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: _NamedRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:43:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:08:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,49 +58,41 @@ * * ************************************************************************/ + #ifndef __com_sun_star_sheet__NamedRange_idl__ #define __com_sun_star_sheet__NamedRange_idl__ - //============================================================================= module com { module sun { module star { module sheet { //============================================================================= -// DocMerge from idl: constants com::sun::star::sheet::_NamedRange /** @deprecated + @see com::sun::star::sheet::NamedRangeFlag */ constants _NamedRange { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::1 - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::FILTER_CRITERIA /** The range contains filter criteria. */ const long FILTER_CRITERIA = 1; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::2 - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::PRINT_AREA /** The range can be used as a print range. */ const long PRINT_AREA = 2; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::4 - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::COLUMN_HEADER /** The range can be used as column headers for printing. */ const long COLUMN_HEADER = 4; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::8 - // DocMerge from idl: value com::sun::star::sheet::_NamedRange::ROW_HEADER /** The range can be used as row headers for printing. */ const long ROW_HEADER = 8; @@ -111,24 +103,5 @@ constants _NamedRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:52 hjs - initial import - - Revision 1.5 2000/09/11 11:52:53 mi - documentation merged from XML - - Revision 1.3 2000/03/24 17:35:24 nn - #74032# documentation added - - Revision 1.2 2000/02/07 11:24:56 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/style/CellStyle.idl b/offapi/com/sun/star/style/CellStyle.idl new file mode 100644 index 000000000000..1ce6985df927 --- /dev/null +++ b/offapi/com/sun/star/style/CellStyle.idl @@ -0,0 +1,94 @@ +/************************************************************************* + * + * $RCSfile: CellStyle.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:20 $ + * + * 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_style_CellStyle_idl__ +#define __com_sun_star_style_CellStyle_idl__ + +#ifndef __com_sun_star_style_Style_idl__ +#include <com/sun/star/style/Style.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module style { + +//============================================================================= + +/** is a common service for table cell styles. + + @see com::sun::star::sheet::TableCellStyle + */ +service CellStyle +{ + //------------------------------------------------------------------------- + + /** provides common functionality for styles. + */ + service com::sun::star::style::Style; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/style/PageStyle.idl b/offapi/com/sun/star/style/PageStyle.idl new file mode 100644 index 000000000000..b1f6bcb5a1ce --- /dev/null +++ b/offapi/com/sun/star/style/PageStyle.idl @@ -0,0 +1,555 @@ +/************************************************************************* + * + * $RCSfile: PageStyle.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:20 $ + * + * 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_style_PageStyle_idl__ +#define __com_sun_star_style_PageStyle_idl__ + +#ifndef __com_sun_star_style_Style_idl__ +#include <com/sun/star/style/Style.idl> +#endif + +#ifndef __com_sun_star_table_ShadowFormat_idl__ +#include <com/sun/star/table/ShadowFormat.idl> +#endif + +#ifndef __com_sun_star_table_BorderLine_idl__ +#include <com/sun/star/table/BorderLine.idl> +#endif + +#ifndef __com_sun_star_style_PageStyleLayout_idl__ +#include <com/sun/star/style/PageStyleLayout.idl> +#endif + +#ifndef __com_sun_star_style_GraphicLocation_idl__ +#include <com/sun/star/style/GraphicLocation.idl> +#endif + +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif + +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module style { + +//============================================================================= + +/** contributes common properties of page styles. + + @see com::sun::star::text::TextPageStyle + @see com::sun::star::sheet::TablePageStyle + */ +service PageStyle +{ + //------------------------------------------------------------------------- + + /** provides common functionality for styles. + */ + service com::sun::star::style::Style; + + //========================================================================= + + /** contains the background color of the page. + */ + [property] long BackColor; + + //------------------------------------------------------------------------- + + /** determines whether the background color is transparent. + + <p>If this property is set to <TRUE/>, + <member>PageStyle::BackColor</member> will not be used.</p> + */ + [property] boolean BackTransparent; + + //------------------------------------------------------------------------- + + /** contains the URL of the background graphic. + */ + [property] string BackGraphicURL; + + //------------------------------------------------------------------------- + + /** contains the filter name of the background graphic. + */ + [property] string BackGraphicFilter; + + //------------------------------------------------------------------------- + + /** determines the location of the background graphic. + */ + [property] com::sun::star::style::GraphicLocation BackGraphicLocation; + + //------------------------------------------------------------------------- + + /** determines the left margin of the page (in 1/100 mm). + */ + [property] long LeftMargin; + + //------------------------------------------------------------------------- + + /** determines the right margin of the page (in 1/100 mm). + */ + [property] long RightMargin; + + //------------------------------------------------------------------------- + + /** determines the top margin of the page (in 1/100 mm). + */ + [property] long TopMargin; + + //------------------------------------------------------------------------- + + /** determines the bottom margin of the page (in 1/100 mm). + */ + [property] long BottomMargin; + + //------------------------------------------------------------------------- + + /** determines the style of the left border line of the page. + */ + [property] com::sun::star::table::BorderLine LeftBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the right border line of the page. + */ + [property] com::sun::star::table::BorderLine RightBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the top border line of the page. + */ + [property] com::sun::star::table::BorderLine TopBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the bottom border line of the page. + */ + [property] com::sun::star::table::BorderLine BottomBorder; + + //------------------------------------------------------------------------- + + /** determines the left border distance of the page (in 1/100 mm). + */ + [property] long LeftBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the right border distance of the page (in 1/100 mm). + */ + [property] long RightBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the top border distance of the page (in 1/100 mm). + */ + [property] long TopBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the bottom border distance of the page (in 1/100 mm). + */ + [property] long BottomBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the distance of all borders of the page (in 1/100 mm). + */ + [property] long BorderDistance; + + //------------------------------------------------------------------------- + + /** determines the shadow of the page. + */ + [property] com::sun::star::table::ShadowFormat ShadowFormat; + + //------------------------------------------------------------------------- + + /** determines if the page format is landscape. + */ + [property] boolean IsLandscape; + + //------------------------------------------------------------------------- + + /** determines the default numbering type for this page. + */ + [property] short NumberingType; + + //------------------------------------------------------------------------- + + /** determines the layout of the page. + */ + [property] com::sun::star::style::PageStyleLayout PageStyleLayout; + + //------------------------------------------------------------------------- + + /** contains the name of a paper tray of the selected printer. + */ + [property] string PrinterPaperTray; + + //------------------------------------------------------------------------- + + /** contains the paper size of the page. + */ + [property] com::sun::star::awt::Size Size; + + //------------------------------------------------------------------------- + + /** contains the width of the page (in 1/100 mm). + */ + [property] long Width; + + //------------------------------------------------------------------------- + + /** contains the height of the page (in 1/100 mm). + */ + [property] long Height; + + //------------------------------------------------------------------------- + + /** contains user defined attributes. + */ + [property] com::sun::star::container::XNameContainer UserDefinedAttributes; + + //------------------------------------------------------------------------- + + /** contains the color of the background of the header. + */ + [property] long HeaderBackColor; + + //------------------------------------------------------------------------- + + /** determines whether the header background color is transparent. + + <p>If this property is set to <TRUE/>, + <member>PageStyle::HeaderBackColor</member> will not be used.</p> + */ + [property] boolean HeaderBackTransparent; + + //------------------------------------------------------------------------- + + /** contains the URL of the background graphic of the header. + */ + [property] string HeaderBackGraphicURL; + + //------------------------------------------------------------------------- + + /** contains the filter name of the background graphic of the header. + */ + [property] string HeaderBackGraphicFilter; + + //------------------------------------------------------------------------- + + /** determines the location of the background graphic of the header. + */ + [property] com::sun::star::style::GraphicLocation HeaderBackGraphicLocation; + + //------------------------------------------------------------------------- + + /** contains the left margin of the header (in 1/100 mm). + */ + [property] long HeaderLeftMargin; + + //------------------------------------------------------------------------- + + /** contains the right margin of the header (in 1/100 mm). + */ + [property] long HeaderRightMargin; + + //------------------------------------------------------------------------- + + /** determines the style of the left border line of the header. + */ + [property] com::sun::star::table::BorderLine HeaderLeftBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the right border line of the header. + */ + [property] com::sun::star::table::BorderLine HeaderRightBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the top border line of the header. + */ + [property] com::sun::star::table::BorderLine HeaderTopBorder; + + //------------------------------------------------------------------------- + + /** determines the style of the bottom border line of the header. + */ + [property] com::sun::star::table::BorderLine HeaderBottomBorder; + + //------------------------------------------------------------------------- + + /** determines the left border distance of the header (in 1/100 mm). + */ + [property] long HeaderLeftBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the right border distance of the header (in 1/100 mm). + */ + [property] long HeaderRightBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the top border distance of the header (in 1/100 mm). + */ + [property] long HeaderTopBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the bottom border distance of the header (in 1/100 mm). + */ + [property] long HeaderBottomBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the distance of all borders of the header (in 1/100 mm). + */ + [property] long HeaderBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the distance between the header and the body text area + (in 1/100 mm). + */ + [property] long HeaderBodyDistance; + + //------------------------------------------------------------------------- + + /** determines the shadow of the header. + */ + [property] com::sun::star::table::ShadowFormat HeaderShadowFormat; + + //------------------------------------------------------------------------- + + /** contains the height of the header (in 1/100 mm). + */ + [property] long HeaderHeight; + + //------------------------------------------------------------------------- + + /** determines whether the height of the header depends on the content. + */ + [property] boolean HeaderIsDynamicHeight; + + //------------------------------------------------------------------------- + + /** determines whether the header content on left and right pages + is the same. + */ + [property] boolean HeaderIsShared; + + //------------------------------------------------------------------------- + + /** determines whether a header is used on the page. + */ + [property] boolean HeaderIsOn; + + //------------------------------------------------------------------------- + + /** contains the color of the background of the footer. + */ + [property] long FooterBackColor; + + //------------------------------------------------------------------------- + + /** determines whether the background is transparent. + */ + [property] boolean FooterBackTransparent; + + //------------------------------------------------------------------------- + + /** contains the URL of the background graphic in the footer. + */ + [property] string FooterBackGraphicURL; + + //------------------------------------------------------------------------- + + /** contains the filter name of the background graphic in the footer. + */ + [property] string FooterBackGraphicFilter; + + //------------------------------------------------------------------------- + + /** determines the location of the background graphic in the footer. + */ + [property] com::sun::star::style::GraphicLocation FooterBackGraphicLocation; + + //------------------------------------------------------------------------- + + /** determines the left margin of the footer (in 1/100 mm). + */ + [property] long FooterLeftMargin; + + //------------------------------------------------------------------------- + + /** determines the right margin of the footer (in 1/100 mm). + */ + [property] long FooterRightMargin; + + //------------------------------------------------------------------------- + + /** contains the style of the left border line of the footer. + */ + [property] com::sun::star::table::BorderLine FooterLeftBorder; + + //------------------------------------------------------------------------- + + /** contains the style of the right border line of the footer. + */ + [property] com::sun::star::table::BorderLine FooterRightBorder; + + //------------------------------------------------------------------------- + + /** contains the style of the top border line of the footer. + */ + [property] com::sun::star::table::BorderLine FooterTopBorder; + + //------------------------------------------------------------------------- + + /** contains the style of the bottom border line of the footer. + */ + [property] com::sun::star::table::BorderLine FooterBottomBorder; + + //------------------------------------------------------------------------- + + /** contains the left border distance of the footer (in 1/100 mm). + */ + [property] long FooterLeftBorderDistance; + + //------------------------------------------------------------------------- + + /** contains the right border distance of the footer (in 1/100 mm). + */ + [property] long FooterRightBorderDistance; + + //------------------------------------------------------------------------- + + /** contains the top border distance of the footer (in 1/100 mm). + */ + [property] long FooterTopBorderDistance; + + //------------------------------------------------------------------------- + + /** contains the bottom border distance of the footer (in 1/100 mm). + */ + [property] long FooterBottomBorderDistance; + + //------------------------------------------------------------------------- + + /** contains the distance of all borders of the footer (in 1/100 mm). + */ + [property] long FooterBorderDistance; + + //------------------------------------------------------------------------- + + /** determines the distance between the footer and the body text area + (in 1/100 mm). + */ + [property] long FooterBodyDistance; + + //------------------------------------------------------------------------- + + /** determines the shadow of the footer. + */ + [property] com::sun::star::table::ShadowFormat FooterShadowFormat; + + //------------------------------------------------------------------------- + + /** determines the height of the footer (in 1/100 mm). + */ + [property] long FooterHeight; + + //------------------------------------------------------------------------- + + /** determines whether the height of the footer depends on the content. + */ + [property] boolean FooterIsDynamicHeight; + + //------------------------------------------------------------------------- + + /** determines whether the footer content on left and right pages + is the same. + */ + [property] boolean FooterIsShared; + + //------------------------------------------------------------------------- + + /** determines whether a footer is used on the page. + */ + [property] boolean FooterIsOn; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/style/PageStyleLayout.idl b/offapi/com/sun/star/style/PageStyleLayout.idl index d2430fbd2134..ecfecc391e4f 100644 --- a/offapi/com/sun/star/style/PageStyleLayout.idl +++ b/offapi/com/sun/star/style/PageStyleLayout.idl @@ -2,9 +2,9 @@ * * $RCSfile: PageStyleLayout.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,46 +58,41 @@ * * ************************************************************************/ + #ifndef __com_sun_star_style_PageStyleLayout_idl__ #define __com_sun_star_style_PageStyleLayout_idl__ - //============================================================================= - module com { module sun { module star { module style { +module com { module sun { module star { module style { //============================================================================= -// DocMerge from xml: enum com::sun::star::style::PageStyleLayout -/** spefifies the pages for which a layout is valid. +/** spefifies the pages for which a page layout is valid. */ enum PageStyleLayout { //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::style::PageStyleLayout::ALL /** The page style is identically used for left and right pages. */ ALL, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::style::PageStyleLayout::LEFT /** The page style is only used for left pages. */ LEFT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::style::PageStyleLayout::RIGHT /** The page style is only used for right pages. */ RIGHT, //------------------------------------------------------------------------- - // DocMerge from xml: value com::sun::star::style::PageStyleLayout::MIRRORED - /** The page style is used for left and right pages, but mirrored for + /** The page style is used unchanged for left pages and mirrored for right pages. */ MIRRORED @@ -108,18 +103,5 @@ enum PageStyleLayout }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:54 hjs - initial import - - Revision 1.3 2000/09/11 11:52:55 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/svg/XSVGPrinter.idl b/offapi/com/sun/star/svg/XSVGPrinter.idl index 85b3260fadad..dd8a6157ee19 100644 --- a/offapi/com/sun/star/svg/XSVGPrinter.idl +++ b/offapi/com/sun/star/svg/XSVGPrinter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSVGPrinter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,8 @@ module com { module sun { module star { module svg { -// DocMerge: empty anyway +/** @deprecated +*/ interface XSVGPrinter: com::sun::star::uno::XInterface { // DocMerge: empty anyway @@ -94,6 +95,12 @@ interface XSVGPrinter: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/08 13:21:07 cl + idl review + + Revision 1.4 2001/03/16 16:41:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:44:16 mi moved from api diff --git a/offapi/com/sun/star/svg/XSVGWriter.idl b/offapi/com/sun/star/svg/XSVGWriter.idl index 4577193f9cc7..4389dfc1ea53 100644 --- a/offapi/com/sun/star/svg/XSVGWriter.idl +++ b/offapi/com/sun/star/svg/XSVGWriter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSVGWriter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,8 @@ module com { module sun { module star { module svg { -// DocMerge: empty anyway +/** @deprecated +*/ interface XSVGWriter: com::sun::star::uno::XInterface { // DocMerge: empty anyway @@ -85,6 +86,12 @@ interface XSVGWriter: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/02/08 13:21:07 cl + idl review + + Revision 1.4 2001/03/16 16:41:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:44:16 mi moved from api diff --git a/offapi/com/sun/star/sync/SyncAction.idl b/offapi/com/sun/star/sync/SyncAction.idl index 3e0aa0e4e1ca..d5814cb071ea 100644 --- a/offapi/com/sun/star/sync/SyncAction.idl +++ b/offapi/com/sun/star/sync/SyncAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:45:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,34 +64,28 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { //============================================================================= -// DocMerge from idl: constants com::sun::star::sync::SyncAction /** contains a synchronization element + + @deprecated */ constants SyncAction { - // DocMerge: empty anyway const unsigned long NONE = 0x00000000; - // DocMerge: empty anyway const unsigned long COPY_TO_SERVER = 0x00000001; - // DocMerge: empty anyway const unsigned long COPY_TO_CLIENT = 0x00000002; - // DocMerge: empty anyway const unsigned long REMOVE_FROM_CLIENT = 0x00000100; - // DocMerge: empty anyway const unsigned long REMOVE_FROM_SERVER = 0x00000200; - // DocMerge: empty anyway const unsigned long CONFLICT_UID = 0x01000000; - // DocMerge: empty anyway const unsigned long CONFLICT_AMBIGUITY = 0x02000000; }; @@ -99,24 +93,4 @@ constants SyncAction }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:16 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:54 hjs - initial import - - Revision 1.4 2000/09/11 11:52:56 mi - documentation merged from XML - - Revision 1.2 2000/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncCollector.idl b/offapi/com/sun/star/sync/SyncCollector.idl index 334cfd247d7e..01a883afe513 100644 --- a/offapi/com/sun/star/sync/SyncCollector.idl +++ b/offapi/com/sun/star/sync/SyncCollector.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncCollector.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,11 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { -// DocMerge: empty anyway +/// @deprecated service SyncCollector { - // DocMerge: empty anyway interface com::sun::star::sync::XSyncCollector; }; @@ -81,22 +80,4 @@ service SyncCollector }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2000/10/17 09:13:08 ka - syntax (UCB must changes) - - Revision 1.1.1.1 2000/09/18 23:35:54 hjs - initial import - - Revision 1.3 2000/09/11 11:52:56 mi - documentation merged from XML - - Revision 1.1 2000/01/10 08:47:41 ka - #71663#: initial revision - - -=============================================================================*/ - #endif diff --git a/offapi/com/sun/star/sync/SyncElement.idl b/offapi/com/sun/star/sync/SyncElement.idl index 2b87673fb5ea..da39db8db01c 100644 --- a/offapi/com/sun/star/sync/SyncElement.idl +++ b/offapi/com/sun/star/sync/SyncElement.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncElement.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:45:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,43 +64,38 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { //============================================================================= -// DocMerge from xml: struct com::sun::star::sync::SyncElement /** contains a synchronization element + + @deprecated */ struct SyncElement { - // DocMerge from xml: field com::sun::star::sync::SyncElement::ContentIdentifier /** contains the ContentIdentifier of this synchronization element */ string ContentIdentifier; //------------------------------------------------------------------------- - // DocMerge: empty anyway unsigned long Type; //------------------------------------------------------------------------- - // DocMerge: empty anyway unsigned long UID; //------------------------------------------------------------------------- - // DocMerge: empty anyway unsigned long Generation; //------------------------------------------------------------------------- - // DocMerge: empty anyway unsigned long Event; //------------------------------------------------------------------------- - // DocMerge: empty anyway unsigned long Action; }; @@ -108,24 +103,4 @@ struct SyncElement }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:16 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:54 hjs - initial import - - Revision 1.4 2000/09/11 11:52:56 mi - documentation merged from XML - - Revision 1.2 2000/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncEvent.idl b/offapi/com/sun/star/sync/SyncEvent.idl index 555a7688b321..889dcdb72329 100644 --- a/offapi/com/sun/star/sync/SyncEvent.idl +++ b/offapi/com/sun/star/sync/SyncEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:45:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,25 +64,22 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { //============================================================================= -// DocMerge from idl: constants com::sun::star::sync::SyncEvent /** contains a synchronization element + + @deprecated */ constants SyncEvent { - // DocMerge: empty anyway const unsigned long NONE = 0; - // DocMerge: empty anyway const unsigned long CREATED = 1; - // DocMerge: empty anyway const unsigned long DELETED = 2; - // DocMerge: empty anyway const unsigned long CHANGED = 3; }; @@ -90,21 +87,4 @@ constants SyncEvent }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:54 hjs - initial import - - Revision 1.3 2000/09/11 11:52:56 mi - documentation merged from XML - - Revision 1.1 2000/01/10 08:47:41 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncInfo.idl b/offapi/com/sun/star/sync/SyncInfo.idl index c84207a336ed..3cd8c78724e4 100644 --- a/offapi/com/sun/star/sync/SyncInfo.idl +++ b/offapi/com/sun/star/sync/SyncInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,28 +68,23 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { typedef sequence< string > FilterData; //============================================================================= -// DocMerge: empty anyway +/// @deprecated struct SyncInfo { - // DocMerge: empty anyway SyncScheme ServerScheme; - // DocMerge: empty anyway SyncScheme ClientScheme; - // DocMerge: empty anyway FilterData SyncFilter; - // DocMerge: empty anyway unsigned long SyncMode; - // DocMerge: empty anyway unsigned long SyncOptions; }; @@ -97,21 +92,4 @@ struct SyncInfo }; }; }; }; -/*============================================================================= - - $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:56 mi - documentation merged from XML - - Revision 1.2 2000/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncMode.idl b/offapi/com/sun/star/sync/SyncMode.idl index fb38a24a2cbf..975d4193dd35 100644 --- a/offapi/com/sun/star/sync/SyncMode.idl +++ b/offapi/com/sun/star/sync/SyncMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncMode.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:45:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,18 +68,16 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::sync::SyncMode /** contains a synchronization element + + @deprecated */ constants SyncMode { - // DocMerge: empty anyway const unsigned long NONE = 0x00000000; - // DocMerge: empty anyway const unsigned long CLIENT_TO_SERVER = 0x00000001; - // DocMerge: empty anyway const unsigned long SERVER_TO_CLIENT = 0x00000002; }; @@ -87,21 +85,4 @@ constants SyncMode }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:17 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:56 mi - documentation merged from XML - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncOptions.idl b/offapi/com/sun/star/sync/SyncOptions.idl index 41f1ded433d3..b10e123bcd39 100644 --- a/offapi/com/sun/star/sync/SyncOptions.idl +++ b/offapi/com/sun/star/sync/SyncOptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncOptions.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:45:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,31 +64,26 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { //============================================================================= -// DocMerge from idl: constants com::sun::star::sync::SyncOptions /** contains a synchronization element + + @deprecated */ constants SyncOptions { - // DocMerge: empty anyway const unsigned long NONE = 0x00000000; - // DocMerge: empty anyway const unsigned long DONT_COPY = 0x00000001; - // DocMerge: empty anyway const unsigned long DONT_REMOVE = 0x00000002; - // DocMerge: empty anyway const unsigned long SERVER_WINS = 0x00000100; - // DocMerge: empty anyway const unsigned long CLIENT_WINS = 0x00000200; - // DocMerge: empty anyway const unsigned long CREATE_BACKUP = 0x00010000; }; @@ -96,21 +91,4 @@ constants SyncOptions }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:17 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 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncScheme.idl b/offapi/com/sun/star/sync/SyncScheme.idl index 8c2f41c62abf..cdaf0279740e 100644 --- a/offapi/com/sun/star/sync/SyncScheme.idl +++ b/offapi/com/sun/star/sync/SyncScheme.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncScheme.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,19 +66,18 @@ module com { module sun { module star { module sync { -// DocMerge from xml: struct com::sun::star::sync::SyncScheme /** contains the scheme name of this SyncScheme + + @derepcated */ struct SyncScheme { - // DocMerge from xml: field com::sun::star::sync::SyncScheme::Scheme /** contains the scheme name of this SyncScheme */ string Scheme; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::sync::SyncScheme::Root /** contains the root for this SyncScheme */ string Root; @@ -88,18 +87,4 @@ struct SyncScheme }; }; }; }; -/*============================================================================= - - $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 2000/01/10 08:47:41 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/SyncType.idl b/offapi/com/sun/star/sync/SyncType.idl index 177d57386db1..91a140176daf 100644 --- a/offapi/com/sun/star/sync/SyncType.idl +++ b/offapi/com/sun/star/sync/SyncType.idl @@ -2,9 +2,9 @@ * * $RCSfile: SyncType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,32 +64,25 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { //============================================================================= -// DocMerge: empty anyway +/// @deprecated constants SyncType { - // DocMerge: empty anyway const unsigned long NONE = 0; - // DocMerge: empty anyway const unsigned long FILE = 1; - // DocMerge: empty anyway const unsigned long FOLDER = 2; - // DocMerge: empty anyway const unsigned long VFS_FILE = 3; - // DocMerge: empty anyway const unsigned long VFS_FOLDER = 4; - // DocMerge: empty anyway const unsigned long POP3 = 5; - // DocMerge: empty anyway const unsigned long IMAP = 6; }; @@ -97,21 +90,4 @@ constants SyncType }; }; }; }; -/*============================================================================= - - $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/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/Synchronizer.idl b/offapi/com/sun/star/sync/Synchronizer.idl index 4c09e0eb3141..d579691a9aa6 100644 --- a/offapi/com/sun/star/sync/Synchronizer.idl +++ b/offapi/com/sun/star/sync/Synchronizer.idl @@ -2,9 +2,9 @@ * * $RCSfile: Synchronizer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,11 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { -// DocMerge: empty anyway +/// @deprecated service Synchronizer { - // DocMerge: empty anyway interface com::sun::star::sync::XSynchronizer; }; @@ -81,19 +80,4 @@ service Synchronizer }; }; }; }; -/*============================================================================= - - $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 2000/01/10 08:47:41 ka - #71663#: initial revision - - -=============================================================================*/ - #endif diff --git a/offapi/com/sun/star/sync/XSyncCollector.idl b/offapi/com/sun/star/sync/XSyncCollector.idl index 428197f0d168..71cc0f4556a9 100644 --- a/offapi/com/sun/star/sync/XSyncCollector.idl +++ b/offapi/com/sun/star/sync/XSyncCollector.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSyncCollector.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:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,48 +80,37 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { -// DocMerge: empty anyway +/// @deprecated interface XSyncCollector: com::sun::star::uno::XInterface { - // DocMerge: empty anyway boolean initialize( [in] com::sun::star::ucb::XContentProviderManager xMgr, [in] sequence<com::sun::star::sync::SyncScheme> aSyncSchemes, [in] string aBaseFileName ); - // DocMerge: empty anyway sequence<com::sun::star::sync::SyncScheme> getRegisteredSyncSchemes(); - // DocMerge: empty anyway sequence<com::sun::star::sync::SyncElement> getSyncSequence( [in] string aSyncSchemeName, [in] com::sun::star::sync::SyncInfo aSyncInfo ); - // DocMerge: empty anyway [oneway] void beginSynchronize(); - // DocMerge: empty anyway [oneway] void endSynchronize(); - // DocMerge: empty anyway boolean getCorrespondingElement( [in] com::sun::star::sync::SyncScheme aSyncSchemeIn, [in] com::sun::star::sync::SyncElement aSyncElementIn, [out] com::sun::star::sync::SyncElement aSyncElementOut ); - // DocMerge: empty anyway boolean executeElementCommand( [in] string aSyncSchemeName, [in] com::sun::star::sync::SyncElement aSyncElement, [in] string aCommandName, [out] any aAny ); - // DocMerge: empty anyway [oneway] void elementSynchronized( [in] string aSyncSchemeName, [in] com::sun::star::sync::SyncElement aSyncElement, [in] unsigned long nSyncAction ); - // Dummy !!! => Remove - - // DocMerge: empty anyway [oneway] void notify( [in] com::sun::star::ucb::XContent XCnt, [in] unsigned long nEvent ); }; @@ -130,24 +119,4 @@ interface XSyncCollector: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:17 mi - moved from api - - 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/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:43 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/sync/XSynchronizer.idl b/offapi/com/sun/star/sync/XSynchronizer.idl index 74e1ce90a9f2..8a874f4903a6 100644 --- a/offapi/com/sun/star/sync/XSynchronizer.idl +++ b/offapi/com/sun/star/sync/XSynchronizer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSynchronizer.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:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,24 +71,20 @@ //============================================================================= - module com { module sun { module star { module sync { +module com { module sun { module star { module sync { -// DocMerge: empty anyway +/// @deprecated interface XSynchronizer: com::sun::star::uno::XInterface { - // DocMerge: empty anyway boolean beginSynchronize( [in] com::sun::star::sync::XSyncCollector xClientCollector, [in] com::sun::star::sync::XSyncCollector xServerCollector, [in] string aSchemeName, [in] FilterData aFilterData, [in] unsigned long nSyncMode, [in] unsigned long nSyncOptions ); - // DocMerge: empty anyway boolean getSyncList( [out] sequence<com::sun::star::sync::SyncElement> aSyncSeq ); - // DocMerge: empty anyway boolean performSync( [in] sequence<com::sun::star::sync::SyncElement> aSyncSeq ); - // DocMerge: empty anyway boolean endSynchronize(); }; @@ -96,24 +92,4 @@ interface XSynchronizer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:17 mi - moved from api - - 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/01/24 16:10:48 ka - #71663#: Sync extended - - Revision 1.1 2000/01/10 08:47:42 ka - #71663#: initial revision - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/system/ProxySettings.idl b/offapi/com/sun/star/system/ProxySettings.idl index 3f4ac3b1e598..2a4c97f92526 100644 --- a/offapi/com/sun/star/system/ProxySettings.idl +++ b/offapi/com/sun/star/system/ProxySettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProxySettings.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-06-28 13:34:58 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ interface XProxySettings; //============================================================================= /** Specifies a service for reading the proxy settings from an old office - installation. + installation or a central system database. @see com::sun::star::system::XProxySettings */ @@ -88,19 +88,17 @@ interface XProxySettings; service ProxySettings { //------------------------------------------------------------------------- - /** Provides access to a XProxySettings interface. - - @see com::sun::star::system::XProxySettings + /** Provides access to a <type>XProxySettings</type> interface. */ interface XProxySettings; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/system/SOffice52ProxySettings.idl b/offapi/com/sun/star/system/SOffice52ProxySettings.idl index d941a1da7872..71148fa964c3 100644 --- a/offapi/com/sun/star/system/SOffice52ProxySettings.idl +++ b/offapi/com/sun/star/system/SOffice52ProxySettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SOffice52ProxySettings.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-07-03 11:22:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ module com { module sun { module star { module system { /** Specifies a service for reading the proxy settings from an old StarOffice 5.2 installation. - @see com::sun::star::system::XProxySettings + @see com::sun::star::system::ProxySettings */ service SOffice52ProxySettings diff --git a/offapi/com/sun/star/system/SimpleCommandMail.idl b/offapi/com/sun/star/system/SimpleCommandMail.idl index 27ef75aa7214..4f0992b91a06 100644 --- a/offapi/com/sun/star/system/SimpleCommandMail.idl +++ b/offapi/com/sun/star/system/SimpleCommandMail.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleCommandMail.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,7 +85,7 @@ interface XSimpleMailClientSupplier; //============================================================================= /** Specifies a SimpleCommandMail service. Implementations of such a service, do implement an interface to send mail messages via the current configured - command line mail app. + command line mail application. @see com::sun::star::system::XSimpleMailClient */ @@ -93,24 +93,22 @@ interface XSimpleMailClientSupplier; service SimpleCommandMail { //------------------------------------------------------------------------- - /** Provides access to a XSimpleMailClientSupplier interface. - - @see com::sun::star::system::XSimpleMailClientSupplier + /** Provides access to a <type>XSimpleMailClientSupplier</type> interface. */ interface XSimpleMailClientSupplier; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; //------------------------------------------------------------------------- - /** needed to store command line profiles in configuration + /** Nneeded to store command line profiles in configuration */ needs com::sun::star::configuration::ConfigurationProvider; }; diff --git a/offapi/com/sun/star/system/SimpleMailClientFlags.idl b/offapi/com/sun/star/system/SimpleMailClientFlags.idl index 19f46daed86f..fe5d79d7b16d 100644 --- a/offapi/com/sun/star/system/SimpleMailClientFlags.idl +++ b/offapi/com/sun/star/system/SimpleMailClientFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleMailClientFlags.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 23:24:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ module com { module sun { module star { module system { constants SimpleMailClientFlags { //--------------------------------------------------------------------- - /** Uses the default settings when sending a mail, for example, + /** Uses the default settings when sending a mail, e.g. launches the current configured system mail client. */ const long DEFAULTS = 0; @@ -82,10 +82,9 @@ constants SimpleMailClientFlags /** Does not show the current configured system mail client, but sends the mail without any further user interaction. If this flag is specified, a recipient address must have been - specified for the given ::com::sun::star::system::XMail object - given to the sendMail method. - - @see ::som::sun::star::system::XSimpleMailClient + specified for the given <type>XSimpleMailMessage</type> + object given to the method + <member scope="com::sun::star::system">XSimpleMailClient::sendSimpleMailMessage()</member>. */ const long NO_USER_INTERFACE = 1; @@ -93,9 +92,9 @@ constants SimpleMailClientFlags /** No logon dialog should be displayed to prompt the user for logon information if necessary. When this flag is specified and the user needs to logon in order - to send the mail via the method sendMail of - ::com::sun::star::system::XSimpleMailClient, an Exception will - be thrown. + to send a simple mail message via the method + <member scope="com::sun::star::system">XSimpleMailClient::sendSimpleMailMessage()</member>, + an Exception will be thrown. */ const long NO_LOGON_DIALOG = 2; }; diff --git a/offapi/com/sun/star/system/SimpleSystemMail.idl b/offapi/com/sun/star/system/SimpleSystemMail.idl index fc97171431f2..1324e644d8ab 100644 --- a/offapi/com/sun/star/system/SimpleSystemMail.idl +++ b/offapi/com/sun/star/system/SimpleSystemMail.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleSystemMail.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 23:31:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,19 +89,17 @@ interface XSimpleMailClientSupplier; service SimpleSystemMail { //------------------------------------------------------------------------- - /** Provides access to an XSimpleMailClientSupplier interface. - - @see com::sun::star::system::XSimpleMailClientSupplier + /** Provides access to a <type>XSimpleMailClientSupplier</type> interface. */ interface XSimpleMailClientSupplier; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/system/SystemProxySettings.idl b/offapi/com/sun/star/system/SystemProxySettings.idl index 2b60bf36b6fa..d44588f2373f 100644 --- a/offapi/com/sun/star/system/SystemProxySettings.idl +++ b/offapi/com/sun/star/system/SystemProxySettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemProxySettings.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-06-28 13:35:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,9 +80,7 @@ module com { module sun { module star { module system { //============================================================================= /** Specifies a service for reading the system proxy settings. Some systems - store this information in a central config database. - - @see com::sun::star::system::XProxySettings + store this information in a central configuration database. */ service SystemProxySettings diff --git a/offapi/com/sun/star/system/SystemShellExecute.idl b/offapi/com/sun/star/system/SystemShellExecute.idl index 4bf34d6b100f..0bcdec8f07b8 100644 --- a/offapi/com/sun/star/system/SystemShellExecute.idl +++ b/offapi/com/sun/star/system/SystemShellExecute.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemShellExecute.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 23:27:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,8 @@ module com { module sun { module star { module system { interface XSystemShellExecute; //============================================================================= -/** Specifies a SystemExecute service. Implementations of such a service -implement an interface to execute an arbitrary system command. +/** Specifies a system executer service. Such a service makes it possible + to execute an arbitrary system command. @see com::sun::star::system::XSystemShellExecute */ @@ -88,19 +88,17 @@ implement an interface to execute an arbitrary system command. service SystemShellExecute { //------------------------------------------------------------------------- - /** Provides access to an XSystemExecute interface. - - @see com::sun::star::system::XSystemShellExecute + /** Provides access to a <type>XSystemShellExecute</type> interface. */ interface XSystemShellExecute; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/system/SystemShellExecuteException.idl b/offapi/com/sun/star/system/SystemShellExecuteException.idl index 566f8ddc4bb3..47b4b24bb372 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteException.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemShellExecuteException.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 23:29:42 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,14 +71,17 @@ module com { module sun { module star { module system { //============================================================================= -/** SystemExecuteException - the inherited member of ::com::sun::star::uno::Exception may contain a +/** May be thrown in cases of errors executing a command using the <type>SystemShellExecute</type> service. + <member scope="com::sun::star::uno">Exception::Message</member> may contain a system error message, but it is not mandatory. The member PosixError specifies a POSIX conforming error code or -1 for unknown errors. */ exception SystemShellExecuteException: com::sun::star::uno::Exception { + //========================================================================= + /** A Posix conforming error code or -1 for unknown errors. + */ long PosixError; }; diff --git a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl index e900ec20e794..94435dcf78f1 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemShellExecuteFlags.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 23:32:58 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,19 +66,19 @@ module com { module sun { module star { module system { //============================================================================= -/** These constants are used to specify a mode of the ShellExecute-Service. +/** Different settings for the <type>SystemShellExecute</type> service. */ constants SystemShellExecuteFlags { //--------------------------------------------------------------------- - /** Uses the default settings for the execute command. + /** Uses the default settings for executing commands. */ const long DEFAULTS = 0; //--------------------------------------------------------------------- /** Prevents the display of system error message boxes if the - method execute of ::com::sun::star::sys::XSystemExecute fails. + method <member scope="com::sun::star::system">XSystemShellExecute::execute()</member> fails. */ const long NO_SYSTEM_ERROR_MESSAGE = 1; }; diff --git a/offapi/com/sun/star/system/XProxySettings.idl b/offapi/com/sun/star/system/XProxySettings.idl index e73373e53925..22b6e2d99b8c 100644 --- a/offapi/com/sun/star/system/XProxySettings.idl +++ b/offapi/com/sun/star/system/XProxySettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProxySettings.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,95 +75,95 @@ module com { module sun { module star { module system { //============================================================================= -/** - @author tra - @version 0.1 +/** Enables access to different proxy settings. If particular settings are not + available an empty string will be returned. */ interface XProxySettings: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** Access to the Ftp proxy address. @returns - the address of the ftp proxy server, if any has been specified + The address of the ftp proxy server, if any has been specified. */ string getFtpProxyAddress( ); //------------------------------------------------------------------------- - /** + /** Access to the Ftp proxy port. @returns - the port of the ftp proxy server, if any has been specified + The port of the ftp proxy server, if any has been specified. */ string getFtpProxyPort( ); //------------------------------------------------------------------------- - /** + /** Access to the Gopher proxy address. @returns - the address of the gopher proxy server, if any has been specified + The address of the gopher proxy server, if any has been specified. */ string getGopherProxyAddress( ); //------------------------------------------------------------------------- - /** + /** Access to the Gopher proxy port. @returns - the port of the gopher proxy server, if any has been specified + The port of the gopher proxy server, if any has been specified. */ string getGopherProxyPort( ); //------------------------------------------------------------------------- - /** + /** Access to the Http proxy address. @returns - the address of the http proxy server, if any has been specified + The address of the http proxy server, if any has been specified. */ string getHttpProxyAddress( ); //------------------------------------------------------------------------- - /** + /** Access to the Http proxy port. @returns - the port of the http proxy server, if any has been specified + The port of the http proxy server, if any has been specified. */ string getHttpProxyPort( ); //------------------------------------------------------------------------- - /** + /** Access to the Https proxy address. @returns - the address of the https proxy server, if any has been specified + The address of the https proxy server, if any has been specified. */ string getHttpsProxyAddress( ); //------------------------------------------------------------------------- - /** + /** Access to the Https proxy port. @returns - the port of the https proxy server, if any has been specified + The port of the https proxy server, if any has been specified. */ string getHttpsProxyPort( ); //------------------------------------------------------------------------- - /** + /** Access to the Socks proxy address. @returns - the address of the socks proxy server, if any has been specified + The address of the socks proxy server, if any has been specified. */ string getSocksProxyAddress( ); //------------------------------------------------------------------------- - /** + /** Access to the Socks proxy port. @returns - the port of the socks proxy server, if any has been specified + The port of the socks proxy server, if any has been specified. */ string getSocksProxyPort( ); //------------------------------------------------------------------------- - /** + /** Access to the Proxy-Bypass address. @returns - a string of ';' separated addresses for which no proxy server - should be used + A string of ';' separated addresses for which no proxy server + should be used. */ string getProxyBypassAddress( ); //------------------------------------------------------------------------- - /** + /** Either a proxy is enabled or not. @returns - if the proxy is enabled or disabled + A value of <TRUE/> if a proxy is enabled. + <p>A value of <FALSE/> if a proxy is disabled.</p> */ boolean isProxyEnabled( ); }; diff --git a/offapi/com/sun/star/system/XSimpleMailClient.idl b/offapi/com/sun/star/system/XSimpleMailClient.idl index 167b1c746edc..edee3a8d8656 100644 --- a/offapi/com/sun/star/system/XSimpleMailClient.idl +++ b/offapi/com/sun/star/system/XSimpleMailClient.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleMailClient.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: arellano $ $Date: 2001-07-17 15:40:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,42 +87,45 @@ module com { module sun { module star { module system { //============================================================================= -/** specifies an interface. - - @author tra - @version 0.1 +/** Specifies an interface for creating and sending email messages. */ interface XSimpleMailClient: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** Create a simple mail message object that implements the interface + <type>XSimpleMailMessage</type>. @returns - an object that implements the ::com::sun::star::system::XSimpleMailMessage interface. + An object that implements the <type>XSimpleMailMessage</type> interface. */ XSimpleMailMessage createSimpleMailMessage( ); //------------------------------------------------------------------------- - /** sends the given mail object. + /** Sends a given simple mail message object that implements the interface + <type>XSimpleMailMessage</type>. @param xSimpleMailMessage - specifies a configured mail object to be sent. + Specifies a configured mail object to be sent. @param aFlag - specifies different flags that control the send process + Specifies different flags that control the send process if the flag NO_USER_INTERFACE is specified. A recipient address must have been specified for the given xMailMessage object. - @throws ::com::sun::star::lang::IllegalArgumentException - if invalid or excluding flags have been specified or if the - flag NO_USER_INTERFACE is specified and no recipient - address has been specified for the given xMailMessage object. + @throws com::sun::star::lang::IllegalArgumentException + <ul> + <li>If invalid or excluding flags have been specified.</li> + <li>The flag NO_USER_INTERFACE is specified and no recipient + address has been specified for the given xSimpleMailMessage object.</li> + <li>The parameter xSimpleMailMessage is NULL.</li> + </ul> - @throws ::com::sun::star::uno::Exception - if an error occurs while sending the mail. The Message - member of the exception may contain an error description. + @throws com::sun::star::uno::Exception + if an error occurs while sending the mail. + <p>The Message member of the exception may contain an error description.</p> - @see ::com::sun::star::system::SimpleMailClientFlags + @see com::sun::star::system::XSimpleMailMessage + @see com::sun::star::system::SimpleMailClientFlags */ void sendSimpleMailMessage( [in] XSimpleMailMessage xSimpleMailMessage, [in] long aFlag ) raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl index 27f2dc85cd36..3cc60f8d2831 100644 --- a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl +++ b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleMailClientSupplier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: arellano $ $Date: 2001-07-16 15:57:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,22 +83,22 @@ module com { module sun { module star { module system { //============================================================================= -/** specifies an interface for executing a system command. +/** Implementations of this interface do provide access to a simple mail client + if there is one available - @author tra - @version 0.1 - - <!-- Dennis: Should the previous two lines be in the comments? --> + @see com::sun::star::system::XSimpleMailClient */ - interface XSimpleMailClientSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** Allows a client to query for an object that implements + <type>XSimpleMailClient</type>. @returns - an interface to a mail client if there is one available on the system - or an empty reference. + An interface to a simple mail client if there is one available on the system + or an empty reference else. + + @see com::sun::star::system::XSimpleMailClient */ XSimpleMailClient querySimpleMailClient( ); }; diff --git a/offapi/com/sun/star/system/XSimpleMailMessage.idl b/offapi/com/sun/star/system/XSimpleMailMessage.idl index 6a6369e571b3..da9e0651108a 100644 --- a/offapi/com/sun/star/system/XSimpleMailMessage.idl +++ b/offapi/com/sun/star/system/XSimpleMailMessage.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleMailMessage.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,108 +79,114 @@ module com { module sun { module star { module system { //============================================================================= -/** specifies a simple mail messaging interface. -<!-- Editor: Missing summary --> - - @author tra - @version 0.1 +/** This interface lets a client set or get the information of a simple mail + message. */ interface XSimpleMailMessage: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** + /** To set the recipient of the simple mail message. @param aRecipient - the email address of a recipient. The method doesn't check if - the given address is valid. + The email address of a recipient. The method doesn't check if + the given email address is valid. */ void setRecipient( [in] string aRecipient ); //------------------------------------------------------------------------- - /** + /** To get the recipient of the simple mail message. @returns - the specified email address of a recipient + The specified email address of a recipient if any has been specified or an empty string. */ string getRecipient( ); //------------------------------------------------------------------------- - /** + /** To set the cc recipients of a simple mail message. + @param aCcRecipient - sets a sequence with the email addresses of one or more cc recipients. - The method does not check if the given addresses are valid. + Sets a sequence with the email addresses of one or more cc recipients. + <p>The method does not check if the given addresses are valid. An empty + sequence means there are no cc recipients.</p> */ void setCcRecipient( [in] sequence< string > aCcRecipient ); //------------------------------------------------------------------------- - /** + /** To get the cc recipients of a simple mail message. @returns - a sequence with the email addresses of one or more cc recipients - or an empty sequence if no cc recipients have been specified. + A sequence with the email addresses of one or more cc recipients. + <p>If no cc recipients have been specified an empty sequence will be returned.</p> */ sequence< string > getCcRecipient( ); //------------------------------------------------------------------------- - /** + /** To set the bcc recipient of a simple mail message. @param aBccRecipient - sets a sequence with the email addresses of one or more bcc recipients. + A sequence with the email addresses of one or more bcc recipients. An empty + sequence means there are no bcc recipients.</p> */ void setBccRecipient( [in] sequence< string > aBccRecipient ); //------------------------------------------------------------------------- - /** + /** To get the bcc recipients of a simple mail message. @returns - a sequence with the email addresses of one or more bcc recipients or an - empty sequence if no bcc recipients have been specified. */ + A sequence with the email addresses of one or more bcc recipients. + <p>If no bcc recipients have been specified an empty sequence will be returned.</p> + */ sequence< string > getBccRecipient( ); //------------------------------------------------------------------------- - /** + /** To set the email address of the originator of a simple mail message. @param aOriginator - sets the email address of the originator of the mail. */ + Sets the email address of the originator of the mail. + */ void setOriginator( [in] string aOriginator ); //------------------------------------------------------------------------- - /** + /** To get the email address of the originator of a simple mail message. @returns - the email address of the originator of the mail, if any has been specified. + The email address of the originator of the mail. + <p>If no originator has been specified an empty string will be returned.</p> */ string getOriginator( ); //------------------------------------------------------------------------- - /** + /** To set the subject of a simple mail message. @param aSubject - sets the subject of the mail. + Sets the subject of the simple mail message. */ void setSubject( [in] string aSubject ); //------------------------------------------------------------------------- - /** + /** To get the subject of a simple mail message. @returns - the subject of the mail if any has been specified. + The subject of the simple mail message. + <p>If no subject has been specified an empty string will be returned.</p> */ string getSubject( ); //------------------------------------------------------------------------- - /** + /** To set an attachment of a simple mail message. @param aAttachement - sets a sequence of File-URL specifying the files that should be - attached to the mail. The method does not check if the specified - file or files really exist. + Sets a sequence of file URLs specifying the files that should be + attached to the mail. The given file URLs must be conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. + The method does not check if the specified file or files really exist. @throws ::com::sun::star::lang::IllegalArgumentException - if at least one of the given File-URLs is invalid. + if at least one of the given file URLs is invalid (doesn't conform to + <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). */ void setAttachement( [in] sequence< string > aAttachement ) raises( ::com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - /** + /** To get the attachment of a simple mail message. @returns - a sequence of File-URLs specifying the files that should be attached to + A sequence of file URLs specifying the files that should be attached to the mail or an empty sequence if no attachments have been specified. -<!-- jrh: Note: Attachement is spelled attachment. Doesn't matter in methods. --> + The returned file URLs are conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. */ sequence< string > getAttachement( ); }; diff --git a/offapi/com/sun/star/system/XSystemShellExecute.idl b/offapi/com/sun/star/system/XSystemShellExecute.idl index 723c3a5f5d22..e271a87555c1 100644 --- a/offapi/com/sun/star/system/XSystemShellExecute.idl +++ b/offapi/com/sun/star/system/XSystemShellExecute.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSystemShellExecute.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 16:57:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,12 +83,7 @@ module com { module sun { module star { module system { //============================================================================= -/** specifies an interface for executing a system command. - - @author tra - @version 0.1 - - <!-- Editor: Do the @ tags belong here? --> +/** Specifies an interface for executing a system command. */ @@ -98,27 +93,28 @@ interface XSystemShellExecute: com::sun::star::uno::XInterface /** Executes an abitrary system command. @param aCommand - specifies the command to execute. This may be an executable file or a - document which is registered with an application, etc. + Specifies the command to execute. This may be an executable file or a + document which is registered with an application on a specific platform, + so that the platform knows what application to launch for that document. If the command specifies a path to an executable, etc, this has to be a system specific path. - <!-- Editor: What is meant by etc. here? --> - @param aParameter - specifies a list of space separated parameters. The method does not - validate the given parameter, but only passes it as a parameter to the + Specifies a list of space separated parameters. The method does not + validate the given parameters, but only passes it as a parameter to the specified command. @param nFlags - specifies different flags to control the execution of this method, for example, + Specifies different flags to control the execution of this method, for example, avoid showing system error messages, in case of failures, etc. - @see ::com::sun::star::sys::shell::SystemShellExecuteFlags - @throws - a ::com::sun::star::lang::IllegalArgumentException when the specified - flags are wrong or exclude each other. -. a ::com::sun::star::sys::SystemExecuteException in the case of errors. + @throws com::sun::star::lang::IllegalArgumentException + when the specified flags are wrong or exclude each other. +. + @throws com::sun::star::sys::SystemExecuteException + in the case of errors when trying to executed the specified command. + + @see com::sun::star::system::SystemShellExecuteFlags */ void execute( [in] string aCommand, [in] string aParameter, [in] long nFlags ) raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::system::SystemShellExecuteException ); 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 + diff --git a/offapi/com/sun/star/task/InteractionClassification.idl b/offapi/com/sun/star/task/InteractionClassification.idl index 81fb4e3610e4..84025075c9e9 100644 --- a/offapi/com/sun/star/task/InteractionClassification.idl +++ b/offapi/com/sun/star/task/InteractionClassification.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionClassification.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,6 +70,9 @@ // DocMerge from xml: enum com::sun::star::task::InteractionClassification /** A classification of interaction requests. + + @see com::sun::star::task::ClassifiedInteractionRequest + This is the base of classified interaction requests. */ enum InteractionClassification { @@ -91,15 +94,19 @@ enum InteractionClassification // DocMerge from xml: value com::sun::star::task::InteractionClassification::INFO /** Some information for the client/user (which will typically lead to the - selection of an XInteractionApprove continuation). + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> + continuation). */ INFO, //------------------------------------------------------------------------- // DocMerge from xml: value com::sun::star::task::InteractionClassification::QUERY - /** A query for the client/user, (which will typically lead to the - selection of an XInteractionApprove or XInteractionDisapprove + /** A query for the client/user (which will typically lead to the + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> or + <type scope="com::sun::star::task">XInteractionDisapprove</type> continuation). */ QUERY @@ -113,6 +120,12 @@ enum InteractionClassification /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/03/13 10:01:24 sb + #98102# Cosmetic changes. + + Revision 1.3 2000/11/08 12:44:23 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:56 hjs initial import diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl index 9a90e2b7dc61..493bfab25a64 100644 --- a/offapi/com/sun/star/task/InteractionHandler.idl +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:52:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,67 +72,76 @@ module com { module sun { module star { module task { //============================================================================ /** An interaction request handler that lets the user handle a number of well known requests via GUI dialogs (and the - <type>com::sun::star::task::PasswordContainer</type> service). + <type scope="com::sun::star::task">PasswordContainer</type> service). <P>The well known requests handled by this service include - <type>com::sun::star::java::WrongJavaVersionException</type>*, - <type>com::sun::star::sync2::BadPartnershipException</type>*, - <type>com::sun::star::task::PasswordRequest</type>, - <type>com::sun::star::ucb::AuthenticationRequest</type>, - <type>com::sun::star::ucb::HandleCookiesRequest</type>, - <type>com::sun::star::ucb::InteractiveAugmentedIOException</type>*, - <type>com::sun::star::ucb::InteractiveCHAOSException</type>*, - <type>com::sun::star::ucb::InteractiveFileIOException</type>*, - <type>com::sun::star::ucb::InteractiveIOException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkConnectException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkGeneralException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkOffLineException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkReadException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkResolveNameException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkWriteException</type>*, and - <type>com::sun::star::ucb::InteractiveWrongMediumException</type>*. The - requests marked with an asterisk are only handled if (a) their + <UL> + <LI><type scope="com::sun::star::ucb">AuthenticationRequest</type></LI> + <LI><type scope="com::sun::star::sync2">BadPartnershipException</type>*</LI> + <LI><type scope="com::sun::star::ucb">HandleCookiesRequest</type></LI> + <LI><type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveCHAOSException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveFileIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkConnectException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkGeneralException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkOffLineException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkReadException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkResolveNameException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkWriteException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveWrongMediumException</type>*</LI> + <LI><type scope="com::sun::star::task">PasswordRequest</type></LI> + <LI><type scope="com::sun::star::java">WrongJavaVersionException</type>*</LI> + </UL> + The requests marked with an asterisk are only handled if (a) their continuations match certain restrictions (see below), and (b) the necessary resource strings are available (this can be exploited by applications that carry only a subset of all resource files with them).</P> - <P>The continuation restrictions are as follows: Let C be the subset of - the provided continuations that are of type - <type>com::sun::star::task::XInteractionApprove</type>, - <type>com::star::task::XInteractionDisapprove</type>, - <type>com::star::task::XInteractionRetry</type>, or - <type>com::star::task::XInteractionAbort</type> (or of a derived type). - All other continuations are ignored for these requests. The request is - only handled if the set C is any of the following: + <P>The continuation restrictions are as follows: Let <VAR>C</VAR> be the + subset of the provided continuations that are of type + <type scope="com::sun::star::task">XInteractionApprove</type>, + <type scope="com::sun::star::task">XInteractionDisapprove</type>, + <type scope="com::sun::star::task">XInteractionRetry</type>, or + <type scope="com::sun::star::task">XInteractionAbort</type> (or of a + derived type). All other continuations are ignored for these requests. + The request is only handled if the set <VAR>C</VAR> is any of the + following: <UL> - <IL>Abort</IL> - <IL>Retry, Abort</IL> - <IL>Approve</IL> - <IL>Approve, Abort</IL> - <IL>Approve, Disapprove</IL> - <IL>Approve, Disapprove, Abort</IL> + <LI>Abort</LI> + <LI>Retry, Abort</LI> + <LI>Approve</LI> + <LI>Approve, Abort</LI> + <LI>Approve, Disapprove</LI> + <LI>Approve, Disapprove, Abort</LI> </UL></P> - <P>A <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> + <P>An + <type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type> carries with it a sequence of arguments, which should be - <type>com::sun::star::beans::PropertyValue</type>s. The following details - which properties are interpreted by the interaction handler, depending on - the request's <type>com::sun::star::ucb::IOErrorCode</type>: + <type scope="com::sun::star::beans">PropertyValue</type>s. The following + details which properties are interpreted by the interaction handler, + depending on the request's + <type scope="com::sun::star::ucb">IOErrorCode</type>: <DL> <DT><code>"Uri"</code></DT> - <DD>All error codes except <const>DIFFERENT_DEVICES</const>. The URI - of the involved resource (a <atom>string</atom>).</DD> + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + The URI of the involved resource (a <atom>string</atom>).</DD> <DT><code>"ResourceName"</code></DT> - <DD>All error codes except <const>DIFFERENT_DEVICES</const>. A name - for the involved resource (a <atom>string</atom>) that might be more - meaningful to the user than the URI. For example, a + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + A name for the involved resource (a <atom>string</atom>) that might be + more meaningful to the user than the URI. For example, a (platform-dependent) path notation for file system resources.</DD> <DT><code>"ResourceType"</code></DT> - <DD><const>DEVICE_NOT_READY</const> and <const>NOT_EXISTING</const> + <DD><const scope="com::sun::star::ucb">IOErrorCode::DEVICE_NOT_READY</const> + and + <const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> only. An identifier for the type of resource involved (a <atom>string</atom>). Currently understood values are <code>"volume"</code> (e.g., a file system volume) and @@ -140,17 +149,19 @@ module com { module sun { module star { module task { resources).</DD> <DT><code>"Removable"</code></DT> - <DD><const>NOT_EXISTING</const> only. A flag indicating whether the - resource resides on a storage medium that can be removed by the user - (a <atom>boolean</atom>).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> + only. A flag indicating whether the resource resides on a storage + medium that can be removed by the user (a <atom>boolean</atom>).</DD> <DT><code>"Folder"</code></DT> - <DD><const>CANT_CREATE</const>only. The name of the foler in which a - resource cannot be created (a <atom>string</atom>).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::CANT_CREATE</const> + only. The name of the foler in which a resource cannot be created (a + <atom>string</atom>).</DD> <DT><code>"Volume"</code> and <code>"OtherVolume"</code></DT> - <DD><const>DIFFERENT_DEVICES</const> only. The names of the two - volumes involved (two <atom>string</atom>s).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const> + only. The names of the two volumes involved (two + <atom>string</atom>s).</DD> </DL></P> */ service InteractionHandler @@ -163,18 +174,18 @@ service InteractionHandler //------------------------------------------------------------------------ /** Initialize the interaction handler. - <p>The arguments must be a sequence of - <type>com::sun::star::beans::PropertyValue</type>s. The currently - supported properties are: - <ul> - <li><code>"Parent"</code> of type - <type>com::sun::star::awt::XWindow</type> denotes the parent - window for any GUI dialogs the interaction handler pops up; it is - strongly recommended that this property is supplied;</li> - <li><code>"Context"</code> of type <atom>string</atom> is a textual - description of the current context (used, e.g., as a first line of - text in error boxes); this property is optional.</li> - </ul></p> + <P>The arguments must be a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>s. The + currently supported properties are: + <UL> + <LI><code>"Parent"</code> of type + <type scope="com::sun::star::awt">XWindow</type> denotes the + parent window for any GUI dialogs the interaction handler pops up; + it is strongly recommended that this property is supplied;</LI> + <LI><code>"Context"</code> of type <atom>string</atom> is a + textual description of the current context (used, e.g., as a first + line of text in error boxes); this property is optional.</LI> + </UL></P> */ interface com::sun::star::lang::XInitialization; }; diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl index 4b27941225cc..9b51c947766f 100644 --- a/offapi/com/sun/star/task/JobExecutor.idl +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -2,9 +2,9 @@ * * $RCSfile: JobExecutor.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2001-12-05 13:18:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,12 +66,44 @@ #include <com/sun/star/task/XJobExecutor.idl> #endif +//============================================================================ + module com { module sun { module star { module task { //============================================================================ /** generic job execution service + + <p> Can start registered uno services on triggered events and handle there - own configuration. + own configuration and there lifetime. Such events are simple strings + wich meaning doesn't matter for any real service implementation of this + specification. But triggered events must be available inside the + configuration and some <type>Job</type>s must be registered for that. + It's possible to start it synchronously (<type>XJob</type>) or asynchronously + (<type>XAsyncJob</type>). But in general it's forbidden to use any UI inside + synchronous one. That can be the source of many trouble and will be forbidden. + </p> + + <p> + A neccessary configuration of such job executor must support follow functionality: + <ul> + <li>Same Job should be able to register for more then one event</li> + <li>It must be possible to provide a place for job specific configuration data, + so the jobs doesn't be forced to use her own config implementation. + That's neccessary to perform whole operation because most possible events + can be occure during startup of an application. And configuration access + shouldn't make it slow. And one part of job interfaces is initialization + of it with her own config data.</li> + <li>It must be possible to configure if a job wish to be started synchronous + or not.</li> + </ul> + </p> + + <p> + Further it must be possible to deregister a successfully runned job. + </p> + + @see Job */ service JobExecutor { diff --git a/offapi/com/sun/star/task/NoMasterException.idl b/offapi/com/sun/star/task/NoMasterException.idl index ae5beb90abb0..28c3e487d19b 100644 --- a/offapi/com/sun/star/task/NoMasterException.idl +++ b/offapi/com/sun/star/task/NoMasterException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoMasterException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,12 @@ module com { module sun { module star { module task { //============================================================================= +/** is thrown when a master password is needed but not available/correct. + */ exception NoMasterException: com::sun::star::uno::RuntimeException { //------------------------------------------------------------------------- - /** Specifies the mode in which password should be asked + /** specifies the mode in which password should be queried. */ PasswordRequestMode Mode; diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl new file mode 100644 index 000000000000..2d3697db872c --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: PasswordContainer.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ + * + * 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_task_PasswordContainer_idl__ +#define __com_sun_star_task_PasswordContainer_idl__ + +module com { module sun { module star { + module task { interface XPasswordContainer; }; +}; }; }; + +module com { module sun { module star { module task { +//============================================================================ +/** this service is kind of storage that allows to store passwords + and to retrieve already stored. + + <P> + A password can be stored for the session period or persistently. + The persistent way is only possible if configuration allows to use storage. + It stores passwords encripted with a super password. An interaction + is used to ask a user for a super password. + To allow such an interaction, an object that implements <type>XInteractionHandler</type> + interface should be provided. For this purpose <type>InteractionHandler</type> + service can be used. + </P> + + <P> + In case no interaction handler is provided all passwords are stored + for the session period. In case an interaction handler is provided, but + the super password interaction does not return super password ( for any reason ), + <type>NoMasterException</type> exception is thrown to let user use + nonpersistent way explicitly. + </P> +*/ +service PasswordContainer +{ + //------------------------------------------------------------------------ + /** handles passwords + + <P> + Use this interface to store\retrieve passwords. + </P> + */ + interface com::sun::star::task::XPasswordContainer; + +}; + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.2.1 2002/03/21 16:48:34 mav + #98235# documentation review + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl index 35e0c1fe984f..dbcce976d883 100644 --- a/offapi/com/sun/star/task/PasswordRequest.idl +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasswordRequest.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,20 @@ module com { module sun { module star { module task { //============================================================================= +/** this request specifies the mode in wich the password should be asked + + <P> + It is supported by <type>InteractionHandler</type> service, and can + be used to interact for a password. Continuations for using with + the mentioned service are Abort and Approve. + </P> +*/ exception PasswordRequest: ClassifiedInteractionRequest { //------------------------------------------------------------------------- - /** Specifies the mode in which password should be asked + /** the mode in which password should be asked + + @see com::sun::star::task::PasswordRequestMode */ PasswordRequestMode Mode; diff --git a/offapi/com/sun/star/task/PasswordRequestMode.idl b/offapi/com/sun/star/task/PasswordRequestMode.idl index e9099625ca13..5593f56c5894 100644 --- a/offapi/com/sun/star/task/PasswordRequestMode.idl +++ b/offapi/com/sun/star/task/PasswordRequestMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasswordRequestMode.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,32 @@ enum PasswordRequestMode //------------------------------------------------------------------------- /** Password creation. + + <P> + The password is asked for the first time, + so it should be entered twice. + </P> */ PASSWORD_CREATE, //------------------------------------------------------------------------- - /** Ask for a password first time. + /** Ask for a password. + + <P> + Just ask for a password. + </P> */ PASSWORD_ENTER, //------------------------------------------------------------------------- /** Wrong password was entered, ask again. + + <P> + A wrong password was entered, notify user + and ask again. + </P> */ PASSWORD_REENTER diff --git a/offapi/com/sun/star/task/UrlRecord.idl b/offapi/com/sun/star/task/UrlRecord.idl index e0a3d0f5efc0..7e3a9d6fb84d 100644 --- a/offapi/com/sun/star/task/UrlRecord.idl +++ b/offapi/com/sun/star/task/UrlRecord.idl @@ -2,9 +2,9 @@ * * $RCSfile: UrlRecord.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-05-02 15:03:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,11 +70,14 @@ module com { module sun { module star { module task { //============================================================================= -/* List of users with there passwords for the url pattern +/* List of users with their passwords for the url pattern. */ struct UrlRecord { + /// The URL for which these passwords where given. string Url; + + // The list of user/password records for the given URL. sequence<UserRecord> UserList; }; diff --git a/offapi/com/sun/star/task/UserRecord.idl b/offapi/com/sun/star/task/UserRecord.idl index 5faa5d9c15dc..648c0d9a19bb 100644 --- a/offapi/com/sun/star/task/UserRecord.idl +++ b/offapi/com/sun/star/task/UserRecord.idl @@ -2,9 +2,9 @@ * * $RCSfile: UserRecord.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-05-02 15:04:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,11 +66,14 @@ module com { module sun { module star { module task { //============================================================================= -/* Users passwords list +/* Specifies user/password entries for <type>UrlRecord</type>. */ struct UserRecord { + /// specifies the user name. string UserName; + + /// specifies the passwords for the given user. sequence<string> Passwords; }; diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index b4bc64f43c98..59cc67042301 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAsyncJob.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,48 +74,52 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. interface XJobListener; -/** specifies a job which is to be executed asynchronously. +//============================================================================= +/** specifies a job which is to be executed asynchronously + + <p> + Instead of <type>XJob</type> the implementation of this interface + must make shure that execution will be real asynchronous (e.g. by using + threads). Because it's not part of the generic <type>JobExecutor</type>, + the asynchronous mode must be guaranteed by the implementation of THIS + interface. + </p> + + @see XJob */ interface XAsyncJob : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------ /** executes the job asynchronously - @param lArgs - are arguments for executing the job. Their semantics is completely implementation dependent. Usually, - a concrete implementation of a job specifies in its service descriptions which parameters are allowed - (or expected). - @param xListener - specifies a listener which should be notified on events. May be <NULL/>. + + @param Arguments + are arguments for executing the job. Their semantics is completely implementation dependent. Usually, + a concrete implementation of a job specifies in its service descriptions which parameters are allowed + (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> + which use this asynchronous job. It's possible to write it back by called listener + function <member>XJobListener::jobFinished()</member> which must be the executor himself. + + @param Listener + specifies a listener which should be notified on events. May be <NULL/>. + If it's not <NULL/> it must be the <type>JobExecutor</type> which force this action. + + @throws com::sun::star::lang::IllegalArgumentException + if some of given arguments doesn't fill out the service specification or + was corrupt so the service couldn't work correctly */ - void executeAsync( [in] sequence< com::sun::star::beans::NamedValue > lArgs , - [in] XJobListener xListener ) raises( com::sun::star::lang::IllegalArgumentException ); + void executeAsync( + [in] sequence< com::sun::star::beans::NamedValue > Arguments, + [in] XJobListener Listener) + raises( com::sun::star::lang::IllegalArgumentException ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.2 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.2 2001/11/20 14:28:26 as - * #91062# make interface more simple! - * - * Revision 1.1 2001/09/14 09:48:03 fs - * initial checkin - specification for a job to be executed asynchronously - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl index 1e1101eb4ae5..bad7df295e9d 100644 --- a/offapi/com/sun/star/task/XJob.idl +++ b/offapi/com/sun/star/task/XJob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJob.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,49 +74,59 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -//............................................................................. +//============================================================================ + module com { module sun { module star { module task { -//............................................................................. -/** specifies a simply synchronous job +//============================================================================= +/** specifies a job which is to be executed synchronously + + <p> + Instead of <type>XAsyncJob</type> the implementation of this interface + must be a real synchronous one. For example: UI relevant service MUST + do so. It's not allowed to make such things asynchronously - because + showing of any e.g. dialogs if may some other dialogs come up + can produce errors. + </p> + + @see XAsyncJob */ interface XJob : com::sun::star::uno::XInterface { - /** executes the job - @param lArgs - are arguments for executing the job. Their semantics is completely implementation dependent. Usually, - a concrete implementation of a job specifies in its service descriptions which parameters are allowed - (or expected). - @return - the result of the job. The concrete semantics is service-dependent. + //------------------------------------------------------------------------ + /** executes the job synchronously + + @param Arguments + are arguments for executing the job. Their semantics is completely implementation dependent. Usually, + a concrete implementation of a job specifies in its service descriptions which parameters are allowed + (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> + which use this synchronous job. It's possible to write it back by use special protocol + in return value. + + @return + the result of the job. The concrete semantics is service-dependent. + But it should be possible to + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successfully(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> + + @throws com::sun::star::lang::IllegalArgumentException + if some of given arguments doesn't fill out the service specification or + was corrupt so the service couldn't work correctly + + @throws com::sun::star::uno::Exception + to notify the excutor about faild operation; otherwise the return value + indicates a successfull finishing. */ - any execute( [in] sequence< com::sun::star::beans::NamedValue > lArgs ) raises( com::sun::star::lang::IllegalArgumentException , - com::sun::star::uno::Exception ); + any execute( + [in] sequence< com::sun::star::beans::NamedValue > Arguments ) + raises( com::sun::star::lang::IllegalArgumentException , + com::sun::star::uno::Exception ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.3 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.3 2001/11/20 14:24:11 as - * #91062# make interface more simple! - * - * Revision 1.2 2001/09/25 14:14:45 fs - * #91062# introduce a result (return value of execute) / allow to throw any exceptions - * - * Revision 1.1 2001/09/14 09:47:49 fs - * initial checkin - specification for a simple executable job - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl index 54a24efbea28..f6cb5aac77f8 100644 --- a/offapi/com/sun/star/task/XJobExecutor.idl +++ b/offapi/com/sun/star/task/XJobExecutor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJobExecutor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,36 +66,43 @@ #include <com/sun/star/uno/XInterface.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. +//============================================================================= +/** starts action for any triggered event from outside + + <p> + If somewhere from outside trigger an event on this interface + it will be used to find any registered service inside configuration + of this executor. If somewhere could be found it will be + started and controlled by this instance. After it finish his work + it's possible to deactivate further startups or let him run again if + a new event will be detected later. + </p> + + @see JobExecutor + */ interface XJobExecutor : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------- /** trigger event to start registered jobs + + <p> Jobs are registered in configuration and will be started by executor automaticly, if they are registered for triggered event. + The meaning of given string <var>Event</var> mustn't be known. Because + for the executor it's enough to use it for searching a registered job + inside his own configuration. So no special events will be defined here. + </p> + + @param Event + describe the event for which jobs can be registered and should be started */ - [oneway] void trigger( [in] string sEvent ); + [oneway] void trigger( [in] string Event ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.1 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.1 20.11.2001 14:35 as - * initial checkin - specification for a job executor - * - * - * Revision 1.0 20.11.2001 14:35 as - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl index a124b053b92f..3a72b9fa90f6 100644 --- a/offapi/com/sun/star/task/XJobListener.idl +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJobListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,48 +66,42 @@ #include <com/sun/star/lang/XEventListener.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. interface XAsyncJob; +//============================================================================= +/** listener on finish states of asynchronous job execution + */ interface XJobListener : com::sun::star::lang::XEventListener { - /** indicates that the job is done. - aResult should be the same like for the synchronous mode on XJob::execute() - and depends from service specification. + //------------------------------------------------------------------------ + /** indicates that the job is done + + @param Job + identifies the asynchronous job so the <type>JobExecutor</type> + can differ between more then ones. + + @param Result + should be the same like for the synchronous mode on <member>XJob::execute()</member>. + It provides information about success or failure of job execution. It's possible too, + to use special protocol (which depends from real implementation) between + <type>JobExecutor</type> and a real job. So it can be possible to: + + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successfully(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> */ - void jobFinished( [in] XAsyncJob xJob , - [in] any aResult ); + void jobFinished( + [in] XAsyncJob Job, + [in] any Result); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.4 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.4 2001/11/20 14:30 as - * #91062# make it more simple! - * - * Revision 1.3 2001/09/26 16:16:17 fs - * #91062# corrected a comment - * - * Revision 1.2 2001/09/25 14:15:44 fs - * #91062# jobCancelled renamed to jobAborted / jobDone gets a new param (the result) - * - * Revision 1.1 2001/09/14 09:48:16 fs - * initial checkin - specification for a listener to an asynchronous job - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl index b7daec8aad69..eb29dd336da9 100644 --- a/offapi/com/sun/star/task/XStatusIndicator.idl +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicator.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,79 +65,100 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= module com { module sun { module star { module task { //============================================================================= - -// DocMerge from xml: interface com::sun::star::task::XStatusIndicator /** controls a status indicator which displays progress of - longer actions to the user.@see XStatusIndicatorSupplier + longer actions to the user + + <p> + Such objects are provided by a <type>XStatusIndicatorFactory</type>. + </p> + + @see XStatusIndicatorFactory */ interface XStatusIndicator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::start - /** TODO + /** initialize and start the progress + + <p> + It activates a new created or reactivate an already used inidicator + (must be finished by calling <member>XStatusIndicator::end()</member> + before!). By the way it's possible to set first progress description + and the possible range of progress value. That means that a progress + can runs from 0 to <var>Range</var>. + </p> + + @param Text + initial value for progress description for showing + Value can be updated by calling <member>XStatusIndicator::setText()</member>. + + @param Range + mewns the maximum value of the progress which can be setted by + calling <member>XStatusIndicator::setValue()</member>. */ - [oneway] void start( [in] string aText, - [in] long nRange ); + [oneway] void start( + [in] string Text, + [in] long Range); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::end - /** TODO + /** stop the progress + + <p> + Further calls of <member>XStatusIndicator::setText()</member>, + <member>XStatusIndicator::setValue()</member> or + <member>XStatusIndicator::reset()</member> must be ignored. + Only <member>XStatusIndicator::start()</member> can reactivate this + indicator. + It's not allowed to destruct the indicator inside this method. + The instance must be gone by using ref count or disposing. + </p> */ [oneway] void end(); //------------------------------------------------------------------------- + /** update progress description + + <p> + Initial value can be set during starting of the progress by calling + <member>XStatusIndicator::start()</member>. + Stopped indicators must ignore this call. + </p> - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::setText - /** TODO + @param Text + new value for progress description which should be shown now */ - [oneway] void setText( [in] string aText ); + [oneway] void setText( [in] string Text ); //------------------------------------------------------------------------- + /** update progress value - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::setValue - /** TODO + <p> + Wrong values must be ignored and stopped indicators must ignore this + call generaly. + </p> + + @param Value + new value for progress which should be shown now + Must fit the range [0..Range] which was set during + <member>XStatusIndicator::start()</member>. */ - [oneway] void setValue( [in] long nValue ); + [oneway] void setValue( [in] long Value ); //------------------------------------------------------------------------- + /** clear progress value and description - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::reset - /** TODO + <p> + Calling of setValue(0) and setText("") should do the same. + Stopped indicators must ignore this call. + </p> */ [oneway] void reset(); - }; -//============================================================================= - }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:20 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:23 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:57 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/task/XStatusIndicatorFactory.idl b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl index a4b9ca2ce759..c3e4f58ef41d 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorFactory.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicatorFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,51 +69,31 @@ #include <com/sun/star/task/XStatusIndicator.idl> #endif - //============================================================================= module com { module sun { module star { module task { //============================================================================= +/** provides multiple, probably parallel running, status indicator objects + + <p> + A possible factory is the <type scope="com::sun::star::frame">Frame</type> + service. + </p> -// DocMerge from xml: interface com::sun::star::task::XStatusIndicatorFactory -/** provides multiple, probably parallel running, status indicator objects.@see Frame + @see com::sun::star::frame::Frame */ interface XStatusIndicatorFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XStatusIndicatorFactory::createStatusIndicator + /** create a new status indicator instance - // DocMerge: empty anyway + @returns + the new indicator + */ com::sun::star::task::XStatusIndicator createStatusIndicator(); - }; -//============================================================================= - }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:20 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:23 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/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/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl index 185a9cc658de..14bf5c2749ed 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicatorSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,56 +75,21 @@ module com { module sun { module star { module task { //============================================================================= - -// DocMerge from xml: interface com::sun::star::task::XStatusIndicatorSupplier -/** gives access to a status indicator interface. - - - - - - - - - - - - +/** use <type>XStatusIndicatorFactory</type> instead of this @deprecated */ interface XStatusIndicatorSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XStatusIndicatorSupplier::getStatusIndicator + /** use <member>XStatusIndicatorFactory::createStatusIndicator()</member> + instead of this - // DocMerge: empty anyway + @deprecated + */ com::sun::star::task::XStatusIndicator getStatusIndicator(); - }; -//============================================================================= - }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:23 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:57 hjs - initial import - - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML - - 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/text/BaseFrame.idl b/offapi/com/sun/star/text/BaseFrame.idl index 9c3c541b7480..6286a9e83f9a 100644 --- a/offapi/com/sun/star/text/BaseFrame.idl +++ b/offapi/com/sun/star/text/BaseFrame.idl @@ -2,9 +2,9 @@ * * $RCSfile: BaseFrame.idl,v $ * - * $Revision: 1.12 $ + * $Revision: 1.13 $ * - * last change: $Author: os $ $Date: 2002-08-16 12:40:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:02 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -61,6 +61,10 @@ #ifndef __com_sun_star_text_BaseFrame_idl__ #define __com_sun_star_text_BaseFrame_idl__ +#ifndef __com_sun_star_text_BaseFrameProperties_idl__ +#include <com/sun/star/text/BaseFrameProperties.idl> +#endif + #ifndef __com_sun_star_text_TextContent_idl__ #include <com/sun/star/text/TextContent.idl> #endif @@ -99,6 +103,7 @@ */ service BaseFrame { + service BaseFrameProperties; service TextContent; //------------------------------------------------------------------------- /** This interface specifies the access to the shape data (position @@ -134,283 +139,10 @@ service BaseFrame */ interface com::sun::star::container::XNamed; //------------------------------------------------------------------------- - /** contains the number of the page where the objects are anchored. - <p> The value is valid only if the - AnchorType is - <const>TextContentAnchorType::AT_PAGE</const>.</p> - */ - [property] short AnchorPageNo; - //------------------------------------------------------------------------- - /** contains the text frame the current frame is anchored to. - <p> The value is valid only if the - AnchorType is <const>TextContentAnchorType::AT_FRAME</const>.</p> - */ - [property] com::sun::star::text::XTextFrame AnchorFrame; - //------------------------------------------------------------------------- - /** contains the color of the background of the object. - */ - [property] long BackColor; - //------------------------------------------------------------------------- - /** contains the URL for the background graphic. - */ - [property] string BackGraphicURL; - - //------------------------------------------------------------------------- - /** contains the name of the file filter for the background graphic. - */ - [property] string BackGraphicFilter; - - //------------------------------------------------------------------------- - /** determines the position of the background graphic. - */ - [property] com::sun::star::style::GraphicLocation BackGraphicLocation; - - //------------------------------------------------------------------------- - /** contains the left border of the object. - - @see BaseFrame::com::sun::star::table::BorderLine - */ - [property] com::sun::star::table::BorderLine LeftBorder; - - //------------------------------------------------------------------------- - /** contains the right border of the object. - - @see BaseFrame::com::sun::star::table::BorderLine - */ - [property] com::sun::star::table::BorderLine RightBorder; - - //------------------------------------------------------------------------- - /** contains the top border of the object. - - @see BaseFrame::com::sun::star::table::BorderLine - */ - [property] com::sun::star::table::BorderLine TopBorder; - - //------------------------------------------------------------------------- - /** contains the bottom border of the object. - - @see BaseFrame::com::sun::star::table::BorderLine - */ - [property] com::sun::star::table::BorderLine BottomBorder; - - //------------------------------------------------------------------------- - /** contains the distance from the border to the object. - */ - [property] long BorderDistance; - - //------------------------------------------------------------------------- - /** contains the distance from the left border to the object. - */ - [property] long LeftBorderDistance; - - //------------------------------------------------------------------------- - /** contains the distance from the right border to the object. - */ - [property] long RightBorderDistance; - - //------------------------------------------------------------------------- - /** contains the distance from the top border to the object. - */ - [property] long TopBorderDistance; - - //------------------------------------------------------------------------- - /** contains the distance from the bottom border to the object. - */ - [property] long BottomBorderDistance; - - //------------------------------------------------------------------------- - /** If TRUE, the "BackColor" is ignored. - */ - [property] boolean BackTransparent; - - //------------------------------------------------------------------------- - - /** determines if the content is protected. - */ - [property] boolean ContentProtected; - //------------------------------------------------------------------------- /** contains the name of the frame style that is applied to this object. */ [property] string FrameStyleName; - //------------------------------------------------------------------------- - /** contains the left margin of the object. - */ - [property] long LeftMargin; - - //------------------------------------------------------------------------- - /** contains the right margin of the object. - */ - [property] long RightMargin; - - //------------------------------------------------------------------------- - - /** contains the top margin of the object. - */ - [property] long TopMargin; - - //------------------------------------------------------------------------- - /** contains the bottom margin of the object. - */ - [property] long BottomMargin; - - //------------------------------------------------------------------------- - /** contains the height of the object (1/100 mm). - <p>It is only valid if <member>TextEmbeddedObject::RelativeHeight</member> is zero.</p> - */ - [property] long Height; - - //------------------------------------------------------------------------- - /** contains the width of the object (1/100 mm). - <p>It is only valid if <member>TextEmbeddedObject::RelativeWidth</member> is zero.</p> - */ - [property] long Width; - //------------------------------------------------------------------------- - /** contains the relative height of the object. - <p> It is only valid if it is greater than zero.</p> - */ - [property] short RelativeHeight; - - //------------------------------------------------------------------------- - /** contains the relative width of the object. - <p> It is only valid if it is greater than zero. </p> - */ - [property] short RelativeWidth; - //------------------------------------------------------------------------- - /** determins whether the width follows the height. - */ - [property] boolean IsSyncWidthToHeight; - //------------------------------------------------------------------------- - /** determins whether the height follows the width. - */ - [property] boolean IsSyncHeightToWidth; - //------------------------------------------------------------------------- - /** determines the horizontal orientation of the object. - - @see BaseFrame::HoriOrientation - */ - [property] short HoriOrient; - //------------------------------------------------------------------------- - /** contains the horizontal position of the object (1/100 mm). - <p> It is only valid if "HoriOrient" is HoriOrientation_NONE.</p> - */ - [property] long HoriOrientPosition; - - //------------------------------------------------------------------------- - /** determines the environment of the object to which the orientation - is related. - - @see BaseFrame::RelOrientation - */ - [property] short HoriOrientRelation; - - //------------------------------------------------------------------------- - /** determines the vertical orientation of the object. - - @see BaseFrame::VertOrientation - */ - [property] short VertOrient; - - //------------------------------------------------------------------------- - /** contains the vertical position of the object (1/100 mm). - - It is only valid if <member>TextEmbeddedObject::VertOrient</member> is - <const>VertOrientation::NONE</const>. - */ - [property] long VertOrientPosition; - - //------------------------------------------------------------------------- - - /** determines the environment of the object to which the orientation is related. - - @see BaseFrame::RelOrientation - */ - [property] short VertOrientRelation; - - //------------------------------------------------------------------------- - /** contains the URL of a hyperlink that is set at the object. - */ - [property] string HyperLinkURL; - - //------------------------------------------------------------------------- - /** contains the name of the target for a hyperlink that is set at the object. - */ - [property] string HyperLinkTarget; - - //------------------------------------------------------------------------- - /** contains the name of the hyperlink that is set at the object. - */ - [property] string HyperLinkName; - - //------------------------------------------------------------------------- - /** determines if the object is opaque or transparent for text. - */ - [property] boolean Opaque; - - //------------------------------------------------------------------------- - /** determines if the object is mirrored on even pages. - */ - [property] boolean PageToggle; - - //------------------------------------------------------------------------- - /** determines if the position is protected. - */ - [property] boolean PositionProtected; - - //------------------------------------------------------------------------- - /** determines if the object is included in printing. - */ - [property] boolean Print; - - //------------------------------------------------------------------------- - /** contains the type of the shadow of the object. - */ - [property] com::sun::star::table::ShadowFormat ShadowFormat; - - //------------------------------------------------------------------------- - /** determines if the object gets an image map from a server. - */ - [property] boolean ServerMap; - - //------------------------------------------------------------------------- - /** contains the size of the object. - - @see BaseFrame::Height - @see BaseFrame::Width - */ - [property] com::sun::star::awt::Size Size; - - //------------------------------------------------------------------------- - /** determines if the size is protected. - */ - [property] boolean SizeProtected; - //------------------------------------------------------------------------- - /** determines the type of the surrounding text. - - @deprecated - */ - [property] com::sun::star::text::WrapTextMode Surround; - - //------------------------------------------------------------------------- - /** determines if the text of the paragraph in which the object - is anchored, wraps around the object. - */ - [property] boolean SurroundAnchorOnly; - //------------------------------------------------------------------------- - /** contains the transparency of the background color as percentage value. - The properties "BackTransparent" and "BackColorTransparency" - are overwriting each other. - */ - [optional, property]byte BackColorTransparency; - //------------------------------------------------------------------------- - /** contains the color of the background. In contrast to the property "BackColor" - it doesn't contain a transparency value. - */ - [optional, property]long BackColorRGB; - //------------------------------------------------------------------------- - /** contains the transparency of the background graphic as percentage value. - */ - [optional, property]byte BackGraphicTransparency; }; //============================================================================= diff --git a/offapi/com/sun/star/text/BaseFrameProperties.idl b/offapi/com/sun/star/text/BaseFrameProperties.idl index 380fb644a336..f591799b26fd 100644 --- a/offapi/com/sun/star/text/BaseFrameProperties.idl +++ b/offapi/com/sun/star/text/BaseFrameProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: BaseFrameProperties.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mh $ $Date: 2002-02-28 15:52:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,6 +70,15 @@ #ifndef __com_sun_star_table_ShadowFormat_idl__ #include <com/sun/star/table/ShadowFormat.idl> #endif +#ifndef __com_sun_star_text_XTextFrame_idl__ +#include <com/sun/star/text/XTextFrame.idl> +#endif +#ifndef __com_sun_star_text_WrapTextMode_idl__ +#include <com/sun/star/text/WrapTextMode.idl> +#endif +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif //============================================================================= diff --git a/offapi/com/sun/star/text/Bookmarks.idl b/offapi/com/sun/star/text/Bookmarks.idl index d9cee1d5e1ae..2d8c424b2801 100644 --- a/offapi/com/sun/star/text/Bookmarks.idl +++ b/offapi/com/sun/star/text/Bookmarks.idl @@ -2,9 +2,9 @@ * * $RCSfile: Bookmarks.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,6 +64,9 @@ #ifndef __com_sun_star_container_XNameAccess_idl__ #include <com/sun/star/container/XNameAccess.idl> #endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif //============================================================================= @@ -85,6 +88,11 @@ service Bookmarks <p>All contents support the service <type>Bookmark</type>. */ interface com::sun::star::container::XNameAccess; + /** makes it possible to access the bookmarks by their index. + + <p>All contents support the service <type>Bookmark</type>. + */ + interface com::sun::star::container::XIndexAccess; }; @@ -95,6 +103,12 @@ service Bookmarks /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/02/14 10:48:33 os + missing interface added + + Revision 1.3 2000/11/08 12:44:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:59 hjs initial import diff --git a/offapi/com/sun/star/text/CellRange.idl b/offapi/com/sun/star/text/CellRange.idl index db7e2a5833f2..cb7e2453763f 100644 --- a/offapi/com/sun/star/text/CellRange.idl +++ b/offapi/com/sun/star/text/CellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellRange.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: tl $ $Date: 2002-09-25 13:32:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,10 @@ #include <com/sun/star/table/XCellRange.idl> #endif +#ifndef __com_sun_star_sheet_XCellRangeData_idl__ +#include <com/sun/star/sheet/XCellRangeData.idl> +#endif + #ifndef __com_sun_star_container_XNamed_idl__ #include <com/sun/star/container/XNamed.idl> #endif @@ -90,7 +94,7 @@ //============================================================================= - module com { module sun { module star { module text { +module com { module sun { module star { module text { //============================================================================= diff --git a/offapi/com/sun/star/text/ContentIndex.idl b/offapi/com/sun/star/text/ContentIndex.idl index 14d88ddb6bad..c23ccafa3a45 100644 --- a/offapi/com/sun/star/text/ContentIndex.idl +++ b/offapi/com/sun/star/text/ContentIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentIndex.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,11 +67,10 @@ //============================================================================= - module com { module sun { module star { module text { +module com { module sun { module star { module text { //============================================================================= -// DocMerge from xml: service com::sun::star::text::ContentIndex /** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex */ service ContentIndex @@ -79,25 +78,23 @@ service ContentIndex // DocMerge: empty anyway service com::sun::star::text::BaseIndex; - /* determins the depth of outline levels that are included into the content index.*/ + /** determins the depth of outline levels that are included into the content index.*/ - // DocMerge: empty anyway + /// @missing [optional, property] short Level; - /* determins if the document index is created from outlines. + + /** determins if the document index is created from outlines. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromOutline; - /* - returns the interface to access the paragraph style names that are included + /** contains the interface to access the paragraph style names that are included in this index. @see DocumentIndexParagraphStyles */ - // DocMerge: empty anyway [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; - /* determins if the document index marks are included in this index. + + /** contains <TRUE/> if the document index marks are included in this index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromMarks; @@ -107,21 +104,5 @@ service ContentIndex }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:26 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:59 hjs - initial import - - Revision 1.3 2000/09/11 11:52:59 mi - documentation merged from XML - - Revision 1.1 2000/08/09 15:52:45 os - #77067# service ContentIndex - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/text/DefaultNumberingProvider.idl b/offapi/com/sun/star/text/DefaultNumberingProvider.idl index 6c62315737b5..e185826af705 100644 --- a/offapi/com/sun/star/text/DefaultNumberingProvider.idl +++ b/offapi/com/sun/star/text/DefaultNumberingProvider.idl @@ -8,6 +8,10 @@ module com { module sun { module star { module text { //============================================================================= + +/** provides access to language dependent numbering types and supports + formatting of those numberings. + */ service DefaultNumberingProvider { interface com::sun::star::text::XDefaultNumberingProvider; diff --git a/offapi/com/sun/star/text/DocumentIndex.idl b/offapi/com/sun/star/text/DocumentIndex.idl index 140109643723..49eb98f2df26 100644 --- a/offapi/com/sun/star/text/DocumentIndex.idl +++ b/offapi/com/sun/star/text/DocumentIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentIndex.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: os $ $Date: 2001-06-18 14:04:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,59 +70,59 @@ //============================================================================= - module com { module sun { module star { module text { +module com { module sun { module star { module text { //============================================================================= -// DocMerge from xml: service com::sun::star::text::DocumentIndex /** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex */ service DocumentIndex { - // DocMerge: empty anyway service com::sun::star::text::BaseIndex; - /* determins if alphabetical separators are genererated. + /** determins if alphabetical separators are genererated. */ - // DocMerge: empty anyway [optional, property] boolean UseAlphabeticalSeparators; - /* determins if a index entry is generated for each primary/secondary key. + + /** determins if a index entry is generated for each primary/secondary key. */ - // DocMerge: empty anyway [optional, property] boolean UseKeyAsEntry; - /* determins if same entries on different pages are combined into one index entry. + + /** determins if same entries on different pages are combined into one index entry. */ - // DocMerge: empty anyway [optional, property] boolean UseCombinedEntries; - /* determins if the similarity of index entries is checked case sensitively. + + /** determins if the similarity of index entries is checked case sensitively. */ - // DocMerge: empty anyway [optional, property] boolean IsCaseSensitive; - /* determins if following page numbers are displayed using a 'pp.'. + + /** determins if following page numbers are displayed using a 'pp.'. */ - // DocMerge: empty anyway [optional, property] boolean UsePP; - /* determins if if following page numbers are displayed using a dash. + + /** determins if if following page numbers are displayed using a dash. */ - // DocMerge: empty anyway [optional, property] boolean UseDash; - /* determins if all entries start with a capital letter. + + /** determins if all entries start with a capital letter. */ - // DocMerge: empty anyway [optional, property] boolean UseUpperCase; - /* determins the name of the character style that is applied to the number + + /** determins the name of the character style that is applied to the number of a page where main index entry is located. */ - // DocMerge: empty anyway [optional, property] string MainEntryCharacterStyleName; + /** contains all index marks that are related to this index. */ [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks; + //------------------------------------------------------------------------ /** contains the locale of the index. */ [property] com::sun::star::lang::Locale Locale; + //------------------------------------------------------------------------ /** contains the name of the sort algorithm that is used to sort the entries. */ diff --git a/offapi/com/sun/star/text/NumberingRules.idl b/offapi/com/sun/star/text/NumberingRules.idl index 1da6bceb702a..07596c6c8864 100644 --- a/offapi/com/sun/star/text/NumberingRules.idl +++ b/offapi/com/sun/star/text/NumberingRules.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberingRules.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: tl $ $Date: 2002-09-24 13:04:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -128,39 +128,4 @@ service NumberingRules }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/11/02 11:57:33 mi - proofreading and corrections from Richard Holt - - Revision 1.4 2000/12/19 14:17:36 cl - #82348# made functionality not available in impress/draw optional - - Revision 1.3 2000/11/08 12:44:26 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:02 hjs - initial import - - Revision 1.7 2000/09/11 11:53:00 mi - documentation merged from XML - - Revision 1.5 2000/07/19 06:50:50 os - new properties, level properties now in NumberingLevel.idl - - Revision 1.4 2000/06/26 06:47:55 os - new optional property: VertOrient - - Revision 1.3 2000/02/21 16:18:15 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:01 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/text/NumberingStyle.idl b/offapi/com/sun/star/text/NumberingStyle.idl index 116f95c32789..2dc48408a6a4 100644 --- a/offapi/com/sun/star/text/NumberingStyle.idl +++ b/offapi/com/sun/star/text/NumberingStyle.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberingStyle.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mh $ $Date: 2002-02-28 15:53:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,7 +70,7 @@ //============================================================================= - module com { module sun { module star { module style { +module com { module sun { module star { module text { //============================================================================= @@ -81,7 +81,7 @@ service NumberingStyle { //------------------------------------------------------------------------- /// specifies administrative properties. - service Style; + service com::sun::star::style::Style; service NumberingRules; }; diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl index d64458b384ee..044b7dc5fccb 100644 --- a/offapi/com/sun/star/text/Shape.idl +++ b/offapi/com/sun/star/text/Shape.idl @@ -2,9 +2,9 @@ * * $RCSfile: Shape.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mh $ $Date: 2002-02-28 16:00:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,11 +105,6 @@ service Shape */ [property] com::sun::star::text::XTextFrame AnchorFrame; //------------------------------------------------------------------------- - /** determines if the text of the paragraph in which the object - is anchored, wraps around the object. - */ - [property] boolean SurroundAnchorOnly; - //------------------------------------------------------------------------- /** specifies how the text content is attached to its surrounding <type scope="com::sun::star::drawing">Text</type>. */ diff --git a/offapi/com/sun/star/text/TextCursor.idl b/offapi/com/sun/star/text/TextCursor.idl index ab0e2b738fc3..05ffeadf5eaf 100644 --- a/offapi/com/sun/star/text/TextCursor.idl +++ b/offapi/com/sun/star/text/TextCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextCursor.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: obo $ $Date: 2001-11-08 10:49:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,10 @@ #include <com/sun/star/text/TextRange.idl> #endif +#ifndef __com_sun_star_text_XTextCursor_idl__ +#include <com/sun/star/text/XTextCursor.idl> +#endif + #ifndef __com_sun_star_text_XWordCursor_idl__ #include <com/sun/star/text/XWordCursor.idl> #endif @@ -113,6 +117,8 @@ service TextCursor // DocMerge: empty anyway service com::sun::star::text::TextRange; + interface com::sun::star::text::XTextCursor; + // DocMerge: empty anyway [optional] interface com::sun::star::text::XWordCursor; @@ -160,6 +166,12 @@ service TextCursor /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8.4.1 2002/08/27 12:55:50 tl + #101301# interface XTextCursor added to service description + + Revision 1.8 2001/11/08 10:49:07 obo + #65293# header include missing + Revision 1.7 2001/11/05 18:10:41 mtg #92662# admit that the TextCursor now supports XMultiPropertyStates diff --git a/offapi/com/sun/star/text/TextDocument.idl b/offapi/com/sun/star/text/TextDocument.idl index 321841a7e0d6..5ed3882a1243 100644 --- a/offapi/com/sun/star/text/TextDocument.idl +++ b/offapi/com/sun/star/text/TextDocument.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextDocument.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-12-10 17:42:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -121,6 +121,10 @@ #include <com/sun/star/style/XStyleFamiliesSupplier.idl> #endif +#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__ +#include <com/sun/star/util/XNumberFormatsSupplier.idl> +#endif + #ifndef __com_sun_star_lang_Locale_idl__ #include <com/sun/star/lang/Locale.idl> #endif @@ -188,6 +192,8 @@ service TextDocument [optional] interface com::sun::star::style::XStyleFamiliesSupplier; + // + interface com::sun::star::util::XNumberFormatsSupplier; //------------------------------------------------------------------------- // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharLocale @@ -240,6 +246,12 @@ service TextDocument /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/02/26 08:31:56 os + XNumberFormatsSupplier added + + Revision 1.6 2001/12/10 17:42:31 mi + #94538# XStyleFamiliesSupplier added + Revision 1.5 2001/05/15 10:29:08 kz add. some missing headers diff --git a/offapi/com/sun/star/text/TextPageStyle.idl b/offapi/com/sun/star/text/TextPageStyle.idl new file mode 100644 index 000000000000..9ae88bfe6010 --- /dev/null +++ b/offapi/com/sun/star/text/TextPageStyle.idl @@ -0,0 +1,230 @@ +/************************************************************************* + * + * $RCSfile: TextPageStyle.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:10:05 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef __com_sun_star_text_TextPageStyle_idl__ +#define __com_sun_star_text_TextPageStyle_idl__ + +#ifndef __com_sun_star_table_ShadowFormat_idl__ +#include <com/sun/star/table/ShadowFormat.idl> +#endif +#ifndef __com_sun_star_table_BorderLine_idl__ +#include <com/sun/star/table/BorderLine.idl> +#endif +#ifndef __com_sun_star_style_PageStyleLayout_idl__ +#include <com/sun/star/style/PageStyleLayout.idl> +#endif +#ifndef __com_sun_star_style_GraphicLocation_idl__ +#include <com/sun/star/style/GraphicLocation.idl> +#endif +#ifndef __com_sun_star_awt_Size_idl__ +#include <com/sun/star/awt/Size.idl> +#endif +#ifndef __com_sun_star_text_XText_idl__ +#include <com/sun/star/text/XText.idl> +#endif +#ifndef __com_sun_star_text_XTextColumns_idl__ +#include <com/sun/star/text/XTextColumns.idl> +#endif +#ifndef __com_sun_star_container_XNameContainer_idl__ +#include <com/sun/star/container/XNameContainer.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module text { + +//============================================================================= + +/** represents a page style for a text document. + + <p>This service extends the service + <type scope="com::sun::star::style">PageStyle</type> with specific + properties for text documents.</p> + */ +service TextPageStyle +{ + //------------------------------------------------------------------------- + + /** determins whether the register mode is active on that page. + */ + [property] boolean RegisterModeActive; + + //------------------------------------------------------------------------- + + /** contains the name of the paragraph style that is used as + reference of the register mode. + */ + [property] string RegisterParagraphStyle; + + //------------------------------------------------------------------------- + + /** contains the column settings of the page. + */ + [property] com::sun::star::text::XTextColumns TextColumns; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the header. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderText; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the header of left pages. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderTextLeft; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the header of right pages. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText HeaderTextRight; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the footer. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterText; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the footer of a left page. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterTextLeft; + + //------------------------------------------------------------------------- + + /** contains the interface to the text of the footer of a right page. + + @see com::sun::star::text::Text + */ + [property] com::sun::star::text::XText FooterTextRight; + + //------------------------------------------------------------------------- + + /** contains the maximum height of the footnote area (in 1/100 mm). + + <p>If set to zero, the height of the current page is used as limit.</p> + */ + [property] long FootnoteHeight; + + //------------------------------------------------------------------------- + + /** contains the weight of the separator line between the text and + the footnote area (in 1/100 mm). + */ + [property] short FootnoteLineWeight; + + //------------------------------------------------------------------------- + + /** contains the color of the separator line between the text and + the footnote area. + */ + [property] long FootnoteLineColor; + + //------------------------------------------------------------------------- + + /** contains the relative width of the separator line between the + text and the footnote area (in percent). + */ + [property] byte FootnoteLineRelativeWidth; + + //------------------------------------------------------------------------- + + /** contains the adjustment of the separator line between the text + and the footnote area. + + @see com::sun::star::text::HorizontalAdjust + */ + [property] short FootnoteLineAdjust; + + //------------------------------------------------------------------------- + + /** contains the distance between the text and the separator line + between the text and the footnote area (in 1/100 mm). + */ + [property] long FootnoteLineTextDistance; + + //------------------------------------------------------------------------- + + /** contains the distance between the footnote area and the separator + line between the text and the footnote area (in 1/100 mm). + */ + [property] long FootnoteLineDistance; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + diff --git a/offapi/com/sun/star/text/TextPortion.idl b/offapi/com/sun/star/text/TextPortion.idl index ed7110d696ee..3cba59f53040 100644 --- a/offapi/com/sun/star/text/TextPortion.idl +++ b/offapi/com/sun/star/text/TextPortion.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextPortion.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: cl $ $Date: 2000-12-19 14:24:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,8 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_text_XTextPortion_idl__ -#define __com_sun_star_text_XTextPortion_idl__ +#ifndef __com_sun_star_text_TextPortion_idl__ +#define __com_sun_star_text_TextPortion_idl__ #ifndef __com_sun_star_style_ParagraphProperties_idl__ @@ -77,6 +77,9 @@ #ifndef __com_sun_star_text_TextRange_idl__ #include <com/sun/star/text/TextRange.idl> #endif +#ifndef __com_sun_star_text_XTextContent_idl__ +#include <com/sun/star/text/XTextContent.idl> +#endif //============================================================================= @@ -110,6 +113,9 @@ service TextPortion <LI><P>ControlCharacter - a control character</P> <LI><P>ReferenceMark - a reference mark </P> <LI><P>DocumentIndexMark - a document index mark</P> + <LI><P>Bookmark - a bookmark</P> + <LI><P>Redline - a redline portion which is a result of the change tracking feature.</P> + <LI><P>Ruby - a ruby attribute which is used in Asian text.</P> </UL> <p>The text portions for reference marks and document index marks are generated twice for each mark since they may include string content.</p> @@ -117,6 +123,13 @@ service TextPortion [readonly, property] string TextPortionType; /** returns the control character if the text portion contains a ControlCharacter*/ [readonly, property] short ControlCharacter; + /** contains the bookmark if the portion is of the type */ + [optional, property] com::sun::star::text::XTextContent Bookmark; + /** determines whether the portion is a point only.*/ + [optional, property] boolean IsCollapsed; + /** determines whether the portion is a start portion if two portions are needed to include an + object (i.e. DocmentIndexMark)*/ + [optional, property] boolean IsStart; }; //============================================================================= diff --git a/offapi/com/sun/star/text/TextRange.idl b/offapi/com/sun/star/text/TextRange.idl index 0ea77e8215c5..a875e5e5e1ea 100644 --- a/offapi/com/sun/star/text/TextRange.idl +++ b/offapi/com/sun/star/text/TextRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextRange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: os $ $Date: 2001-04-23 09:57:16 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,49 +92,40 @@ //============================================================================= - module com { module sun { module star { module text { +module com { module sun { module star { module text { //============================================================================= -// DocMerge from xml: service com::sun::star::text::TextRange /** points to a sequence of characters within a <type>Text</type>. - - <p>The service provides access to the string content and the properties of this range of text and the <type>TextContent</type> instances which - are bound to this text range. + are bound to this text range. </p> - </p> <p>A <type>TextRange</type> is also used for a <i>text portion</i> which is returned by the <type scope="com::sun::star::container">XEnumeration</type> for a single paragraph. Because this is the mechanism to use to export data, all formatting attributes and contents bound to this range have - to be available from implementations of this service. + to be available from implementations of this service. </p> - </p>@see Text + @see Text */ service TextRange { - // DocMerge: empty anyway interface com::sun::star::text::XTextRange; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertyState; - // DocMerge: empty anyway [optional] interface com::sun::star::container::XContentEnumerationAccess; - // DocMerge: empty anyway service com::sun::star::style::CharacterProperties; [optional] service com::sun::star::style::CharacterPropertiesAsian; [optional] service com::sun::star::style::CharacterPropertiesComplex; - // DocMerge: empty anyway + service com::sun::star::style::ParagraphProperties; }; @@ -146,6 +137,12 @@ service TextRange /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.14.1 2002/05/03 10:25:52 mi + autodoc warnings elimitanted, part of review procss + + Revision 1.6 2001/04/23 09:57:16 os + #83551# cjk services added + Revision 1.5 2000/12/21 08:35:21 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/text/TextTable.idl b/offapi/com/sun/star/text/TextTable.idl index 250c34ddabbc..e075e3633097 100644 --- a/offapi/com/sun/star/text/TextTable.idl +++ b/offapi/com/sun/star/text/TextTable.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextTable.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: tl $ $Date: 2002-04-30 11:05:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -130,32 +130,26 @@ </p> - - - - @example Create and insert a TextTable via a TextTableDescriptor: <listing> - xTableProvider = xTextDoc.queryServiceProvider( "com.sun.star.text.TextTable" ) - xTableDescriptor = xTableProvider.createDescriptor - xTableDescriptor.Columns = 5 - xTableDescriptor.Rows = 8 - xTableDescriptor.LeftBorder = 2000 - xTableDescriptor.RightBorder = 1500 - xTextDoc.insertNewTextContent( xTextRange, xTableDescriptor ) + xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" ) + xTable.initialize(5, 8) + xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE + xTable.LeftMargin = 2000 + xTable.RightMargin = 1500 + xTextDoc.getText.insertTextContent( xTextRange, xTable, false ) </listing> - Create and insert a TextTable directly (may be flicker): + Create and insert a TextTable directly (may flicker): <listing> - xTableProvider = xTextDoc.queryServiceProvider( "com.sun.star.text.TextTable" ) - xTable = xTableProvider.createInstance - xTable.Columns = 5 - xTable.Rows = 8 - xTable.LeftBorder = 2000 - xTable.RightBorder = 1500 - xTextDoc.insertTextContent( xTextRange, xTable ) + xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" ) + xTable.initialize(5, 8) + xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE + xTable.LeftMargin = 2000 + xTable.RightMargin = 1500 + xTextDoc.getText.insertTextContent( xTextRange, xTable, false ) </listing> */ service TextTable @@ -183,8 +177,6 @@ service TextTable [optional] interface com::sun::star::sheet::XCellRangeData; - //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::text::TextTable::BreakType /** determins the type of break that is applied at the beginning of the table.@see com.sun.star.style.BreakType */ @@ -351,36 +343,4 @@ service TextTable }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/06 15:45:57 os - #84509# useless property SizeRelative removed - - Revision 1.4 2000/12/21 08:35:21 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:27 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:03 hjs - initial import - - Revision 1.6 2000/09/11 11:53:01 mi - documentation merged from XML - - Revision 1.4 2000/07/06 12:15:39 os - old docu removed - - Revision 1.3 2000/06/30 12:14:43 os - #75739# service description updated - - Revision 1.2 2000/06/16 11:42:16 os - #75622# BackGraphicLocation/URL/Filter added/changed - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/text/TextTableCursor.idl b/offapi/com/sun/star/text/TextTableCursor.idl index 6039c544a60c..9aad57c6a116 100644 --- a/offapi/com/sun/star/text/TextTableCursor.idl +++ b/offapi/com/sun/star/text/TextTableCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextTableCursor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,6 +68,18 @@ #ifndef __com_sun_star_beans_XPropertySet_idl__ #include <com/sun/star/beans/XPropertySet.idl> #endif +#ifndef __com_sun_star_style_CharacterProperties_idl__ +#include <com/sun/star/style/CharacterProperties.idl> +#endif +#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__ +#include <com/sun/star/style/CharacterPropertiesAsian.idl> +#endif +#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__ +#include <com/sun/star/style/CharacterPropertiesComplex.idl> +#endif +#ifndef __com_sun_star_style_ParagraphProperties_idl__ +#include <com/sun/star/style/ParagraphProperties.idl> +#endif //============================================================================= @@ -101,25 +113,14 @@ service TextTableCursor // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; - + service com::sun::star::style::CharacterProperties; + service com::sun::star::style::CharacterPropertiesAsian; + service com::sun::star::style::CharacterPropertiesComplex; + service com::sun::star::style::ParagraphProperties; }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:04 hjs - initial import - - Revision 1.3 2000/09/11 11:53:01 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/text/UserDefinedIndex.idl b/offapi/com/sun/star/text/UserDefinedIndex.idl index 3d8aa251904d..10719a074e66 100644 --- a/offapi/com/sun/star/text/UserDefinedIndex.idl +++ b/offapi/com/sun/star/text/UserDefinedIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: UserDefinedIndex.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: os $ $Date: 2001-03-07 12:41:22 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,50 +70,46 @@ //============================================================================= - module com { module sun { module star { module text { +module com { module sun { module star { module text { //============================================================================= -// DocMerge from xml: service com::sun::star::text::UserDefinedIndex /** specifies service of user defined indexes within a document.@see com::sun::star::text::BaseIndex */ service UserDefinedIndex { - // DocMerge: empty anyway service com::sun::star::text::BaseIndex; - /* - returns the interface to access the paragraph style names that are included + /** contains the interface to access the paragraph style names that are included in this index. @see DocumentIndexParagraphStyles */ - // DocMerge: empty anyway [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; - /* determins if the document index marks are included in this index. + + /** determins if the document index marks are included in this index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromMarks; - /* determins if the outline level of the location of the indexed object is - used as index level of the index entry.*/ - // DocMerge: empty anyway + /** determins if the outline level of the location of the indexed object is + used as index level of the index entry.*/ [optional, property] boolean UseLevelFromSource; - /* determins if tables are included in the index. + + /** determins if tables are included in the index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromTables; - /* determins if text frames are included in the index. + + /** determins if text frames are included in the index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromTextFrames; - /* determins if graphic objects are included in the index. + + /** determins if graphic objects are included in the index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromGraphicObjects; - /* determins if embedded objects are included in the index. + + /** determins if embedded objects are included in the index. */ - // DocMerge: empty anyway [optional, property] boolean CreateFromEmbeddedObjects; + /** contains all index marks that are related to this index. */ diff --git a/offapi/com/sun/star/text/UserIndex.idl b/offapi/com/sun/star/text/UserIndex.idl index 130a48b0c40e..a64b6b83d6bf 100644 --- a/offapi/com/sun/star/text/UserIndex.idl +++ b/offapi/com/sun/star/text/UserIndex.idl @@ -2,9 +2,9 @@ * * $RCSfile: UserIndex.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: os $ $Date: 2002-01-07 16:14:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,33 @@ service UserIndex { service com::sun::star::text::BaseIndex; - /* - returns the interface to access the paragraph style names that are included + /** contains the interface to access the paragraph style names that are included in this index. @see DocumentIndexParagraphStyles */ [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles; - /* determins if the document index marks are included in this index. + + /** determins if the document index marks are included in this index. */ [optional, property] boolean CreateFromMarks; - /* determins if the outline level of the location of the indexed object is + + /** determins if the outline level of the location of the indexed object is used as index level of the index entry.*/ [optional, property] boolean UseLevelFromSource; - /* determins if tables are included in the index. + + /** determins if tables are included in the index. */ [optional, property] boolean CreateFromTables; - /* determins if text frames are included in the index. + + /** determins if text frames are included in the index. */ [optional, property] boolean CreateFromTextFrames; - /* determins if graphic objects are included in the index. + + /** determins if graphic objects are included in the index. */ [optional, property] boolean CreateFromGraphicObjects; - /* determins if embedded objects are included in the index. + + /** determins if embedded objects are included in the index. */ [optional, property] boolean CreateFromEmbeddedObjects; /** contains the name of the user index. diff --git a/offapi/com/sun/star/text/XPagePrintable.idl b/offapi/com/sun/star/text/XPagePrintable.idl index 62499ebef963..6db2aaed1949 100644 --- a/offapi/com/sun/star/text/XPagePrintable.idl +++ b/offapi/com/sun/star/text/XPagePrintable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPagePrintable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -116,7 +116,7 @@ interface XPagePrintable: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::text::XPagePrintable::printPages - /** prints the pages according to the <type scope="com::sun::star::view">PrintSettings</type>.@see com::sun::star::view::PrintOptions + /** prints the pages according to the <type scope="com::sun::star::view">PagePrintSettings</type>.@see com::sun::star::view::PrintOptions */ void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -130,6 +130,12 @@ interface XPagePrintable: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/04/12 08:10:50 os + service name of properties corrected + + Revision 1.5 2001/03/16 16:41:46 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/21 08:35:21 mi @see interface/service/... ident -> @see ident - for new docu generator diff --git a/offapi/com/sun/star/text/XTextContent.idl b/offapi/com/sun/star/text/XTextContent.idl index 22dfbe730a6a..9224b47fbf24 100644 --- a/offapi/com/sun/star/text/XTextContent.idl +++ b/offapi/com/sun/star/text/XTextContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextContent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:06 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,9 @@ //============================================================================= -// DocMerge: empty anyway +/** enables objects to be inserted into a text and to provide their + location in a text once they are inserted into it. + */ interface XTextContent: com::sun::star::lang::XComponent { //------------------------------------------------------------------------- @@ -124,6 +126,12 @@ interface XTextContent: com::sun::star::lang::XComponent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.1 2002/08/27 12:01:09 tl + #97432# documentation added + + Revision 1.4 2001/03/16 16:41:46 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:44:27 mi moved from api diff --git a/offapi/com/sun/star/text/XTextCursor.idl b/offapi/com/sun/star/text/XTextCursor.idl index ecf07071af8d..f8cb35b315a9 100644 --- a/offapi/com/sun/star/text/XTextCursor.idl +++ b/offapi/com/sun/star/text/XTextCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextCursor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,8 @@ //============================================================================= -// DocMerge: empty anyway +/** extends a text range by method to modify its position. + */ interface XTextCursor: com::sun::star::text::XTextRange { //------------------------------------------------------------------------- @@ -143,6 +144,15 @@ interface XTextCursor: com::sun::star::text::XTextRange /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.2 2002/08/27 12:02:55 tl + #97433# documentation added + + Revision 1.4.16.1 2002/08/27 12:01:55 tl + #97435# documentation added + + Revision 1.4 2001/03/16 16:41:46 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:44:27 mi moved from api diff --git a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl index 4a9f761159e9..2ee6a5927e3f 100644 --- a/offapi/com/sun/star/text/fieldmaster/Bibliography.idl +++ b/offapi/com/sun/star/text/fieldmaster/Bibliography.idl @@ -2,9 +2,9 @@ * * $RCSfile: Bibliography.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: os $ $Date: 2001-06-06 11:27:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,6 +77,7 @@ module com { module sun { module star { module text { module FieldMaster { service Bibliography { service com::sun::star::text::TextFieldMaster; + //------------------------------------------------------------------------ /** determins whether the bibiliography text fields are numbered. If </FALSE> the short name of the bibliography entry is displayed instead. diff --git a/offapi/com/sun/star/text/fieldmaster/Database.idl b/offapi/com/sun/star/text/fieldmaster/Database.idl index 9e2da4bfea52..9f921dce6da7 100644 --- a/offapi/com/sun/star/text/fieldmaster/Database.idl +++ b/offapi/com/sun/star/text/fieldmaster/Database.idl @@ -2,9 +2,9 @@ * * $RCSfile: Database.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tl $ $Date: 2002-07-10 11:57:14 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,6 +76,7 @@ module com { module sun { module star { module text { module FieldMaster { service Database { service com::sun::star::text::TextFieldMaster; + //------------------------------------------------------------------------ /** contains the name of the data source. */ diff --git a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl index 72cd20dd1da9..7b47c70b9959 100644 --- a/offapi/com/sun/star/text/fieldmaster/SetExpression.idl +++ b/offapi/com/sun/star/text/fieldmaster/SetExpression.idl @@ -2,9 +2,9 @@ * * $RCSfile: SetExpression.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2001-04-20 11:38:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,6 +76,7 @@ module com { module sun { module star { module text { module FieldMaster { service SetExpression { service com::sun::star::text::TextFieldMaster; + //------------------------------------------------------------------------ /** determins the number of the chapter. This values is used if the field master is set as number sequence. diff --git a/offapi/com/sun/star/text/textfield/Annotation.idl b/offapi/com/sun/star/text/textfield/Annotation.idl index 9bd891cfb5b8..5a86e7ce922c 100644 --- a/offapi/com/sun/star/text/textfield/Annotation.idl +++ b/offapi/com/sun/star/text/textfield/Annotation.idl @@ -2,9 +2,9 @@ * * $RCSfile: Annotation.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2002-01-08 15:32:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ service Annotation /** contains the annotation's content */ [property]string Content; - /** contains the creation data. + /** contains the creation date. */ [property]com::sun::star::util::Date Date; }; diff --git a/offapi/com/sun/star/text/textfield/Author.idl b/offapi/com/sun/star/text/textfield/Author.idl index 515b5f846a53..b050048e6b6a 100644 --- a/offapi/com/sun/star/text/textfield/Author.idl +++ b/offapi/com/sun/star/text/textfield/Author.idl @@ -2,9 +2,9 @@ * * $RCSfile: Author.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: os $ $Date: 2002-01-09 07:44:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,6 +90,14 @@ service Author @see com::sun::star::text::AuthorDisplayFormat */ [optional, property] short AuthorFormat; + /** contains the current content of the text field. + <p> This property is escpecially usefull for import/export purposes. </p> + */ + [optional, property]string CurrentPresentation; + /** determines whether the full name of the author is displayed rather than + the initials. + */ + [optional, property]boolean FullName; }; //============================================================================= diff --git a/offapi/com/sun/star/text/textfield/Bibliography.idl b/offapi/com/sun/star/text/textfield/Bibliography.idl index c5f2922b6f41..cb5ba8d67a18 100644 --- a/offapi/com/sun/star/text/textfield/Bibliography.idl +++ b/offapi/com/sun/star/text/textfield/Bibliography.idl @@ -2,9 +2,9 @@ * * $RCSfile: Bibliography.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2000-11-16 12:20:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,8 +62,9 @@ #ifndef __com_sun_star_text_textfield_Bibliography_idl__ #define __com_sun_star_text_textfield_Bibliography_idl_ -#include <com/sun/star/text/TextField.idl> #include <com/sun/star/beans/PropertyValue.idl> +#include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -75,7 +76,8 @@ module com { module sun { module star { module text { module textfield { */ service Bibliography { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the bibliography fields of the text field. */ [property] sequence <com::sun::star::beans::PropertyValue> Fields; diff --git a/offapi/com/sun/star/text/textfield/Database.idl b/offapi/com/sun/star/text/textfield/Database.idl index e593a0eab6a5..7253d51602ad 100644 --- a/offapi/com/sun/star/text/textfield/Database.idl +++ b/offapi/com/sun/star/text/textfield/Database.idl @@ -2,9 +2,9 @@ * * $RCSfile: Database.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2002-01-08 15:33:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_Database_idl_ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -74,8 +75,9 @@ module com { module sun { module star { module text { module textfield { */ service Database { - service com::sun::star::text::TextField; - /** contains the database content that was merged in at the last database merge action. + service com::sun::star::text::DependentTextField; + + /** contains the database content that was merged in the last database merge action. Initially it contains the colum name in parenthesis (<>). */ [property]string Content; diff --git a/offapi/com/sun/star/text/textfield/DatabaseName.idl b/offapi/com/sun/star/text/textfield/DatabaseName.idl index 703b9cbb2917..58ca4b32950e 100644 --- a/offapi/com/sun/star/text/textfield/DatabaseName.idl +++ b/offapi/com/sun/star/text/textfield/DatabaseName.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseName.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tl $ $Date: 2002-07-10 11:58:33 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,7 +62,8 @@ #ifndef __com_sun_star_text_textfield_DatabaseName_idl__ #define __com_sun_star_text_textfield_DatabaseName_idl_ -#include <com/sun/star/text/TextField.idl> + +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -74,12 +75,13 @@ module com { module sun { module star { module text { module textfield { */ service DatabaseName { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the name of the database. */ [property]string DataBaseName; /** determines the interpretation of the property DataTableName. - <type scope="com::sun::star::sdb">CommandType</type>. + @see com::sun::star::sdb::CommandType */ [property]long DataCommandType; /** contains the name of the database table, query or a statement depending diff --git a/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl b/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl index 5e0f849c1249..3ab288b99378 100644 --- a/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl +++ b/offapi/com/sun/star/text/textfield/DatabaseNextSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseNextSet.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tl $ $Date: 2002-07-10 11:58:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_DatabaseNextSet_idl_ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -74,12 +75,13 @@ module com { module sun { module star { module text { module textfield { */ service DatabaseNextSet { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the name of the database. */ [property]string DataBaseName; /** determines the interpretation of the property DataTableName. - <type scope="com::sun::star::sdb">CommandType</type>. + @see com::sun::star::sdb::CommandType */ [property]long DataCommandType; /** contains the name of the database table, query or a statement depending diff --git a/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl b/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl index f2212907afdb..727ac6ec0694 100644 --- a/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl +++ b/offapi/com/sun/star/text/textfield/DatabaseNumberOfSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseNumberOfSet.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tl $ $Date: 2002-07-10 11:58:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_DatabaseNumberOfSet_idl_ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -75,12 +76,13 @@ module com { module sun { module star { module text { module textfield { */ service DatabaseNumberOfSet { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the name of the database. */ [property]string DataBaseName; /** determines the interpretation of the property DataTableName. - <type scope="com::sun::star::sdb">CommandType</type>. + @see com::sun::star::sdb::CommandType */ [property]long DataCommandType; /** contains the name of the database table, query or a statement depending diff --git a/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl b/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl index 7db2c8dddf78..9774d57b4812 100644 --- a/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl +++ b/offapi/com/sun/star/text/textfield/DatabaseSetNumber.idl @@ -2,9 +2,9 @@ * * $RCSfile: DatabaseSetNumber.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tl $ $Date: 2002-07-10 11:58:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_DatabaseSetNumber_idl_ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -75,12 +76,13 @@ module com { module sun { module star { module text { module textfield { */ service DatabaseSetNumber { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the name of the database. */ [property]string DataBaseName; /** determines the interpretation of the property DataTableName. - <type scope="com::sun::star::sdb">CommandType</type>. + @see com::sun::star::sdb::CommandType */ [property]long DataCommandType; /** contains the name of the database table, query or a statement depending diff --git a/offapi/com/sun/star/text/textfield/DateTime.idl b/offapi/com/sun/star/text/textfield/DateTime.idl index 92f0164a3a06..0eb8845397fd 100644 --- a/offapi/com/sun/star/text/textfield/DateTime.idl +++ b/offapi/com/sun/star/text/textfield/DateTime.idl @@ -2,9 +2,9 @@ * * $RCSfile: DateTime.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: os $ $Date: 2001-03-13 09:49:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,13 +82,13 @@ service DateTime */ [optional, property] boolean IsFixed; - /** If this flag is set to <TRUE/> this field represents, + /** If this flag is set to <TRUE/> this field represents a date with an optional time. If it is set to <FALSE/> only the time is used here. */ [property] boolean IsDate; - /** the is the content of this field + /** the is the content of this field. */ [optional, property] com::sun::star::util::DateTime DateTimeValue; @@ -100,12 +100,12 @@ service DateTime /** this is the display format for this field. Depending on <member>IsDate</member>, this is either a - <const scope="com::sun::star">text::DateDisplayFormat</const> or - <const scope="com::sun::star">text::TimeDisplayFormat</const>. + <type scope="com::sun::star::text">DateDisplayFormat</type> or + <type scope="com::sun::star::text">TimeDisplayFormat</type>. This property is deprecated and is here only for components that do not support a - <type scope="com::sun::star">util::NumberFormatter</type>. + <type scope="com::sun::star::util">NumberFormatter</type>. @see com::sun::star::text::DateDisplayFormat @see com::sun::star::text::TimeDisplayFormat diff --git a/offapi/com/sun/star/text/textfield/GetReference.idl b/offapi/com/sun/star/text/textfield/GetReference.idl index 3c64098f7026..5318819930c6 100644 --- a/offapi/com/sun/star/text/textfield/GetReference.idl +++ b/offapi/com/sun/star/text/textfield/GetReference.idl @@ -2,9 +2,9 @@ * * $RCSfile: GetReference.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,7 +81,7 @@ service GetReference */ [property] string CurrentPresentation; /** contains the source of the reference. - @see com.sun.star.text.ReferenceFieldSource + @see com::sun::star::text::ReferenceFieldSource */ [property] short ReferenceFieldSource; /** contains the name of the source. @@ -90,12 +90,12 @@ service GetReference */ [property] string SourceName; /** contains the type of the reference. - @see com.sun.star.text.ReferenceFieldPart + @see com::sun::star::text::ReferenceFieldPart */ [property] short ReferenceFieldPart; /** contains the sequence number of a set expression field that is used as sequence field or the value of the ReferenceId property of a footnote or endnote. - @see service com.sun.star.text.Footnote + @see com::sun::star::text::Footnote */ [property] short SequenceNumber; }; diff --git a/offapi/com/sun/star/text/textfield/Input.idl b/offapi/com/sun/star/text/textfield/Input.idl index efef2e7de53b..b41b52583fba 100644 --- a/offapi/com/sun/star/text/textfield/Input.idl +++ b/offapi/com/sun/star/text/textfield/Input.idl @@ -2,9 +2,9 @@ * * $RCSfile: Input.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,6 @@ module com { module sun { module star { module text { module textfield { service Input { service com::sun::star::text::TextField; - /** contains the text content of the text field. <p> The field displays the text content.</p> */ diff --git a/offapi/com/sun/star/text/textfield/InputUser.idl b/offapi/com/sun/star/text/textfield/InputUser.idl index a69d1de95e28..d8be16dcf617 100644 --- a/offapi/com/sun/star/text/textfield/InputUser.idl +++ b/offapi/com/sun/star/text/textfield/InputUser.idl @@ -2,9 +2,9 @@ * * $RCSfile: InputUser.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,18 @@ module com { module sun { module star { module text { module textfield { //============================================================================= /** specifies service of an input field that is used to change the content of a corresponding field master of a user defined text field. + @see com::sun::star::text::TextField */ -service Input +service InputUser { service com::sun::star::text::TextField; - /* contains the name of the corresponding field master. + /** contains the name of the corresponding field master. */ [optional, property] string Content; - /* contains a hint text. + + /** contains a hint text. <p> This hint may be used as help tip or as headline of a corresponding dialog to edit the field content.</p> */ diff --git a/offapi/com/sun/star/text/textfield/SetExpression.idl b/offapi/com/sun/star/text/textfield/SetExpression.idl index f0ef950824a0..b30efc0cfab2 100644 --- a/offapi/com/sun/star/text/textfield/SetExpression.idl +++ b/offapi/com/sun/star/text/textfield/SetExpression.idl @@ -2,9 +2,9 @@ * * $RCSfile: SetExpression.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2002-01-09 08:20:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_SetExpression_idl_ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> //============================================================================= @@ -74,7 +75,8 @@ module com { module sun { module star { module text { module textfield { */ service SetExpression { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; + /** contains the textual content of the field. */ [property]string Content; diff --git a/offapi/com/sun/star/text/textfield/TableFormula.idl b/offapi/com/sun/star/text/textfield/TableFormula.idl index 30bdb2bbeabb..40397d2fad7a 100644 --- a/offapi/com/sun/star/text/textfield/TableFormula.idl +++ b/offapi/com/sun/star/text/textfield/TableFormula.idl @@ -2,9 +2,9 @@ * * $RCSfile: TableFormula.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: os $ $Date: 2001-10-17 13:58:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,8 +88,8 @@ service TableFormula /** determins whether the formula displayed as text or evaluated. */ [property] boolean IsShowFormula; - /** this is the number format for this field - @see <type>scope="com::sun::star::util">NumberFormatter</type> + /** this is the number format for this field. + @see com::sun::star::util::NumberFormatter */ [property] short NumberFormat; }; diff --git a/offapi/com/sun/star/text/textfield/User.idl b/offapi/com/sun/star/text/textfield/User.idl index 4da53f14c520..eb46f3b248c4 100644 --- a/offapi/com/sun/star/text/textfield/User.idl +++ b/offapi/com/sun/star/text/textfield/User.idl @@ -2,9 +2,9 @@ * * $RCSfile: User.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2001-03-13 10:26:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,6 +63,7 @@ #define __com_sun_star_text_textfield_User_idl__ #include <com/sun/star/text/TextField.idl> +#include <com/sun/star/text/DependentTextField.idl> #include <com/sun/star/text/XDependentTextField.idl> //============================================================================= @@ -75,15 +76,16 @@ module com { module sun { module star { module text { module textfield { */ service User { - service com::sun::star::text::TextField; + service com::sun::star::text::DependentTextField; - interface ::com::sun::star::text::XDependentTextField; - /* determins if the content is shown as text rather than as value. + /** determins if the content is shown as text rather than as value. */ [optional, property] boolean IsShowFormula; - /* determins if the field is visible. + + /** determins if the field is visible. */ [optional, property] boolean IsVisible; + /** this is the number format for this field. @see com::sun::star::util::NumberFormatter */ diff --git a/offapi/com/sun/star/ucb/CHAOSProgressStart.idl b/offapi/com/sun/star/ucb/CHAOSProgressStart.idl index e860b49206cb..76bc28a3a324 100644 --- a/offapi/com/sun/star/ucb/CHAOSProgressStart.idl +++ b/offapi/com/sun/star/ucb/CHAOSProgressStart.idl @@ -2,9 +2,9 @@ * * $RCSfile: CHAOSProgressStart.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,6 +74,8 @@ module com { module sun { module star { module ucb { /** An object representing the start of a task's activity that will progress from some minimal to some maximal value. + @deprecated + @see XProgressHandler */ struct CHAOSProgressStart diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 47cdeb149c56..2d7130af197d 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,9 +88,10 @@ service CachedDynamicResultSet /** Provides remote optimized read access to a static or a dynamically changing <type>ContentResultSet</type>. - <p>The <type>XResultSet</type>s given to the listener in the first - notification in the <type>WelcomeDynamicResultSetStruct</type> are - implementations of the <type>CachedContentResultSet</type> service. + <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to + the listener in the first notification in the + <type>WelcomeDynamicResultSetStruct</type> are implementations of the + <type>CachedContentResultSet</type> service. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 0317d09227da..a4914e2b5966 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSetStub.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,9 +89,10 @@ service CachedDynamicResultSetStub remote optimized read access to a static or dynamically changing <type>ContentResultSet</type>. - <p>The <type>XResultSet</type>s given to the listener in the first - notification in the <type>WelcomeDynamicResultSetStruct</type> are - implementations of <type>CachedContentResultSetStub</type>. + <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to + the listener in the first notification in the + <type>WelcomeDynamicResultSetStruct</type> are implementations of + <type>CachedContentResultSetStub</type>. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/Command.idl b/offapi/com/sun/star/ucb/Command.idl index 6421f7b0b055..c07b385e4388 100644 --- a/offapi/com/sun/star/ucb/Command.idl +++ b/offapi/com/sun/star/ucb/Command.idl @@ -2,9 +2,9 @@ * * $RCSfile: Command.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,7 +85,8 @@ struct Command //------------------------------------------------------------------------- /** contains an implementation specific handle for the command. - <p>It may be <code>-1</code> if the implementation has no handle. + <p>It must be <code>-1</code> if the implementation has no handle. + <code>0</code> is a valid command handle. */ long Handle; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index 6d12b239769e..c993688787ef 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -2,9 +2,9 @@ * * $RCSfile: Content.idl,v $ * - * $Revision: 1.18 $ + * $Revision: 1.19 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -148,8 +148,7 @@ service Content /** enables the caller to let the content execute commands. <p>It is strongly recommended that any implementation supports the - improved <type>com::sun::star::ucb::XCommandProcessor2</type> - interface.</p> + improved <type>XCommandProcessor2</type> interface.</p> <p>Typical commands are "open", "delete", "getPropertyValues" and "setPropertyValues". Each content must support a set of standard @@ -286,7 +285,7 @@ service Content // when "updating" a POP3-Inbox, the content for that box will get // and store all new objects on the appropriate server. The inserted // contents will be notified by calling - // <member>XContent::contentEvent</member>. + // <member>XContentEventListener::contentEvent</member>. void <B>update</B> <type>OpenCommandArgument2</type> aOpenCommandArg @@ -683,7 +682,7 @@ service Content the interface <type scope="com::sun::star::beans">XPropertyContainer</type>. ) */ - interface com::sun::star::beans::XPropertySetInfoChangeNotifier; + [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier; //------------------------------------------------------------------------- /** can be used to notify commands removed from or added to the @@ -721,7 +720,7 @@ service Content <p>This interface must be implemented by a content which is a (logical) child of a content. */ - interface com::sun::star::container::XChild; + [optional] interface com::sun::star::container::XChild; }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/ContentTransmitter.idl b/offapi/com/sun/star/ucb/ContentTransmitter.idl index bde9d3c49956..48e329f54ed4 100644 --- a/offapi/com/sun/star/ucb/ContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/ContentTransmitter.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentTransmitter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,6 +71,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** A <type>ContentTransmitter</type> is a service that provides + + @deprecated */ service ContentTransmitter { diff --git a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl index 6fc149c38de9..365339a1c128 100644 --- a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl +++ b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl @@ -2,9 +2,9 @@ * * $RCSfile: DuplicateCommandIdentifierException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-09-07 09:16:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ module com { module sun { module star { module ucb { the same command identifier was used for two threads. <p>Each thread must use it's own command identifier, which must be obtained - using <method>XcommandProcessor::createCommandIdentifier</method>. Command + using <member>XcommandProcessor::createCommandIdentifier</member>. Command identifier <code>0</code>, which indicates that the command shall never be aborted by a client, can be used by any thread. diff --git a/offapi/com/sun/star/ucb/Error.idl b/offapi/com/sun/star/ucb/Error.idl index 5017f3a1e4a9..9ed127bee30b 100644 --- a/offapi/com/sun/star/ucb/Error.idl +++ b/offapi/com/sun/star/ucb/Error.idl @@ -2,9 +2,9 @@ * * $RCSfile: Error.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,6 +68,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** These codes are used to indicate errors. + + @deprecated */ constants Error { diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index 521f2244750b..53eb207f57b1 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: FetchResult.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,7 +66,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** containes data of several rows of a <type>ContentResultSet</type>. +/** contains data of several rows of a <type>ContentResultSet</type>. <p>This struct is returned from <member>XFetchProvider::fetch</member>, for example. @@ -75,7 +75,7 @@ module com { module sun { module star { module ucb { struct FetchResult { //------------------------------------------------------------------------- - /** containes the demanded data. + /** contains the demanded data. <p>One any contains the data of one whole row. Those methods which use this struct have to specify, what the any has to contain. @@ -83,24 +83,24 @@ struct FetchResult sequence< any > Rows; //------------------------------------------------------------------------- - /** indicates the index of the first in <member>Rows</member> contained - row in the original resultset. So if <member>StartIndex</member> - equals <code>3</code>, the first element in the sequence - <member>Rows</member> containes the data of the index <code>3</code> - in the original resultset. + /** indicates the index of the first row contained in + <member>FetchResult::Rows</member> in the original resultset. So if + <member>FetchResult::StartIndex</member> equals <code>3</code>, the + first element in the sequence <member>FetchResult::Rows</member> + contains the data of the index <code>3</code> in the original resultset. <p>The following rows are one after the other, but the direction - depends on the value of <member>Direction</member> + depends on the value of <member>FetchResult::Direction</member> */ long StartIndex; //------------------------------------------------------------------------- /** indicates the orientation in which the rows are fetched and set into - the sequence <member>Rows</member>. + the sequence <member>FetchResult::Rows</member>. - <p>When <member>Orientation</member> equals <TRUE/>, the rows in - <member>Rows</member> are ordered in the same way as in the original - resultset. + <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the + rows in <member>FetchResult::Rows</member> are ordered in the same way + as in the original resultset. */ boolean Orientation; diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index 0e1054d3fdcc..24d2fa3d2072 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FileContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index 7e1c2d6d8f83..f00b0f9e6e82 100644 --- a/offapi/com/sun/star/ucb/FolderListEntry.idl +++ b/offapi/com/sun/star/ucb/FolderListEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: FolderListEntry.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,7 +100,7 @@ struct FolderListEntry //------------------------------------------------------------------------- /** The folder shall be purged (only used in conjunction with the - <type>FolderListCommand::SET</type>). + <member>FolderListCommand::SET</member>). */ boolean Purge; }; diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl index d51779cba75b..f225e032dfb2 100644 --- a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyContentProvider.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -124,10 +124,10 @@ service HierarchyContentProvider <ul> <li> - vnd.sun.star.hier:/ ( The URL of the HCP Root Folder ) + vnd.sun.star.hier:/ (The URL of the HCP Root Folder) </li> <li> - vnd.sun.star.hier:/Bookmarks/Sun%20Microssystems%20Home%20Page + vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page </li> <li> vnd.sun.star.hier:/Workplace/Printers diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index c5bf2e269961..126720585768 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyFolderContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 0bf10d1b3a33..4b9ed42985d6 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyLinkContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index 0b6a3dd5aa0b..9b763c328c91 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyRootFolderContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/IOErrorCode.idl b/offapi/com/sun/star/ucb/IOErrorCode.idl index fb3e7c15b1e5..1badc35a1cb1 100644 --- a/offapi/com/sun/star/ucb/IOErrorCode.idl +++ b/offapi/com/sun/star/ucb/IOErrorCode.idl @@ -2,9 +2,9 @@ * * $RCSfile: IOErrorCode.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:50:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,10 +69,10 @@ module com { module sun { module star { module ucb { //============================================================================= /** Types of input/output errors. - <P>See <type>com::sun::star::task::InteractionHandler</type> for a + <P>See <type scope="com::sun::star::task">InteractionHandler</type> for a description of what kinds of arguments - <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> should - use with each of these error codes.</P> + <type>InteractiveAugmentedIOException</type> should use with each of these + error codes.</P> */ enum IOErrorCode { diff --git a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl index 698c6d3d6416..7adf1a58e0f4 100644 --- a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveAugmentedIOException.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:50:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,8 +78,8 @@ exception InteractiveAugmentedIOException : com::sun::star::ucb::InteractiveIOEx //------------------------------------------------------------------------- /** Additional arguments. - <P>See <type>com::sun::star::task::InteractionHandler</type> for a - description of well-known arguments.</P> + <P>See <type scope="com::sun::star::task">InteractionHandler</type> + for a description of well-known arguments.</P> */ sequence< any > Arguments; }; diff --git a/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl b/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl index bdff7dddc99a..614e088aac27 100644 --- a/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl +++ b/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveCHAOSException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-12 15:53:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** An error capsuling error information as used by CHAOS. + + @deprecated */ exception InteractiveCHAOSException: com::sun::star::task::ClassifiedInteractionRequest { diff --git a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl index c2ceec68a969..03d3a29e54d3 100644 --- a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveFileIOException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sb $ $Date: 2001-08-31 08:00:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,9 +77,10 @@ module com { module sun { module star { module ucb { //============================================================================= /** An input/output error while processing a file. + <p>This exception is deprecated. Use + <type>InteractiveAugmentedIOException</type> instead. + @deprecated - Use <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> - instead. */ exception InteractiveFileIOException: com::sun::star::ucb::InteractiveIOException { diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 16d663b3eeaa..c361d6bd2b33 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListAction.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,9 @@ struct ListAction <code>1</code> as usual with JDBC ). <p>Its value does not necessary indicate the new position in the new - <type>XResultSet</type>, but a position while doing the changes step by - step beginning with the old <type>XResultSet</type>. + <type scope="com::sun::star::sdbc">XResultSet</type>, but a position + while doing the changes step by step beginning with the old + <type scope="com::sun::star::sdbc">XResultSet</type>. */ long Position; diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index 45218eb2d10f..be0bf637de21 100644 --- a/offapi/com/sun/star/ucb/ListActionType.idl +++ b/offapi/com/sun/star/ucb/ListActionType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListActionType.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,10 +85,12 @@ constants ListActionType <p>The member <member>ListAction::ActionInfo</member> is required to contain a struct <type>WelcomeDynamicResultSetStruct</type>. - This struct contains two <type>XResultSet</type>s (old and new). + This struct contains two + <type scope="com::sun::star::sdbc">XResultSet</type>s (old and new). During and after the notification only the new set is valid for access. - But the listener is required to remind both <type>XResultSet</type>s as he - will not get another chance to get them again. + But the listener is required to remind both + <type scope="com::sun::star::sdbc">XResultSet</type>s as he will not get + another chance to get them again. <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> are not used. @@ -100,9 +102,9 @@ constants ListActionType <p>This action is related to <member>ContentAction::INSERTED</member>. - <p>The memners <member>ListAction::Count</member> and + <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> contain the position and count of - newly inserted rows. If the Count is greater than one, the inserted rows + newly inserted rows. If the count is greater than one, the inserted rows have to be one after the other. <p> <member>ListAction::ActionInfo</member> could contain something but @@ -137,7 +139,7 @@ constants ListActionType <p>The members <member>ListAction::ListActionType</member>, <member>ListAction::Count</member> and <member>ListAction::Position</member> - are useless. + are ignored. */ const long CLEARED = 23; @@ -169,9 +171,9 @@ constants ListActionType rows with modified properties have to be one after the other. <p> <member>ListAction::ActionInfo</member> could contain something but - this is not required. - E.g it could contain the new properties (i.e. for remote optimizing), - but this is not required nor unrestrictly recommended. + this is not required. For example, it could contain the new properties + (i.e. for remote optimizing), but this is not required nor unrestrictly + recommended. <p>@todo ... further description of allowed contents for <member>ListAction::ActionInfo</member> is needed diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 80a21f163517..0b5ae0ce32fe 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenCommandArgument.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2002-07-30 10:41:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 954c1e8f7053..9507be343485 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageFolderContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 47ce061b68df..f759c4c83a1d 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageStreamContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl index 44906f7ebefa..c5b86e0da14a 100644 --- a/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: RemoteContentProviderAcceptor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: sb $ $Date: 2001-02-12 09:35:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,12 +80,13 @@ service RemoteContentProviderAcceptor interface XRemoteContentProviderAcceptor; //------------------------------------------------------------------------ - /** This optional interface can be used to adopt a layz implement strategy + /** This optional interface can be used to adopt a lazy implement strategy for this service, which can improve performance in certain situations. + <p>The way this works might change, therefore this interface is marked + as deprectated. + @deprecated - The way this works might change, therefore this interface is marked as - deprectated. */ [optional] interface XRemoteContentProviderActivator; }; diff --git a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl index 571670cb0138..05d33fa73543 100644 --- a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: RemoteProxyContentProvider.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,9 +79,10 @@ interface XParameterizedContentProvider; <type>RemoteContentProviderAcceptor</type> and <type>XRemoteContentProviderActivator</type> for more information). - @deprecated - The way this works might change, therefore this interface is marked as + <p>The way this works might change, therefore this interface is marked as deprectated. + + @deprecated */ service RemoteProxyContentProvider { diff --git a/offapi/com/sun/star/ucb/TransferCommandOperation.idl b/offapi/com/sun/star/ucb/TransferCommandOperation.idl index ef40f3a4c425..1cccbd0b62d5 100644 --- a/offapi/com/sun/star/ucb/TransferCommandOperation.idl +++ b/offapi/com/sun/star/ucb/TransferCommandOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransferCommandOperation.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** These are the possible values for - <member>GlobalTransferCommandArgument::Operation</type>. + <member>GlobalTransferCommandArgument::Operation</member>. */ enum TransferCommandOperation { diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index ca47c6d7d0ce..8be2db163085 100644 --- a/offapi/com/sun/star/ucb/UniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/UniversalContentBroker.idl @@ -2,9 +2,9 @@ * * $RCSfile: UniversalContentBroker.idl,v $ * - * $Revision: 1.13 $ + * $Revision: 1.14 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl index 540189d26e50..11930a0101c0 100644 --- a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl +++ b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVContentProvider.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,9 +74,9 @@ module com { module sun { module star { module ucb { for the <type>UniversalContentBroker</type> (UCB). <p>It provides access to WebDAV and standard HTTP servers. The DCP - communicates with the server using the <a href="www.webdav.org">WebDAV</a> - protocol which is an extention to the HTTP protocol or using the plain HTTP - protocol in case the server is not WebDAV enabled. + communicates with the server using the WebDAV protocol which is an + extention to the HTTP protocol or using the plain HTTP protocol in case + the server is not WebDAV enabled. @see com::sun::star::ucb::Content */ diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index 37c19687fa8d..fe8359f9d136 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVDocumentContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index ec984be979c7..20fa138feb37 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVFolderContent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/XAnyCompare.idl b/offapi/com/sun/star/ucb/XAnyCompare.idl index cbf3c0889fd5..eb3ee2f7ffc4 100644 --- a/offapi/com/sun/star/ucb/XAnyCompare.idl +++ b/offapi/com/sun/star/ucb/XAnyCompare.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAnyCompare.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** compares two <type scope="com::sun::star::uno">Any</type>s. +/** compares two <atom>any</atom>s. */ interface XAnyCompare: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** allows comparision of two <type scope="com::sun::star::uno">Any</type>s. + /** allows comparision of two <atom>any</atom>s. @param Any1 is the first compare value diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index 2c9d8fff1a3a..e798c4a3b4a9 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,8 @@ module com { module sun { module star { module ucb { interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a remote optimized <type>XResultSet</type>. + /** creates a remote optimized + <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource must be an instance of service <type>CachedContentResultSetStub</type>. diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl index 3206daf547ac..cffe2c100b9c 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetStubFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,8 @@ module com { module sun { module star { module ucb { interface XCachedContentResultSetStubFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a remote optimized <type>XResultSet</type>. + /** creates a remote optimized + <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource must be an instance of service <type>ContentResultSet</type>. diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 0ebcf134967c..387a7fc2f999 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedDynamicResultSetStubFactory.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,8 +89,9 @@ module com { module sun { module star { module ucb { <p>Pay attention to instanciate this helper on serverside where your source <type>DynamicResultSet</type> was instanciated. - <p>Method <method>createCachedDynamicResultSetStub</method> can be used to - create a stub on serverside. + <p>Method + <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> + can be used to create a stub on serverside. <p>If you have instanciated a <type>CachedDynamicResultSet</type> on client side already, use method <member>connectToCache</member> to connect your diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index a750ee97f228..caaeedaca019 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandProcessor.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2002-06-21 12:43:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,7 +89,6 @@ module com { module sun { module star { module ucb { @version 1.0 @author Kai Sommerfeld - @deprecated @see com::sun::star::ucb::XCommandProcessor2 for the improved version of this interface. @@ -110,11 +109,11 @@ interface XCommandProcessor : com::sun::star::uno::XInterface only should get one identifier per thread and assign it to every command executed by that thread.</p> - <p>Also, after a call to <method>abort</method>, an identifier should - not be used any longer (and instead be released by a call to - <member>XCommandProcessor2::releaseCommandIdentifier</member>), + <p>Also, after a call to <member>XCommandProcessor::abort</member>, an + identifier should not be used any longer (and instead be released by a + call to <member>XCommandProcessor2::releaseCommandIdentifier</member>), because it may well abort <em>all</em> further calls to - <method>execute</method>.</p> + <member>XCommandProcessor::execute</member>.</p> <p>To avoid ever-increasing resource consumption, the identifier should be released via diff --git a/offapi/com/sun/star/ucb/XCommandProcessor2.idl b/offapi/com/sun/star/ucb/XCommandProcessor2.idl index e2615ec4cf15..4400868a1472 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor2.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandProcessor2.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sb $ $Date: 2001-08-20 15:30:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,20 +77,23 @@ interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor { //------------------------------------------------------------------------ /** releases a command identifier obtainded through - <method>createCommandIdentifier</method> when it is no longer used. + <member>XCommandProcessor::createCommandIdentifier</member> when it is + no longer used. <p>After this call the command identifier cannot be used any longer in - calls to <method>execute</method> and <method>abort</method>. (But it - can happen that a call to <method>createCommandIdentifier</method> + calls to <member>XCommandProcessor::execute</member> and + <member>XCommandProcessor::abort</member>. (But it can happen that a + call to <member>XCommandProcessor::createCommandIdentifier</member> reuses this identifier.)</p> @param CommandId A command identifier obtained through - <method>createCommandIdentifier</method>. If the identifier is zero, - the request is silently ignored; but if the identifier is invalid (not - obtained via <method>createCommandIdentifier</method> or already - handed to <method>releaseCommandIdentifier</method> before), the - behaviour is undefined. + <member>XCommandProcessor::createCommandIdentifier</member>. If the + identifier is zero, the request is silently ignored; but if the + identifier is invalid (not obtained via + <member>XCommandProcessor::createCommandIdentifier</method> or already + handed to <member>XCommandProcessor2::releaseCommandIdentifier</member> + before), the behaviour is undefined. */ [oneway] void releaseCommandIdentifier([in] long CommandId); }; diff --git a/offapi/com/sun/star/ucb/XContentTransmitter.idl b/offapi/com/sun/star/ucb/XContentTransmitter.idl index c7dc466f7a05..ee3245e4f1ca 100644 --- a/offapi/com/sun/star/ucb/XContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/XContentTransmitter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentTransmitter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** + @deprecated @version 1.0 @author Dirk Voelzke diff --git a/offapi/com/sun/star/ucb/XDataContainer.idl b/offapi/com/sun/star/ucb/XDataContainer.idl index 059d945a9d13..cdf5e16a4aee 100644 --- a/offapi/com/sun/star/ucb/XDataContainer.idl +++ b/offapi/com/sun/star/ucb/XDataContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataContainer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,8 @@ module com { module sun { module star { module ucb { @version 1.0 @author Kai Sommerfeld + + @deprecated */ interface XDataContainer: com::sun::star::container::XIndexContainer { diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index ffd31b58beca..dbec07c2126c 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDynamicResultSet.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,7 +105,8 @@ module com { module sun { module star { module ucb { about changes on a <type>ContentResultSet</type> and have an listener-controlled update from one version to the next version. Two <type>ContentResultSet</type> implementations were given to the listener in - the first notification as interface <type>XResultSet</type>. + the first notification as interface + <type scope="com::sun::star::sdbc">XResultSet</type>. </p> <p> @@ -130,7 +131,7 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access both ContentResultSets, + <li> The listener is allowed to access both <type>ContentResultSet</type>s, they must be both valid.</li> <li> It is not allowed to start a second notify-call.</li> <li> All addditional things we want to send as notification are to be @@ -143,10 +144,11 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access the new ContentResultSet. - The new one is first assigned in the WELCOME-event and than - the ResultSets are always swapped.</li> - <li> The listener is not allowed to access the old ContentResultSet.</li> + <li> The listener is allowed to access the new + <type>ContentResultSet</type>. The new one is first assigned in the + WELCOME-event and than the ResultSets are always swapped.</li> + <li> The listener is not allowed to access the old + <type>ContentResultSet</type>.</li> </ol> */ @@ -156,8 +158,9 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent /** Call this, if you don't care about any changes. @returns - an <type>XResultSet</type> that is implemented as - <type>ContentResultSet</type>. Its content will never change. + an <type scope="com::sun::star::sdbc">XResultSet</type> that is + implemented as <type>ContentResultSet</type>. Its content will never + change. @trows ListenerAlreadySetException if someone already has registered as listener via diff --git a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl index 4f22947bfbf2..3feaaf605d07 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDynamicResultSetListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,12 +83,13 @@ interface XDynamicResultSetListener: com::sun::star::lang::XEventListener /** A method used to propagate changes of a resultset. <p>In the first notify-call the listener gets two(!) - <type>XResultSet</type>s and has to hold them. The - <type>XResultSet</type>s are implementations of the service - <type>ContentResultSet</type>. + <type scope="com::sun::star::sdbc">XResultSet</type>s and has to hold + them. The <type scope="com::sun::star::sdbc">XResultSet</type>s are + implementations of the service <type>ContentResultSet</type>. - <p>The notified new <type>XResultSet</type> will stay valid after - returning from this method. The old one will become invalid after + <p>The notified new + <type scope="com::sun::star::sdbc">XResultSet</type> will stay valid + after returning from this method. The old one will become invalid after returning. <p>While in notify-call the listener is allowed to read from old and diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index b2892196ea5c..3efcf7c8e4e6 100644 --- a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl +++ b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionHandlerSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,20 +71,23 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This interface should be implemented by an interbnal XCommandEnvironment - that can not supply an <type>XInteractionHandler</type>, but instead wants - interaction requests to be handled by other internal error handling +/** This interface should be implemented by an internal + <type>XCommandEnvironment</type> that can not supply an + <type scope="com::sun::star::task">XInteractionHandler</type>, but instead + wants interaction requests to be handled by other internal error handling mechanism. - - @see XCommandEnvironment. */ interface XInteractionHandlerSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Returns whether an <type>XInteractionHandler</type> can be supplied. + /** Returns whether an + <type scope="com::sun::star::task">XInteractionHandler</type> can be + supplied. @returns - <TRUE/>, if an XInteractionHandler can be supplied, <FALSE/> otherwise. + <TRUE/>, if an + <type scope="com::sun::star::task">XInteractionHandler</type> can be + supplied, <FALSE/> otherwise. */ boolean hasInteractionHandler(); }; diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index d58489add5f6..b62d9ae4e4bd 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionSupplyAuthentication.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,8 +90,11 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'realm' value to hand back. - <p> This method should be called before select(), and should only - be called if canSetRealm() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetRealm</member> returned + <true/>.</p> */ void setRealm( [in] string Realm ); @@ -103,8 +106,11 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'user name' value to hand back. - <p>This method should be called before select(), and should only - be called if canSetUserName() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetUserName</member> + returned <true/>.</p> */ void setUserName( [in] string UserName ); @@ -116,31 +122,39 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'password' value to hand back. - <p>This method should be called before select(), and should only - be called if canSetPassword() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetPassword</member> + returned <true/>.</p> */ void setPassword( [in] string Password ); //------------------------------------------------------------------------- /** Specifies the available modes of how long to remember the password. - @param Default Returns the default mode (to be initially displayed to - the user). + @param Default + Returns the default mode (to be initially displayed to the user). - @returns A sequence of available modes to hand back. Each individual - mode should appear at most once in the sequence. If the sequence is - empty, a new mode cannot be handed back. + @returns + A sequence of available modes to hand back. Each individual mode + should appear at most once in the sequence. If the sequence is empty, + a new mode cannot be handed back. */ sequence<com::sun::star::ucb::RememberAuthentication> getRememberPasswordModes( [out] com::sun::star::ucb::RememberAuthentication Default ); //------------------------------------------------------------------------- /** Set a new mode of how long to remember the password. - <p> This method should be called before select(), and should only - be called if setPassword() is also called. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::setPassword</member> + is also called.</p> - @param Remember The mode to hand back, should be contained in the - sequence returned by getRememberPasswordModes. + @param Remember + The mode to hand back, should be contained in the sequence returned by + <member>XInteractionSupplyAuthentication::getRememberPasswordModes</member>. */ void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember ); @@ -152,8 +166,12 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'account' value to hand back. - <p> This method should be called before select(), and should only - be called if canSetAccount() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetAccount</member> + returned <true/>.</p> + */ void setAccount( [in] string Account ); @@ -172,11 +190,15 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new mode of how long to remember the account. - <p> This method should be called before select(), and should only - be called if setAccount() is also called. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::setAccount</member> + is also called.</p> @param Remember The mode to hand back, should be contained in the - sequence returned by getRememberAccountModes. + sequence returned by + <member>XInteractionSupplyAuthentication::getRememberAccountModes</member>. */ void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember ); diff --git a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl index a469322eca22..454f304b8381 100644 --- a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl +++ b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParameterizedContentProvider.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,8 +96,9 @@ interface XParameterizedContentProvider: com::sun::star::uno::XInterface @param Arguments Any supplementary arguments required by this <type>XContentProvider</type>, represented as a single string. If the - input is malformed, an <type>IllegalArgumentException</type> may be - raised. + input is malformed, an + <type scope="com::sun::star::lang">IllegalArgumentException</type> + may be raised. @param ReplaceExisting If true, and if the given Template conflicts with an already registered instance, the old registration is replaced @@ -127,8 +128,9 @@ interface XParameterizedContentProvider: com::sun::star::uno::XInterface @param Arguments Any supplementary arguments required by this <type>XContentProvider</type>, represented as a single string. If the - input is malformed, an <type>IllegalArgumentException</type> may be - raised. + input is malformed, an + <type scope="com::sun::star::lang">IllegalArgumentException</type> + may be raised. @return Either this <type>XContentProvider</type>, or another, specially adjusted version of this <type>XContentProvider</type> (this diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl index d0fe664fa960..a04839fd7b2c 100644 --- a/offapi/com/sun/star/ucb/XProgressHandler.idl +++ b/offapi/com/sun/star/ucb/XProgressHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProgressHandler.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,12 +82,14 @@ interface XProgressHandler: com::sun::star::uno::XInterface @param Status An object representing the new activity. There has to be an agreement between caller and callee of methods - <member>push</member> and <member>update</member> as to which Status - arguments are meaningful. For example, a <type>string</type> argument - to <member>push</member> should be used to transport some status text - that describes the progress being made (possibly followed by one or - more <member>update</member>s with <type>string</type> arguments, if - the appropriate status text changes as progress is being made). + <member>XProgressHandler::push</member> and + <member>XProgressHandler::update</member> as to which Status + arguments are meaningful. For example, a <atom>string</atom> argument + to <member>XProgressHandler::push</member> should be used to transport + some status text that describes the progress being made (possibly + followed by one or more <member>XProgressHandler::update</member>s with + <atom>string</atom> arguments, if the appropriate status text changes + as progress is being made). */ void push([in] any Status); @@ -96,7 +98,8 @@ interface XProgressHandler: com::sun::star::uno::XInterface progress. @param Status An object representing the progress made. See the - documentation of <member>push</member> for more information. + documentation of <member>XProgressHandler::push</member> for more + information. */ void update([in] any Status); diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 4a2448697906..83f2d7c003b1 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderAcceptor.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: sb $ $Date: 2001-03-20 13:31:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,12 +100,13 @@ interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface @param DoneListener If not null, the implementation of this interface can---through this callback---tell the calling side that the implementation no longer needs the remote content provider. (And the - calling side should call <member>removeRemoteContentProvider</member> + calling side should call + <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member> then.) To enable connection control, it is recommended that this argument also implements the interface - <type scope="com::sun::star::ucb">XRemoteContentProviderConnectionControl</type>. + <type>XRemoteContentProviderConnectionControl</type>. @return true if the remote content provider has successfully been added. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index 3c8c4e839666..dde48e3cf20e 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderActivator.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,29 +72,30 @@ interface XContentProviderManager; //============================================================================ /** This interface should be implemented together with - <type scope="com::sun::star::ucb">XRemoteContentProviderAcceptor</type> - and allows for a lazy implementation of - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>. + <type>XRemoteContentProviderAcceptor</type> and allows for a lazy + implementation of + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. - @deprecated The way this works might change, therefore this interface is marked as deprectated. + + @deprecated */ interface XRemoteContentProviderActivator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** Activate (i.e., register at the broker) the remote content providers that until now have only been remembered by - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>, but not registered. + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>, + but not registered. <p>This allows for - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method> + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member> to be implemented in a layz fashion (remember the remote content providers, but do not register them right away), which can increase performance in certain situations. But it is not required that an - implementation of - <type scope"com::sun::star::ucb">XRemoteContentProviderAcceptor</type> - uses this lazy strategy (and thus also implements this interface). + implementation of <type>XRemoteContentProviderAcceptor</type> uses this + lazy strategy (and thus also implements this interface). @return the broker at which the remote content providers have been registered. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 8ea22618948c..e761088697ce 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderChangeNotifier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-03-21 16:45:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,7 @@ module com { module sun { module star { module ucb { module com { module sun { module star { module ucb { //============================================================================ -/** Notify about changes to a - <type scope="com::sun::star::ucb">XRemoteContentProviderSupplier</type>. +/** Notify about changes to a <type>XRemoteContentProviderSupplier</type>. @version 1.0 @author Stephan Bergmann @@ -97,7 +96,7 @@ interface XRemoteContentProviderChangeNotifier: @param Listener. Some listener previously added via - <method>addRemoteContentProviderChangeListener</method>. + <member>XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener</member>. */ void removeRemoteContentProviderChangeListener( diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl index 1f60852ef30f..6df2873d50d2 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderConnectionControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,9 +76,9 @@ module com { module sun { module star { module ucb { /** A simple mechanism to find out if the connection between a remote content provider distributor and acceptor gets lost. - <p>This interface should be supported by the <code>DoneListener</code> + <p>This interface should be supported by the <var>DoneListener</var> parameter of - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>. + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index 4c85290bdb7f..880413e3e5c0 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleFileAccess.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-12-07 14:28:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -277,7 +277,7 @@ interface XSimpleFileAccess: com::sun::star::uno::XInterface <type>UnsupportedDataSinkException</type>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources - <method>XSimpleFileAccess2::writeFile</method> may be used. + <member>XSimpleFileAccess2::writeFile</member> may be used. */ com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); @@ -295,7 +295,7 @@ interface XSimpleFileAccess: com::sun::star::uno::XInterface <type>UnsupportedDataSinkException</type>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources - <method>XSimpleFileAccess2::writeFile</method> may be used. + <member>XSimpleFileAccess2::writeFile</member> may be used. */ com::sun::star::io::XStream openFileReadWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl index 2fdec149f11f..cc617b8e9aeb 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleFileAccess2.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-12-07 14:57:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,7 +79,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This is the basic interface to read data from a stream. +/** This is an extension to the interface <type>XSimpleFileAccess</type>. */ interface XSimpleFileAccess2 : com::sun::star::ucb::XSimpleFileAccess { diff --git a/offapi/com/sun/star/ui/ActionTriggerContainer.idl b/offapi/com/sun/star/ui/ActionTriggerContainer.idl index 59ebc48284bb..06b030309a7f 100644 --- a/offapi/com/sun/star/ui/ActionTriggerContainer.idl +++ b/offapi/com/sun/star/ui/ActionTriggerContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: ActionTriggerContainer.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: cd $ $Date: 2001-11-29 07:31:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,10 +100,10 @@ module com { module sun { module star { module ui { service ActionTriggerContainer { /** provides access to the entries of a menu. The element type - is <type scope=com::sun::star::beans>XPropertySet<type>. + is <type scope="com::sun::star::beans">XPropertySet<type>. The property set contains attributes like CommandURL, HelpURL - as defined in the service <type scope=com::sun::star::ui>ActionTrigger<type> - and optional a <type scope=com::sun::star::ui>ActionTriggerContainer<type>. + as defined in the service <type scope="com::sun::star::ui">ActionTrigger<type> + and optional a <type scope="com::sun::star::ui">ActionTriggerContainer<type>. */ interface ::com::sun::star::container::XIndexContainer; diff --git a/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl index 8b002b617bff..d848082c905f 100644 --- a/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl +++ b/offapi/com/sun/star/ui/dialogs/CommonFilePickerElementIds.idl @@ -2,9 +2,9 @@ * * $RCSfile: CommonFilePickerElementIds.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: fs $ $Date: 2001-10-26 08:30:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,14 +88,14 @@ constants CommonFilePickerElementIds const short LISTBOX_FILTER = 3; //--------------------------------------------------------------------- - /** is used to refer to the file view of the file picker. This view shows the list of + /** Is used to refer to the file view of the file picker. This view shows the list of all files/folders in the currently selected folder. */ const short CONTROL_FILEVIEW = 4; //--------------------------------------------------------------------- - /** is used to refer to the edit line where a file or path can be entered by the user. + /** Is used to refer to the edit line where a file or path can be entered by the user. */ const short EDIT_FILEURL = 5; }; diff --git a/offapi/com/sun/star/ui/dialogs/ControlActions.idl b/offapi/com/sun/star/ui/dialogs/ControlActions.idl index 1834c1945bc9..a46e9c9eafe3 100644 --- a/offapi/com/sun/star/ui/dialogs/ControlActions.idl +++ b/offapi/com/sun/star/ui/dialogs/ControlActions.idl @@ -2,9 +2,9 @@ * * $RCSfile: ControlActions.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tra $ $Date: 2001-11-14 16:45:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,7 +66,11 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** +/** Control actions for common and extended controls of a FilePicker. + + @see com::sun::star::ui::dialogs::XFilePickerControlAccess + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExetendedFilePickerElementIds */ constants ControlActions @@ -124,12 +128,12 @@ constants ControlActions const short GET_SELECTED_ITEM_INDEX = 8; //--------------------------------------------------------------------- - /** sets the help URL of a control. + /** Sets the help URL of a control. */ const short SET_HELP_URL = 100; //--------------------------------------------------------------------- - /** retrieves the help URL of a control. + /** Retrieves the help URL of a control. */ const short GET_HELP_URL = 101; }; diff --git a/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl b/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl index 6c56610059ba..6652a3205b4a 100644 --- a/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl +++ b/offapi/com/sun/star/ui/dialogs/ExecutableDialogException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ExecutableDialogException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-07-03 09:01:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** base class of all XExecutableDialog related exceptions. +/** Base class of all XExecutableDialog related exceptions. */ exception ExecutableDialogException: com::sun::star::uno::Exception { diff --git a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl index d86627991dfe..e20e3c040415 100644 --- a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl +++ b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl @@ -2,9 +2,9 @@ * * $RCSfile: ExecutableDialogResults.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-07-03 09:01:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,8 +67,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify a result of the file picker - @see com::sun::star::ui::XFilePicker +/** These constants are used to specify a result of executing a <type>XExecutableDialog</type>. */ constants ExecutableDialogResults @@ -91,6 +90,12 @@ constants ExecutableDialogResults /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.10.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.1 2001/07/03 09:01:57 tra + moved from drafts + Revision 1.1 2001/06/06 15:01:02 tra new dialogs interfaces diff --git a/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl index 92084ed80a30..77c0beeeb405 100644 --- a/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl +++ b/offapi/com/sun/star/ui/dialogs/ExtendedFilePickerElementIds.idl @@ -2,9 +2,9 @@ * * $RCSfile: ExtendedFilePickerElementIds.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: tra $ $Date: 2001-10-04 12:57:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,9 +66,13 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify common controls of a FilePicker dialog. - Prefix BTN means button. +/** <p>These constants are used to specify extended controls of a FilePicker dialog. + A FilePicker service may be initialized so that it has additional controls + extending the set of common controls a FilePicker usually supports.</p> + @see com::sun::star::ui::dialogs::FilePicker + @see com::sun::star::ui::dialogs::XFilePickerControlAccess + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds */ constants ExtendedFilePickerElementIds diff --git a/offapi/com/sun/star/ui/dialogs/FilePicker.idl b/offapi/com/sun/star/ui/dialogs/FilePicker.idl index 0cf8846bb6fc..9cbf155986eb 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePicker.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilePicker.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: fs $ $Date: 2002-08-20 14:40:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,30 +106,28 @@ interface XControlAccess; service FilePicker { //------------------------------------------------------------------------- - /** allows to associate a help URL with the file picker instance. + /** Allows to associate a help URL with the file picker instance. */ [optional, property] string HelpURL; //------------------------------------------------------------------------- /** Provides access to the basic FilePicker functionality. - - @see XFilePicker */ interface XFilePicker; //------------------------------------------------------------------------- - /** provides the ability to request notifications about changes. + /** Provides the ability to request notifications about changes. */ interface XFilePickerNotifier; //------------------------------------------------------------------------- - /** provides the ability to add different filter, query for the current + /** Provides the ability to add different filter, query for the current filters and set a current filter */ interface XFilterManager; //------------------------------------------------------------------------- - /** provides the ability to show a preview of a selected file + /** Provides the ability to show a preview of a selected file */ [optional] interface XFilePreview; @@ -150,28 +148,32 @@ service FilePicker [optional] interface XFilePickerControlAccess; //------------------------------------------------------------------------- - /** an interface which allows manipulation of groups of filters + /** An interface which allows manipulation of groups of filters */ [optional] interface XFilterGroupManager; //------------------------------------------------------------------------- - /** Provides the ability to choose between different custom templates for - the FileOpen dialog. Implementers may omit this interface if the FileOpen + /** Provides the ability to choose between different custom templates that + do extend the subset of common controls a FilePicker usually supports. + Implementers may omit this interface if the FileOpen dialog doesn't support custom templates. In this case a createInstance - will create an ordinary FileOpen dialog without any custom elements. + will create an ordinary FileOpen dialog with only the common FilePicker + elements. The client has to provide one of the specified constants in TemplateDescription. + <br/><br/> + <p><strong>Notes for the implementation of a FileSave dialog:</strong> + The implementation of a FileSave dialog should automatically check + for existens of a file and issue a warning if a file with the same + name already exist.</p> - <p>Notes for the implementation of a FileSave dialog: The implementation - of a FileSave dialog should automatically check for existens of a file - and issue a warning if a file with the same name already exist.</p> - - @see TemplateDescription + @see com::sun::star::ui::dialogs::TemplateDescription */ [optional] interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- /** For canceling a running dialog instance. + <p>This may be usefull for automatic test tools for instance.</p> */ [optional] interface com::sun::star::util::XCancellable; @@ -362,17 +364,17 @@ service FilePicker [optional] interface com::sun::star::ui::dialogs::XControlAccess; //------------------------------------------------------------------------- - /** for shutdown and listener support. + /** For shutdown and listener support. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; }; diff --git a/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl index fb61b54efddf..4cac6ad6aa3f 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePickerEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilePickerEvent.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:19:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,16 +73,17 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= //============================================================================= -/** Context information in case of a FilePicker event - - @see com::sun::star::lang::EventObject +/** Context information in case of a FilePicker event. */ struct FilePickerEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- /** @param ElementId - identifies the affected element + Identifies the affected element + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ short ElementId; }; diff --git a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl index 5dafa9289b11..23e35ca2b948 100644 --- a/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl +++ b/offapi/com/sun/star/ui/dialogs/FilePreviewImageFormats.idl @@ -2,9 +2,9 @@ * * $RCSfile: FilePreviewImageFormats.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:20:04 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,8 +66,8 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** These constants are used to specify supported image formats of a - FilePreview implementation. +/** These constants are used to specify image formats supported by an implementation + of the interface <type scope="com::sun::star::ui::dialogs">XFilePreview</type>. */ constants FilePreviewImageFormats diff --git a/offapi/com/sun/star/ui/dialogs/FolderPicker.idl b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl index 5588842b34ad..47f95d0f28cc 100644 --- a/offapi/com/sun/star/ui/dialogs/FolderPicker.idl +++ b/offapi/com/sun/star/ui/dialogs/FolderPicker.idl @@ -2,9 +2,9 @@ * * $RCSfile: FolderPicker.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: fs $ $Date: 2002-09-03 13:36:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,8 +90,6 @@ interface XControlAccess; //============================================================================= /** A FolderPicker service. - - @see XFolderPicker */ service FolderPicker @@ -103,17 +101,18 @@ service FolderPicker interface XFolderPicker; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XServiceInfo; //------------------------------------------------------------------------- - /** service should always support this interface. + /** Service should always support this interface. */ interface com::sun::star::lang::XTypeProvider; //------------------------------------------------------------------------- /** For canceling a running dialog instance. + <p>This may be usefull for automatic test tools for instance.</p> */ [optional] interface com::sun::star::util::XCancellable; diff --git a/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl index f16826287a5c..babb0c1004b3 100644 --- a/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl +++ b/offapi/com/sun/star/ui/dialogs/TemplateDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: TemplateDescription.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:20:29 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,7 +66,11 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** +/** The implementation of a FilePicker service may support the usage of + different templates. The following constants define the currently + specified templates. + + @see com::sun::star::ui::dialogs::FilePicker */ constants TemplateDescription @@ -82,69 +86,85 @@ constants TemplateDescription const short FILESAVE_SIMPLE = 1; //--------------------------------------------------------------------- - /** A FileSave dialog with: - 1. A checkbox "Auto Extension" - 2. A checkbox "Password" + /** A FileSave dialog with additional controls. + <ul> + <li>A checkbox "Auto Extension"</li> + <li>A checkbox "Password"</li> + </ul> */ const short FILESAVE_AUTOEXTENSION_PASSWORD = 2; //--------------------------------------------------------------------- - /** A FileSave dialog with: - 1. A checkbox "Auto Extension" - 2. A checkbox "Password" - 3. A checkbox "Filter Options" + /** A FileSave dialog with additional controls. + <ul> + <li>A checkbox "Auto Extension"</li> + <li>A checkbox "Password"</li> + <li>A checkbox "Filter Options"</li> + </ul> */ const short FILESAVE_AUTOEXTENSION_PASSWORD_FILTEROPTIONS = 3; //--------------------------------------------------------------------- - /** A FileSave dialog with: - 1. A checkbox "Auto Extension" - 2. A checkbox "Selection" + /** A FileSave dialog with additional controls. + <ul> + <li>A checkbox "Auto Extension"</li> + <li>A checkbox "Selection"</li> + </ul> */ const short FILESAVE_AUTOEXTENSION_SELECTION = 4; //--------------------------------------------------------------------- - /** A FileSave dialog with: - 1. A checkbox "Auto Extension" - 2. A listbox "Template" for selecting different templates + /** A FileSave dialog with additional controls. + <ul> + <li>A checkbox "Auto Extension"</li> + <li>A listbox "Template" for selecting different templates</li> + </ul> */ const short FILESAVE_AUTOEXTENSION_TEMPLATE = 5; //--------------------------------------------------------------------- - /** A FileOpen dialog with: - 1. A checkbox "Insert as link" - 2. A checkbox "Show Preview" - 3. A listbox "Image Template" for inserting an image with - different styles. - 4. A window for displaying a file preview + /** A FileOpen dialog with additional controls. + <ul> + <li>A checkbox "Insert as link" + <li>A checkbox "Show Preview" + <li>A listbox "Image Template" for inserting an image with different styles.</li> + <li>A window for displaying a file preview</li> + </ul> */ const short FILEOPEN_LINK_PREVIEW_IMAGE_TEMPLATE = 6; //--------------------------------------------------------------------- - /** A FileOpen dialog with: - 1. A push button "Play" + /** A FileOpen dialog with additional controls. + <ul> + <li>A push button "Play"</li> + </ul> */ const short FILEOPEN_PLAY = 7; //--------------------------------------------------------------------- - /** A FileOpen dialog with: - 1. A checkbox "Read only" - 2. A listbox "Version" for selecting a document version + /** A FileOpen dialog with additional controls. + <ul> + <li>A checkbox "Read only"</li> + <li>A listbox "Version" for selecting a document version</li> + <ul> */ const short FILEOPEN_READONLY_VERSION = 8; //--------------------------------------------------------------------- - /** - A FileOpen dialog with: - 1. A checkbox "Insert as link" - 2. A checkbox "Show Preview" - 3. A window for displaying a file preview + /** A FileOpen dialog with additional controls. + <ul> + <li>A checkbox "Insert as link"</li> + <li>A checkbox "Show Preview"</li> + <li>A window for displaying a file preview</li> + </ul> */ const short FILEOPEN_LINK_PREVIEW = 9; //--------------------------------------------------------------------- - /** A FileSave dialog with: - 1. A checkbox "Auto Extension" + /** A FileSave dialog with additional controls. + <ul> + <li>A checkbox "Auto Extension"</li> + </ul> */ const short FILESAVE_AUTOEXTENSION = 10; diff --git a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl index 9eac4f745c5e..a739a01b172a 100644 --- a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl +++ b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExecutableDialog.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-07-03 09:02:08 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Specifies an interface for a system dialog - - @author tra - @version 0.1 +/** Specifies an interface for an executable dialog. */ @@ -88,7 +85,9 @@ interface XExecutableDialog: com::sun::star::uno::XInterface /** Sets the title of the dialog. @param aTitle - set an abitrary title of the dialog, may be an empty string + Set an abitrary title for the dialog, + may be an empty string if the dialog should not + have a title. */ void setTitle( [in] string aTitle ); @@ -96,12 +95,7 @@ interface XExecutableDialog: com::sun::star::uno::XInterface /** Executes (shows) the dialog. @returns - a status code of type ExecutableDialogResults - - @see ExecutableDialogResults - - @throws - a RuntimeException in the case of fatal errors + A status code of type <type>ExecutableDialogResults</type>. */ short execute(); }; @@ -113,6 +107,12 @@ interface XExecutableDialog: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.10.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.1 2001/07/03 09:02:08 tra + moved from drafts + Revision 1.1 2001/06/06 15:01:02 tra new dialogs interfaces diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl index 4b1d84ce004f..a97401d50df7 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePicker.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-02 12:09:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,34 +78,32 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** specifies an interface for a filepicker +/** Specifies an interface for a FilePicker */ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog { //------------------------------------------------------------------------- - /** enable/disable multiselection mode + /** Enable/disable multiselection mode <p>If the multiselection mode is enabled, multiple files - may be selected else only one selection is possible</p> + may be selected bz the user else only one file selection at a time is possible</p> @param bMode - True enables multiselection mode, - False disables multiselection mode. This is the default - value + <p>A value of <TRUE/> enables the multiselection mode.</p> + <p>A value of <FALSE/> disables the multiselection mode, this is the default.</p> */ void setMultiSelectionMode( [in] boolean bMode ); //------------------------------------------------------------------------- - /** Sets the default string that appears in the edit field of the FilePicker - dialog where the user may enter a file name. + /** Sets the default string that appears in the file name box of a FilePicker. @param aName - <p> Specifies the default file name, displayed when the FilePicker - is shown. The implementation may accept any string, and does not - have to check for a valid file name, if the file exists, etc. - </p> + <p> Specifies the default file name, displayed when the FilePicker + is shown. The implementation may accept any string, and does not + have to check for a valid file name or if the file really exists. + </p> */ void setDefaultName( [in] string aName ); @@ -113,11 +111,11 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog /** Sets the directory that the file dialog initially displays. @param aDirectory - Specifies the initial directory in URL format. The given URL has to - follow the rules of rfc1738. + Specifies the initial directory in URL format. The given URL must be + conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). @throws com::sun::star::lang::IllegalArgumentException - If the URL is invalid (doesn't conform to rfc1738). + if the URL is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). */ void setDisplayDirectory( [in] string aDirectory ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -128,41 +126,45 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog did cancel the dialog, the returned value is undefined. @returns - The directory in URL format. + The directory in URL format, must be conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. */ string getDisplayDirectory(); //------------------------------------------------------------------------- /** Returns a sequence of the selected files including path information in - URL format. + URL format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. <p>If the user closed the dialog with cancel an empty sequence will be - returned. - - <p>If the dialog is in execution mode only a single file URL will be - returned or an empty sequence, if multiple files have been selected, or - the current selected file is not a valid file name or any other error - occurs. -<!-- JRH: please check and clarify the previous paragraph --> + returned.</p> + <br/> + <p>If the dialog is in execution mode and a single file is selected + the complete URL of this file will be returned.</p> + <p>If the dialog is in execution mode and multiple files are selected + an empty sequence will be returned.</p> + <p>If the dialog is in execution mode and the selected file name is false + or any other error occurs an empty sequence will be returned.</p> @returns <p> The complete path of the file or directory currently selected in URL format. There are two different cases: - 1. Multiselection is disabled: - The first and only entry of the sequence contains the complete - path/filename in URL format. - - 2. Multiselection is enabled: - If only one file is selected, the first entry - of the sequence contains the complete path/filename in URL format. - If multiple files are selected, the first entry of the sequence contains - the path in URL format, and the other entries contains one of the selected - file names. - - <p>Notes for the implementation of a FileSave dialog: If there exists - a checkbox "Automatic File Extension" and it is checked the dialog should - automatically add an extension to the file name, if one is selected in the - filter listbox.</p> + <ol> + <li>Multiselection is disabled: + The first and only entry of the sequence contains the complete + path/filename in URL format.</li> + + <li>Multiselection is enabled: + If only one file is selected, the first entry + of the sequence contains the complete path/filename in URL format. + If multiple files are selected, the first entry of the sequence contains + the path in URL format, and the other entries contains the names of the selected + files without path information.</li> + </ol> + + <br/> + + <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists + a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected + the dialog may automatically add an extension to the selected file name.</p> </p> */ sequence< string > getFiles(); @@ -175,6 +177,12 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.2.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.2 2001/11/02 12:09:19 mi + proofreading and corrections from Richard Holt + Revision 1.1 2001/08/30 10:20:36 tra #88584#moved from drafts diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index bea3429ea537..0aa80a7328f5 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePickerControlAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: tra $ $Date: 2001-12-12 11:10:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,11 +71,13 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Specifies extension of a file picker. +/** Provides access to the controls of a FilePicker. <p> A FilePicker may contain additional elements according to the needs of the different applications. These additional elements can be - addresed by this interface.</p> + addressed by this interface.</p> + + @see com::sun::star::ui::dialogs::FilePicker */ interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker { @@ -84,7 +86,7 @@ interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker /** Set the value of an additional element within a FilePicker. @param ControlId - Identifies the element which value is to be set. + Identifies the element which value is to be set. @param aControlAction Specifies an action to perform with the given value. @@ -95,10 +97,12 @@ interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFilePicker method. @param aValue - The value to set. For checkboxes aValue should be a boolean, which - should be true if the checkbox should be checked else false. + The value to set. For checkboxes aValue should be a boolean value that + should be <TRUE/> if the checkbox should be checked and <FALSE/> otherwise. - @see ControlActions + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds + @see com::sun::star::ui::dialogs::ControlActions */ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue ); @@ -106,39 +110,55 @@ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue /** Get the value of an additional element within a FilePicker @param aControlId - Identifies the element which value is to set. + Identifies the element for which value is requested. @param aControlAction - Specifies which value to retrieve. - aControlAction has to be one of the values defined in <type>ControlActions</type>. - Not all of the values are valid for all controls. - To get the currently selected filter of the FilePicker use the interface - XFilterManager, but optionally an implementation may also return the currently - selected filter through this method. + Specifies which value to retrieve. + aControlAction has to be one of the values defined in <type>ControlActions</type>. + Not all of the values are valid for all controls. @returns - The value of the specified element. If the specified control - is a checkbox the returned value is a boolean, which is true - if the checkbox is checked else false. - If the specified element doesn't exist or the specified element - doesn't support the specidfied control action an empty any will be - returned. + The value of the specified element. If the specified control + is a checkbox the returned value is a boolean that is <TRUE/> + if the checkbox is checked <FALSE/> otherwise. + If the specified element doesn't exist or the specified element + doesn't support the specidfied control action an empty any will be + returned. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds + @see com::sun::star::ui::dialogs::ControlActions */ any getValue( [in] short aControlId, [in] short aControlAction ); //------------------------------------------------------------------------- /** Set the label of the specified element. If the specified element doesn't support setting a label, this method has no effect. + + @param aControlId + Identifies the element for which the label should be set. + + @param aLabel + The label to be set. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ void setLabel( [in] short aControlId, [in] string aLabel ); //------------------------------------------------------------------------- -/** Returns the lable of the specified element. +/** Returns the label of the specified element. + + @param aControlId + Identifies the element for which the label should be returned. @returns - The label of the specified element or an empty string if - the specified element has no or supports no label or the - specified element doesn't exist. + The label of the specified element or an empty string if + the specified element has no or supports no label or the + specified element doesn't exist. + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ string getLabel( [in] short aControlId ); @@ -146,11 +166,14 @@ string getLabel( [in] short aControlId ); /** Enables or disables a control. @param ControlId - Identifies the control. + Identifies the control. @param bEnable - If true the specified control will be enabled. - If false the specified control will be disabled. + <p>If <TRUE/> the specified control will be enabled.</p> + <p>If <FALSE/> the specified control will be disabled.</p> + + @see com::sun::star::ui::dialogs::CommonFilePickerElementIds + @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ void enableControl( [in] short aControlId, [in] boolean bEnable ); }; @@ -159,47 +182,6 @@ void enableControl( [in] short aControlId, [in] boolean bEnable ); }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/10/26 08:47:39 fs - #92988# get/setValue now using ControlActions instead of ListboxControlActions - - Revision 1.1 2001/08/30 10:20:44 tra - #88584#moved from drafts - - Revision 1.4 2001/07/02 08:05:54 tra - removed IllegalArgumentException specification from interface methods - - Revision 1.3 2001/06/08 09:06:31 tra - *** empty log message *** - - Revision 1.2 2001/06/07 14:04:30 tra - *** empty log message *** - - Revision 1.1 2001/06/06 15:01:02 tra - new dialogs interfaces - - Revision 1.1 2001/04/10 06:43:06 tra - replacement for XExtendedFilePicker - - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:14 mi - moved from api - - Revision 1.2 2000/10/20 07:58:15 tra - minor changed and improvment of the documentation - - Revision 1.1.1.1 2000/09/18 23:36:17 hjs - initial import - - Revision 1.1 2000/09/05 14:55:11 tra - initial version filepicker interface - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl index daeb79ea1119..727150f27df4 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePickerListener.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:20:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= //============================================================================= -/** Interface to be implemented by all FilePicker service clients. +/** Interface to be implemented by a FilePicker listener. <p> The <type>XFilePickerListener</type> interface must be implemented by the clients of the FilePicker service which need to be informed about @@ -91,21 +91,21 @@ interface XFilePickerListener: com::sun::star::lang::XEventListener FilePicker service dialog changes. @param aEvent - of type <type>FilePickerEvent</type> that describes the event + of type <type>FilePickerEvent</type> that describes the event - @see FilePickerEvent + @see com::sun::star::ui::dialogs::FilePickerEvent */ void fileSelectionChanged( [in] FilePickerEvent aEvent ); //------------------------------------------------------------------------- /** A client receives this event if the directory selection within the - FilePicker service dialog changes. + FilePicker dialog changes. @param aEvent - Of type <type>FilePickerEvent</type> that describes the event. + Of type <type>FilePickerEvent</type> that describes the event. - @see FilePickerEvent + @see com::sun::star::ui::dialogs::FilePickerEvent */ void directoryChanged( [in] FilePickerEvent aEvent ); @@ -114,16 +114,16 @@ interface XFilePickerListener: com::sun::star::lang::XEventListener pressed. @param aEvent - of type <type>FilePickerEvent</type> that describes the event + of type <type>FilePickerEvent</type> that describes the event @returns - A help string which the FilePicker dialog should display - in a tooltip window. If the returned string is empty it is - undefined how the FilePicker implementation will behave. - It may show a message 'no help available' or may show no - tooltip window at all etc. + A help string which the FilePicker dialog should use to display + a help for a specific control. If the returned string is empty it is + undefined how the FilePicker implementation will behave. + It may show a message 'no help available' or may show no + help at all. - @see FilePickerEvent + @see com::sun::star::ui::dialogs::FilePickerEvent */ string helpRequested( [in] FilePickerEvent aEvent ); @@ -132,9 +132,9 @@ interface XFilePickerListener: com::sun::star::lang::XEventListener FilePicker service dialog changes. @param aEvent - of type <type>FilePickerEvent</type> that describes the event. + of type <type>FilePickerEvent</type> that describes the event. - @see FilePickerEvent + @see com::sun::star::ui::dialogs::FilePickerEvent */ void controlStateChanged( [in] FilePickerEvent aEvent ); diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl index 215057f6dd6e..bc15913c61ad 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePickerNotifier.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:20:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,11 +77,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= //============================================================================= -/** Interface to be implemented by all FilePicker service clients. - - <p> The <type>XFilePickerListener</type> interface must be implemented by - the clients of the FilePicker service which need to be notified about - events while the FilePicker service is displayed. +/** Interface to be implemented in order to support listener management. */ interface XFilePickerNotifier: com::sun::star::uno::XInterface { @@ -89,10 +85,9 @@ interface XFilePickerNotifier: com::sun::star::uno::XInterface /** Interface for clients to register as XFilePickerListener @param xListener - the <type>XFilePickerListener</type> interface of the object that - wants to receive FilePickerEvents. - - @see XFilePickerListener + The <type>XFilePickerListener</type> interface of the listener that + wants to receive events of type <type>FilePickerEvent</type>. + <p>Invalid interfaces or NULL values will be ignored.</p> */ [oneway] void addFilePickerListener( [in] XFilePickerListener xListener ); @@ -100,10 +95,9 @@ interface XFilePickerNotifier: com::sun::star::uno::XInterface /** Interface for clients to unregister as XFilePickerListener. @param xListener - The <type>XFilePickerListener</type> interface of the object that - wants to receive FilePickerEvents. - - @see XFilePickerListener + The <type>XFilePickerListener</type> interface of the listener that + wants to receive events of type <type>FilePickerEvent</type>. + <p>Invalid interfaces or NULL values will be ignored.</p> */ [oneway] void removeFilePickerListener( [in] XFilePickerListener xListener ); }; diff --git a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl index 4bab7f277d5c..398da1bdecf0 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePreview.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePreview.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePreview.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:21:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,8 +75,8 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** - +/** FilePicker that support the preview of various file formats should implement + this interface. */ interface XFilePreview: com::sun::star::uno::XInterface @@ -85,9 +85,9 @@ interface XFilePreview: com::sun::star::uno::XInterface /** The method returns all image formats that the preview supports. @returns - a sequence of all supported preview formats + A sequence of all supported preview formats - @see ::com::sun::star::ui::dialogs::PreviewImageFormats + @see com::sun::star::ui::dialogs::FilePreviewImageFormats */ sequence< short > getSupportedImageFormats( ); @@ -95,7 +95,7 @@ interface XFilePreview: com::sun::star::uno::XInterface /** The method returns the supported color depth of the target device. @returns - the color depth in bit, e.g. 8 bit, 16 bit, 32 bit + The color depth in bit, e.g. 8 bit, 16 bit, 32 bit. */ long getTargetColorDepth( ); @@ -106,7 +106,7 @@ interface XFilePreview: com::sun::star::uno::XInterface 0 will be returned. @returns - the width of the preview window in pixel + The width of the preview window in pixel. */ long getAvailableWidth( ); @@ -116,8 +116,8 @@ interface XFilePreview: com::sun::star::uno::XInterface If a service implementation doesn't support a file preview 0 will be returned. - @param - the heigth of the preview window in pixel + @returns + The heigth of the preview window in pixel. */ long getAvailableHeight( ); @@ -126,17 +126,17 @@ interface XFilePreview: com::sun::star::uno::XInterface image will be ignored. An empty any will clear the preview window. @param aImageFormat - specifies the format of the data that will be delivered + Specifies the format of the data that will be delivered @param aImage - the image data, the image format defines how - the image data have to be delivered + The image data, the image format defines how + the image data have to be delivered - @throws ::com::sun::star::lang::IllegalArgumentException - if the specified image format is invalid or not - supported by the preview implementation + @throws com::sun::star::lang::IllegalArgumentException + If the specified image format is invalid or not + supported by the preview implementation - @see ::com::sun::star::ui::dialogs::PreviewImageFormats + @see com::sun::star::ui::dialogs::FilePreviewImageFormats */ void setImage( [in] short aImageFormat, [in] any aImage ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -146,13 +146,13 @@ interface XFilePreview: com::sun::star::uno::XInterface that the preview implementation doesn't support hiding the preview. @param bShowState - True shows the preview window. - False hides the preview window. + A value of <TRUE/> shows the preview window. + <p>A value of <FALSE/> hides the preview window.</p> @returns - True on success. - False if the operation fails for any reason or the preview - implementation doesn't support hiding the preview. + A value of <TRUE/> on success. + <p>A vaue of <FALSE/> if the operation fails for any reason or the preview + implementation doesn't support hiding the preview.</p> */ boolean setShowState( [in] boolean bShowState ); @@ -160,8 +160,8 @@ interface XFilePreview: com::sun::star::uno::XInterface /** Returns the current show state of the preview. @returns - True if the preview window is visible. - False if the preview window is invisible. + A value of <TRUE/> if the preview window is visible. + <p>A value of <FALSE/> if the preview window is invisible.</p> */ boolean getShowState( ); }; diff --git a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl index e1e80eceb6ad..19fbf0db323b 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilterGroupManager.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: fs $ $Date: 2001-09-14 09:51:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,33 +71,35 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -//............................................................................. module com { module sun { module star { module ui { module dialogs { -//............................................................................. -/** specifies an interface which allows manipulation of groups of filters for the <service>FilePicker</service> - service. +//============================================================================= +/** Specifies an interface which allows manipulation of groups of filters + for the <service>FilePicker</service> service. */ interface XFilterGroupManager : com::sun::star::uno::XInterface { - /** appends a group of filters to the current filter list + /** Appends a group of filters to the current filter list. <p>It is implementation dependent how the filter groups are presented to the user.<br/> It is not even guaranteed that the groups are visualized: implementations are free to simply append all the filters separately, with ignoring the group title.</p> @param sGroupTitle - the title of the filter group. Usually, the caller should localize this title, as it is to be presented to + The title of the filter group. Usually, the caller should localize this title, as it is to be presented to the user. @param aFilters - the filters which form a group. Every filter consists of two strings, where the first one is a display name + The filters which form a group. Every filter consists of two strings, where the first one is a display name (as for <arg>sGroupTitle</arg>, it holds that these strings should be localized), and the second one the semicolon separated list of wildcard expressions for the filter.<br/> Usually, the expressions are simply extensions (e.g. "*.txt"), but this must no necessarily be the case. - @see XFilterManager - @see FilePicker + @throws com::sun::star::lang::IllegalArgumentException + if one or more filters in the given filter list already exist. + + @see com::sun::star::ui::dialogs::XFilterManager + @see com::sun::star::ui::dialogs::FilePicker */ void appendFilterGroup( [in] string sGroupTitle, @@ -113,6 +115,12 @@ interface XFilterGroupManager : com::sun::star::uno::XInterface /************************************************************************* * history: * $Log: not supported by cvs2svn $ + * Revision 1.1.6.1 2002/01/30 11:44:29 tra + * #97073#reviewd + * + * Revision 1.1 2001/09/14 09:51:18 fs + * initial checkin - specification of an interface for adding filter _groups_ to a file picker component + * * * Revision 1.0 13.09.01 17:36:43 fs ************************************************************************/ diff --git a/offapi/com/sun/star/ui/dialogs/XFilterManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl index f9d821fcf5f3..9484b37b3d42 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilterManager.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilterManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilterManager.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:21:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** Specifies a filter manager interface for a file picker +/** Specifies a filter manager interface for a FilePicker */ interface XFilterManager: com::sun::star::uno::XInterface @@ -85,16 +85,16 @@ interface XFilterManager: com::sun::star::uno::XInterface /** Adds a filter identified by a title. @param aTitle - Specifies the name of the filter as shown in the filter box of the - FilePicker dialog. + Specifies the name of the filter as shown in the filter box of the + FilePicker dialog. @param aFilter - Specifies the extensions of the filter. Multiple filters should be - semicolon separated. The semicolon may not be used as character in - a filter expresion. A typical filter is for instance '*.txt'. + Specifies the extensions of the filter. Multiple filters should be + semicolon separated. The semicolon may not be used as character in + a filter expresion. A typical filter is for instance '*.txt'. @throws ::com::sun::star::lang::IllegalArgumentException - If a filter with the specified title already exists. + If a filter with the specified title already exists. */ void appendFilter( [in] string aTitle, [in] string aFilter ) @@ -104,10 +104,10 @@ interface XFilterManager: com::sun::star::uno::XInterface /** Sets the current filter. @param aTitle - Specifies the name of the filter to be set. + Specifies the name of the filter to be set. @throws com::sun::star::lang::IllegalArgumentException - If the specified filter was not found. + If the specified filter was not found. */ void setCurrentFilter( [in] string aTitle ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -116,8 +116,8 @@ interface XFilterManager: com::sun::star::uno::XInterface /** Returns the currently selected filter. @returns - The the name of the selected filter or an empty string if - there is no filter or no filter is currently selected. + The the name of the selected filter or an empty string if + there is no filter or no filter is currently selected. */ string getCurrentFilter( ); }; @@ -129,6 +129,12 @@ interface XFilterManager: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.6.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.1 2001/08/30 10:21:15 tra + #88584#moved from drafts + Revision 1.2 2001/07/06 13:03:20 tra documentation update diff --git a/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl index a61d105a2246..cfa4ecae5057 100644 --- a/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFolderPicker.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFolderPicker.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: tra $ $Date: 2001-08-30 10:21:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,10 +89,10 @@ interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog chooses if the specified root directory doesn't exist. @param aDirectory - Specifies the root directory in url format. + Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. - @throws ::com::sun::star::lang::IllegalArgumentException - If the given url is invalid. + @throws com::sun::star::lang::IllegalArgumentException + if the given url is invalid. */ void setDisplayDirectory( [in] string aDirectory ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -103,23 +103,24 @@ interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog or the previously specified root directory doesn't exist. @returns - The the directory in url format. + The the directory in url format. */ string getDisplayDirectory(); //------------------------------------------------------------------------- - /** Returns the selected directory as url. + /** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. @returns - The selected directory as url if the user did close the dialog with ok - else the returned value is undefined. + The selected directory as url if the user did close the dialog with ok + else the returned value is undefined. */ string getDirectory( ); //------------------------------------------------------------------------- /** The implementation may optionally show the given text as a description - for the user. If the client doesn't set a description the dialog may - show a default description. + for the user within the dialog, e.g. "Please select a directory". + If the client doesn't set a description the dialog may show a default + description. */ void setDescription( [in] string aDescription ); }; @@ -131,6 +132,12 @@ interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1.6.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.1 2001/08/30 10:21:21 tra + #88584#moved from drafts + Revision 1.3 2001/06/26 13:20:04 tra #88797#added a method to set a description diff --git a/offapi/com/sun/star/util/AliasProgrammaticPair.idl b/offapi/com/sun/star/util/AliasProgrammaticPair.idl index 6bf696f3971c..3638679386dc 100644 --- a/offapi/com/sun/star/util/AliasProgrammaticPair.idl +++ b/offapi/com/sun/star/util/AliasProgrammaticPair.idl @@ -2,9 +2,9 @@ * * $RCSfile: AliasProgrammaticPair.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,23 +62,25 @@ #define __com_sun_star_util_AliasProgrammaticPair_idl__ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::AliasProgrammaticPair -/** represents an entry from a component which implements the <type>LocalizedAliases</type>.@see com::sun::star::util::XLocalizedAliases +/** represents an entry from a component which implements the + <type>LocalizedAliases</type>. + + @see com::sun::star::util::XLocalizedAliases */ struct AliasProgrammaticPair { - // DocMerge from xml: field com::sun::star::util::AliasProgrammaticPair::Alias /** determines the name which is registered as an alias for a programmatic name. */ string Alias; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::AliasProgrammaticPair::ProgrammaticName - /** determines which programmatic name belongs to the alias. @see com::sun::star::util::XLocalizedAliases + /** determines which programmatic name belongs to the alias. + + @see com::sun::star::util::XLocalizedAliases */ string ProgrammaticName; }; @@ -87,21 +89,4 @@ struct AliasProgrammaticPair }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:18 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.1 2000/01/27 07:50:23 dg - #71571# new files - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/AtomClassRequest.idl b/offapi/com/sun/star/util/AtomClassRequest.idl index 9913724cd3cb..7381ae0d1373 100644 --- a/offapi/com/sun/star/util/AtomClassRequest.idl +++ b/offapi/com/sun/star/util/AtomClassRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: AtomClassRequest.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,19 +70,18 @@ module star module util { -/** <type scope="com::sun::star::util">AtomCLassRequest</type> is used to - describe which atoms the user wants to know about +/** is used to describe which atoms the user wants to know about. @see com::sun::star::util::XAtomServer */ struct AtomClassRequest { /** the class of the atoms described in member - <member scope="com::sun::staer::util">AtomClassRequest::atoms</member> + <member>AtomClassRequest::atoms</member>. */ long atomClass; - /** the atoms requested from class - <member scope="com::sun::staer::util">AtomClassRequest::atomClass</member> + + /** the atoms requested from class <member>AtomClassRequest::atomClass</member>. */ sequence< long > atoms; }; diff --git a/offapi/com/sun/star/util/AtomDescription.idl b/offapi/com/sun/star/util/AtomDescription.idl index 457f39265909..b935415b7717 100644 --- a/offapi/com/sun/star/util/AtomDescription.idl +++ b/offapi/com/sun/star/util/AtomDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: AtomDescription.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,8 +70,7 @@ module star module util { -/** <type scope="com::sun::star::util">AtomDescription</type> contains - a string and the corresponding registered atom +/** contains a string and the corresponding registered atom . @see com::sun:star::util::XAtomServer */ @@ -80,6 +79,7 @@ struct AtomDescription /** the atom itself */ long atom; + /** the string it stands for */ string description; diff --git a/offapi/com/sun/star/util/CellProtection.idl b/offapi/com/sun/star/util/CellProtection.idl index 56f6356bf713..e9907a0365a2 100644 --- a/offapi/com/sun/star/util/CellProtection.idl +++ b/offapi/com/sun/star/util/CellProtection.idl @@ -2,9 +2,9 @@ * * $RCSfile: CellProtection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:47 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,37 +64,29 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::CellProtection /** describes the kind of protection for a protectable cell. */ struct CellProtection { - // DocMerge from xml: field com::sun::star::util::CellProtection::IsLocked /** specifies if the cell is locked from modifications by the user. */ boolean IsLocked; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::CellProtection::IsFormulaHidden /** specifies if the formula is hidden from the user. */ boolean IsFormulaHidden; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::CellProtection::IsHidden /** specifies if the cell is hidden from the user. */ boolean IsHidden; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::CellProtection::IsPrintHidden /** specifies if the cell is hidden on printouts. */ boolean IsPrintHidden; @@ -105,27 +97,4 @@ struct CellProtection }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:18 hjs - initial import - - Revision 1.5 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:09 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/ChangesEvent.idl b/offapi/com/sun/star/util/ChangesEvent.idl index 189832435a65..64fb3e51f245 100644 --- a/offapi/com/sun/star/util/ChangesEvent.idl +++ b/offapi/com/sun/star/util/ChangesEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangesEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,34 +75,30 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::ChangesEvent -/** This event is fired when a set of changes becomes effective on the source of the event.@see XChangesSet - @see XChangesBatch - @see XChangesListener - @see XChangesNotifier - @see com::sun::star::container::ContainerEvent - @see ElementChange +/** This event is fired when a set of changes becomes effective on the source of the event. + + @see XChangesSet + @see XChangesBatch + @see XChangesListener + @see XChangesNotifier + @see com::sun::star::container::ContainerEvent + @see ElementChange */ struct ChangesEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- + /** contains the accessor to the common root of the changed elements. - // DocMerge from xml: field com::sun::star::util::ChangesEvent::Base - /** This contains the accessor to the common root of the changed elements - - - <p>The type and the value of the accessor depends on the service.</p> + <p>Type and value of the accessor depend on the service.</p> */ any Base; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::ChangesEvent::Changes - /** This contains the changes that occurred. + /** contains the changes which occurred. */ ChangesSet Changes; @@ -112,19 +108,4 @@ struct ChangesEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:18 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.1 2000/06/15 15:58:12 jb - Add event class for batch changes - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/ChangesSet.idl b/offapi/com/sun/star/util/ChangesSet.idl index c826e1e8c57e..f62acb882acf 100644 --- a/offapi/com/sun/star/util/ChangesSet.idl +++ b/offapi/com/sun/star/util/ChangesSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: ChangesSet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ module com { module sun { module star { module util { //============================================================================= -/** This is a type that describes a set of changes occurring as a batch transaction. +/** describes a set of changes occurring as a batch transaction. @see XChangesBatch @see XChangesSet diff --git a/offapi/com/sun/star/util/DataEditorEvent.idl b/offapi/com/sun/star/util/DataEditorEvent.idl index 1352e33f29f7..cc4d9f09f0f7 100644 --- a/offapi/com/sun/star/util/DataEditorEvent.idl +++ b/offapi/com/sun/star/util/DataEditorEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataEditorEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,14 +71,12 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { -// DocMerge from xml: struct com::sun::star::util::DataEditorEvent -/** specifies an event broadcast by an <type>XEventEditor</type>. +/** specifies an event broadcasted by an <type>XEventEditor</type>. */ struct DataEditorEvent: com::sun::star::lang::EventObject { - // DocMerge from xml: field com::sun::star::util::DataEditorEvent::Type /** specifies the type of the event. */ DataEditorEventType Type; @@ -88,21 +86,4 @@ struct DataEditorEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:51:45 tlx - DataEditor + UniqIDs - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/DataEditorEventType.idl b/offapi/com/sun/star/util/DataEditorEventType.idl index b35e47c41d0d..23959218529a 100644 --- a/offapi/com/sun/star/util/DataEditorEventType.idl +++ b/offapi/com/sun/star/util/DataEditorEventType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataEditorEventType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,19 +63,16 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { -// DocMerge from xml: enum com::sun::star::util::DataEditorEventType /** specifies the type of an event from an <type>XDataEditor</type>. */ enum DataEditorEventType { - // DocMerge from xml: value com::sun::star::util::DataEditorEventType::DONE /** specifies that the data editing is done (data stored). */ DONE, - // DocMerge from xml: value com::sun::star::util::DataEditorEventType::CANCELED /** specifies that the data editing was cancelled by the user (data not stored). */ CANCELED @@ -85,18 +82,4 @@ enum DataEditorEventType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:51:45 tlx - DataEditor + UniqIDs - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/Date.idl b/offapi/com/sun/star/util/Date.idl index b387efbc1b92..1f830da3818d 100644 --- a/offapi/com/sun/star/util/Date.idl +++ b/offapi/com/sun/star/util/Date.idl @@ -2,9 +2,9 @@ * * $RCSfile: Date.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,30 +64,26 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::Date /** represents a date value. */ struct Date { - // DocMerge from xml: field com::sun::star::util::Date::Day /** contains the day of month (1-31 or 0 for a void date). */ unsigned short Day; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::Date::Month /** contains the month of year (1-12 or 0 for a void date). */ unsigned short Month; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::Date::Year /** contains the year. */ unsigned short Year; @@ -98,18 +94,4 @@ struct Date }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 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/util/DateTime.idl b/offapi/com/sun/star/util/DateTime.idl index 168e3d8daa6d..34ae66ede861 100644 --- a/offapi/com/sun/star/util/DateTime.idl +++ b/offapi/com/sun/star/util/DateTime.idl @@ -2,9 +2,9 @@ * * $RCSfile: DateTime.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,58 +64,50 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::DateTime /** represents a combined date+time value. */ struct DateTime { - // DocMerge from xml: field com::sun::star::util::DateTime::HundredthSeconds /** contains the hundredth seconds (0-99). */ unsigned short HundredthSeconds; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Seconds /** contains the seconds (0-59). */ unsigned short Seconds; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Minutes /** contains the minutes (0-59). */ unsigned short Minutes; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Hours /** contains the hour (0-23). */ unsigned short Hours; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Day /** is the day of month (1-31 or 0 for a void date). */ unsigned short Day; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Month /** is the month of year (1-12 or 0 for a void date). */ unsigned short Month; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::DateTime::Year /** is the year. */ unsigned short Year; @@ -126,18 +118,4 @@ struct DateTime }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 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/util/DateTimeRange.idl b/offapi/com/sun/star/util/DateTimeRange.idl index 067be5b70c96..b2b3104878a4 100644 --- a/offapi/com/sun/star/util/DateTimeRange.idl +++ b/offapi/com/sun/star/util/DateTimeRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: DateTimeRange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,107 +64,79 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::DateTimeRange /** represents a range of date+time values. */ struct DateTimeRange { - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartHundredthSeconds /** contains the start hundredth seconds (0-99) for the range. */ unsigned short StartHundredthSeconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartSeconds /** contains the start seconds (0-59) for the range. */ unsigned short StartSeconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartMinutes /** contains the start minutes (0-59) for the range. */ unsigned short StartMinutes; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartHours /** contains the start hour (0-23) for the range. */ unsigned short StartHours; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartDay /** contains the start day of month (1-31 or 0 for a void date) for the range. */ unsigned short StartDay; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartMonth /** contains the start month of year (1-12 or 0 for a void date) for the range. */ unsigned short StartMonth; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::StartYear /** contains the start year for the range. */ unsigned short StartYear; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndHundredthSeconds /** contains the end hundredth seconds (0-99) for the range. */ unsigned short EndHundredthSeconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndSeconds /** contains the end seconds (0-59) for the range. */ unsigned short EndSeconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndMinutes /** contains the end minutes (0-59) for the range. */ unsigned short EndMinutes; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndHours /** contains the end hour (0-23) for the range. */ unsigned short EndHours; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndDay /** contains the end day of month (1-31 or 0 for a void date) for the range. */ unsigned short EndDay; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndMonth /** contains the end month of year (1-12 or 0 for a void date) for the range. */ unsigned short EndMonth; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::DateTimeRange::EndYear /** contains the end year for the range. */ unsigned short EndYear; @@ -175,18 +147,4 @@ struct DateTimeRange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 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/util/DiskFullException.idl b/offapi/com/sun/star/util/DiskFullException.idl index bd78d46b8162..fffe6db5806a 100644 --- a/offapi/com/sun/star/util/DiskFullException.idl +++ b/offapi/com/sun/star/util/DiskFullException.idl @@ -2,9 +2,9 @@ * * $RCSfile: DiskFullException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,11 +68,10 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: exception com::sun::star::util::DiskFullException /** is thrown when a disk full error occurs. */ exception DiskFullException: com::sun::star::util::FileIOException @@ -83,18 +82,4 @@ exception DiskFullException: com::sun::star::util::FileIOException }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 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/util/ElementChange.idl b/offapi/com/sun/star/util/ElementChange.idl index da6c61b75680..d54b5e46e500 100644 --- a/offapi/com/sun/star/util/ElementChange.idl +++ b/offapi/com/sun/star/util/ElementChange.idl @@ -2,9 +2,9 @@ * * $RCSfile: ElementChange.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,18 +64,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::ElementChange /** This structure describes a single change that is part of a batch of changes. */ struct ElementChange { - // DocMerge from xml: field com::sun::star::util::ElementChange::Accessor - /** This contains the accessor to the element which changed - + /** This contains the accessor to the element which changed. <p>The type and the value of the accessor depends on the service.</p> */ @@ -83,14 +80,12 @@ struct ElementChange //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::ElementChange::Element /** This contains the element that was inserted or changed. */ any Element; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::ElementChange::ReplacedElement /** This contains the element that was replaced or removed. */ any ReplacedElement; @@ -101,21 +96,4 @@ struct ElementChange }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.1 2000/06/15 15:58:13 jb - Add event class for batch changes - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/FileIOException.idl b/offapi/com/sun/star/util/FileIOException.idl index d3edeb2f2a4d..ef1a2d68a0ca 100644 --- a/offapi/com/sun/star/util/FileIOException.idl +++ b/offapi/com/sun/star/util/FileIOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: FileIOException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,11 +67,10 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: exception com::sun::star::util::FileIOException /** thrown when file I/O error occurs. */ exception FileIOException: com::sun::star::uno::Exception @@ -82,24 +81,4 @@ exception FileIOException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.4 2000/09/11 11:53:04 mi - documentation merged from XML - - Revision 1.2 2000/03/24 16:55:03 mhe - Exceptions must be derived from com.sun.star.uno.Exception - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/MalformedNumberFormatException.idl b/offapi/com/sun/star/util/MalformedNumberFormatException.idl index 2c23504144c5..38e12fe494f8 100644 --- a/offapi/com/sun/star/util/MalformedNumberFormatException.idl +++ b/offapi/com/sun/star/util/MalformedNumberFormatException.idl @@ -2,9 +2,9 @@ * * $RCSfile: MalformedNumberFormatException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,16 +72,14 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::util::MalformedNumberFormatException -/** exception thrown when a NumberFormat string is syntactically +/** is thrown when a NumberFormat string is syntactically incorrect. */ exception MalformedNumberFormatException: com::sun::star::uno::Exception { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::util::MalformedNumberFormatException::CheckPos - /** character position in a string where malformation + /** contains the character position in the string where the malformation begins. */ long CheckPos; @@ -92,21 +90,5 @@ exception MalformedNumberFormatException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:04 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/util/MeasureUnit.idl b/offapi/com/sun/star/util/MeasureUnit.idl index 292bd57334e8..4da1f13fd847 100644 --- a/offapi/com/sun/star/util/MeasureUnit.idl +++ b/offapi/com/sun/star/util/MeasureUnit.idl @@ -2,9 +2,9 @@ * * $RCSfile: MeasureUnit.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: cl $ $Date: 2001-02-21 14:07:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,7 +64,7 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= diff --git a/offapi/com/sun/star/util/NotNumericException.idl b/offapi/com/sun/star/util/NotNumericException.idl index f40ca4bf51ff..d7efb5d2433e 100644 --- a/offapi/com/sun/star/util/NotNumericException.idl +++ b/offapi/com/sun/star/util/NotNumericException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NotNumericException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,11 +68,10 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: exception com::sun::star::util::NotNumericException /** indicates that a non-numeric string is to be converted to a number. */ exception NotNumericException: com::sun::star::uno::Exception @@ -83,18 +82,4 @@ exception NotNumericException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/NumberFormat.idl b/offapi/com/sun/star/util/NumberFormat.idl index d63a1ca41529..075d90aa63c9 100644 --- a/offapi/com/sun/star/util/NumberFormat.idl +++ b/offapi/com/sun/star/util/NumberFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,87 +68,86 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::util::NumberFormat -/** These constants are used to specify the type of a number format. +/** contains constants that are used to specify the type of a number format. */ constants NumberFormat { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::0 - // DocMerge: empty anyway + /** selects all number formats. + */ const short ALL = 0; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::1 - // DocMerge: empty anyway + /** selects only user-defined number formats. + */ const short DEFINED = 1; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::2 - // DocMerge: empty anyway + /** selects date formats. + */ const short DATE = 2; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::4 - // DocMerge: empty anyway + /** selects time formats. + */ const short TIME = 4; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::8 - // DocMerge: empty anyway + /** selects currency formats. + */ const short CURRENCY = 8; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::16 - // DocMerge: empty anyway + /** selects decimal number formats. + */ const short NUMBER = 16; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::32 - // DocMerge: empty anyway + /** selects scientific number formats. + */ const short SCIENTIFIC = 32; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::64 - // DocMerge: empty anyway + /** selects number formats for fractions. + */ const short FRACTION = 64; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::128 - // DocMerge: empty anyway + /** selects percentage number formats. + */ const short PERCENT = 128; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::256 - // DocMerge: empty anyway + /** selects text number formats. + */ const short TEXT = 256; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::6 - // DocMerge: empty anyway + /** selects number formats which contain date and time. + */ const short DATETIME = 6; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::1024 - // DocMerge: empty anyway + /** selects boolean number formats. + */ const short LOGICAL = 1024; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR constants::2048 - // DocMerge: empty anyway + /** is used as a return value if no format exists. + */ const short UNDEFINED = 2048; }; @@ -157,21 +156,5 @@ constants NumberFormat }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.4 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/NumberFormatProperties.idl b/offapi/com/sun/star/util/NumberFormatProperties.idl index 1f3f2b1f17fd..8395ba06a5b6 100644 --- a/offapi/com/sun/star/util/NumberFormatProperties.idl +++ b/offapi/com/sun/star/util/NumberFormatProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormatProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-21 08:35:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,35 +72,34 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::util::NumberFormatProperties -/** properties specifying the behavior of a <type>NumberFormatter</type>.@see NumberFormatter. +/** contains properties specifying the behavior of a <type>NumberFormatter</type>. + + @see NumberFormatter */ service NumberFormatProperties { //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatProperties::FormatString /** contains the format string of the number format. */ [readonly, property] string FormatString; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatProperties::Locale /** contains the locale of the number format. */ [readonly, property] com::sun::star::lang::Locale Locale; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatProperties::Type - /** contains the type of the number format.@see NumberFormat + /** contains the type of the number format. + + @see NumberFormat */ [readonly, property] short Type; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatProperties::Comment /** contains a comment regarding the number format for display to the user. */ @@ -112,30 +111,5 @@ service NumberFormatProperties }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.6 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.4 2000/02/21 16:18:16 mi - string documentation from stardiv...*.idl-files - - Revision 1.3 2000/01/28 15:01:52 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/NumberFormatSettings.idl b/offapi/com/sun/star/util/NumberFormatSettings.idl index 16d21a4ea62c..22a6eaa86b79 100644 --- a/offapi/com/sun/star/util/NumberFormatSettings.idl +++ b/offapi/com/sun/star/util/NumberFormatSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormatSettings.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,28 +76,24 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::util::NumberFormatSettings /** specifies the settings for number formatting. */ service NumberFormatSettings { - // DocMerge: empty anyway + /** provides access to the properties. + */ interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatSettings::NullDate /** specifies the date which is represented by the value 0. - - <p>The most common value for this is 12/30/1899.</p> */ [property] com::sun::star::util::Date NullDate; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatSettings::StandardDecimals /** specifies the maximum number of decimals used for the standard number format ("General"). */ @@ -105,14 +101,12 @@ service NumberFormatSettings //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatSettings::NoZero - /** set to indicate that a zero value should be formatted as an empty string. + /** is set to indicate that a zero value should be formatted as an empty string. */ [property] boolean NoZero; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::NumberFormatSettings::TwoDigitDateStart /** specifies the first year to be generated from a two-digit year input. */ @@ -124,18 +118,5 @@ service NumberFormatSettings }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/NumberFormats.idl b/offapi/com/sun/star/util/NumberFormats.idl index 6c06e7c34563..c39ac3f71fc9 100644 --- a/offapi/com/sun/star/util/NumberFormats.idl +++ b/offapi/com/sun/star/util/NumberFormats.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormats.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,16 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::util::NumberFormats /** specifies a container of number formats. */ service NumberFormats { - // DocMerge: empty anyway + /** is used to access or create individual formats. + */ interface com::sun::star::util::XNumberFormats; - // DocMerge: empty anyway + /** is used to get specific, predefined number formats. + */ interface com::sun::star::util::XNumberFormatTypes; }; @@ -93,18 +94,5 @@ service NumberFormats }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/NumberFormatter.idl b/offapi/com/sun/star/util/NumberFormatter.idl index f6eaaadf48fb..73961fcfb908 100644 --- a/offapi/com/sun/star/util/NumberFormatter.idl +++ b/offapi/com/sun/star/util/NumberFormatter.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberFormatter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,20 +76,21 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::util::NumberFormatter -/** specifies an object which can format numbers and strings. - - +/** represents an object which can format numbers and strings. <p>A NumberFormatter, if available, can be created by the global service manager.</p> */ service NumberFormatter { - // DocMerge: empty anyway + /** is used to format or parse numbers using formats from a + <type>NumberFormats</type> object. + */ interface com::sun::star::util::XNumberFormatter; - // DocMerge: empty anyway + /** is used to format numbers using a number format string + that is not inserted into a <type>NumberFormats</type> object. + */ interface com::sun::star::util::XNumberFormatPreviewer; }; @@ -98,18 +99,5 @@ service NumberFormatter }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/ReplaceDescriptor.idl b/offapi/com/sun/star/util/ReplaceDescriptor.idl index 5b792c40ff67..2e731b8cabeb 100644 --- a/offapi/com/sun/star/util/ReplaceDescriptor.idl +++ b/offapi/com/sun/star/util/ReplaceDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ReplaceDescriptor.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,19 +72,16 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: service com::sun::star::util::ReplaceDescriptor /** describes what and how to replace strings. */ service ReplaceDescriptor { - // DocMerge: empty anyway service com::sun::star::util::SearchDescriptor; - // DocMerge: empty anyway interface com::sun::star::util::XReplaceDescriptor; }; @@ -93,18 +90,4 @@ service ReplaceDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/SearchDescriptor.idl b/offapi/com/sun/star/util/SearchDescriptor.idl index 8ead4c7b20f9..ee0544d42783 100644 --- a/offapi/com/sun/star/util/SearchDescriptor.idl +++ b/offapi/com/sun/star/util/SearchDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SearchDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,64 +72,47 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: service com::sun::star::util::SearchDescriptor /** describes what and how to search within a container. */ service SearchDescriptor { - // DocMerge: empty anyway interface com::sun::star::util::XSearchDescriptor; - // DocMerge: empty anyway interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchBackwards /** If <TRUE/>, the search is done backwards in the document. */ [property] boolean SearchBackwards; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchCaseSensitive /** If <TRUE/>, the case of the letters is important for the match. */ [property] boolean SearchCaseSensitive; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchWords /** If <TRUE/>, only complete words will be found. */ [property] boolean SearchWords; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchRegularExpression /** If <TRUE/>, the search string is evaluated as a regular expression. */ [property] boolean SearchRegularExpression; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchStyles /** If <TRUE/>, it is searched for positions where the paragraph style with the name of the search pattern is applied. */ [property] boolean SearchStyles; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarity /** If <TRUE/>, a "similarity search" is performed. - - <p>In the case of a similarity search, the following properties specify the kind of similarity: </p> @@ -147,12 +130,8 @@ service SearchDescriptor [property] boolean SearchSimilarity; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityRelax /** If <TRUE/>, all similarity rules are applied together. - - <p>In the case of a relaxed similarity search, the following properties are applied together: @@ -169,24 +148,18 @@ service SearchDescriptor [property] boolean SearchSimilarityRelax; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityRemove /** This property specifies the number of characters that may be ignored to match the search pattern. */ [property] short SearchSimilarityRemove; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityAdd /** specifies the number of characters that must be added to match the search pattern. */ [property] short SearchSimilarityAdd; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityExchange /** This property specifies the number of characters that must be replaced to match the search pattern. */ @@ -198,24 +171,4 @@ service SearchDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/14 12:53:46 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/SortDescriptor.idl b/offapi/com/sun/star/util/SortDescriptor.idl index 501e18b7da43..eab0204a4473 100644 --- a/offapi/com/sun/star/util/SortDescriptor.idl +++ b/offapi/com/sun/star/util/SortDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: SortDescriptor.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,32 +75,26 @@ module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: service com::sun::star::util::SortDescriptor /** specifies the properties which can be used to describe - a sort order applied to an XSortable.@see XSortable + a sort order applied to an XSortable. + + @see XSortable */ service SortDescriptor { interface com::sun::star::beans::XPropertySet; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::IsCaseSensitive - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::IsCaseSensitive /** specifies if the case of letters is important when comparing entries. */ [property] boolean IsCaseSensitive; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR SheetSortDescriptor::SortAscending - - // DocMerge from xml: property com::sun::star::sheet::SheetSortDescriptor::SortAscending /** specifies the sorting order. */ [property] boolean SortAscending; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::util::SortDescriptor::SortColumns /** specifies if the columns are sorted. <dl> @@ -136,30 +130,4 @@ service SortDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/14 16:31:44 mi - collation properties added / all global props now in util::SortDescriptor - - Revision 1.5 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:46 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/SortField.idl b/offapi/com/sun/star/util/SortField.idl index 420772553e7a..15f6b10d854b 100644 --- a/offapi/com/sun/star/util/SortField.idl +++ b/offapi/com/sun/star/util/SortField.idl @@ -2,9 +2,9 @@ * * $RCSfile: SortField.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,31 +68,24 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= - -// DocMerge from xml: struct com::sun::star::util::SortField /** describes a single field in a sort descriptor. */ struct SortField { - // DocMerge from xml: field com::sun::star::util::SortField::Field - /** index of the field in the table. + /** index of the field in the table; 0-based. */ long Field; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::SortField::SortAscending - /** if data are sorted in ascending order, + /** <TRUE/> if data are sorted in ascending order, <FALSE/> if in descending order. */ boolean SortAscending; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::SortField::FieldType /** type of contents in the field. */ com::sun::star::util::SortFieldType FieldType; @@ -103,21 +96,4 @@ struct SortField }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/SortFieldType.idl b/offapi/com/sun/star/util/SortFieldType.idl index e4080982c51e..c0e84f004891 100644 --- a/offapi/com/sun/star/util/SortFieldType.idl +++ b/offapi/com/sun/star/util/SortFieldType.idl @@ -2,9 +2,9 @@ * * $RCSfile: SortFieldType.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,33 +64,25 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: enum com::sun::star::util::SortFieldType -/** enumeration used to specify the type of contents in a - sort field. +/** enumeration used to specify the type of contents in a sort field. */ enum SortFieldType { //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::util::SortFieldType::AUTOMATIC /** type is determined automatically. */ AUTOMATIC, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::util::SortFieldType::NUMERIC /** sort field contains numerical data. */ NUMERIC, //------------------------------------------------------------------------- - - // DocMerge from xml: value com::sun::star::util::SortFieldType::ALPHANUMERIC /** sort field contains text data. */ ALPHANUMERIC @@ -101,18 +93,4 @@ enum SortFieldType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/TextSearch.idl b/offapi/com/sun/star/util/TextSearch.idl index dc0ce478c286..c0921dfed47e 100644 --- a/offapi/com/sun/star/util/TextSearch.idl +++ b/offapi/com/sun/star/util/TextSearch.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextSearch.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,13 +67,13 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -//-------------------------------------------------------------------------- /** search a string with a defined algorithm in another string. - It is able to search forward or backward in the string + + <p>It is possible to search forward or backward in the string. */ service TextSearch { diff --git a/offapi/com/sun/star/util/Time.idl b/offapi/com/sun/star/util/Time.idl index aaeceecde3d1..51afed3d76c5 100644 --- a/offapi/com/sun/star/util/Time.idl +++ b/offapi/com/sun/star/util/Time.idl @@ -2,9 +2,9 @@ * * $RCSfile: Time.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,37 +64,29 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::Time /** represents a time value. */ struct Time { - // DocMerge from xml: field com::sun::star::util::Time::HundredthSeconds /** contains the hundredth seconds (0-99). */ unsigned short HundredthSeconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::Time::Seconds /** contains the seconds (0-59). */ unsigned short Seconds; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::Time::Minutes /** contains the minutes (0-59). */ unsigned short Minutes; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::Time::Hours /** contains the hour (0-23). */ unsigned short Hours; @@ -105,18 +97,4 @@ struct Time }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/URL.idl b/offapi/com/sun/star/util/URL.idl index a83e783d0855..840468d572c4 100644 --- a/offapi/com/sun/star/util/URL.idl +++ b/offapi/com/sun/star/util/URL.idl @@ -2,9 +2,9 @@ * * $RCSfile: URL.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,98 +64,94 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: struct com::sun::star::util::URL -/** represents the original and the parsed structure of a - Uniform Resource Locator. +/** represents the structure of an Uniform Resource Locator. - - - <p>It is not necessary to set all of the fields; either <member>URL::Complete</member> + <p> + If the structure represents a valid URL or not depends on prior usage of + the functions of <type>XURLTransformer</type>. Only after one of the functions + returned </TRUE> this can be assumed.</br> + It is not necessary to set all of the fields; either <member>URL::Complete</member> or (some of) the others are set. Additionally, most of the other - fields, like <member>URL::User</member>, <member>URL::Password</member>, + fields, like <member>URL::Host</member>, <member>URL::Port</member>, + <member>URL::User</member>, <member>URL::Password</member>, or <member>URL::Mark</member>, are optional. + @see XURLTransformer + </p> */ struct URL { - // DocMerge from xml: field com::sun::star::util::URL::Complete - /** contains the unparsed original URL, for example, - http://me:pass@www.sun.de:8080/pub/test/foo.txt?a=b#xyz + /** contains the string representation of the complete URL, for example, + http://www.sun.de:8080/pub/test/foo.txt?a=b#xyz + + <p> + It is used as a central input/output or input parameter for the interfaces of + <type>XURLTransformer</type>. The usage of one of the <type>XURLTransformer</type> + function is mandatory to validate the URL. It cannot be assumed that + <member>URL::Complete</member> represents always a valid URL! + </p> */ string Complete; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Main /** contains the URL without a mark and without arguments, for example, - http://me:pass@www.sun.de:8080/pub/test/foo.txt + http://www.sun.de:8080/pub/test/foo.txt */ string Main; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Protocol /** contains the protocol (scheme) of the URL, for example, "http" */ string Protocol; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::User /** contains the user-identifier of the URL, for example, "me" */ string User; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Password /** contains the users password of the URL, for example, "pass" */ string Password; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Server /** contains the server part of the URL, for example, "www.sun.de" */ string Server; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Port /** contains the port at the server of the URL, for example, "8080" */ short Port; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Path - /** contains the path part of the URL without the filename, for example, "/pub/test" + /** contains all segments but the last one of the hierarchical path of the URL, for example, "/pub/test/" */ string Path; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Name - /** contains the filename part of the URL, for example, "foo.txt" + /** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt" + <p> + <strong>Attention:</strong>A service implementing the <type>XURLTransformer</type> interface + will normally not detect if the last segment is a folder or a file. So it is possible that + the last segment describes a folder. If you want to be sure that a file URL that references + a folder will be correctly put into the URL fields you should append a '/' at the end of the + hierarchical path. + </p> */ string Name; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Arguments /** contains the arguments part of the URL, for example, "a=b" */ string Arguments; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::util::URL::Mark /** contains the mark part of the URL, for example, "xyz" */ string Mark; @@ -166,33 +162,4 @@ struct URL }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/12 14:06:16 mi - #78715# stardiv references removed - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.6 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.4 2000/02/21 16:18:16 mi - string documentation from stardiv...*.idl-files - - Revision 1.3 2000/01/27 16:13:34 mi - #70728# missing documentation marked - - Revision 1.2 2000/01/03 12:03:24 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/URLTransformer.idl b/offapi/com/sun/star/util/URLTransformer.idl index ebbf5c2ea44c..124d24023d07 100644 --- a/offapi/com/sun/star/util/URLTransformer.idl +++ b/offapi/com/sun/star/util/URLTransformer.idl @@ -2,9 +2,9 @@ * * $RCSfile: URLTransformer.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,17 +68,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: service com::sun::star::util::URLTransformer /** helps to split up a string containing a URL into its structural parts and assembles the parts into a single string. */ service URLTransformer { - // DocMerge: empty anyway interface com::sun::star::util::XURLTransformer; }; @@ -87,18 +85,4 @@ service URLTransformer }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XArchiver.idl b/offapi/com/sun/star/util/XArchiver.idl index 5a97422a4ac3..173b229ce94a 100644 --- a/offapi/com/sun/star/util/XArchiver.idl +++ b/offapi/com/sun/star/util/XArchiver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArchiver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,27 +76,22 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XArchiver /** @deprecated */ interface XArchiver: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DOCUMENTATION OMITTED FOR XArchiver::pack - - // DocMerge: empty anyway boolean pack( [in] sequence<string> input, [in] string destination, [in] sequence<com::sun::star::beans::PropertyValue> aArgs ); //------------------------------------------------------------------------- // DOCUMENTATION OMITTED FOR XArchiver::unpack - - // DocMerge: empty anyway boolean unpack( [in] string destinationpath, [in] string source, [in] sequence<string> files, @@ -104,14 +99,10 @@ interface XArchiver: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DOCUMENTATION OMITTED FOR XArchiver::getContent - - // DocMerge: empty anyway com::sun::star::container::XIndexAccess getContent( [in] string source ); //------------------------------------------------------------------------- // DOCUMENTATION OMITTED FOR XArchiver::getExtraData - - // DocMerge: empty anyway string getExtraData( [in] string source ); }; @@ -120,27 +111,4 @@ interface XArchiver: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.5 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:10 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/XAtomServer.idl b/offapi/com/sun/star/util/XAtomServer.idl index 2dceac7b34ab..9cc688ff0f7d 100644 --- a/offapi/com/sun/star/util/XAtomServer.idl +++ b/offapi/com/sun/star/util/XAtomServer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAtomServer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -131,6 +131,8 @@ interface XAtomServer : com::sun::star::uno::XInterface the strings for the requested atoms */ sequence< string > getAtomDescriptions( [in] sequence< AtomClassRequest > atoms ); + + //----------------------------------------------------------------------- /** returns the atoms that have been registered to a class after an already known atom @@ -148,6 +150,8 @@ interface XAtomServer : com::sun::star::uno::XInterface <code>atomClass</code> after <code>atom</code> */ sequence< AtomDescription > getRecentAtoms( [in] long atomClass, [in] long atom ); + + //----------------------------------------------------------------------- /** registers or searches for a string @param atomClass diff --git a/offapi/com/sun/star/util/XCancelManager.idl b/offapi/com/sun/star/util/XCancelManager.idl index e9fb3ac9b3ea..78595a82bc70 100644 --- a/offapi/com/sun/star/util/XCancelManager.idl +++ b/offapi/com/sun/star/util/XCancelManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCancelManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,39 +72,22 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XCancelManager /** manages a list of cancellable objects. - - - - - - - - - - - - @deprecated */ interface XCancelManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XCancelManager::registerCancellable /** registers a cancellable object. */ void registerCancellable( [in] com::sun::star::util::XCancellable Cancel ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XCancelManager::releaseCancellable /** deregisters a cancellable object. */ void releaseCancellable( [in] com::sun::star::util::XCancellable Cancel ); @@ -115,27 +98,4 @@ interface XCancelManager: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.5 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:10 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/XCancellable.idl b/offapi/com/sun/star/util/XCancellable.idl index 087cf41fc541..519dadafa588 100644 --- a/offapi/com/sun/star/util/XCancellable.idl +++ b/offapi/com/sun/star/util/XCancellable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCancellable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,19 +68,17 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XCancellable /** offers the possibility of cancelling a job. - This is supported by objects which represent a job. + + <p>This is supported by objects which represent a job. */ interface XCancellable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XCancellable::cancel /** cancels the current job of the object. */ void cancel(); @@ -91,21 +89,4 @@ interface XCancellable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XChainable.idl b/offapi/com/sun/star/util/XChainable.idl index 9ce9d909f701..a8e405383e5a 100644 --- a/offapi/com/sun/star/util/XChainable.idl +++ b/offapi/com/sun/star/util/XChainable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChainable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XChainable /** enables the object to be a member of a chain. */ interface XChainable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XChainable::getPredecessor /** @returns the previous object in this chain or NULL, if this is the first object of this chain. @@ -91,8 +88,6 @@ interface XChainable: com::sun::star::uno::XInterface com::sun::star::util::XChainable getPredecessor(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XChainable::getSuccessor /** @returns the next object in this chain or NULL, if this is the last object in this chain. @@ -100,23 +95,15 @@ interface XChainable: com::sun::star::uno::XInterface com::sun::star::util::XChainable getSuccessor(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChainable::setSuccessor /** connects the specified object to this object as the successor in a chain. - - <p>This implies that this object will become the predecessor of - <var>xChainable</var>. - - </p> + <var>xChainable</var>. </p> */ void setSuccessor( [in] com::sun::star::util::XChainable xChainable ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChainable::isChainable /** checks if the specified object can be linked to this. */ boolean isChainable( [in] com::sun::star::util::XChainable xChainable ); @@ -127,21 +114,4 @@ interface XChainable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XChangesBatch.idl b/offapi/com/sun/star/util/XChangesBatch.idl index aeb816075119..1dc91aa94e81 100644 --- a/offapi/com/sun/star/util/XChangesBatch.idl +++ b/offapi/com/sun/star/util/XChangesBatch.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangesBatch.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,11 +76,9 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= - -// DocMerge from xml: interface com::sun::star::util::XChangesBatch /** this interface enables applying a set of changes in one batch transaction. <p>An object implementing this interface allows other interfaces to change @@ -97,29 +95,19 @@ interface XChangesBatch: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- + /** commits any pending changes. - // DocMerge from xml: method com::sun::star::util::XChangesBatch::commitChanges - /** Commits any pending changes. - - - <p>The meaning of 'commit', especially any transactional guarantees, - depend on the service. - - </p> + <p>The exact action depends on the concrete service. </p> */ void commitChanges() raises( com::sun::star::lang::WrappedTargetException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChangesBatch::hasPendingChanges /** checks whether this object has any pending changes that can be committed. */ boolean hasPendingChanges(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChangesBatch::getPendingChanges /** queries for any pending changes that can be committed. */ ChangesSet getPendingChanges(); @@ -129,24 +117,4 @@ interface XChangesBatch: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.1 2000/06/15 16:00:08 jb - Add Interfaces to support batch changes - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XChangesListener.idl b/offapi/com/sun/star/util/XChangesListener.idl index ef528ba4d061..5acf21d3ed1e 100644 --- a/offapi/com/sun/star/util/XChangesListener.idl +++ b/offapi/com/sun/star/util/XChangesListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangesListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,20 +72,19 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XChangesListener -/** receives events from batch change broadcaster objects.@see ChangesEvent - @see XChangesNotifier - @see XChangesBatch +/** receives events from batch change broadcaster objects. + + @see ChangesEvent + @see XChangesNotifier + @see XChangesBatch */ interface XChangesListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChangesListener::changesOccurred /** is invoked when a batch of changes occurred. */ [oneway] void changesOccurred( [in] com::sun::star::util::ChangesEvent Event ); @@ -96,22 +95,4 @@ interface XChangesListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:19 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.1 2000/06/15 16:00:08 jb - Add Interfaces to support batch changes - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XChangesNotifier.idl b/offapi/com/sun/star/util/XChangesNotifier.idl index 7ab077f27fa7..9dcf1cd8415f 100644 --- a/offapi/com/sun/star/util/XChangesNotifier.idl +++ b/offapi/com/sun/star/util/XChangesNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangesNotifier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,27 +67,24 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XChangesNotifier -/** broadcasts events about multiple changes that occur in bulk.@see XChangesListener - @see XChangesBatch - @see ChangesEvent +/** broadcasts events about multiple changes that occur in bulk. + + @see XChangesListener + @see XChangesBatch + @see ChangesEvent */ interface XChangesNotifier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChangesNotifier::addChangesListener - /** adds the specified listener to receive events when "changesOccurred". + /** adds the specified listener to receive events when changes occured. */ [oneway] void addChangesListener( [in] com::sun::star::util::XChangesListener aListener ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XChangesNotifier::removeChangesListener /** removes the specified listener. */ [oneway] void removeChangesListener( [in] com::sun::star::util::XChangesListener aListener ); @@ -98,25 +95,4 @@ interface XChangesNotifier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.4 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.2 2000/07/14 13:02:10 jb - Removed wrong base class XEventListener - - Revision 1.1 2000/06/15 16:00:08 jb - Add Interfaces to support batch changes - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XChangesSet.idl b/offapi/com/sun/star/util/XChangesSet.idl index e67c462d312d..6d0a708774bb 100644 --- a/offapi/com/sun/star/util/XChangesSet.idl +++ b/offapi/com/sun/star/util/XChangesSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChangesSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,26 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= - -// DocMerge from xml: interface com::sun::star::util::XChangesSet /** this interface enables inspecting a set of changes forming one batch transaction. - <p>An object implementing this interface should implement more - container interfaces to access individual changes as well. + container interfaces to access individual changes as well. </p> - </p>@see XChangesBatch - @see ChangesEvent - @see XChangesListener - @see XChangesNotifier + @see XChangesBatch + @see ChangesEvent + @see XChangesListener + @see XChangesNotifier */ interface XChangesSet: com::sun::star::container::XElementAccess { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XChangesSet::getAllChanges /** queries for all contained changes at once. - @returns an array of <type>ElementChange</type> holding information about each changes - that is part of this object. + @returns an array of <type>ElementChange</type> holding information about + each changes that is part of this object. */ sequence<ElementChange> getAllChanges(); }; @@ -109,21 +104,4 @@ interface XChangesSet: com::sun::star::container::XElementAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.1 2000/06/15 16:00:08 jb - Add Interfaces to support batch changes - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XCloneable.idl b/offapi/com/sun/star/util/XCloneable.idl index 156204a9d255..ba42d437749a 100644 --- a/offapi/com/sun/star/util/XCloneable.idl +++ b/offapi/com/sun/star/util/XCloneable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCloneable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,18 +68,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XCloneable -/** makes it possible to create a copy of the object. +/** makes it possible to create a copy of the object which supports this interface. */ interface XCloneable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XCloneable::createClone /** creates a copy of the object. */ com::sun::star::util::XCloneable createClone(); @@ -90,21 +87,4 @@ interface XCloneable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XDataEditor.idl b/offapi/com/sun/star/util/XDataEditor.idl index eb5732d0a772..d407fb3b60d9 100644 --- a/offapi/com/sun/star/util/XDataEditor.idl +++ b/offapi/com/sun/star/util/XDataEditor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataEditor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,32 +71,33 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { -// DocMerge from xml: interface com::sun::star::util::XDataEditor /** connects to a model and broadcasts status change events. */ interface XDataEditor: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::util::XDataEditor::show /** makes the data editor visible to the user. */ void show(); - // DocMerge from xml: method com::sun::star::util::XDataEditor::setModel + //-------------------------------------------------------------------------- /** connects the data editor to a data model. */ void setModel( [in] com::sun::star::uno::XInterface model ); - // DocMerge: empty anyway + //-------------------------------------------------------------------------- + /** @returns + the data model which was set by <method>XDataEditor::setModel</method>. + */ com::sun::star::uno::XInterface getModel(); - // DocMerge from xml: method com::sun::star::util::XDataEditor::addDataEditorListener + //-------------------------------------------------------------------------- /** registers a listener to receive <type>DataEditorEvent</type>s. */ void addDataEditorListener( [in] XDataEditorListener listener ); - // DocMerge from xml: method com::sun::star::util::XDataEditor::removeDataEditorListener + //-------------------------------------------------------------------------- /** unregisters a listener which received <type>DataEditorEvent</type>s. */ void removeDataEditorListener( [in] XDataEditorListener listener ); @@ -106,21 +107,4 @@ interface XDataEditor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:51:45 tlx - DataEditor + UniqIDs - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XDataEditorListener.idl b/offapi/com/sun/star/util/XDataEditorListener.idl index ba55e73504f6..61e913d4b000 100644 --- a/offapi/com/sun/star/util/XDataEditorListener.idl +++ b/offapi/com/sun/star/util/XDataEditorListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataEditorListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,15 +71,13 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { -// DocMerge from xml: interface com::sun::star::util::XDataEditorListener /** makes it possible to receive status change events from an <type>XDataEditor</type>. */ interface XDataEditorListener: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::util::XDataEditorListener::updateDataEditorState /** is called when the state of a connected <type>XDataEditor</type> changes. */ void updateDataEditorState( [in] DataEditorEvent event ); @@ -89,21 +87,4 @@ interface XDataEditorListener: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:51:45 tlx - DataEditor + UniqIDs - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XFlushListener.idl b/offapi/com/sun/star/util/XFlushListener.idl index 3b5e52fc7f89..7ffad6f5cc47 100644 --- a/offapi/com/sun/star/util/XFlushListener.idl +++ b/offapi/com/sun/star/util/XFlushListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFlushListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XFlushListener /** makes it possible to receive <em>flushed</em> events. */ interface XFlushListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XFlushListener::flushed /** is called when the object data is flushed. */ void flushed( [in] com::sun::star::lang::EventObject rEvent ); @@ -94,21 +91,4 @@ interface XFlushListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XFlushable.idl b/offapi/com/sun/star/util/XFlushable.idl index ef8b007e6806..5d6d1ad534e2 100644 --- a/offapi/com/sun/star/util/XFlushable.idl +++ b/offapi/com/sun/star/util/XFlushable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFlushable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,25 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XFlushable /** is supported by objects with data that can be flushed to a data source. */ interface XFlushable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XFlushable::flush /** flushes the data of the object to the connected data source. */ void flush(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XFlushable::addFlushListener /** adds the specified listener to receive event "flushed." */ [oneway] void addFlushListener( [in] com::sun::star::util::XFlushListener l ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XFlushable::removeFlushListener /** removes the specified listener. */ [oneway] void removeFlushListener( [in] com::sun::star::util::XFlushListener l ); @@ -108,21 +101,4 @@ interface XFlushable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:05 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/util/XIndent.idl b/offapi/com/sun/star/util/XIndent.idl index 15101ae48276..e9a3ea3197e5 100644 --- a/offapi/com/sun/star/util/XIndent.idl +++ b/offapi/com/sun/star/util/XIndent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,22 +71,16 @@ module com { module sun { module star { module util { //============================================================================= - -// DocMerge from xml: interface com::sun::star::util::XIndent /** allows indentation of the object to be changed. */ interface XIndent: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XIndent::decrementIndent /** shifts the indentation by one default step to the left. */ void decrementIndent(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XIndent::incrementIndent /** shifts the indentation by one default step to the right. */ void incrementIndent(); @@ -97,21 +91,4 @@ interface XIndent: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XLinkUpdate.idl b/offapi/com/sun/star/util/XLinkUpdate.idl index c87523d3564c..989cbb1d86db 100644 --- a/offapi/com/sun/star/util/XLinkUpdate.idl +++ b/offapi/com/sun/star/util/XLinkUpdate.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLinkUpdate.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,7 +68,7 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= @@ -78,7 +78,6 @@ interface XLinkUpdate: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** initiates the reloading of all linked document content like linked graphics, linked text sections. */ @@ -88,7 +87,7 @@ interface XLinkUpdate: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; -#endif +#endif diff --git a/offapi/com/sun/star/util/XLocalizedAliases.idl b/offapi/com/sun/star/util/XLocalizedAliases.idl index 5851c1a880e1..0487f39672c5 100644 --- a/offapi/com/sun/star/util/XLocalizedAliases.idl +++ b/offapi/com/sun/star/util/XLocalizedAliases.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLocalizedAliases.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,18 +78,16 @@ #endif //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XLocalizedAliases /** is the interface for binding programmatic names to aliases. Aliases can be provided in several locales for the same programmatic name. */ interface XLocalizedAliases: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::bindAlias /** registers an alias for a programmatic name. */ void bindAlias([in]string programmaticName, @@ -97,39 +95,29 @@ interface XLocalizedAliases: com::sun::star::uno::XInterface [in]string alias) raises (com::sun::star::container::ElementExistException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::unbindAlias /** revokes an alias for a programmatic name. */ void unbindAlias([in]com::sun::star::lang::Locale locale, [in]string alias) raises (com::sun::star::container::NoSuchElementException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::lookupAlias /** retrieves a registered porgrammatic name identified by an alias. */ string lookupAlias([in]com::sun::star::lang::Locale locale, [in]string Alias) raises (com::sun::star::container::NoSuchElementException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::lookupProgrammatic /** retrieves a given alias for a programmatic name. */ string lookupProgrammatic([in]com::sun::star::lang::Locale locale, [in]string programmatic) raises (com::sun::star::container::NoSuchElementException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::unbindAliases /** removes all aliases for a programmatic name. */ void unbindAliases([in]string programmaticName) raises (com::sun::star::container::NoSuchElementException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::rebindAliases /** rebinds all aliases registered to a given URL to a new one. */ void rebindAliases([in]string currentProgrammatic, @@ -137,8 +125,6 @@ interface XLocalizedAliases: com::sun::star::uno::XInterface raises (com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XLocalizedAliases::renameAlias /** renames an alias for a programmatic name. */ void renameAlias([in]com::sun::star::lang::Locale locale, @@ -147,13 +133,13 @@ interface XLocalizedAliases: com::sun::star::uno::XInterface raises (com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XLocalizedAliases::listAliases /** retrieves a list of all registered aliases for a certain language. - @param locale - is the locale scope. - @returns - a sequence of registered pair of alias and programmatic name. + + @param locale + specifies the locale scope. + + @returns + a sequence of registered pair of alias and programmatic name. */ sequence<AliasProgrammaticPair> listAliases([in]com::sun::star::lang::Locale locale); }; @@ -162,21 +148,4 @@ interface XLocalizedAliases: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.1 2000/01/27 07:50:24 dg - #71571# new files - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XMergeable.idl b/offapi/com/sun/star/util/XMergeable.idl index b1f9a11e9925..72ddaa12c64a 100644 --- a/offapi/com/sun/star/util/XMergeable.idl +++ b/offapi/com/sun/star/util/XMergeable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMergeable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,26 +68,23 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XMergeable /** represents a range of cells that can be merged. */ interface XMergeable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XMergeable::merge - /** merges the cells. + /** merges/unmerges the area specified by this object. */ void merge( [in] boolean bMerge ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XMergeable::getIsMerged - /** returns the current state of the cells. + /** @returns + <TRUE/> if the area specified by this object is merged, + or <FALSE/> otherwise. */ boolean getIsMerged(); @@ -97,21 +94,4 @@ interface XMergeable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XModeSelector.idl b/offapi/com/sun/star/util/XModeSelector.idl index 8bfbcdbe1a24..d135f4e15541 100644 --- a/offapi/com/sun/star/util/XModeSelector.idl +++ b/offapi/com/sun/star/util/XModeSelector.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModeSelector.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,42 +72,33 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XModeSelector /** is supported by objects which supply different modes. */ interface XModeSelector: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModeSelector::setMode /** sets a new mode for the implementing object. */ void setMode( [in] string aMode ) raises( com::sun::star::lang::NoSupportException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XModeSelector::getMode /** @returns the current mode. */ string getMode(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XModeSelector::getSupportedModes /** @returns a sequence of all supported modes. */ sequence<string> getSupportedModes(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModeSelector::supportsMode /** asks whether a mode is supported or not. */ boolean supportsMode( [in] string aMode ); @@ -118,27 +109,4 @@ interface XModeSelector: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:10 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/XModifiable.idl b/offapi/com/sun/star/util/XModifiable.idl index 2004999ca9f5..141a111d6e58 100644 --- a/offapi/com/sun/star/util/XModifiable.idl +++ b/offapi/com/sun/star/util/XModifiable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModifiable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:56 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,34 +72,27 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XModifiable /** makes the modify state of the object accessible. - - <p>Additionally, it makes it possible to register listener objects, which get notification whenever the status or content of the object changes. </p> */ interface XModifiable: com::sun::star::util::XModifyBroadcaster { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XModifiable::isModified /** @returns <TRUE/> if the object is modified. - <p>The modification is always in relation to a certain state - (i.e., the initial, loaded, or last stored version). + <p>The modification is always in relation to a certain state + (i.e., the initial, loaded, or last stored version). */ boolean isModified(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModifiable::setModified /** sets the status of the <em>modified</em>-flag from outside of the object. */ @@ -112,24 +105,4 @@ interface XModifiable: com::sun::star::util::XModifyBroadcaster }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XModifyBroadcaster.idl b/offapi/com/sun/star/util/XModifyBroadcaster.idl index c1ce412c4e11..7f6447a08c4d 100644 --- a/offapi/com/sun/star/util/XModifyBroadcaster.idl +++ b/offapi/com/sun/star/util/XModifyBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModifyBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,12 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XModifyBroadcaster -/** broadcasts each modification made on its data. - - +/** broadcasts each modification made on the date data of the object which + supports this interface. <p>The modified object must post the modification events immediately after the modification is performed.</p> @@ -87,15 +85,11 @@ interface XModifyBroadcaster: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModifyBroadcaster::addModifyListener /** adds the specified listener to receive events "modified." */ [oneway] void addModifyListener( [in] com::sun::star::util::XModifyListener aListener ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModifyBroadcaster::removeModifyListener /** removes the specified listener. */ [oneway] void removeModifyListener( [in] com::sun::star::util::XModifyListener aListener ); @@ -106,21 +100,4 @@ interface XModifyBroadcaster: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XModifyListener.idl b/offapi/com/sun/star/util/XModifyListener.idl index 0828c69d6acf..3cd911c7ee40 100644 --- a/offapi/com/sun/star/util/XModifyListener.idl +++ b/offapi/com/sun/star/util/XModifyListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XModifyListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,27 +72,20 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XModifyListener -/** makes it possible to receive events when a model object - changes. +/** makes it possible to receive events when a model object changes. */ interface XModifyListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XModifyListener::modified /** is called when something changes in the object. - - <p>Due to such an event, it may be necessary to update views or - controllers. + controllers. </p> - </p> <p>The source of the event may be the content of the object to which the listener is registered.</p> */ @@ -104,24 +97,4 @@ interface XModifyListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XNumberFormatPreviewer.idl b/offapi/com/sun/star/util/XNumberFormatPreviewer.idl index 0a523118ed54..fd4cac4c0624 100644 --- a/offapi/com/sun/star/util/XNumberFormatPreviewer.idl +++ b/offapi/com/sun/star/util/XNumberFormatPreviewer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormatPreviewer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,18 +84,37 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XNumberFormatPreviewer -/** represents a number formatter, which can preview number - formats without inserting them.@see NumberFormatter +/** represents a number formatter which can preview number + formats without inserting them. + + @see NumberFormatter */ interface XNumberFormatPreviewer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormatPreviewer::convertNumberToPreviewString - // DocMerge from xml: method com::sun::star::util::XNumberFormatPreviewer::convertNumberToPreviewString /** formats a value using a format string, without inserting a number format into the list. + + @param aFormat + is the format string that is used for formatting. + + @param fValue + is the value that is formatted. + + @param nLocale + is the locale that is used to interpret the format string. + + @param bAllowEnglish + specifies if English language number format strings are accepted + in addition to those from the selected locale. + + @returns + the formatted string. + + @throws com::sun::star::util::MalformedNumberFormatException + if the format string is invalid. + */ string convertNumberToPreviewString( [in] string aFormat, [in] double fValue, @@ -105,8 +124,31 @@ interface XNumberFormatPreviewer: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormatPreviewer::queryPreviewColorForNumber /** returns the color which is to be used for a number. + + @param aFormat + is the format string that is used for formatting. + + @param fValue + is the value that is formatted. + + @param nLocale + is the locale that is used to interpret the format string. + + @param bAllowEnglish + specifies if English language number format strings are accepted + in addition to those from the selected locale. + + @param aDefaultColor + is the color that should be returned if no color is set by + the number format. + + @returns + the color that should used to output the formatted string. + + @throws com::sun::star::util::MalformedNumberFormatException + if the format string is invalid. + */ com::sun::star::util::color queryPreviewColorForNumber( [in] string aFormat, [in] double fValue, @@ -121,36 +163,5 @@ interface XNumberFormatPreviewer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.7 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.5 2000/03/24 13:13:40 nn - #74032# documentation added - - Revision 1.4 2000/01/28 15:24:56 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.3 2000/01/28 15:01:52 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.2 2000/01/27 16:13:34 mi - #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/util/XNumberFormatTypes.idl b/offapi/com/sun/star/util/XNumberFormatTypes.idl index 61d3c78e790f..f785d52b0660 100644 --- a/offapi/com/sun/star/util/XNumberFormatTypes.idl +++ b/offapi/com/sun/star/util/XNumberFormatTypes.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormatTypes.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,14 +76,12 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XNumberFormatTypes /** represents functions to get specific, predefined number formats. */ interface XNumberFormatTypes: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getStandardIndex /** @returns the key of the standard format for a locale. */ @@ -91,20 +89,18 @@ interface XNumberFormatTypes: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getStandardFormat /** @returns the key of the standard format within a specified type for a given locale. @param nType the type of the number format. Must be one of the - NUMBERFORMAT_... constants. + <type>NumberFormat</type> constants. */ long getStandardFormat( [in] short nType, [in] com::sun::star::lang::Locale nLocale ); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getFormatIndex /** @returns the key of a built-in format for a locale: @@ -119,7 +115,6 @@ interface XNumberFormatTypes: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormatTypes::isTypeCompatible /** verifies if one type of number format is compatible with another type. */ boolean isTypeCompatible( [in] short nOldType, @@ -127,7 +122,6 @@ interface XNumberFormatTypes: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatTypes::getFormatForLocale /** @returns the index of the converted number format if successful, the old index if the number format could not be converted. @@ -147,30 +141,5 @@ interface XNumberFormatTypes: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.2 2000/11/02 20:34:33 er - getFormatIndex: added a comment pointing to <type scope=com::sun::star::i18n>NumberFormatIndex</type> - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.4 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.2 2000/01/28 15:01:52 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl index 945669b5a8fd..ccd97969036b 100644 --- a/offapi/com/sun/star/util/XNumberFormats.idl +++ b/offapi/com/sun/star/util/XNumberFormats.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormats.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,23 +84,19 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XNumberFormats /** provides access to multiple <type>NumberFormat</type>s. */ interface XNumberFormats: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormats::getByKey /** @returns a readonly <type>NumberFormatProperties</type>. */ com::sun::star::beans::XPropertySet getByKey( [in] long nKey ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormats::queryKeys - // DocMerge from idl: method com::sun::star::util::XNumberFormats::queryKeys /** @returns a sequence of the keys of all number formats with the specified type and language. @@ -121,7 +117,6 @@ interface XNumberFormats: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormats::queryKey /** finds a number format by its format string and returns its key. */ long queryKey( [in] string aFormat, @@ -130,7 +125,6 @@ interface XNumberFormats: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormats::addNew /** adds a new number format to the list, using a format string. */ long addNew( [in] string aFormat, @@ -139,7 +133,6 @@ interface XNumberFormats: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormats::addNewConverted /** adds a new number format to the list, using a format string in a different locale than the desired locale of the resulting number format. @@ -151,15 +144,12 @@ interface XNumberFormats: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormats::removeByKey /** removes a number format from the list. */ void removeByKey( [in] long nKey ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormats::generateFormat - // DocMerge from xml: method com::sun::star::util::XNumberFormats::generateFormat /** generates a format string from several parameters without creating an actual number format. */ @@ -176,39 +166,5 @@ interface XNumberFormats: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.9 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.7 2000/03/24 13:17:00 nn - #74032# documentation added - - Revision 1.6 2000/01/28 15:24:59 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.5 2000/01/28 15:01:52 mi - #72210# Locale instead of Language in NumberFormatter - - Revision 1.4 2000/01/27 16:13:34 mi - #70728# missing documentation marked - - Revision 1.3 2000/01/07 13:22:26 nn - #71543# Numberformat really as XPropertySet - - Revision 1.2 2000/01/06 11:06:40 mi - #71543# Numberformat as XPropertySet - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif + diff --git a/offapi/com/sun/star/util/XNumberFormatsSupplier.idl b/offapi/com/sun/star/util/XNumberFormatsSupplier.idl index f1a53e77b751..71bb74ac19da 100644 --- a/offapi/com/sun/star/util/XNumberFormatsSupplier.idl +++ b/offapi/com/sun/star/util/XNumberFormatsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormatsSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,6 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XNumberFormatsSupplier /** supplies the collection of <type>NumberFormat</type>s (for example, in a document) and the settings belonging to these formats. */ @@ -88,7 +87,6 @@ interface XNumberFormatsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatsSupplier::getNumberFormatSettings /** @returns the <type>NumberFormatSettings</type> of this object. */ @@ -96,7 +94,6 @@ interface XNumberFormatsSupplier: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatsSupplier::getNumberFormats /** @returns the collection of number formats belonging to this object (e.g., to this document). */ @@ -108,24 +105,5 @@ interface XNumberFormatsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XNumberFormatter.idl b/offapi/com/sun/star/util/XNumberFormatter.idl index 979454f194cf..cea559d2ff4f 100644 --- a/offapi/com/sun/star/util/XNumberFormatter.idl +++ b/offapi/com/sun/star/util/XNumberFormatter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNumberFormatter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,19 +84,15 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XNumberFormatter /** represents a number formatter. */ interface XNumberFormatter: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::attachNumberFormatsSupplier /** attaches an <type>XNumberFormatsSupplier</type> to this <type>NumberFormatter</type>. - - <p>This <type>NumberFormatter</type> will only use the <type>NumberFormats</type> specified in the attached <type>XNumberFormatsSupplier</type>. Without an attached <type>XNumberFormatsSupplier</type>, no formatting is possible.</p> @@ -105,7 +101,6 @@ interface XNumberFormatter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatter::getNumberFormatsSupplier /** @returns the attached <type>NumberFormatsSupplier</type>. */ @@ -113,7 +108,6 @@ interface XNumberFormatter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::detectNumberFormat /** detects the number format in a string which contains a formatted number. */ long detectNumberFormat( [in] long nKey, @@ -122,11 +116,8 @@ interface XNumberFormatter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::convertStringToNumber /** converts a string which contains a formatted number into a number. - - <p>If this is a text format, the string will not be converted.</p> */ double convertStringToNumber( [in] long nKey, @@ -134,9 +125,7 @@ interface XNumberFormatter: com::sun::star::uno::XInterface raises( com::sun::star::util::NotNumericException ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormatter::convertNumberToString - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::convertNumberToString /** converts a number into a string. */ string convertNumberToString( [in] long nKey, @@ -144,7 +133,6 @@ interface XNumberFormatter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatter::queryColorForNumber /** @returns the color which is specified for the given value in the number format, which is otherwise the value of <var>aDefaultColor</var>. @@ -154,9 +142,7 @@ interface XNumberFormatter: com::sun::star::uno::XInterface [in] com::sun::star::util::color aDefaultColor ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormatter::formatString - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::formatString /** converts a string into another string. */ string formatString( [in] long nKey, @@ -164,7 +150,6 @@ interface XNumberFormatter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::util::XNumberFormatter::queryColorForString /** @returns the color which is specified for the given string in the number format, which is otherwise the value of <var>aDefaultColor</var>. @@ -174,16 +159,11 @@ interface XNumberFormatter: com::sun::star::uno::XInterface [in] com::sun::star::util::color aDefaultColor ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XNumberFormatter::getInputString - // DocMerge from xml: method com::sun::star::util::XNumberFormatter::getInputString /** converts a number into a string with the specified format. - - <p>This string can always be converted back to a number using the same format. - </p> */ string getInputString( [in] long nKey, @@ -195,27 +175,5 @@ interface XNumberFormatter: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/24 13:17:55 nn - #74032# documentation added - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XPropertyReplace.idl b/offapi/com/sun/star/util/XPropertyReplace.idl index 6261fc779a3c..b1c246d21c3f 100644 --- a/offapi/com/sun/star/util/XPropertyReplace.idl +++ b/offapi/com/sun/star/util/XPropertyReplace.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyReplace.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,42 +80,33 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XPropertyReplace /** makes it possible to search and replace properties. */ interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XPropertyReplace::getValueSearch /** provides the information if specific property values are searched, or just the existence of the specified properties. */ boolean getValueSearch(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XPropertyReplace::setValueSearch /** specifies if specific property values are searched, or just the existence of the specified properties. */ void setValueSearch( [in] boolean bValueSearch ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XPropertyReplace::getSearchAttributes /** @returns the attributes to search for. */ sequence<com::sun::star::beans::PropertyValue> getSearchAttributes(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XPropertyReplace::setSearchAttributes /** sets the properties to search for. */ void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs ) @@ -123,16 +114,12 @@ interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XPropertyReplace::getReplaceAttributes /** @returns the attribute values which are used to replace the found occurrences. */ sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XPropertyReplace::setReplaceAttributes /** sets the properties to replace the found occurrences. */ void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs ) @@ -145,30 +132,4 @@ interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:10 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XProtectable.idl b/offapi/com/sun/star/util/XProtectable.idl index bff60f39f256..33109b424f12 100644 --- a/offapi/com/sun/star/util/XProtectable.idl +++ b/offapi/com/sun/star/util/XProtectable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProtectable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,33 +72,26 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XProtectable /** makes it possible to protect objects from modifications. */ interface XProtectable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XProtectable::protect /** activates the protection. */ void protect( [in] string aPassword ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XProtectable::unprotect /** removes the protection. */ void unprotect( [in] string aPassword ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XProtectable::isProtected /** @returns the current state of protection. */ @@ -110,21 +103,4 @@ interface XProtectable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:20 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XRefreshListener.idl b/offapi/com/sun/star/util/XRefreshListener.idl index 7b6e26d0bfe3..563faeb790b7 100644 --- a/offapi/com/sun/star/util/XRefreshListener.idl +++ b/offapi/com/sun/star/util/XRefreshListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRefreshListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XRefreshListener /** makes it possible to receive <em>refreshed</em> events. */ interface XRefreshListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XRefreshListener::refreshed /** is called when the object data is refreshed. */ void refreshed( [in] com::sun::star::lang::EventObject rEvent ); @@ -94,21 +91,4 @@ interface XRefreshListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XRefreshable.idl b/offapi/com/sun/star/util/XRefreshable.idl index fe2a4dd21f35..71e8c43a66f0 100644 --- a/offapi/com/sun/star/util/XRefreshable.idl +++ b/offapi/com/sun/star/util/XRefreshable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRefreshable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,25 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XRefreshable /** is supported by objects with data that can be refreshed from a data source. */ interface XRefreshable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XRefreshable::refresh /** refreshes the data of the object from the connected data source. */ void refresh(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XRefreshable::addRefreshListener /** adds the specified listener to receive the event "refreshed." */ [oneway] void addRefreshListener( [in] com::sun::star::util::XRefreshListener l ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XRefreshable::removeRefreshListener /** removes the specified listener. */ [oneway] void removeRefreshListener( [in] com::sun::star::util::XRefreshListener l ); @@ -108,24 +101,4 @@ interface XRefreshable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XReplaceDescriptor.idl b/offapi/com/sun/star/util/XReplaceDescriptor.idl index fbeb3f937d7d..f07abed43044 100644 --- a/offapi/com/sun/star/util/XReplaceDescriptor.idl +++ b/offapi/com/sun/star/util/XReplaceDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XReplaceDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,26 +68,21 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XReplaceDescriptor /** specifies a string replace operation. */ interface XReplaceDescriptor: com::sun::star::util::XSearchDescriptor { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XReplaceDescriptor::getReplaceString /** @returns the string which replaces the found occurrences. */ string getReplaceString(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XReplaceDescriptor::setReplaceString /** sets the string which replaces the found occurrences. */ void setReplaceString( [in] string aReplaceString ); @@ -98,30 +93,4 @@ interface XReplaceDescriptor: com::sun::star::util::XSearchDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:11 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XReplaceable.idl b/offapi/com/sun/star/util/XReplaceable.idl index 87ef123fc7fd..27fd8e177b4b 100644 --- a/offapi/com/sun/star/util/XReplaceable.idl +++ b/offapi/com/sun/star/util/XReplaceable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XReplaceable.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,15 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XReplaceable /** makes it possible to replace strings in a text described by a <type>SearchDescriptor</type>. - - @example <listing> + @example + <listing> 'replace all bold words "search for" by "look for" xReplaceDescr = xDocument.createReplaceDescriptor() xReplaceDescr.SearchString = "search for" @@ -96,16 +95,12 @@ interface XReplaceable: com::sun::star::util::XSearchable { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XReplaceable::createReplaceDescriptor /** creates a descriptor which contains properties that specify a search in this container.@see SearchDescriptor */ com::sun::star::util::XReplaceDescriptor createReplaceDescriptor(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XReplaceable::replaceAll /** searches for all occurrences of whatever is specified.@see SearchDescriptor */ long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc ); @@ -116,27 +111,4 @@ interface XReplaceable: com::sun::star::util::XSearchable }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XSearchDescriptor.idl b/offapi/com/sun/star/util/XSearchDescriptor.idl index ed5e22f70cf1..7a4b7cf07fa5 100644 --- a/offapi/com/sun/star/util/XSearchDescriptor.idl +++ b/offapi/com/sun/star/util/XSearchDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSearchDescriptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,26 +68,21 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XSearchDescriptor /** specifies a string search operation. */ interface XSearchDescriptor: com::sun::star::beans::XPropertySet { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XSearchDescriptor::getSearchString /** @returns the string of characters to search for. */ string getSearchString(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XSearchDescriptor::setSearchString /** sets the string of characters to look for. */ [oneway] void setSearchString( [in] string aString ); @@ -98,27 +93,4 @@ interface XSearchDescriptor: com::sun::star::beans::XPropertySet }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:11 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XSearchable.idl b/offapi/com/sun/star/util/XSearchable.idl index 587581956fb7..ee772e688e9c 100644 --- a/offapi/com/sun/star/util/XSearchable.idl +++ b/offapi/com/sun/star/util/XSearchable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSearchable.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,18 +76,16 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XSearchable -/** enables the object to look for specified contents - of the object (in particular, for a text range which contains a specific - string pattern). +/** enables the object to look for specified contents of the object + (in particular, for a text range which contains a specific string pattern). - - @example in a <type scope="com::sun::star::text">TextDocument</type>: - set all "search for" to bold using findFirst()/findNext(): + @example + in a <type scope="com::sun::star::text">TextDocument</type>: + set all "search for" to bold using findFirst()/findNext(): <listing> xSearchDescr = xDocument.createSearchDescriptor() @@ -119,31 +117,36 @@ interface XSearchable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XSearchable::createSearchDescriptor /** creates a <type>SearchDescriptor</type> which contains properties that specify a search in this container.@see SearchDescriptor */ com::sun::star::util::XSearchDescriptor createSearchDescriptor(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XSearchable::findAll /** searches the contained texts for all occurrences of whatever is specified.@see SearchDescriptor */ com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc ); //------------------------------------------------------------------------- + /** searches the contained texts for the next occurrence of whatever is specified. + + @returns + the position within the component, e.g. a <type scope="com::sun::star::text>XTextRange</type> + which determines the found elements. - // DocMerge from xml: method com::sun::star::util::XSearchable::findFirst - /** searches the contained texts for the next occurrence of whatever is specified.@see SearchDescriptor + @see SearchDescriptor */ com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc ); //------------------------------------------------------------------------- + /** searches the contained texts for the next occurrence of whatever is specified. - // DocMerge from xml: method com::sun::star::util::XSearchable::findNext - /** searches the contained texts for the next occurrence of whatever is specified.@see SearchDescriptor + @param xStartAt + represents a position within the component at which the search continues. + This position is returned by <method>XSearchable::findFirst</method> or + the previous <method>XSearchable::findNext</method>. + + @see SearchDescriptor */ com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt, [in] com::sun::star::util::XSearchDescriptor xDesc ); @@ -154,30 +157,4 @@ interface XSearchable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:46 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 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/util/XSimpleErrorHandler.idl b/offapi/com/sun/star/util/XSimpleErrorHandler.idl index 93e9d34af9c5..b48c72167396 100644 --- a/offapi/com/sun/star/util/XSimpleErrorHandler.idl +++ b/offapi/com/sun/star/util/XSimpleErrorHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleErrorHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,23 +65,18 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= // DOCUMENTATION OMITTED FOR XSimpleErrorHandler - -// DocMerge from xml: interface com::sun::star::util::XSimpleErrorHandler /** @deprecated */ interface XSimpleErrorHandler: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- // DOCUMENTATION OMITTED FOR XSimpleErrorHandler::handleError - - // DocMerge: empty anyway boolean handleError( [in] any Exception ); }; @@ -90,27 +85,4 @@ interface XSimpleErrorHandler: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:11 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XSortable.idl b/offapi/com/sun/star/util/XSortable.idl index 982c914e5d5a..9f1b6e75fb86 100644 --- a/offapi/com/sun/star/util/XSortable.idl +++ b/offapi/com/sun/star/util/XSortable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSortable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,27 +72,21 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XSortable /** makes it possible to sort the contents of this object. */ interface XSortable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::util::XSortable::createSortDescriptor /** @returns - a sequence of arguments which can be used to specify the - search. + a sequence of arguments which can be used to specify the search. */ sequence<com::sun::star::beans::PropertyValue> createSortDescriptor(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XSortable::sort /** sorts the contents of the object according to the specified <type>SortDescriptor</type>. */ @@ -104,27 +98,4 @@ interface XSortable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:11 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XStringAbbreviation.idl b/offapi/com/sun/star/util/XStringAbbreviation.idl index 2c5c8e93ddbf..b2b547cd52d1 100644 --- a/offapi/com/sun/star/util/XStringAbbreviation.idl +++ b/offapi/com/sun/star/util/XStringAbbreviation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStringAbbreviation.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,21 +95,21 @@ interface XStringAbbreviation: com::sun::star::uno::XInterface string's length), or the width in pixel when displayed with a specific font (which <type>XStringWidth</type> would encapsulate).</p> - @param StringWidth + @param xStringWidth The interface that makes concrete the abstract notion of string width. - @param Width + @param nWidth The resulting abbreviated string's width will be no larger than this. - @param String + @param aString The string that is abbreviated. @returns an abbreviated string. */ - string abbreviateString([in] XStringWidth StringWidth, - [in] long Width, - [in] string String); + string abbreviateString([in] XStringWidth xStringWidth, + [in] long nWidth, + [in] string aString); }; }; }; }; }; diff --git a/offapi/com/sun/star/util/XStringEscape.idl b/offapi/com/sun/star/util/XStringEscape.idl index 1c84e0096bc1..988596b17e8e 100644 --- a/offapi/com/sun/star/util/XStringEscape.idl +++ b/offapi/com/sun/star/util/XStringEscape.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStringEscape.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,24 +71,24 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { - -// DocMerge from xml: interface com::sun::star::util::XStringEscape /** This interface is used to encode an arbitrary String into a escaped form. - <p> - The escaped form is chosen to be suitable for use with other interfaces + + <p>The escaped form is chosen to be suitable for use with other interfaces of the object or service providing this interface.</p> - <p> - Any characters or character sequences that are not compatible with + + <p>Any characters or character sequences that are not compatible with any naming rules or restrictions must be replaced by an escaped form, - that complies to these rules.<br> - The transformation should preserve all traits of the string that are + that complies to these rules. + + <p>The transformation should preserve all traits of the string that are generally respected by the service. For example, the case of a string may be lost after encoding and then decoding, if the service - generally is case insensitive.<br> - Other than that the encoding is one-to-one and can be reversed. The + generally is case insensitive. + + <p>Other than that the encoding is one-to-one and can be reversed. The encoding should try to preserve as much as possible of the original string, to keep human-readable input human-friendly where possible. Strings that already conform to the naming conventions should be left @@ -96,16 +96,12 @@ */ interface XStringEscape: com::sun::star::uno::XInterface { - - // DocMerge from xml: method com::sun::star::util::XStringEscape::escapeString - /** Encodes an arbitrary string into an escaped form compatible with some naming rules. + /** encodes an arbitrary string into an escaped form compatible with some naming rules. */ string escapeString([in] string aString) raises( com::sun::star::lang::IllegalArgumentException); - - // DocMerge from xml: method com::sun::star::util::XStringEscape::unescapeString - /** Decodes an escaped string into the original form. + /** decodes an escaped string into the original form. */ string unescapeString([in] string aEscapedString) raises( com::sun::star::lang::IllegalArgumentException); @@ -118,24 +114,4 @@ interface XStringEscape: com::sun::star::uno::XInterface #endif -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.1 2000/08/09 19:09:27 jb - New interface - - -=============================================================================*/ diff --git a/offapi/com/sun/star/util/XStringMapping.idl b/offapi/com/sun/star/util/XStringMapping.idl index 7a668e73a123..b65054005d31 100644 --- a/offapi/com/sun/star/util/XStringMapping.idl +++ b/offapi/com/sun/star/util/XStringMapping.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStringMapping.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,20 +67,17 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XStringMapping /** provides a mapping from <atom>string</atom> to <atom>string</atom> */ interface XStringMapping: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XStringMapping::mapStrings - /** provides a mapping for a given sequence of Strings to - a sequence of belonging Strings. + /** provides a mapping for a given sequence of strings to + a sequence of belonging strings. */ boolean mapStrings( [inout] sequence< string > Parameter ); }; @@ -89,24 +86,4 @@ interface XStringMapping: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:06 mi - documentation merged from XML - - Revision 1.1 2000/07/28 19:19:38 iha - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XStringWidth.idl b/offapi/com/sun/star/util/XStringWidth.idl index b17c86f6fa16..15477522dc08 100644 --- a/offapi/com/sun/star/util/XStringWidth.idl +++ b/offapi/com/sun/star/util/XStringWidth.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStringWidth.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sb $ $Date: 2001-10-08 14:04:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,20 +76,20 @@ module com { module sun { module star { module util { interface XStringWidth: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ - /** Compute the width of a given string. + /** compute the width of a given string. <p>Depending on the implementation of this interface, the width of a string can be rather different things, like the number of characters in the string, or the width in pixel when displayed with a specific font.</p> - @param String + @param aString The string that is to be measured. @returns the string's width. */ - long queryStringWidth([in] string String); + long queryStringWidth([in] string aString); }; }; }; }; }; diff --git a/offapi/com/sun/star/util/XURLTransformer.idl b/offapi/com/sun/star/util/XURLTransformer.idl index 33db6c0b4326..fb97a48207da 100644 --- a/offapi/com/sun/star/util/XURLTransformer.idl +++ b/offapi/com/sun/star/util/XURLTransformer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XURLTransformer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,89 +72,109 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= -// DocMerge from xml: interface com::sun::star::util::XURLTransformer -/** supports parsing and assembling of URLs.@see URL +/** supports parsing and assembling of URLs + + @see URL + @see URLTransformer */ interface XURLTransformer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XURLTransformer::parseStrict - /** parses the string in <member>URL::Complete</member> which must contain + /** parses the string in <member>URL::Complete</member> which should contain a syntactically complete URL. + <p> + The implementation is allowed to correct minor failures in <member>URL::Complete</member> + if the meaning of the URL remain unchanged. Parts of the URL are stored in the other + fields of <var>aURL</var>. + </p> + @param aURL + the URL which include the complete string notation and will contain + all parsed parts of it after finishing this call. <member>URL::Complete</member> + can be overwritten if the implementation corrected minor failures. - <p>Parts of the URL are stored in the other fields of aURL.</p> + @returns + <TRUE/> if parsing was successfully (means if given URL was syntactically correct) + or <FALSE/> otherwhise. */ boolean parseStrict( [inout] com::sun::star::util::URL aURL ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::util::XURLTransformer::parseSmart /** parses the string in <member>URL::Complete</member>, which may contain - a syntactically complete URL or is completed by the specified - protocol. - - - - <p>The parts of the URL are stored in the other fields of aURL.</p> + a syntactically complete URL or is specified by the provided protocol + + <p> + The implementation can use smart functions to correct or interpret + <member>URL::Complete</member> if it is not a syntactically complete URL. + The parts of the URL are stored in the other fields of <var>aURL</var>. + </p> + + @param aURL + the URL which include the string notation and will contain + all parsed parts of it after finishing this call. This includes + <member>URL::Complete</member>. + + @param sSmartProtocol + optional information which protocol specification should be used to parse + member<member>URL::Complete</member>. If empty the implementation can use a + protocol which fit best. + + @returns + <TRUE/> if parsing was successful (means if <member>URL::Complete</member> could + be syntactically correct) or <FALSE/> otherwise. */ - boolean parseSmart( [inout] com::sun::star::util::URL aURL, - [in] string aSmartProt ); + boolean parseSmart( + [inout] com::sun::star::util::URL aURL, + [in] string sSmartProtocol ); //------------------------------------------------------------------------- + /** assembles the parts of the URL specified by <var>aURL</var> and + stores it into <member>URL::Complete</member> + + @param aURL + the URL which contains alls neccessary information in a structured form. The + member <member>URL::Complete</member> contains the URL in string notation after + the operation finished successfully. Otherwise the content of <member>URL::complete</member> + is not defined. - // DocMerge from xml: method com::sun::star::util::XURLTransformer::assemble - /** assembles the parts of the URL specified by aURL and - stores it into <member>URL::Complete</member>. + @returns + <TRUE/> if assembling was successfully or <FALSE/> otherwise. */ boolean assemble( [inout] com::sun::star::util::URL aURL ); //------------------------------------------------------------------------- + /** returns a representation of the URL for UI purposes only - // DocMerge from idl: method com::sun::star::util::XURLTransformer::getPresentation - /** @returns - a presentation of the URL which can be used at the user - interface. - */ - string getPresentation( [in] com::sun::star::util::URL aURL, - [in] boolean bWithPass ); + <p> + Sometimes it can be usefull to show an URL on an user interface + in a more "human readable" form. Such URL can't be used on any API + call, but make it easier for the user to understand it. + </p> + + @param aURL + URL in structured form which should be shown at the UI + + @param bWithPassword + specifies whether the password will be included in the encoding + or not. Usually passwords should never be shown at the user + interface. + @returns + a string representing the <var>aURL</var> if it is syntactically correct. A empty string if <var>aURL</var> + is not syntactically correct. + */ + string getPresentation( + [in] com::sun::star::util::URL aURL, + [in] boolean bWithPassword ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 15:25:12 mi - #70728# missing documentation - - Revision 1.2 2000/01/27 16:13:35 mi - #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/util/XUniqueIDFactory.idl b/offapi/com/sun/star/util/XUniqueIDFactory.idl index 18e1714553df..209c3c8b72de 100644 --- a/offapi/com/sun/star/util/XUniqueIDFactory.idl +++ b/offapi/com/sun/star/util/XUniqueIDFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUniqueIDFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,15 +67,14 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { -// DocMerge from xml: interface com::sun::star::util::XUniqueIDFactory /** creates IDs which are unique within the container. */ interface XUniqueIDFactory: com::sun::star::uno::XInterface { - // DocMerge: empty anyway + /// creates a new ID, unique within this container. string createUniqueID( ); }; @@ -83,21 +82,4 @@ interface XUniqueIDFactory: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:51:45 tlx - DataEditor + UniqIDs - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/util/XUpdatable.idl b/offapi/com/sun/star/util/XUpdatable.idl index 147b9da50448..dc619d361865 100644 --- a/offapi/com/sun/star/util/XUpdatable.idl +++ b/offapi/com/sun/star/util/XUpdatable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUpdatable.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: os $ $Date: 2001-03-23 11:45:13 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module util { +module com { module sun { module star { module util { //============================================================================= /** is supported by objects with data that can be updated from a data source. diff --git a/offapi/com/sun/star/view/DocumentZoomType.idl b/offapi/com/sun/star/view/DocumentZoomType.idl index 65cc38657529..86eda09b40ed 100644 --- a/offapi/com/sun/star/view/DocumentZoomType.idl +++ b/offapi/com/sun/star/view/DocumentZoomType.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentZoomType.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,37 +64,37 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from idl: constants com::sun::star::view::DocumentZoomType -/** These constants describe how the document content is zoomed into the document view. +/** These constants specify how the document content is zoomed into the document view. */ constants DocumentZoomType { //------------------------------------------------------------------------- - /** the page content width (excluding margins) at the current selection fits into the view + /** The page content width (excluding margins) at the current selection is fit into the view. */ const short OPTIMAL = 0; //------------------------------------------------------------------------- - /** the page width at the current selection fits into the view + /** The page width at the current selection is fit into the view. */ const short PAGE_WIDTH = 1; //------------------------------------------------------------------------- - /** a complete page of the document fits into the view + /** A complete page of the document is fit into the view. */ const short ENTIRE_PAGE = 2; //------------------------------------------------------------------------- - /** the zoom is relative and is to be set via the property ZoomValue + /** The zoom is relative and is to be set via the property + <member>ViewSettigns::ZoomValue</member>. */ const short BY_VALUE = 3; //------------------------------------------------------------------------- - /** the page width at the current selection fits into the view. The view ends - exactly at the end of the page. + /** The page width at the current selection is fit into the view, + with zhe view ends exactly at the end of the page. */ const short PAGE_WIDTH_EXACT = 4; }; diff --git a/offapi/com/sun/star/view/OfficeDocumentView.idl b/offapi/com/sun/star/view/OfficeDocumentView.idl index 32df0c897276..e2cd6962a24d 100644 --- a/offapi/com/sun/star/view/OfficeDocumentView.idl +++ b/offapi/com/sun/star/view/OfficeDocumentView.idl @@ -2,9 +2,9 @@ * * $RCSfile: OfficeDocumentView.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-23 10:08:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,34 +76,32 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::OfficeDocumentView -/** specifies a view of a normal office document. +/** specifies a view of a standard office document. */ service OfficeDocumentView { - - - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XSelectionSupplier /** This mandatory interface gives access to the current user selection within this office document view. + + <p>The type of the selection depends on the actual document type.</p> */ interface com::sun::star::view::XSelectionSupplier; - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XViewSettingsSupplier /** This optional interface gives access to the view properties within this - control for an office document. + control for an office document. + + @see ViewSettings */ [optional] interface com::sun::star::view::XViewSettingsSupplier; - // DocMerge from xml: service com::sun::star::view::OfficeDocumentView: interface com::sun::star::view::XControlAccess /** Within this office document view, this optional interface gives - access to the controls which belong to specified control models. + access to the controls which belong to specified control models. */ [optional] interface com::sun::star::view::XControlAccess; @@ -113,21 +111,4 @@ service OfficeDocumentView }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 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/view/PaperFormat.idl b/offapi/com/sun/star/view/PaperFormat.idl index 2193c4c370b7..05baf701244e 100644 --- a/offapi/com/sun/star/view/PaperFormat.idl +++ b/offapi/com/sun/star/view/PaperFormat.idl @@ -2,9 +2,9 @@ * * $RCSfile: PaperFormat.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,84 +64,56 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: enum com::sun::star::view::PaperFormat /** specifies the format (size) of the paper on a text document. */ enum PaperFormat { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A3, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A3 - /** Specify the paper format to A3. + /** specifies the paper format as A3. */ A3, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A4, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A4 - /** Specify the paper format to A4. + /** specifies the paper format as A4. */ A4, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: A5, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::A5 - /** Specify the paper format to A5. + /** specifies the paper format as A5. */ A5, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: B4, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::B4 - /** Specify the paper format to B4. + /** specifies the paper format as B4. */ B4, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: B5, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::B5 - /** Specify the paper format to B5. + /** specifies the paper format as B5. */ B5, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: LETTER, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::LETTER - /** Specify the paper format to Letter. + /** specifies the paper format as Letter. */ LETTER, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: LEGAL, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::LEGAL - /** Specify the paper format to Legal. + /** specifies the paper format as Legal. */ LEGAL, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: TABLOID, - - // DocMerge from xml: value com::sun::star::view::PaperFormat::TABLOID - /** Specify the paper format to Tabloid. + /** specifies the paper format as Tabloid. */ TABLOID, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperFormat:: USER - - // DocMerge from xml: value com::sun::star::view::PaperFormat::USER - /** Specify the real paper size in 100th mm. + /** The real paper size is user defined in 100th mm. */ USER @@ -151,24 +123,4 @@ enum PaperFormat }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:05 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/view/PaperOrientation.idl b/offapi/com/sun/star/view/PaperOrientation.idl index 34a8a68696ef..81f0000fe094 100644 --- a/offapi/com/sun/star/view/PaperOrientation.idl +++ b/offapi/com/sun/star/view/PaperOrientation.idl @@ -2,9 +2,9 @@ * * $RCSfile: PaperOrientation.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,28 +64,21 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: enum com::sun::star::view::PaperOrientation /** specifies the orientation of the paper. */ enum PaperOrientation { //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperOrientation:: PORTRAIT, - - // DocMerge from xml: value com::sun::star::view::PaperOrientation::PORTRAIT - /** set the paper orientation to Portrait. + /** set the paper orientation to portrait. */ PORTRAIT, //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR PaperOrientation:: LANDSCAPE - - // DocMerge from xml: value com::sun::star::view::PaperOrientation::LANDSCAPE - /** set the paper orientation to Landscape. + /** set the paper orientation to landscape. */ LANDSCAPE @@ -95,24 +88,4 @@ enum PaperOrientation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 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/view/PrintOptions.idl b/offapi/com/sun/star/view/PrintOptions.idl index 4086bb824f34..3950d661e0db 100644 --- a/offapi/com/sun/star/view/PrintOptions.idl +++ b/offapi/com/sun/star/view/PrintOptions.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintOptions.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,47 +64,42 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrintOptions /** describes the options for print jobs. + + <p>These options are only valid for a single print job. They do not + change layout or formatting of the document. */ service PrintOptions { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::CopyCount /** specifies the number of copies to print. */ [property] short CopyCount; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::FileName /** if set, specifies the name of a file to print to. */ [property] string FileName; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Collate /** advises the printer to collate the pages of the copies. */ [property] boolean Collate; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Sort /** advises the printer to sort the pages of the copies. */ [property] boolean Sort; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintOptions::Pages /** specifies which pages to print. + + <p>This range is given as at the user interface. For example: "1-4;10" + to print the pages 1 to 4 and 10. </p> */ [property] string Pages; @@ -114,24 +109,4 @@ service PrintOptions }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 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/view/PrintSettings.idl b/offapi/com/sun/star/view/PrintSettings.idl index 76692d20b1cf..5df8b7674610 100644 --- a/offapi/com/sun/star/view/PrintSettings.idl +++ b/offapi/com/sun/star/view/PrintSettings.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintSettings.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:53:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,98 +64,75 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrintSettings /** provides access to the settings for printing documents. + + <p>These settings are printer independet but affect the rendering of + the document. */ service PrintSettings { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintBlackFonts /** If <TRUE/>, all characters are printed in black. - - <p>It is useful for printing colored text on a b/w printer.</p> */ [property] boolean PrintBlackFonts; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintControls /** If <TRUE/>, control shapes are included in printing. */ [property] boolean PrintControls; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintDrawings /** If <TRUE/>, drawing objects (shapes) are included in printing. */ [property] boolean PrintDrawings; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintGraphics /** If <TRUE/>, graphic objects are included in printing. */ [property] boolean PrintGraphics; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintLeftPages /** If <TRUE/>, left pages are included in printing. */ [property] boolean PrintLeftPages; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintRightPages /** If <TRUE/>, right pages are included in printing. */ [property] boolean PrintRightPages; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintTables /** If <TRUE/>, tables are included in printing. */ [property] boolean PrintTables; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintReversed /** If <TRUE/>, the pages are printed in reverse order. - - <p>The last page is printed first.</p> */ [property] boolean PrintReversed; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintProspect /** If <TRUE/>, the pages are printed in the order of prospects. */ [property] boolean PrintProspect; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintPageBackground /** If <TRUE/>, the background of the page is printed. */ [property] boolean PrintPageBackground; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrintSettings::PrintAnnotationMode /** determines how annotations are printed. - (enum NotePrintMode) + + @see NotePrintMode */ [property] short PrintAnnotationMode; @@ -165,24 +142,4 @@ service PrintSettings }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:24 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/PrintableState.idl b/offapi/com/sun/star/view/PrintableState.idl index 758626d484bb..a6e7998403a0 100644 --- a/offapi/com/sun/star/view/PrintableState.idl +++ b/offapi/com/sun/star/view/PrintableState.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintableState.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,36 +64,43 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -/** specifies the print progress of an <type>XPrintable</type> +/** specifies the print progress of an <type>XPrintable</type>. - <p>printing consists of two abstract phases: collecting the raw - data to send to the printer and then sending them (spooling). + <p>Printing consists of two abstract phases: rendering the document + for the printer and then sending it to the printer (spooling). <type>PrintableState</type> describes which phase is currently progressing or has failed.</p> + + @see PrintableStateEvent */ enum PrintableState { - /** printing (that is, collecting the data to send to the printer) has begun + /** printing (rendering the document) has begun */ JOB_STARTED, - /** printing has finished, spooling has begun + + /** printing (rendering the document) has finished, spooling has begun */ JOB_COMPLETED, + /** spooling has finished successfully. This is the only state that can be considered as "success" for a print job. */ JOB_SPOOLED, - /** printing was aborted (e.g., by the user) while either printing or spooling + + /** printing was aborted (e.g., by the user) while either printing or spooling. */ JOB_ABORTED, - /** printing ran into an error + + /** printing ran into an error. */ JOB_FAILED, - /** the document could be printed but not spooled + + /** the document could be printed but not spooled. */ JOB_SPOOLING_FAILED }; diff --git a/offapi/com/sun/star/view/PrintableStateEvent.idl b/offapi/com/sun/star/view/PrintableStateEvent.idl index 78483f3bf3af..17eda2b39f8b 100644 --- a/offapi/com/sun/star/view/PrintableStateEvent.idl +++ b/offapi/com/sun/star/view/PrintableStateEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrintableStateEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,19 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -/** specifies the print progress of an <type>XPrintable</type> +/** specifies the print progress of an <type>XPrintable</type>. + + <p><member scope="com::sun::star::lang">EventObject::Source</member> + contains the <type>XPrintable</type> having changed its state</p>. - <p> - <ul> - <li><member scope="com::sun::star::lang">EventObject::Source</member> - contains the <type>XPrintable</type> having changed its state</li> - <li><member scope="com::sun::star::view">PrintableStateEvent</member> - contains the new state</li> - </ul> - </p> */ struct PrintableStateEvent : com::sun::star::lang::EventObject { + /// contains the current state. PrintableState State; }; diff --git a/offapi/com/sun/star/view/PrinterDescriptor.idl b/offapi/com/sun/star/view/PrinterDescriptor.idl index 256bccb63123..1ec778043348 100644 --- a/offapi/com/sun/star/view/PrinterDescriptor.idl +++ b/offapi/com/sun/star/view/PrinterDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: PrinterDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,13 +76,11 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: service com::sun::star::view::PrinterDescriptor -/** describes a printer by specifying the queue name and - some settings. +/** describes a printer by specifying the queue name and some settings. <p>This service may be represented by a <type dim="[]">PropertyValue</type>. @@ -91,67 +89,56 @@ service PrinterDescriptor { //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::Name /** specifies the name of the printer queue to be used. + + <p>Which printer queues are available, can be figured out with the + system library of the used programming language/environment. */ [property] string Name; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperOrientation /** specifies the orientation of the paper. */ [property] com::sun::star::view::PaperOrientation PaperOrientation; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperFormat /** specifies a predefined paper size or if the paper size is a user-defined size. - - - <p>Setting this property may change the value of "PaperSize".</p> + <p>Setting this property may change the value of + <member>PrinterDescriptor</member>PaperSize</member.</p> */ [property] com::sun::star::view::PaperFormat PaperFormat; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::PaperSize /** specifies the size of the paper in 100th mm. - - - <p>Setting this property may change the value of "PaperFormat".</p> + <p>Setting this property may change the value of + <member>PrinterDescriptor</member>PaperFormat</member.</p> */ [property] com::sun::star::awt::Size PaperSize; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::IsBusy - /** indicates if the printer is busy. + /** indicates, whether the printer is busy or not. */ [readonly, property] boolean IsBusy; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperOrientation - /** indicates if the printer allows changes to PaperOrientation. + /** indicates, whether the printer allows changes to + <member>PrinterDescriptor::PaperOrientation</member>. */ [readonly, property] boolean CanSetPaperOrientation; //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperFormat - /** indicates if the printer allows changes to PaperFormat. + /** indicates, whether the printer allows changes to + <member>PrinterDescriptor::PaperFormat</member>. */ [readonly, property] boolean CanSetPaperFormat; //------------------------------------------------------------------------- - // DocMerge from xml: property com::sun::star::view::PrinterDescriptor::CanSetPaperSize - /** indicates if the printer allows changes to PaperSize. + /** indicates if the printer allows changes to + <member>PrinterDescriptor::PaperSize</member>. */ [readonly, property] boolean CanSetPaperSize; @@ -161,33 +148,4 @@ service PrinterDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/02/21 16:18:17 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:06 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/view/ViewSettings.idl b/offapi/com/sun/star/view/ViewSettings.idl new file mode 100644 index 000000000000..b7de3eb67054 --- /dev/null +++ b/offapi/com/sun/star/view/ViewSettings.idl @@ -0,0 +1,110 @@ +/************************************************************************* + * + * $RCSfile: ViewSettings.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ + * + * 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_view_ViewSettings_idl__ +#define __com_sun_star_view_ViewSettings_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module view { + +//============================================================================= + +/** provides access to the settings of the controller of an office document. + */ +service ViewSettings +{ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the horizontal ruler is displayed. + */ + [optional, property] boolean ShowHoriRuler; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the horizontal scroll bar is displayed. + */ + [optional, property] boolean ShowHoriScrollBar; + + //------------------------------------------------------------------------- + /** specfifies the zoom-value in percent. + */ + [optional, property] short ZoomValue; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the vertical ruler is displayed. + */ + [optional, property] boolean ShowVertRuler; + + //------------------------------------------------------------------------- + /** If this property is <TRUE/>, the vertical scroll bar is displayed. + */ + [optional, property] boolean ShowVertScrollBar; +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/view/XControlAccess.idl b/offapi/com/sun/star/view/XControlAccess.idl index fc19a8d30fcf..2feea22e61f9 100644 --- a/offapi/com/sun/star/view/XControlAccess.idl +++ b/offapi/com/sun/star/view/XControlAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XControlAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,19 +80,18 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XControlAccess -/** provides access to the controls in a view.@see com::sun::star::frame::XController +/** provides access to the controls in a view. + + @see com::sun::star::frame::XController */ interface XControlAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XControlAccess::getControl - /** is called to get the control from a control model. + /** is called to get the control from the specified control model. */ com::sun::star::awt::XControl getControl( [in] com::sun::star::awt::XControlModel xModel ) raises( com::sun::star::container::NoSuchElementException ); @@ -103,24 +102,4 @@ interface XControlAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 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/view/XLineCursor.idl b/offapi/com/sun/star/view/XLineCursor.idl index 2b40a6add79f..206b130ebf67 100644 --- a/offapi/com/sun/star/view/XLineCursor.idl +++ b/offapi/com/sun/star/view/XLineCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLineCursor.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,44 +68,43 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XLineCursor -/** makes it possible to move a cursor to the start or end of laid out text.@see com::sun::star::sheet::CellCursor - @see com::sun::star::text::TextCursor - @see com::sun::star::view::ViewCursor +/** makes it possible to move a cursor by lines within laid out text. + + @see com::sun::star::sheet::CellCursor + @see com::sun::star::text::TextCursor + @see com::sun::star::view::ViewCursor */ interface XLineCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::isAtStartOfLine /** determines if the cursor is positioned at the start of a line. */ boolean isAtStartOfLine(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::isAtEndOfLine /** determines if the cursor is positioned at the end of a line. */ boolean isAtEndOfLine(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::gotoEndOfLine /** moves the cursor to the end of the current line. + + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). */ void gotoEndOfLine( [in] boolean bExpand ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XLineCursor::gotoStartOfLine /** moves the cursor to the start of the current line. - @see XLineCursor::gotoPreviousOfPara + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). */ void gotoStartOfLine( [in] boolean bExpand ); @@ -115,30 +114,4 @@ interface XLineCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/19 16:04:00 mi - documentations syntax errors fixed - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 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/view/XPrintSettingsSupplier.idl b/offapi/com/sun/star/view/XPrintSettingsSupplier.idl index 5501151319eb..d99dd39c159e 100644 --- a/offapi/com/sun/star/view/XPrintSettingsSupplier.idl +++ b/offapi/com/sun/star/view/XPrintSettingsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintSettingsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,22 +72,21 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XPrintSettingsSupplier -/** offers printing related settings. +/** offers printing related settings, which affect document rendering, + but are not related to the printer itself. */ interface XPrintSettingsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::view::XPrintSettingsSupplier::getPrintSettings /** @returns - a set of properties which are related to printing. + a set of properties which are related to printing. - @see PrintSettings + @see PrintSettings */ com::sun::star::beans::XPropertySet getPrintSettings(); @@ -97,27 +96,4 @@ interface XPrintSettingsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:21 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XPrintable.idl b/offapi/com/sun/star/view/XPrintable.idl index b6baac3a3fa9..474cd1500a83 100644 --- a/offapi/com/sun/star/view/XPrintable.idl +++ b/offapi/com/sun/star/view/XPrintable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintable.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,33 +76,28 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XPrintable -/** represents something that can be printed. +/** offers printing functionality. */ interface XPrintable: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::view::XPrintable::getPrinter /** @returns a descriptor of the current printer. - <p>The parameters of the current printer are used for formatting. + <p>The attributes of the current printer are used for formatting. @see PrinterDescriptor */ sequence<com::sun::star::beans::PropertyValue> getPrinter(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XPrintable::setPrinter /** assigns a new printer to the object. - <p>The sequence is a <type>PrinterDescriptor</type>. </p> + <p>Setting a new printer will cause reformatting. @see PrinterDescriptor */ @@ -110,10 +105,12 @@ interface XPrintable: com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XPrintable::print /** prints the object. + @param xOptions + specifies the number of copies and some other values which do not + affect formatting. + @see PrintOptions */ void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions ) @@ -125,30 +122,4 @@ interface XPrintable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.5 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.3 2000/03/09 16:58:22 mi - #70728# missing documentation - - Revision 1.2 2000/02/07 11:25:06 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/view/XPrintableBroadcaster.idl b/offapi/com/sun/star/view/XPrintableBroadcaster.idl index c6703a158242..2b8cb345289b 100644 --- a/offapi/com/sun/star/view/XPrintableBroadcaster.idl +++ b/offapi/com/sun/star/view/XPrintableBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintableBroadcaster.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,23 +71,24 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { -/** allows for getting information about a print job +//----------------------------------------------------------------------------- +/** allows for getting information about a print job. - <p><type>XPrintableBroadcaster</type> can be implemented by classes by - implementing <type>XPrintable</type>. It allows for <type>XPrintableListener</type> - to be set, so a user can be informed about the print progress.</p> + <p><type>XPrintableBroadcaster</type> can be implemented by classes which + implement <type>XPrintable</type>. It allows a <type>XPrintableListener</type> + to be registered, thus a client object will learn about the print progress.</p> @see XPrintableListener */ interface XPrintableBroadcaster : com::sun::star::uno::XInterface { - /** adds an <type>XPrintableListener</type> to be informed about print progress + /** adds an <type>XPrintableListener</type> to be notified about print progress. */ [oneway] void addPrintableListener( [in] XPrintableListener xListener ); - /** removes an <type>XPrintableListener</type> + /** removes an <type>XPrintableListener</type>. */ [oneway] void removePrintableListener( [in] XPrintableListener xListener ); }; diff --git a/offapi/com/sun/star/view/XPrintableListener.idl b/offapi/com/sun/star/view/XPrintableListener.idl index 2e078cf4c54a..e234a8249368 100644 --- a/offapi/com/sun/star/view/XPrintableListener.idl +++ b/offapi/com/sun/star/view/XPrintableListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPrintableListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,23 +75,22 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { -/** allows for getting information about a print job. +/** receives events about print job progress. - <p><type>XPrintableListener</type> can be registered to - <type>XPrintableBroadcaster</type>. Then, the user will be informed about - print progress. - </p> + <p><type>XPrintableListener</type> can be registered to <type>XPrintableBroadcaster</type>. + Then, the client object will receive events about print progress. </p> @see XPrintableBroadcaster */ - interface XPrintableListener : com::sun::star::lang::XEventListener +interface XPrintableListener : com::sun::star::lang::XEventListener { - /** informs the user of the new state in print progress + //-------------------------------------------------------------------------- + /** informs the user of the new state in print progress. @param Event - contains the <type>XPrintable</type> having changed state and the new state + contains the <type>XPrintable</type> having changed state and the new state. */ [oneway] void stateChanged( [in] PrintableStateEvent Event ); }; diff --git a/offapi/com/sun/star/view/XScreenCursor.idl b/offapi/com/sun/star/view/XScreenCursor.idl index 88df5a407ddf..949a8b39372b 100644 --- a/offapi/com/sun/star/view/XScreenCursor.idl +++ b/offapi/com/sun/star/view/XScreenCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScreenCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,25 +68,20 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XScreenCursor -/** enables the object to leaf through steps of the displayed size. +/** makes it possible to page through the document in steps of the displayed size. */ interface XScreenCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XScreenCursor::screenDown /** scrolls the view forward by one visible page. */ boolean screenDown(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XScreenCursor::screenUp /** scrolls the view backward by one visible page. */ boolean screenUp(); @@ -97,24 +92,4 @@ interface XScreenCursor: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2001/03/16 16:41:53 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XSelectionChangeListener.idl b/offapi/com/sun/star/view/XSelectionChangeListener.idl index b6f4300212f1..0ffc82c20187 100644 --- a/offapi/com/sun/star/view/XSelectionChangeListener.idl +++ b/offapi/com/sun/star/view/XSelectionChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSelectionChangeListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,19 +72,23 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XSelectionChangeListener -/** makes it possible to receive an event when the selection changes.@see com::sun::star::sheet::SpreadsheetViewPane +/** makes it possible to receive an event when the current selection changes. + + @see com::sun::star::view::XSelectionSupplier */ interface XSelectionChangeListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::view::XSelectionChangeListener::selectionChanged /** is called when the selection changes. + + <p>You can get the new selection via <type>XSelectionSupplier</type> from + <member scope="com::sun::star::lang">EventObject::Source</member>. + */ [oneway] void selectionChanged( [in] com::sun::star::lang::EventObject aEvent ); @@ -94,27 +98,4 @@ interface XSelectionChangeListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XSelectionSupplier.idl b/offapi/com/sun/star/view/XSelectionSupplier.idl index d1d6f17544af..b6098b570e17 100644 --- a/offapi/com/sun/star/view/XSelectionSupplier.idl +++ b/offapi/com/sun/star/view/XSelectionSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSelectionSupplier.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:43:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,46 +76,39 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XSelectionSupplier -/** makes it possible to access and change the selection in a view.@see OfficeDocumentView +/** makes it possible to access and change the selection in a view. + + @see OfficeDocumentView */ interface XSelectionSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::select - /** selects the object represented by <var>aInterface</var> if it is - known and selectable in this interface. + /** selects the object represented by <var>xSelection</var> if it is + known and selectable in this object. */ - boolean select( [in] any aSelection ) + boolean select( [in] any xSelection ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::view::XSelectionSupplier::getSelection /** @returns the current selection. - <p>The selection is either specified by an object which is contained - in the component to which the view belongs, or it is an interface of a - collection which contains such objects. + <p>The selection is either specified by an object which is contained + in the component to which the view belongs, or it is an interface of a + collection which contains such objects. */ any getSelection(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::addSelectionChangeListener /** registers an event listener, which is called when the selection changes. */ void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XSelectionSupplier::removeSelectionChangeListener /** unregisters an event listener which was registered with <method>XSelectionSupplier::addSelectionChangeListener</method>. */ @@ -127,33 +120,4 @@ interface XSelectionSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/04/06 12:23:39 mi - com::sun::star::package finally removed - now in com::sun::star::packages (with 's' at the end, due to conflict with reserved identifier in Java) - - Revision 1.5 2001/03/16 16:41:53 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 1999/11/25 16:03:33 mi - welforming HTML for XML - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XViewCursor.idl b/offapi/com/sun/star/view/XViewCursor.idl index c9ad2ea8cbd5..ddd533dc987d 100644 --- a/offapi/com/sun/star/view/XViewCursor.idl +++ b/offapi/com/sun/star/view/XViewCursor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewCursor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,11 +68,10 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XViewCursor /** makes it possible to move a cursor up/down/left/right within laid out text. @see com::sun::star::sheet::CellCursor @@ -82,64 +81,70 @@ interface XViewCursor: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::view::XViewCursor::goDown /** moves the cursor the specified number of lines down. - */ - boolean goDown( [in] short nCount, - [in] boolean bExpand ); - //------------------------------------------------------------------------- + @param nCount + specifies the number of lines to go down. - // DocMerge from xml: method com::sun::star::view::XViewCursor::goUp - /** moves the cursor the specified number of lines up. + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) + or the cursor will be just at the new position after the move (<FALSE/>). + + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the bottom row. */ - boolean goUp( [in] short nCount, - [in] boolean bExpand ); + boolean goDown( [in] short nCount, [in] boolean bExpand ); //------------------------------------------------------------------------- + /** moves the cursor the specified number of lines up. - // DocMerge from xml: method com::sun::star::view::XViewCursor::goLeft - /** moves the cursor the specified number of characters to the left. - */ - boolean goLeft( [in] short nCount, - [in] boolean bExpand ); + @param nCount + specifies the number of lines to go up. - //------------------------------------------------------------------------- + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) - // DocMerge from xml: method com::sun::star::view::XViewCursor::goRight - /** moves the cursor the specified number of characters to the right. + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already in the top row. */ - boolean goRight( [in] short nCount, - [in] boolean bExpand ); + boolean goUp( [in] short nCount, [in] boolean bExpand ); -}; + //------------------------------------------------------------------------- + /** moves the cursor the specified number of characters to the left. -//============================================================================= + @param nCount + specifies the number of characters to move. -}; }; }; }; + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) -/*============================================================================= + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the leftmost position. + */ + boolean goLeft( [in] short nCount, [in] boolean bExpand ); - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:28 mi - @see interface/service/... ident -> @see ident - for new docu generator + //------------------------------------------------------------------------- + /** moves the cursor the specified number of characters to the right. - Revision 1.3 2000/11/08 12:45:34 mi - moved from api + @param nCount + specifies the number of characters to move. - Revision 1.2 2000/10/09 14:25:03 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) + @param bExpand + determines whether the text range of the cursor is expanded (<TRUE/>) - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import + @returns + <TRUE/> if the cursor was moved, + or <FALSE/> if it was already at the rightmost position. + */ + boolean goRight( [in] short nCount, [in] boolean bExpand ); - Revision 1.3 2000/09/11 11:53:07 mi - documentation merged from XML +}; - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new +//============================================================================= +}; }; }; }; -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/view/XViewSettingsSupplier.idl b/offapi/com/sun/star/view/XViewSettingsSupplier.idl index 27d0b937fe53..9dcf19735f3f 100644 --- a/offapi/com/sun/star/view/XViewSettingsSupplier.idl +++ b/offapi/com/sun/star/view/XViewSettingsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XViewSettingsSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:14 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,20 +72,20 @@ //============================================================================= - module com { module sun { module star { module view { +module com { module sun { module star { module view { //============================================================================= -// DocMerge from xml: interface com::sun::star::view::XViewSettingsSupplier /** provides access to the view settings of the object. */ interface XViewSettingsSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::view::XViewSettingsSupplier::getViewSettings /** @returns - an interface to the <type scope="com::sun::star::text">ViewSettings</type>. + an interface to the <type>ViewSettings</type>. + + <p>Subclasses might be returned instead, offering more settings. </p> */ com::sun::star::beans::XPropertySet getViewSettings(); @@ -95,24 +95,4 @@ interface XViewSettingsSupplier: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:34 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:07 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/AttributeContainer.idl b/offapi/com/sun/star/xml/AttributeContainer.idl index 7c18f8b78ceb..7f29915cc320 100644 --- a/offapi/com/sun/star/xml/AttributeContainer.idl +++ b/offapi/com/sun/star/xml/AttributeContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: AttributeContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:45:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,12 +70,13 @@ module com { module sun { module star { module xml { //============================================================================= -/** This service describes a container for xml attributes. Each attribute is - accessed with its local name, or optionally, its local name with its namespace - prefix. The type and value of an attribute is stored in a - <code>AttributeData</code> struct. If you use a namespace in the <code> - AttributeData</code>, you must use a prefix in the name and you must use a - namespace, if you use a prefix. +/** This service describes a container for xml attributes. + + <p>Each attribute is accessed with its local name, or optionally, its local + name with its namespace prefix. The type and value of an attribute is stored + in a <code>AttributeData</code> struct. If you use a namespace in the + <code>AttributeData</code>, you must use a prefix in the name and you must + use a namespace, if you use a prefix. */ service AttributeContainer { diff --git a/offapi/com/sun/star/xml/AttributeData.idl b/offapi/com/sun/star/xml/AttributeData.idl index cacbf230f51f..52ca9fc2d93f 100644 --- a/offapi/com/sun/star/xml/AttributeData.idl +++ b/offapi/com/sun/star/xml/AttributeData.idl @@ -2,9 +2,9 @@ * * $RCSfile: AttributeData.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:41 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,27 +68,25 @@ //============================================================================= -// DocMerge from xml: struct com::sun::star::xml::AttributeData /** store the type and value of an XML attribute inside a XNameContainer */ struct AttributeData { - // DocMerge from xml: field com::sun::star::xml::AttributeData::Namespace - /** the namespace of this XML attribute, This string can be empty if you are - not using namespaces + /** the namespace of this XML attribute. + + <p>This string can be empty if you are not using namespaces. */ string Namespace; - // DocMerge from xml: field com::sun::star::xml::AttributeData::Type - /** the type of this XML attribute. For non validating parsers this must - be CDATA + /** the type of this XML attribute. + + <p>For non validating parsers this must be CDATA. */ string Type; - // DocMerge from xml: field com::sun::star::xml::AttributeData::Value /** the string value of this XML attribute. */ string Value; @@ -98,22 +96,4 @@ struct AttributeData }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/01/26 14:49:33 cl - #70258# AttributeData now also contains the namespace - - Revision 1.1 2000/01/21 15:53:02 cl - #70258# added Interfaces/Services for xml container item - - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/NamespaceContainer.idl b/offapi/com/sun/star/xml/NamespaceContainer.idl index b5c7c2f2eb0b..69da63c078c0 100644 --- a/offapi/com/sun/star/xml/NamespaceContainer.idl +++ b/offapi/com/sun/star/xml/NamespaceContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamespaceContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:45:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,8 +70,9 @@ module com { module sun { module star { module xml { //============================================================================= -/** This service describes a container for XML namespaces. Each namespace is - accessed with its prefix and the URL is stored as a string. +/** This service describes a container for XML namespaces. + + <p>Each namespace is accessed with its prefix and the URL is stored as a string. */ service NamespaceContainer { diff --git a/offapi/com/sun/star/xml/XMLExportFilter.idl b/offapi/com/sun/star/xml/XMLExportFilter.idl index 8f22ed95e07a..58d7d5ca5dde 100644 --- a/offapi/com/sun/star/xml/XMLExportFilter.idl +++ b/offapi/com/sun/star/xml/XMLExportFilter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMLExportFilter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:45:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,16 +72,17 @@ module com { module sun { module star { module xml { //============================================================================= -/** describes an export filter for XML-based file formats. It is an - extension of <type scope="com::sun::star::document">ExportFilter</type> and differs - from it only in that an +/** describes an export filter for XML-based file formats. + + <p>It is an extension of <type scope="com::sun::star::document">ExportFilter</type> + and differs from it only in that an <type scope="com::sun::star::xml::sax">XDocumentHandler</type> needs to be passed through the XInitialization interface. This XDocumentHandler will then be used to export the XML data stream. */ service XMLExportFilter { /** An com.sun.star.xml.sax.XDocumentHandler needs to be passed to - the XInitialization::initialize() call. + the <method scope="com::sun::star::lang">XInitialization::initialize</method> call. */ service com::sun::star::document::ExportFilter; }; diff --git a/offapi/com/sun/star/xml/XMLImportFilter.idl b/offapi/com/sun/star/xml/XMLImportFilter.idl index 8d0af2266a25..0dd204ce7d68 100644 --- a/offapi/com/sun/star/xml/XMLImportFilter.idl +++ b/offapi/com/sun/star/xml/XMLImportFilter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMLImportFilter.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:45:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,9 +76,10 @@ module com { module sun { module star { module xml { //============================================================================= -/** describes an import filter for XML-based file formats. It is an - extension of <type scope="com::sun::star::document">ImportFilter</type> and differs - from it in that this filter additionally supports the +/** describes an import filter for XML-based file formats. + + <p>It is an extension of <type scope="com::sun::star::document">ImportFilter</type> + and differs from it in that this filter additionally supports the <type scope="com::sun::star::xml::sax">XDocumentHandler</type> interface. */ service XMLImportFilter diff --git a/offapi/com/sun/star/xml/sax/InputSource.idl b/offapi/com/sun/star/xml/sax/InputSource.idl index 6046a2ea4579..fa5314b3297c 100644 --- a/offapi/com/sun/star/xml/sax/InputSource.idl +++ b/offapi/com/sun/star/xml/sax/InputSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: InputSource.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,50 +68,32 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: struct com::sun::star::xml::sax::InputSource /** specifies the Datasource plus some additional information for the parser. - - <p>There are two places where the application will deliver this input source to the parser: </p> <ul> - <li>as the argument of - - - - - - </li> - <li>as the return value of - - - - - . + <li>as the argument of <method>XParser::parseStream</method></li> + <li>as the return value of <method>XEntityReslover::resolveEntity</method>. </li> </ul> */ struct InputSource { - // DocMerge from xml: field com::sun::star::xml::sax::InputSource::aInputStream /** contains the byte input stream of the document. */ com::sun::star::io::XInputStream aInputStream; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::InputSource::sEncoding /** contains the encoding of the data stream. This is used by the parser to do unicode conversions. - - <p>Note that in general you do not need to specify an encoding. Either it is UTF-8 or UTF-16 which is recognized by the parser or it is specified in the first line of the XML-File @@ -121,7 +103,6 @@ struct InputSource //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::InputSource::sPublicId /** constains the public Id of the document, for example, needed in exception-message strings. */ @@ -129,7 +110,6 @@ struct InputSource //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::InputSource::sSystemId /** contains the sytemID of the document. */ string sSystemId; @@ -139,27 +119,4 @@ struct InputSource }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.6 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.4 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.3 2000/02/21 16:18:17 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/SAXException.idl b/offapi/com/sun/star/xml/sax/SAXException.idl index 8bf835f649b8..e3d2e53f40e1 100644 --- a/offapi/com/sun/star/xml/sax/SAXException.idl +++ b/offapi/com/sun/star/xml/sax/SAXException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SAXException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,30 +68,26 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: exception com::sun::star::xml::sax::SAXException /** encapsulates the details of an XML parse error or warning. - - <p>This structure is a replacement for the Java class - <em>org.xml.sax.SAXException</em>. - - Some abbreviations : <br> + <em>org.xml.sax.SAXException</em>. </p> - SAX = Simple API for XML <br> - URI = Uniform Resource Identifier <br> - DTD = document type definition <br> </p> + <p>Some abbreviations: </p> + <ul> + <li>SAX = Simple API for XML </li> + <li>URI = Uniform Resource Identifier </li> + <li>DTD = document type definition </li> */ exception SAXException: com::sun::star::uno::Exception { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::SAXException::WrappedException - /** This field may contain a wrapped exception + /** This field may contain a wrapped exception. */ any WrappedException; @@ -101,21 +97,4 @@ exception SAXException: com::sun::star::uno::Exception }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl b/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl index 9f925ec6302d..bfa33ab1aa9d 100644 --- a/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl +++ b/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SAXInvalidCharacterException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sab $ $Date: 2001-11-26 09:24:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,13 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: exception com::sun::star::xml::sax::SAXParseException -/** stores information for locating the error in the original XML document.@see XLocater +/** stores information for locating the error in the original XML document. + + @see XLocater */ exception SAXInvalidCharacterException: com::sun::star::xml::sax::SAXException { @@ -84,30 +85,4 @@ exception SAXInvalidCharacterException: com::sun::star::xml::sax::SAXException }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.6 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.4 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.3 2000/02/21 16:18:17 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/SAXParseException.idl b/offapi/com/sun/star/xml/sax/SAXParseException.idl index 38580e4c7789..756b228d7363 100644 --- a/offapi/com/sun/star/xml/sax/SAXParseException.idl +++ b/offapi/com/sun/star/xml/sax/SAXParseException.idl @@ -2,9 +2,9 @@ * * $RCSfile: SAXParseException.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:45:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,18 +68,18 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: exception com::sun::star::xml::sax::SAXParseException -/** stores information for locating the error in the original XML document.@see XLocater +/** stores information for locating the error in the original XML document. + + @see XLocater */ exception SAXParseException: com::sun::star::xml::sax::SAXException { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::SAXParseException::PublicId /** contains the public identifier of the document where the exception has occurred. */ @@ -87,21 +87,18 @@ exception SAXParseException: com::sun::star::xml::sax::SAXException //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::SAXParseException::SystemId /** contains the system identifier of the document. */ string SystemId; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::SAXParseException::LineNumber /** contains the line number in the document. */ long LineNumber; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::xml::sax::SAXParseException::ColumnNumber /** contains the column number in the document. */ long ColumnNumber; @@ -112,27 +109,4 @@ exception SAXParseException: com::sun::star::xml::sax::SAXException }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.6 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.4 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.3 2000/02/21 16:18:17 mi - string documentation from stardiv...*.idl-files - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XAttributeList.idl b/offapi/com/sun/star/xml/sax/XAttributeList.idl index fb2734a5a939..abafe7a9aca9 100644 --- a/offapi/com/sun/star/xml/sax/XAttributeList.idl +++ b/offapi/com/sun/star/xml/sax/XAttributeList.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAttributeList.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,18 +65,14 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XAttributeList /** specifies an element's attributes. - - <p>This interface describes a name-type-value triple which describes a single attribute of a tag. Implementors are encouraged to implement the <type scope="com::sun::star::util">XCloneable</type> interface also to @@ -90,7 +86,6 @@ interface XAttributeList: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getLength /** @returns the number of attributes in this list. */ @@ -98,7 +93,6 @@ interface XAttributeList: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getNameByIndex /** @returns the name of an attribute in this list (by position). */ @@ -106,7 +100,6 @@ interface XAttributeList: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getTypeByIndex /** @returns the type of an attribute in the list (by position). Non-validating parsers may return CDATA only. @@ -115,7 +108,6 @@ interface XAttributeList: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getTypeByName /** @returns the type of an attribute in the list (by name). Non-validating parsers may return CDATA only. @@ -124,7 +116,6 @@ interface XAttributeList: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getValueByIndex /** @returns the value of an attribute in the list (by position). */ @@ -132,7 +123,6 @@ interface XAttributeList: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XAttributeList::getValueByName /** @returns the value of an attribute in the list (by name). */ @@ -143,27 +133,4 @@ interface XAttributeList: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.5 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.3 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XDTDHandler.idl b/offapi/com/sun/star/xml/sax/XDTDHandler.idl index fd3e1969f7db..d8fa642ddcf8 100644 --- a/offapi/com/sun/star/xml/sax/XDTDHandler.idl +++ b/offapi/com/sun/star/xml/sax/XDTDHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDTDHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,15 +68,12 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XDTDHandler /** receives events according to the DTD of the document. - - <p>The SAX parser may report these events in any order, regardless of the order in which the notations and unparsed entities were declared; however, all DTD events must be reported after the document handler's @@ -92,7 +89,6 @@ interface XDTDHandler: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDTDHandler::notationDecl /** receives notification of a notation declaration event. */ void notationDecl( [in] string sName, @@ -101,7 +97,6 @@ interface XDTDHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDTDHandler::unparsedEntityDecl /** receives notification of an unparsed entity declaration event. */ void unparsedEntityDecl( [in] string sName, @@ -115,24 +110,4 @@ interface XDTDHandler: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XDocumentHandler.idl index 4f97ac8d50ec..44d242859ac9 100644 --- a/offapi/com/sun/star/xml/sax/XDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XDocumentHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDocumentHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,15 +80,12 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XDocumentHandler /** receives notification of general document events. - - <p>This interface is an IDL version of the Java interface <em>org.xml.sax.DocumentHandler</em> with some smaller adaptations.</p> @@ -97,7 +94,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::startDocument /** receives notification of the beginning of a document. */ void startDocument() @@ -105,7 +101,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::endDocument /** receives notification of the end of a document. */ void endDocument() @@ -113,7 +108,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::startElement /** receives notification of the beginning of an element . */ void startElement( [in] string aName, @@ -122,7 +116,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::endElement /** receives notification of the end of an element. */ void endElement( [in] string aName ) @@ -130,7 +123,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::characters /** receives notification of character data. */ void characters( [in] string aChars ) @@ -138,7 +130,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::ignorableWhitespace /** receives notification of white space that can be ignored. */ void ignorableWhitespace( [in] string aWhitespaces ) @@ -146,7 +137,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::processingInstruction /** receives notification of a processing instruction. */ void processingInstruction( [in] string aTarget, @@ -155,7 +145,6 @@ interface XDocumentHandler: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::xml::sax::XDocumentHandler::setDocumentLocator /** receives an object for locating the origin of SAX document events. */ void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator ) @@ -167,24 +156,4 @@ interface XDocumentHandler: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XEntityResolver.idl b/offapi/com/sun/star/xml/sax/XEntityResolver.idl index f072ebb3b0f1..cb8e30c27a4c 100644 --- a/offapi/com/sun/star/xml/sax/XEntityResolver.idl +++ b/offapi/com/sun/star/xml/sax/XEntityResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEntityResolver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,16 +72,13 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XEntityResolver /** makes it possible to modify the behaviour of resolving external preferences. - - <p>Usually, the parser has a default behaviour of resolving external references (See documentation of the parser implementation). Use this interface to modify or reimplement this behaviour.</p> @@ -90,13 +87,12 @@ interface XEntityResolver: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::xml::sax::XEntityResolver::resolveEntity /** @returns <type>InputSource</type> for the external entity. - <p>If <var>aInputStream</var> is a valid reference to an input stream, - the parser uses this <type>InputSource</type>. Otherwise the - parser seeks for the entity using its default behaviour. + <p>If <var>aInputStream</var> is a valid reference to an input stream, + the parser uses this <type>InputSource</type>. Otherwise the + parser seeks for the entity using its default behaviour. */ InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId ); @@ -106,24 +102,4 @@ interface XEntityResolver: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XErrorHandler.idl b/offapi/com/sun/star/xml/sax/XErrorHandler.idl index 88376be2f9c6..c81364b53740 100644 --- a/offapi/com/sun/star/xml/sax/XErrorHandler.idl +++ b/offapi/com/sun/star/xml/sax/XErrorHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XErrorHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,53 +72,38 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XErrorHandler /** is the basic interface for SAX error handlers. - - <p>If a SAX application needs to implement customized error handling, it must implement this interface and then register an instance with the - SAX parser using the parser's - - - - - + SAX parser using the parser's <method>XParser::setErrorhandler</method> method. The parser will then report all errors and warnings through this - interface. + interface. </p> - </p> <p>This interface is a slight adaption of the Java interface <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed - as an argument, so an <code>any</code> serves as the container. The type of the exception is - <type>SAXParseException</type> or an instance of a derived class.</p> + as an argument, so an <code>any</code> serves as the container. The type of the + exception is <type>SAXParseException</type> or an instance of a derived class.</p> */ interface XErrorHandler: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XErrorHandler::error /** receives notification of a recoverable error. */ void error( [in] any aSAXParseException ) raises( com::sun::star::xml::sax::SAXException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XErrorHandler::fatalError /** receives notification of a non-recoverable error. */ void fatalError( [in] any aSAXParseException ) raises( com::sun::star::xml::sax::SAXException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XErrorHandler::warning /** receives notification of a warning. */ void warning( [in] any aSAXParseException ) @@ -130,24 +115,4 @@ interface XErrorHandler: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:19 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl index 065674caab55..cf8dbe2844f5 100644 --- a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExtendedDocumentHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,24 +72,21 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XExtendedDocumentHandler -/** this interface does not conform to the SAX-standard. Note: Whether or not every callback is supported is dependent +/** this interface does not conform to the SAX-standard. + + <p>Note: Whether or not every callback is supported is dependent on the parser implementation. */ interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XExtendedDocumentHandler::startCDATA /** receives notification about the start of a CDATA section in the XML-source. - - <p>Any string comming in via character handler may include chars, that would otherwise be interpreted as markup. </p> */ @@ -97,28 +94,20 @@ interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler raises( com::sun::star::xml::sax::SAXException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XExtendedDocumentHandler::endCDATA /** informs about the end of a CDATA-Section. - - <p>Note that <code>startCDATA/endCDATA</code> MUST NOT enclose any <code>startElement/endElement</code>-call!</p> */ void endCDATA(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XExtendedDocumentHandler::comment /** receives notification about a comment in the XML-source. */ void comment( [in] string sComment ) raises( com::sun::star::xml::sax::SAXException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XExtendedDocumentHandler::allowLineBreak /** informs a writer that it is allowable to insert a line break and indentation before the next <type>XDocumentHandler</type>-call. */ @@ -126,8 +115,6 @@ interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler raises( com::sun::star::xml::sax::SAXException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XExtendedDocumentHandler::unknown /** notifies that any characters that cannot be handled by other callback methods are announced through this method. */ @@ -139,24 +126,4 @@ interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:20 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XLocator.idl b/offapi/com/sun/star/xml/sax/XLocator.idl index 66f594edefcc..446189232655 100644 --- a/offapi/com/sun/star/xml/sax/XLocator.idl +++ b/offapi/com/sun/star/xml/sax/XLocator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLocator.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,47 +68,36 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================ -// DocMerge from xml: interface com::sun::star::xml::sax::XLocator /** makes it possible to associate a SAX event with a document location. - - <p>This interface is an IDL version of the Java interface <em>org.xml.sax.Locator</em>.</p> */ interface XLocator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::xml::sax::XLocator::getColumnNumber /** @returns the column number where the current document event ends. */ long getColumnNumber(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::xml::sax::XLocator::getLineNumber /** @returns the line number where the current document event ends. */ long getLineNumber(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::xml::sax::XLocator::getPublicId /** @returns the public identifier for the current document event. */ string getPublicId(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::xml::sax::XLocator::getSystemId /** @returns the system identifier for the current document event. */ @@ -119,27 +108,4 @@ interface XLocator: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.5 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.3 2000/02/23 11:41:20 mi - results from proofreading in layouted version - - Revision 1.2 2000/02/07 11:25:06 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif diff --git a/offapi/com/sun/star/xml/sax/XParser.idl b/offapi/com/sun/star/xml/sax/XParser.idl index e467c3d630fe..d888bc3579a4 100644 --- a/offapi/com/sun/star/xml/sax/XParser.idl +++ b/offapi/com/sun/star/xml/sax/XParser.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParser.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:11:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,47 +100,34 @@ //============================================================================= - module com { module sun { module star { module xml { module sax { +module com { module sun { module star { module xml { module sax { //============================================================================= -// DocMerge from xml: interface com::sun::star::xml::sax::XParser /** specifies a SAX parser. - - <p>This interface is an IDL version of the Java interface <em>org.xml.sax.Parser</em> with some minor adaptations.</p> */ interface XParser: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::parseStream /** parses an XML document from a stream. - - <p>Set the desired handlers before calling this method.</p> */ - void parseStream( [in] com::sun::star::xml::sax::InputSource strucInputSource ) + void parseStream( [in] com::sun::star::xml::sax::InputSource aInputSource ) raises( com::sun::star::xml::sax::SAXException, com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::setDocumentHandler /** allows an application to register a document event handler. */ void setDocumentHandler( [in] com::sun::star::xml::sax::XDocumentHandler xHandler ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::setErrorHandler /** allows an application to register an error event handler. - - <p>Note that the error handler can throw an exception when an error or warning occurs. Note that an exception is thrown by the parser when an unrecoverable (fatal) error occurs.</p> @@ -148,26 +135,18 @@ interface XParser: com::sun::star::uno::XInterface void setErrorHandler( [in] com::sun::star::xml::sax::XErrorHandler xHandler ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::setDTDHandler /** allows an application to register a DTD-Handler. */ void setDTDHandler( [in] com::sun::star::xml::sax::XDTDHandler xHandler ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::setEntityResolver /** allows an application to register a DTD-Handler. */ void setEntityResolver( [in] com::sun::star::xml::sax::XEntityResolver xResolver ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::xml::sax::XParser::setLocale /** sets a locale specified for localization of warnings and error messages. - - <p>Set the language of the error messages. Useful when the parsing errors will be presented to the user.</p> */ @@ -178,24 +157,4 @@ interface XParser: com::sun::star::uno::XInterface }; }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:45:43 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:36:22 hjs - initial import - - Revision 1.4 2000/09/11 11:53:08 mi - documentation merged from XML - - Revision 1.2 2000/02/23 11:41:20 mi - results from proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:47 jsc - new - - -=============================================================================*/ #endif |