diff options
Diffstat (limited to 'udkapi/com/sun')
136 files changed, 1396 insertions, 2930 deletions
diff --git a/udkapi/com/sun/star/beans/IllegalTypeException.idl b/udkapi/com/sun/star/beans/IllegalTypeException.idl index 3b40fdab0..6464cfd71 100644 --- a/udkapi/com/sun/star/beans/IllegalTypeException.idl +++ b/udkapi/com/sun/star/beans/IllegalTypeException.idl @@ -2,9 +2,9 @@ * * $RCSfile: IllegalTypeException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:06:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:37 $ * * 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 beans { +module com { module sun { module star { module beans { //============================================================================= -// DocMerge from xml: exception com::sun::star::beans::IllegalTypeException /** This exception is thrown to indicate the use of a type which is not appropriate. @@ -88,27 +87,4 @@ exception IllegalTypeException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:35 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:20 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/17 09:30:04 mi - proofreading in layouted version - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/Introspection.idl b/udkapi/com/sun/star/beans/Introspection.idl index 0c0bd9427..646da7c5e 100644 --- a/udkapi/com/sun/star/beans/Introspection.idl +++ b/udkapi/com/sun/star/beans/Introspection.idl @@ -2,9 +2,9 @@ * * $RCSfile: Introspection.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,19 @@ module com { module sun { module star { module beans { //============================================================================= - -// DocMerge from xml: service com::sun::star::beans::Introspection -/** makes it possible to inspect an object concerning its properties and - functions. +/** provides functionality to get information about an object's + properties and methods. + + <p><strong>Important note:</strong>An object can only be + inspected completely if it supports the <type scope= + "com::sun::star::lang">XTypeProvider</type> interface.</p> - <p>For details see method <member>XIntrospection::inspect</member>. </p> + <p>For details see method <member>XIntrospection::inspect + </member>.</p> */ service Introspection { - // DocMerge: empty anyway + /// The only interface of this service interface com::sun::star::beans::XIntrospection; }; @@ -89,27 +92,4 @@ service Introspection }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:20 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/02/17 09:30:04 mi - proofreading in layouted version - - Revision 1.2 2000/01/03 12:03:18 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/IntrospectionException.idl b/udkapi/com/sun/star/beans/IntrospectionException.idl index 0733cffcb..ce096be94 100644 --- a/udkapi/com/sun/star/beans/IntrospectionException.idl +++ b/udkapi/com/sun/star/beans/IntrospectionException.idl @@ -2,9 +2,9 @@ * * $RCSfile: IntrospectionException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,16 +71,12 @@ module com { module sun { module star { module beans { //============================================================================= - -// DocMerge from xml: exception com::sun::star::beans::IntrospectionException /** This exception is thrown when an exception happens during introspection. - - <p>Typical causes include not being able to map a class - name to an interface object or not being able to resolve - a method name or an attribute name. </p> - @see PropertyContainer + @deprecated + + <p>This exception isn't specified and used anywhere</p> */ exception IntrospectionException: com::sun::star::uno::Exception { @@ -90,21 +86,4 @@ exception IntrospectionException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:20 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/udkapi/com/sun/star/beans/MethodConcept.idl b/udkapi/com/sun/star/beans/MethodConcept.idl index 7c3fbd458..c7483e547 100644 --- a/udkapi/com/sun/star/beans/MethodConcept.idl +++ b/udkapi/com/sun/star/beans/MethodConcept.idl @@ -2,9 +2,9 @@ * * $RCSfile: MethodConcept.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:06:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:37 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,90 +67,88 @@ module com { module sun { module star { module beans { //============================================================================= - -// DocMerge from idl: constants com::sun::star::beans::MethodConcept -/** These constants are used to specify concepts of the introspection - which apply to methods. +/** These constants are used to specify concepts of the + introspection which apply to methods. - This list is not necessarily complete; new constants may be added - (by the author). - */ + <p>This list is not necessarily complete; new constants + may be added.</p> + + @see Introspection + @see XIntrospection + @see XIntrospectionAccess + +*/ constants MethodConcept { //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::ALL - /** This value is used to query for all methods. + /** This value is used to query for all methods, see + <member>XIntrospectionAccess::getMethod()</member> and + <member>XIntrospectionAccess::getMethods()</member> */ const long ALL = -1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::DANGEROUS /** specifies methods which can result in an unstable state - (i.e., deadlock, application crash, security hole, etc.) when called - directly by the user. + (i.e. deadlock, application crash, security hole, etc.) + when called directly by the user. */ const long DANGEROUS = 1; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::PROPERTY - /** specifies methods which are used to set and get the + /** specifies methods which are used to set and get the value of properties/attributes. - <p>These methods have the signature <code>type get...()</code>, - <code>void set...()</code> or <code>boolean is...()</code>. </p> + <p>These methods have the signature <code>type get...() + </code>, <code>void set...()</code> or <code>boolean is...() + </code>. </p> */ const long PROPERTY = 2; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::LISTENER - /** specifies methods of the <em>listener concept</em>. + /** specifies methods of the <em>listener concept</em>. - <p>These methods have the signature <code>add...Listener()</code> - or <code>remove...Listener()</code>. </p> + <p>These methods have the signature <code>add...Listener() + </code> or <code>remove...Listener()</code>. </p> */ const long LISTENER = 4; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::ENUMERATION /** specifies methods of the <em>enumeration concept</em>. - <p>These methods have the signature <code>create...Enumeration</code> - and return an interface that was derived from - <type scope="com::sun::star::container">XEnumeration</type>. - Additionally, the method - <member scope="com::sun::star::container">XEnumerationAccess::getElementType</member> - belongs to this concept. </p> + <p>These methods have the signature + <code>create...Enumeration</code> and return an interface + that is derived from <type scope="com::sun::star::container"> + XEnumeration</type> Additionally, the method <member scope= + "com::sun::star::container">XEnumerationAccess::getElementType + </member> belongs to this concept.</p> */ const long ENUMERATION = 8; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::NAMECONTAINER /** specifies methods of the <em>name container concept</em>. - <p>These methods have the signature <code>get...ByName()</code>, - <code>set...ByName()</code>, <code>replace...ByName()</code>, - <code>remove...ByName()</code>, <code>has...ByName()</code>, or + <p>These methods have the signature + <code>get...ByName()</code>, + <code>set...ByName()</code>, + <code>replace...ByName()</code>, + <code>remove...ByName()</code>, + <code>has...ByName()</code>, or <code>get...Names</code>. In addition, the method - <member>XNameAccess::getElementType()</member> belongs to this - concept. </p> + <member>XNameAccess::getElementType()</member> + belongs to this concept. </p> */ const long NAMECONTAINER = 16; //------------------------------------------------------------------------- - - // DocMerge from idl: value com::sun::star::beans::MethodConcept::INDEXCONTAINER /** specifies methods of the <em>index container concept</em>. - <p>These methods have the signature <code>get...ByIndex()</code>, - <code>insert...ByIndex()</code>, <code>replace...ByIndex()</code>, or - <code>remove...ByIndex()</code>. The method - <member scope="com::sun::star::container">XIndexAccess::getCount()</member> + <p>These methods have the signature + <code>get...ByIndex()</code>, + <code>insert...ByIndex()</code>, + <code>replace...ByIndex()</code>, or + <code>remove...ByIndex()</code>. + The method <member scope="com::sun::star::container"> + XIndexAccess::getCount()</member> also belongs to this concept. </p> */ const long INDEXCONTAINER = 32; @@ -161,33 +159,4 @@ constants MethodConcept }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2000/12/19 15:32:23 mi - documentation syntax fixed - - Revision 1.5 2000/12/11 16:09:35 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:20 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/02/17 09:30:04 mi - proofreading in layouted version - - Revision 1.2 2000/02/07 11:24:18 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/NotRemoveableException.idl b/udkapi/com/sun/star/beans/NotRemoveableException.idl index 859603b6e..043bbe1ac 100644 --- a/udkapi/com/sun/star/beans/NotRemoveableException.idl +++ b/udkapi/com/sun/star/beans/NotRemoveableException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NotRemoveableException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,10 +65,9 @@ #include <com/sun/star/uno/Exception.idl> #endif - //============================================================================= - module com { module sun { module star { module beans { +module com { module sun { module star { module beans { //============================================================================= diff --git a/udkapi/com/sun/star/beans/Property.idl b/udkapi/com/sun/star/beans/Property.idl index 80e5c3a1c..5d6e8ab71 100644 --- a/udkapi/com/sun/star/beans/Property.idl +++ b/udkapi/com/sun/star/beans/Property.idl @@ -2,9 +2,9 @@ * * $RCSfile: Property.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyAttribute.idl b/udkapi/com/sun/star/beans/PropertyAttribute.idl index 71aaffe7b..e0f496771 100644 --- a/udkapi/com/sun/star/beans/PropertyAttribute.idl +++ b/udkapi/com/sun/star/beans/PropertyAttribute.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyAttribute.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyBag.idl b/udkapi/com/sun/star/beans/PropertyBag.idl index 5650915e0..d5bf57668 100644 --- a/udkapi/com/sun/star/beans/PropertyBag.idl +++ b/udkapi/com/sun/star/beans/PropertyBag.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyBag.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyChangeEvent.idl b/udkapi/com/sun/star/beans/PropertyChangeEvent.idl index a12135083..ff283b1f5 100644 --- a/udkapi/com/sun/star/beans/PropertyChangeEvent.idl +++ b/udkapi/com/sun/star/beans/PropertyChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyChangeEvent.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:53 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyConcept.idl b/udkapi/com/sun/star/beans/PropertyConcept.idl index aa37579c2..171834518 100644 --- a/udkapi/com/sun/star/beans/PropertyConcept.idl +++ b/udkapi/com/sun/star/beans/PropertyConcept.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyConcept.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:55 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:38 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,26 +64,32 @@ //============================================================================= - module com { module sun { module star { module beans { +module com { module sun { module star { module beans { //============================================================================= - -/** These constants are used to specify concepts of the introspection - which apply to properties and to the methods which represent attributes. +/** These constants are used to specify concepts of the + introspection which apply to properties and to the + methods which represent attributes. - <p>This list is not necessarily complete; new constants may be added - (by the author). </p> + <p>This list is not necessarily complete; new constants + may be added.</p> + + @see Introspection + @see XIntrospection + @see XIntrospectionAccess */ constants PropertyConcept { //------------------------------------------------------------------------- - - /** This value is used to query for all methods and properties. + /** This value is used to query for all properties. + + See + <member>XIntrospectionAccess::getProperty()</member> and + <member>XIntrospectionAccess::getProperties()</member> */ const long ALL = -1; //------------------------------------------------------------------------- - /** specifies that the change or retrieval of this property directly by the user can result in an unstable state (deadlock, application crash, security hole, etc.) @@ -91,9 +97,8 @@ constants PropertyConcept const long DANGEROUS = 1; //------------------------------------------------------------------------- - /** specifies all properties which are reachable by - <type>XPropertySet</type>, <type>XFastPropertySet</type> or + <type>XPropertySet</type>, <type>XFastPropertySet</type> or <type>XMultiPropertySet</type>. */ const long PROPERTYSET = 2; @@ -102,14 +107,14 @@ constants PropertyConcept /** specifies all properties which are actually attributes of interfaces. */ - const long ATTRIBUTES = 4; + const long ATTRIBUTES = 4; //------------------------------------------------------------------------- /** specifies all properties which are represented by getter or setter methods. <p>These methods have the signature <code>type get...()</code>, - <code>void set...()</code> or <code>boolean is...()</code>. </p> + <code>void set...()</code> or <code>boolean is...()</code>.</p> */ const long METHODS = 8; diff --git a/udkapi/com/sun/star/beans/PropertyExistException.idl b/udkapi/com/sun/star/beans/PropertyExistException.idl index 768e122bf..1929a15ee 100644 --- a/udkapi/com/sun/star/beans/PropertyExistException.idl +++ b/udkapi/com/sun/star/beans/PropertyExistException.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyExistException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertySetInfoChange.idl b/udkapi/com/sun/star/beans/PropertySetInfoChange.idl index f185e3e36..0ef9caa64 100644 --- a/udkapi/com/sun/star/beans/PropertySetInfoChange.idl +++ b/udkapi/com/sun/star/beans/PropertySetInfoChange.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertySetInfoChange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:21:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl b/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl index 0c3b300c7..ed4786131 100644 --- a/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl +++ b/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertySetInfoChangeEvent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyState.idl b/udkapi/com/sun/star/beans/PropertyState.idl index 37d5ef72a..24b702522 100644 --- a/udkapi/com/sun/star/beans/PropertyState.idl +++ b/udkapi/com/sun/star/beans/PropertyState.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyState.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl b/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl index df2d22339..84ee3a983 100644 --- a/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl +++ b/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyStateChangeEvent.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:05 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:39 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyValue.idl b/udkapi/com/sun/star/beans/PropertyValue.idl index 664ed9280..ede8b694c 100644 --- a/udkapi/com/sun/star/beans/PropertyValue.idl +++ b/udkapi/com/sun/star/beans/PropertyValue.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyValue.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/PropertyVetoException.idl b/udkapi/com/sun/star/beans/PropertyVetoException.idl index 22a833472..d6917f78a 100644 --- a/udkapi/com/sun/star/beans/PropertyVetoException.idl +++ b/udkapi/com/sun/star/beans/PropertyVetoException.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyVetoException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/UnknownPropertyException.idl b/udkapi/com/sun/star/beans/UnknownPropertyException.idl index 407b193ed..64406801d 100644 --- a/udkapi/com/sun/star/beans/UnknownPropertyException.idl +++ b/udkapi/com/sun/star/beans/UnknownPropertyException.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnknownPropertyException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:11 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XFastPropertySet.idl b/udkapi/com/sun/star/beans/XFastPropertySet.idl index 2b88508db..3a0b3f5cf 100644 --- a/udkapi/com/sun/star/beans/XFastPropertySet.idl +++ b/udkapi/com/sun/star/beans/XFastPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFastPropertySet.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:15 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl index bb829d491..f9eb2f3ea 100644 --- a/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl +++ b/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalPropertySet.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl b/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl index 931ab2bdf..546bd4004 100644 --- a/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl +++ b/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalPropertySetInfo.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XIntroTest.idl b/udkapi/com/sun/star/beans/XIntroTest.idl index 33f5db8a8..5c29d09b9 100644 --- a/udkapi/com/sun/star/beans/XIntroTest.idl +++ b/udkapi/com/sun/star/beans/XIntroTest.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIntroTest.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:33:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,12 +87,6 @@ interface XPropertiesChangeListener; //============================================================================= /** This is a test interface for introspection. - <p>IMPORTANT: FOR TEST ONLY! </p> - - <p>The following interface is just for testing purposes. It will not - stay in the product. It is only used as an exportable test class, - i.e., for BASIC integration. - @deprecated */ interface XIntroTest: com::sun::star::uno::XInterface diff --git a/udkapi/com/sun/star/beans/XIntrospection.idl b/udkapi/com/sun/star/beans/XIntrospection.idl index 0a7031fc2..8797eeab7 100644 --- a/udkapi/com/sun/star/beans/XIntrospection.idl +++ b/udkapi/com/sun/star/beans/XIntrospection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIntrospection.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:06:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,11 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::beans::XIntrospection -/** allows the inspection of an object's properties and functions. +/** allows the inspection of an object's properties and methods. + + <p><strong>Important note:</strong>An object can only be + inspected completely if it supports the <type scope= + "com::sun::star::lang">XTypeProvider</type> interface.</p> <p>For details see method <member>XIntrospection::inspect</member>. </p> @@ -148,33 +152,4 @@ interface XIntrospection: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/03/16 15:10:32 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.6 2000/12/12 10:21:31 jbu - reconstructed some method references, that have gone lost during merges - - Revision 1.5 2000/12/11 16:09:35 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:20 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:56 hjs - initial import - - Revision 1.4 2000/09/11 11:52:11 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:18 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/XIntrospectionAccess.idl b/udkapi/com/sun/star/beans/XIntrospectionAccess.idl index 9c16ce30a..c7cb14b4a 100644 --- a/udkapi/com/sun/star/beans/XIntrospectionAccess.idl +++ b/udkapi/com/sun/star/beans/XIntrospectionAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIntrospectionAccess.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:06:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:41 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,41 +95,25 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::beans::XIntrospectionAccess -/** gives access to the result of an interface / object - introspection done by the inspect-method of XIntrospection. - - <p>It supports some of the methods that are also defined in - <type>XPropertySet</type>, but not the methods for listener registration, - since this would not be appropriate for an introspection result. </p> - - <p>The results of the <code>get..()</code> and <code>has..()</code> - methods depends on the concepts given in the parameter - <var>nConcepts</var>. The minimum supported concepts should be - for the <type>MethodConcept</type>: </p> - - <ul> - <li> <const>MethodConcept::PROPERTY</const>, </li> - <li> <const>MethodConcept::LISTENER</const>, </li> - <li> <const>MethodConcept::ENUMERATION</const>, </li> - <li> <const>MethodConcept::NAMECONTAINER</const> and </li> - <li> <const>MethodConcept::INDEXCONTAINER</const>; </li> - </ul> +/** represents the result of an introspection operation done by + the inspect method of <type scope="com::sun::star::beans"> + XIntrospection</type>. - and for the <type>PropertyConcept</type>: + <p>This interface gives information about an object's + properties and methods as detected in the introspection + process. It's not possible to access properties or call + methods directly using this interface but it provides + access to other interfaces to do so. + See <member scope="com::sun::star::beans"> + XIntrospectionAccess::queryAdapter()</member></p> - <ul> - <li> <const>PropertyConcept::PROPERTYSET</const>, </li> - <li> <const>PropertyConcept::ATTRIBUTES</const> and </li> - <li> <const>PropertyConcept::METHODS</const>. </li> - </ul> + <p>The <type>XExactName</type> interface has to be supported + in order to implement inaccurate name access for all objects + which implement the <type scope="com::sun::star::container"> + XNameAccess</type> interface or <type>XPropertySet</type>.</p> - Both groups get combined by an arithmetical or-operation. - - <p>The <type>XExactName</type> interface has to be supported in order to - implement inaccurate name access for all objects which implement the - <type scope="com::sun::star::container">XNameAccess</type> interface or - <type>XPropertySet</type>. </p> + <p>The <type>XMaterialHolder</type> interface has to be + supported to give access to the inspected object.</p> @see XPropertySet @see com::sun::star::beans::XExactName @@ -137,156 +121,225 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getSuppliedMethodConcepts - /** @returns - zero or more constants of the <type>MethodConcept</type> constants group. + /** returns information about which method concepts described in + the <type>MethodConcept</type> constants group are supported + by this <type>XIntrospectionAccess</type> implementation. + + <p>The minimum supported concepts should be:</p> + + <ul> + <li> <const>MethodConcept::PROPERTY</const>, </li> + <li> <const>MethodConcept::LISTENER</const>, </li> + <li> <const>MethodConcept::ENUMERATION</const>, </li> + <li> <const>MethodConcept::NAMECONTAINER</const></li> + <li> <const>MethodConcept::INDEXCONTAINER</const>; </li> + </ul> + + @returns + zero or more constants of the <type>MethodConcept</type> + constants group combined by an arithmetical or-operation. */ long getSuppliedMethodConcepts(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getSuppliedPropertyConcepts - /** @returns - zero or more constants of the <type>PropertyConcept</type> constants group. + /** returns information about which property concepts described in + the <type>PropertyConcept</type> constants group are supported + by this <type>XIntrospectionAccess</type> implementation. + + <p>The minimum supported concepts should be:</p> + + <ul> + <li> <const>PropertyConcept::PROPERTYSET</const>, </li> + <li> <const>PropertyConcept::ATTRIBUTES</const> and </li> + <li> <const>PropertyConcept::METHODS</const>. </li> + </ul> + + @returns + zero or more constants of the <type>PropertyConcept</type> + constants group.combined by an arithmetical or-operation. */ long getSuppliedPropertyConcepts(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getProperty - /** @returns - <TRUE/> if the method exists and fits the - given MethodConcepts; otherwise <FALSE/> is returned. + /** returns information about a property if a property with + the demanded name exists and if it accords to one of the + demanded <type>PropertyConcept</type>s. The information + is provided as <type>Property</type> struct. + + @returns + A <type>Property</type> struct providing + information about the demanded property, + if a corresponding property exists. @param aName - the name of the <type>Property</type>. + the name of the property. @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept</type> constants group. + zero or more constants of the <type>PropertyConcept + </type> constants group combined by an arithmetical + or-operation. @throws NoSuchElementException - when an element under Name does not exist. + when a property with the demanded name doesn't exist + or if it accords to a wrong <type>PropertyConcept + </type>. */ com::sun::star::beans::Property getProperty( [in] string aName, [in] long nPropertyConcepts ) raises( com::sun::star::container::NoSuchElementException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::hasProperty - /** @returns - <TRUE/> if the method exists and fits the given <type>PropertyConcept</type>s; - otherwise <FALSE/> is returned. + /** allows to ask if a property with the demanded name exists + and if it accords to one of the demanded <type> + PropertyConcept</type>s. + + @returns + <TRUE/> if the property exists and accords to one of + the demanded <type>PropertyConcept</type>s, otherwise + <FALSE/> is returned. @param aName - the name of the <type>Property</type>. + the name of the property. - @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept</type> constants group. + @param nPropertyConcepts + zero or more constants of the <type>PropertyConcept + </type> constants group combined by an arithmetical + or-operation. */ boolean hasProperty( [in] string aName, [in] long nPropertyConcepts ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getProperties - /** @returns - all properties of the introspected object which accord to the - given <type>PropertyConcept</type>s. + /** returns a sequence of properties of the introspected object + + @returns + all properties of the introspected object which accord + to the demanded <type>PropertyConcept</type>s. + + @param nPropertyConcepts + zero or more constants of the <type>PropertyConcept + </type> constants group combined by an arithmetical + or-operation. */ sequence<com::sun::star::beans::Property> getProperties( [in] long nPropertyConcepts ); - + //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getMethod - /** @returns - the method with the given name if it exists and fits the - specified <type>MethodConcept</type>s. + /** returns information about a method if a method with + the demanded name exists and if it accords to one of + the demanded MethodConcepts. The information is + provided as <type scope="com::sun::star::reflection"> + XIdlMethod</type>. + + @returns + A <type scope="com::sun::star::reflection"> + XIdlMethod</type> providing information about and + access to the demanded method if a corresponding + method exists. @param aName - the name of the method. + the name of the method. @param nMethodConcepts - zero or more constants of the <type>MethodConcept</type> group. - + zero or more constants of the <type>MethodConcept + </type> constants group combined by an arithmetical + or-operation. + @throws NoSuchElementException - if no element with the <var>Name</var> exists. + when a method with the demanded name doesn't exist + or if it accords to a wrong <type>MethodConcept</type>. */ com::sun::star::reflection::XIdlMethod getMethod( [in] string aName, [in] long nMethodConcepts ) raises( com::sun::star::lang::NoSuchMethodException ); - + //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::hasMethod - /** @returns - <TRUE/> if the method exists and fits the given <type>MethodConcepts</type>s; - otherwise <FALSE/> is returned. + /** allows to ask if a method with the demanded name exists + and if it accords to one of the demanded <type>MethodConcept + </type>s. + + @returns + <TRUE/> if the method exists and accords to one of + the demanded <type>MethodConcept</type>s, otherwise + <FALSE/> is returned. @param aName - the name of the method. + the name of the method. - @param nMethodConcepts - zero or more constants of the <type>MethodConcept</type> constants group. + @param nMethodConcepts + zero or more constants of the <type>MethodConcept + </type> constants group combined by an arithmetical + or-operation. */ boolean hasMethod( [in] string aName, [in] long nMethodConcepts ); - + //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getMethods - /** @returns - all methods of the introspected object which accord to the - given <type>MethodConcept</type>s. + /** returns a sequence of methods of the introspected object. + + @returns + all methods of the introspected object which accord + to the demanded <type>MethodConcept</type>s. + + @param nMethodConcepts + zero or more constants of the <type>MethodConcept + </type> constants group combined by an arithmetical + or-operation. */ sequence<com::sun::star::reflection::XIdlMethod> getMethods( [in] long nMethodConcepts ); - + //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getSupportedListeners - /** @returns - a sequence of the types of listener interfaces which are - supported by the introspected object. + /** returns the listener types supported by the introspected + object. + + <p>If the introspected object has the methods + <code>addFooListener( XFooListener xFoo )</code> and + <code>removeFooListener( XFooListener xFoo )</code> + the type of XFooListener will be one of the elements + in the returned sequence. + + @returns + a sequence of the types of listener interfaces + which are supported by the introspected object. */ sequence<type> getSupportedListeners(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::beans::XIntrospectionAccess::queryAdapter - /** creates an adapter that implements an interface - with the specified type. + /** creates an adapter that implements an interface with the + specified type. - <p>The supplied concepts (see the methods - <member>XIntrospectionAccess::setConcepts()</member>) - and the <member>XIntrospectionAccess::setConcepts()</member> member - determine the interfaces returned by this method. </p> + <p>To access properties, query for the <type>XPropertySet + </type> interface. If the <type>XPropertySet</type> can + be queried, the <type>XFastPropertySet</type> interface + must be supported too. </p> - <p>To access properties, query for the <type>XPropertySet</type> - interface. If the <type>XPropertySet</type> can be queried, - the <type>XFastPropertySet</type> interface must be - supported too. </p> + <p>If the introspected object implements a name container, + the introspection should return the <type scope= + "com::sun::star::container">XNameAccess</type> and <type + scope="com::sun::star::container">XNameContainer</type> + interfaces.</p> - <p>If the introspected object implements a name container, the - introspection should return the <type scope="com::sun::star::container">XNameAccess</type> and - <type scope="com::sun::star::container">XNameContainer</type> interfaces. </p> + <p>If the introspected object implements an index container, + the introspection should return the <type scope= + "com::sun::star::container">XIndexAccess</type> and <type + scope="com::sun::star::container">XIndexContainer</type> + interfaces.</p> - <p>If the introspected object implements an index container, the - introspection should return the <type scope="com::sun::star::container">XIndexAccess</type> and - <type scope="com::sun::star::container">XIndexContainer</type> interfaces. </p> + <p>If the introspected object implements an enumeration + container, the introspection should return the <type scope= + "com::sun::star::container">XEnumerationAccess</type> + interface.</p> - <p>If the introspected object implements an enumeration container, the introspection - should return the <type scope="com::sun::star::container">XEnumerationAccess</type> - interface. </p> + <p>If the introspected object implements the <type scope= + "com::sun::star::reflection">XIdlArray</type> interface, + the introspection should return this.</p> - <p>If the introspected object implements the <type scope="com::sun::star::reflection">XIdlArray</type> - interface, the introspection should return this. </p> - - <p>To implement inaccurate name access, at all objects, which - implement the <type scope="com::sun::star::container">XNameAccess</type> or <type>XPropertySet</type> - interface, the <type>XExactName</type> interface has to be supported. </p> + <p>To implement inaccurate name access, at all objects, + which implement the <type scope="com::sun::star::container"> + XNameAccess</type> or <type>XPropertySet</type> interface, + the <type>XExactName</type> interface has to be supported. + </p> @see com::sun::star::beans::XExactName */ @@ -299,51 +352,4 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.8 2001/03/16 15:10:32 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.7 2001/01/31 09:45:40 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.6 2000/12/12 10:21:31 jbu - reconstructed some method references, that have gone lost during merges - - Revision 1.5 2000/12/11 16:09:35 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:20 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:56 hjs - initial import - - Revision 1.8 2000/09/11 11:52:11 mi - documentation merged from XML - - Revision 1.6 2000/02/23 12:43:24 mi - missing documentations - - Revision 1.5 2000/02/17 09:30:05 mi - proofreading in layouted version - - Revision 1.4 2000/02/07 11:24:18 mi - zu #70728# missing documentation marked - - Revision 1.3 2000/01/14 11:05:18 jsc - #71616# Typumstellung - - Revision 1.2 1999/11/24 17:48:16 mi - documentation welformed - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/XMaterialHolder.idl b/udkapi/com/sun/star/beans/XMaterialHolder.idl index eff3c28a4..e84e9c852 100644 --- a/udkapi/com/sun/star/beans/XMaterialHolder.idl +++ b/udkapi/com/sun/star/beans/XMaterialHolder.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMaterialHolder.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,19 +71,24 @@ module com { module sun { module star { module beans { //============================================================================= - -// DocMerge from xml: interface com::sun::star::beans::XMaterialHolder -/** allows the inspection of an object's properties and functions. +/** gives access to the material a (tool-) object is working on. + + <p>Example: The introspection service allows the inspection of an + object's properties and methods. The result is represented as + XIntrospectionAccess interface. The inspected object then is the + material attached to the introspection tool and an implementation + of <type>XIntrospectionAccess</type> should also support + <type>XMaterialHolder</type> to give access to this material.</p> - @see XIntrospectionAccess::inspect + @see XIntrospectionAccess */ interface XMaterialHolder: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::beans::XMaterialHolder::getMaterial - /** @returns - the material that is connected to this (tool-) object. + /** returns the material that is connected to this (tool-) object + + @returns + the material that is connected to this (tool-) object. */ any getMaterial(); @@ -93,27 +98,4 @@ interface XMaterialHolder: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2000/12/19 16:15:24 mi - documentation syntax fixed - - Revision 1.5 2000/12/11 16:09:35 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:20 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:34:56 hjs - initial import - - Revision 1.3 2000/09/11 11:52:11 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:40 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl index 2e2b248e8..b2075969a 100644 --- a/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl +++ b/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiHierarchicalPropertySet.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XMultiPropertySet.idl b/udkapi/com/sun/star/beans/XMultiPropertySet.idl index b30786c9b..afb1d9ea6 100644 --- a/udkapi/com/sun/star/beans/XMultiPropertySet.idl +++ b/udkapi/com/sun/star/beans/XMultiPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiPropertySet.idl,v $ * - * $Revision: 1.11 $ + * $Revision: 1.12 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:28:24 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XProperty.idl b/udkapi/com/sun/star/beans/XProperty.idl index e0b685af5..90443f5e7 100644 --- a/udkapi/com/sun/star/beans/XProperty.idl +++ b/udkapi/com/sun/star/beans/XProperty.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProperty.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyAccess.idl b/udkapi/com/sun/star/beans/XPropertyAccess.idl index ade4da370..477888bb3 100644 --- a/udkapi/com/sun/star/beans/XPropertyAccess.idl +++ b/udkapi/com/sun/star/beans/XPropertyAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyAccess.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyChangeListener.idl b/udkapi/com/sun/star/beans/XPropertyChangeListener.idl index dd92b9c7a..834daa829 100644 --- a/udkapi/com/sun/star/beans/XPropertyChangeListener.idl +++ b/udkapi/com/sun/star/beans/XPropertyChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyChangeListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyContainer.idl b/udkapi/com/sun/star/beans/XPropertyContainer.idl index 639ee460d..246b60f89 100644 --- a/udkapi/com/sun/star/beans/XPropertyContainer.idl +++ b/udkapi/com/sun/star/beans/XPropertyContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyContainer.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertySet.idl b/udkapi/com/sun/star/beans/XPropertySet.idl index d61cbaafa..803c56cf6 100644 --- a/udkapi/com/sun/star/beans/XPropertySet.idl +++ b/udkapi/com/sun/star/beans/XPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySet.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:28:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertySetInfo.idl b/udkapi/com/sun/star/beans/XPropertySetInfo.idl index a2bc85182..a2004a31b 100644 --- a/udkapi/com/sun/star/beans/XPropertySetInfo.idl +++ b/udkapi/com/sun/star/beans/XPropertySetInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySetInfo.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertySetInfoChangeListener.idl b/udkapi/com/sun/star/beans/XPropertySetInfoChangeListener.idl index 261bc19f0..66af72ade 100644 --- a/udkapi/com/sun/star/beans/XPropertySetInfoChangeListener.idl +++ b/udkapi/com/sun/star/beans/XPropertySetInfoChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySetInfoChangeListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertySetInfoChangeNotifier.idl b/udkapi/com/sun/star/beans/XPropertySetInfoChangeNotifier.idl index 3fca95c63..c34c28b29 100644 --- a/udkapi/com/sun/star/beans/XPropertySetInfoChangeNotifier.idl +++ b/udkapi/com/sun/star/beans/XPropertySetInfoChangeNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySetInfoChangeNotifier.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:28:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyState.idl b/udkapi/com/sun/star/beans/XPropertyState.idl index db1a18884..a2ff1d551 100644 --- a/udkapi/com/sun/star/beans/XPropertyState.idl +++ b/udkapi/com/sun/star/beans/XPropertyState.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyState.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:42 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl b/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl index 64d33b11b..fbf12cb4e 100644 --- a/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl +++ b/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyStateChangeListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XPropertyWithState.idl b/udkapi/com/sun/star/beans/XPropertyWithState.idl index d63e045cb..de9d26a48 100644 --- a/udkapi/com/sun/star/beans/XPropertyWithState.idl +++ b/udkapi/com/sun/star/beans/XPropertyWithState.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyWithState.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:46 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/beans/XVetoableChangeListener.idl b/udkapi/com/sun/star/beans/XVetoableChangeListener.idl index 48611c325..2cff46f91 100644 --- a/udkapi/com/sun/star/beans/XVetoableChangeListener.idl +++ b/udkapi/com/sun/star/beans/XVetoableChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XVetoableChangeListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:22:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/udkapi/com/sun/star/bridge/OleBridgeSupplierVar1.idl b/udkapi/com/sun/star/bridge/OleBridgeSupplierVar1.idl new file mode 100644 index 000000000..53cde5a95 --- /dev/null +++ b/udkapi/com/sun/star/bridge/OleBridgeSupplierVar1.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * $RCSfile: OleBridgeSupplierVar1.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 12:43: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_bridge_OleBridgeSupplierVar1_idl__ +#define __com_sun_star_bridge_OleBridgeSupplierVar1_idl__ + +#ifndef __com_sun_star_bridge_OBridgeSupplier2_idl__ +#include <com/sun/star/bridge/OleBridgeSupplier2.idl> +#endif + + + module com { module sun { module star { module bridge { + + +/** maps UNO types to COM types and vice versa. It is optimized for use in a + remote szenario. <p> +The functionality is basically the same as +<type scope="com::sun::star::bridge">com::sun::star::bridge::OleBridgeSupplier2</type>. +However, the implementation should be optimized for remote access. For example, it could +try to reduce the calls into the remote process. Also it could create components on its own behalf in the remote process, if this increases performance. +*/ +service OleBridgeSupplierVar1 +{ + service OleBridgeSupplier2; + +}; + +//============================================================================= + +}; }; }; }; + + +#endif diff --git a/udkapi/com/sun/star/container/ContainerEvent.idl b/udkapi/com/sun/star/container/ContainerEvent.idl index 55834e9e7..733d0f86e 100644 --- a/udkapi/com/sun/star/container/ContainerEvent.idl +++ b/udkapi/com/sun/star/container/ContainerEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContainerEvent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43: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 container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: struct com::sun::star::container::ContainerEvent /** This event is fired when an element is inserted in a container. @see XContainerListener @@ -81,7 +80,6 @@ struct ContainerEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::container::ContainerEvent::Accessor /** It contains the accessor to the element which is inserted or removed. <p>The type and the value of the accessor depends on the service.</p> @@ -90,14 +88,12 @@ struct ContainerEvent: com::sun::star::lang::EventObject //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::container::ContainerEvent::Element /** This contains the element that was inserted or removed. */ any Element; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::container::ContainerEvent::ReplacedElement /** This contains the replaced element. */ any ReplacedElement; @@ -108,21 +104,4 @@ struct ContainerEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/ElementExistException.idl b/udkapi/com/sun/star/container/ElementExistException.idl index f2107185f..6b2ee60d3 100644 --- a/udkapi/com/sun/star/container/ElementExistException.idl +++ b/udkapi/com/sun/star/container/ElementExistException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ElementExistException.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:50 $ * * 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 container { +module com { module sun { module star { module container { //============================================================================= @@ -89,24 +89,4 @@ exception ElementExistException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/NoSuchElementException.idl b/udkapi/com/sun/star/container/NoSuchElementException.idl index e4b49f828..935ac23a1 100644 --- a/udkapi/com/sun/star/container/NoSuchElementException.idl +++ b/udkapi/com/sun/star/container/NoSuchElementException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSuchElementException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,14 +65,12 @@ #include <com/sun/star/uno/Exception.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: exception com::sun::star::container::NoSuchElementException /** is thrown by child access methods of collections, if the addressed child does not exist. @@ -87,21 +85,4 @@ exception NoSuchElementException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XChild.idl b/udkapi/com/sun/star/container/XChild.idl index 84c2907a1..33c3d7246 100644 --- a/udkapi/com/sun/star/container/XChild.idl +++ b/udkapi/com/sun/star/container/XChild.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChild.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:50 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,10 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XChild /** provides access to the parent of the object. <p>This interface normally is only supported if the objects all have @@ -86,14 +85,12 @@ interface XChild: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XChild::getParent /** grants access to the object containing this content. */ com::sun::star::uno::XInterface getParent(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XChild::setParent /** sets the parent to this object. @throws com::sun::star::lang::NoSupportException @@ -108,30 +105,4 @@ interface XChild: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/03/10 09:51:31 mi - UIK exchanged with awt::XTextArea - was less incompatible - - Revision 1.2 2000/02/07 11:24:23 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XComponentEnumeration.idl b/udkapi/com/sun/star/container/XComponentEnumeration.idl index 739fbcc77..9cc4f6b31 100644 --- a/udkapi/com/sun/star/container/XComponentEnumeration.idl +++ b/udkapi/com/sun/star/container/XComponentEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentEnumeration.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * 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 container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XComponentEnumeration /** provides a typified enumeration through components. */ interface XComponentEnumeration: com::sun::star::container::XEnumeration { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XComponentEnumeration::nextComponent /** @returns the next component of this enumeration. @@ -103,33 +101,4 @@ interface XComponentEnumeration: com::sun::star::container::XEnumeration }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.6 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.4 2000/01/31 11:02:36 mi - #72484# UIKs were not unique - - Revision 1.3 2000/01/28 12:24:20 jsc - #72382# same Uik as XIdlClass - - 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:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XComponentEnumerationAccess.idl b/udkapi/com/sun/star/container/XComponentEnumerationAccess.idl index cea275e73..2d8f3d506 100644 --- a/udkapi/com/sun/star/container/XComponentEnumerationAccess.idl +++ b/udkapi/com/sun/star/container/XComponentEnumerationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentEnumerationAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,10 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XComponentEnumerationAccess /** provides a factory for a typified enumeration through a collection of components. */ @@ -84,8 +83,7 @@ interface XComponentEnumerationAccess: com::sun::star::container::XEnumerationAc { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XComponentEnumerationAccess::createComponentEnumeration - /** creates an instance of enumeration through components. + /** creates a new instance of enumeration through components. */ com::sun::star::container::XComponentEnumeration createComponentEnumeration(); @@ -95,27 +93,4 @@ interface XComponentEnumerationAccess: com::sun::star::container::XEnumerationAc }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/02/23 11:41:15 mi - results from proofreading in layouted version - - Revision 1.2 2000/01/31 15:39:36 mi - #72482# some UIks were not unique - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XContainer.idl b/udkapi/com/sun/star/container/XContainer.idl index aca1dfb55..71507ffad 100644 --- a/udkapi/com/sun/star/container/XContainer.idl +++ b/udkapi/com/sun/star/container/XContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContainer.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,10 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XContainer /** supports quick access to the information if a container currently contains elements. @@ -97,19 +96,23 @@ interface XContainer: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XContainer::addContainerListener /** adds the specified listener to receive events when elements are inserted or removed. + <p>It is suggested to allow multiple registration of the same listener, + thus for each time a listener is added, it has to be removed. + @see XContainerListener */ [oneway] void addContainerListener( [in] com::sun::star::container::XContainerListener xListener ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XContainer::removeContainerListener /** removes the specified listener so it does not receive any events from this container. + + <p>It is suggested to allow multiple registration of the same listener, + thus for each time a listener is added, it has to be removed. @see XContainerListener */ @@ -121,27 +124,4 @@ interface XContainer: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 15:10:34 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XContainerListener.idl b/udkapi/com/sun/star/container/XContainerListener.idl index 051892d62..4d2740b92 100644 --- a/udkapi/com/sun/star/container/XContainerListener.idl +++ b/udkapi/com/sun/star/container/XContainerListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContainerListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,28 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XContainerListener /** receives events when the content of the related container changes. */ interface XContainerListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XContainerListener::elementInserted /** is invoked when a container has inserted an element. */ [oneway] void elementInserted( [in] com::sun::star::container::ContainerEvent Event ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XContainerListener::elementRemoved /** is invoked when a container has removed an element. */ [oneway] void elementRemoved( [in] com::sun::star::container::ContainerEvent Event ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XContainerListener::elementReplaced /** is invoked when a container has replaced an element. */ [oneway] void elementReplaced( [in] com::sun::star::container::ContainerEvent Event ); @@ -108,24 +104,4 @@ interface XContainerListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.4 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.2 2000/04/20 14:06:11 mi - documentation - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl index 53b6d2bfc..2e9fe620e 100644 --- a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl +++ b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentEnumerationAccess.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,21 +72,19 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XContentEnumerationAccess /** allows access to the collections of all content types within the object. @example <p>This example prints the names of all tables: </p> <listing> - xTextTableEnum = xTextDoc.createContentEnumeration( - "com::sun::star::text::TextTable" ) + xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" ) while xTextTableEnum.hasMoreElements() do - print xTextTableEnum.getNextElement().Name + print xTextTableEnum.nextElement().Name wend </listing> */ @@ -94,7 +92,6 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XContentEnumerationAccess::createContentEnumeration /** @returns a new enumeration object for the contents of the specified service type. */ @@ -118,36 +115,4 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/03/16 15:10:34 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.6 2000/12/19 15:32:24 mi - documentation syntax fixed - - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:54 mi - missing documentations - - Revision 1.2 2000/02/07 11:24:23 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XElementAccess.idl b/udkapi/com/sun/star/container/XElementAccess.idl index 57cad9065..33f0a05a4 100644 --- a/udkapi/com/sun/star/container/XElementAccess.idl +++ b/udkapi/com/sun/star/container/XElementAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XElementAccess.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:51 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,14 +76,12 @@ module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XElementAccess /** This is the base interface of all collection interfaces. */ interface XElementAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XElementAccess::getElementType /** @returns the type of the elements. <type>void</type> means that it is a multi-type container and you cannot determine the exact types @@ -93,7 +91,6 @@ interface XElementAccess: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XElementAccess::hasElements /** @returns <TRUE/> if the object contain elements, otherwise <FALSE/>. @@ -106,36 +103,4 @@ interface XElementAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/01/31 09:45:40 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.6 2000/12/19 13:49:34 mi - syntax errors in documentation fixed - - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/01/14 11:06:24 jsc - #71616# Typumstellung - - Revision 1.2 2000/01/03 12:03:19 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XEnumeration.idl b/udkapi/com/sun/star/container/XEnumeration.idl index c8316dc06..8ce94d3f6 100644 --- a/udkapi/com/sun/star/container/XEnumeration.idl +++ b/udkapi/com/sun/star/container/XEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEnumeration.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,6 @@ module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XEnumeration /** provides functionality to enumerate the contents of a container. <p>An object that implements the <type>XEnumeration</type> interface @@ -107,14 +106,12 @@ interface XEnumeration: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XEnumeration::hasMoreElements /** tests whether this enumeration contains more elements. */ boolean hasMoreElements(); //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XEnumeration::nextElement /** @returns the next element of this enumeration. @@ -136,33 +133,4 @@ interface XEnumeration: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.2 2000/10/09 14:24:54 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/02/23 11:41:15 mi - results from proofreading in layouted version - - Revision 1.2 2000/01/03 12:03:19 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XEnumerationAccess.idl b/udkapi/com/sun/star/container/XEnumerationAccess.idl index 0426b4e0c..a0cdf2e1a 100644 --- a/udkapi/com/sun/star/container/XEnumerationAccess.idl +++ b/udkapi/com/sun/star/container/XEnumerationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEnumerationAccess.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,15 @@ module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XEnumerationAccess /** used to enumerate objects in a container which contains objects. */ interface XEnumerationAccess: com::sun::star::container::XElementAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XEnumerationAccess::createEnumeration /** @returns - the enumeration object to the objects. - It returns NULL if there are no objects. + a new enumeration object for this container. + It returns NULL if there are no objects in this container. */ com::sun::star::container::XEnumeration createEnumeration(); @@ -96,24 +94,4 @@ interface XEnumerationAccess: com::sun::star::container::XElementAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XHierarchicalName.idl b/udkapi/com/sun/star/container/XHierarchicalName.idl index 3e839e2a6..169153cd8 100644 --- a/udkapi/com/sun/star/container/XHierarchicalName.idl +++ b/udkapi/com/sun/star/container/XHierarchicalName.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalName.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,14 +73,12 @@ #include <com/sun/star/lang/NoSupportException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XHierarchicalName /** specifies the fully qualified name of the object within a hierarchy. <p>The name is generally globally unique in the hierarchy. </p> @@ -92,7 +90,6 @@ interface XHierarchicalName: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XHierarchicalName::getHierarchicalName /** @returns the fully qualified hierarchical name of the object. */ @@ -100,7 +97,6 @@ interface XHierarchicalName: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XHierarchicalName::composeHierarchicalName /** builds the hierarchical name of an object, given a relative name <p>Can be used to find the name of a descendant object in the hierarchy @@ -117,24 +113,4 @@ interface XHierarchicalName: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1 2000/06/15 15:55:51 jb - Add XHierarchicalName interface - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl index 0d0141dc3..f80a55bde 100644 --- a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl +++ b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalNameAccess.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,15 +68,13 @@ #ifndef __com_sun_star_container_NoSuchElementException_idl__ #include <com/sun/star/container/NoSuchElementException.idl> #endif - - + //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XHierarchicalNameAccess /** is used to have hierarchical access to elements within a container. <p>You address an object of a specific level in the hierarchy by giving its @@ -91,7 +89,6 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XHierarchicalNameAccess::getByHierarchicalName /** @returns the object with the specified name. @@ -106,7 +103,6 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XHierarchicalNameAccess::hasByHierarchicalName /** @returns <TRUE/> if an element with this name is in the container, <FALSE/> otherwise. @@ -125,42 +121,4 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/03/16 15:10:35 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.6 2000/12/19 15:32:24 mi - documentation syntax fixed - - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.2 2000/10/09 14:24:54 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.6 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.4 2000/02/07 11:24:23 mi - zu #70728# missing documentation marked - - Revision 1.3 2000/01/03 12:03:20 mi - reference manual - - Revision 1.2 1999/11/15 16:05:39 dbo - doc added - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XIdentifierAccess.idl b/udkapi/com/sun/star/container/XIdentifierAccess.idl index 05ef2759b..497bcc73a 100644 --- a/udkapi/com/sun/star/container/XIdentifierAccess.idl +++ b/udkapi/com/sun/star/container/XIdentifierAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdentifierAccess.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: cl $ $Date: 2001-05-31 13:37:47 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,10 +73,9 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= @@ -102,6 +101,7 @@ interface XIdentifierAccess: com::sun::star::container::XElementAccess raises( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException ); + // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** @returns a sequence of all identifiers in this container. diff --git a/udkapi/com/sun/star/container/XIdentifierContainer.idl b/udkapi/com/sun/star/container/XIdentifierContainer.idl index 392e81eb8..097871e79 100644 --- a/udkapi/com/sun/star/container/XIdentifierContainer.idl +++ b/udkapi/com/sun/star/container/XIdentifierContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdentifierContainer.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,10 +81,9 @@ #include <com/sun/star/container/NoSuchElementException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= diff --git a/udkapi/com/sun/star/container/XIdentifierReplace.idl b/udkapi/com/sun/star/container/XIdentifierReplace.idl index 63e21277b..a63c80662 100644 --- a/udkapi/com/sun/star/container/XIdentifierReplace.idl +++ b/udkapi/com/sun/star/container/XIdentifierReplace.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdentifierReplace.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:35:17 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:53 $ * * 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 container { +module com { module sun { module star { module container { //============================================================================= diff --git a/udkapi/com/sun/star/container/XIndexAccess.idl b/udkapi/com/sun/star/container/XIndexAccess.idl index 79404b2d5..6eda4b4f5 100644 --- a/udkapi/com/sun/star/container/XIndexAccess.idl +++ b/udkapi/com/sun/star/container/XIndexAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexAccess.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,6 @@ module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XIndexAccess /** provides access to the elements of a collection through an index. @@ -91,9 +90,8 @@ interface XIndexAccess: com::sun::star::container::XElementAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XIndexAccess::getCount /** @returns - the number of elements. + the number of elements in this container. */ long getCount(); @@ -101,7 +99,7 @@ interface XIndexAccess: com::sun::star::container::XElementAccess // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex /** @returns - the element at the specified index + the element at the specified index. @param Index specifies the position in the array. The first index is 0. @@ -124,27 +122,4 @@ interface XIndexAccess: com::sun::star::container::XElementAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.2 2000/10/09 14:24:54 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XIndexContainer.idl b/udkapi/com/sun/star/container/XIndexContainer.idl index 8bb88a74b..15aefbb58 100644 --- a/udkapi/com/sun/star/container/XIndexContainer.idl +++ b/udkapi/com/sun/star/container/XIndexContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexContainer.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,14 +77,12 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XIndexContainer /** This is the generic interface for supporting the insertion and removal of indexed elements.@see XContainer */ @@ -92,8 +90,7 @@ interface XIndexContainer: com::sun::star::container::XIndexReplace { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XIndexContainer::insertByIndex - /** inserts the element at the specified index. + /** inserts the given element at the specified index. <p>To append an element, use the index "last index +1". </p> */ @@ -105,7 +102,6 @@ interface XIndexContainer: com::sun::star::container::XIndexReplace //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XIndexContainer::removeByIndex /** removes the element at the specified index. */ void removeByIndex( [in] long Index ) @@ -118,24 +114,4 @@ interface XIndexContainer: com::sun::star::container::XIndexReplace }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XIndexReplace.idl b/udkapi/com/sun/star/container/XIndexReplace.idl index 860c9463f..16843a8b4 100644 --- a/udkapi/com/sun/star/container/XIndexReplace.idl +++ b/udkapi/com/sun/star/container/XIndexReplace.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexReplace.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,14 +77,12 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XIndexReplace /** This is the generic interface for supporting the replacement of indexed elements. @@ -94,8 +92,7 @@ interface XIndexReplace: com::sun::star::container::XIndexAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XIndexReplace::replaceByIndex - /** replaces the element at the specified index. + /** replaces the element at the specified index with the given element. */ void replaceByIndex( [in] long Index, [in] any Element ) @@ -109,24 +106,4 @@ interface XIndexReplace: com::sun::star::container::XIndexAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XNameAccess.idl b/udkapi/com/sun/star/container/XNameAccess.idl index 9d5549f20..7f2f8b2d3 100644 --- a/udkapi/com/sun/star/container/XNameAccess.idl +++ b/udkapi/com/sun/star/container/XNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNameAccess.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,14 +73,12 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XNameAccess /** is used to access named objects within a container. <p>To implement inaccurate name access, support the @@ -93,9 +91,8 @@ interface XNameAccess: com::sun::star::container::XElementAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XNameAccess::getByName /** @returns - the object with the specified name. + the object with the specified name. @param aName the name of the object. @@ -104,9 +101,9 @@ interface XNameAccess: com::sun::star::container::XElementAccess if an element under Name does not exist. @throws com::sun::star::lang::WrappedTargetException - If the implementation has internal reasons for exceptions, - then wrap these in a <type>WrappedTargetException</type> - exception. + If the implementation has internal reasons for exceptions, + then wrap these in a <type>WrappedTargetException</type> + exception. */ any getByName( [in] string aName ) raises( com::sun::star::container::NoSuchElementException, @@ -114,7 +111,6 @@ interface XNameAccess: com::sun::star::container::XElementAccess //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XNameAccess::getElementNames /** @returns a sequence of all element names in this container. @@ -124,7 +120,6 @@ interface XNameAccess: com::sun::star::container::XElementAccess //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XNameAccess::hasByName /** @returns <TRUE/> if an element with this name is in the container, <FALSE/> otherwise. @@ -132,7 +127,7 @@ interface XNameAccess: com::sun::star::container::XElementAccess <p>In many cases the next call is <member>XNameAccess::getByName</member>. You should optimize this case. </p> - @param iaName + @param aName the name of the object. */ boolean hasByName( [in] string aName ); @@ -143,39 +138,4 @@ interface XNameAccess: com::sun::star::container::XElementAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2000/12/19 15:32:24 mi - documentation syntax fixed - - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.2 2000/10/09 14:24:54 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.6 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.4 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.3 2000/02/07 11:24:23 mi - zu #70728# missing documentation marked - - Revision 1.2 2000/01/03 12:03:20 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XNameContainer.idl b/udkapi/com/sun/star/container/XNameContainer.idl index 9bd5e0b89..268af4bf0 100644 --- a/udkapi/com/sun/star/container/XNameContainer.idl +++ b/udkapi/com/sun/star/container/XNameContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNameContainer.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,14 +81,12 @@ #include <com/sun/star/container/NoSuchElementException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XNameContainer /** This is the generic interface for supporting the insertion and removal of named elements. @@ -98,8 +96,7 @@ interface XNameContainer: com::sun::star::container::XNameReplace { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XNameContainer::insertByName - /** inserts the element at the specified name. + /** inserts the given element at the specified name. */ void insertByName( [in] string aName, [in] any aElement ) @@ -109,7 +106,6 @@ interface XNameContainer: com::sun::star::container::XNameReplace //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XNameContainer::removeByName /** removes the element with the specified name. */ void removeByName( [in] string Name ) @@ -122,24 +118,4 @@ interface XNameContainer: com::sun::star::container::XNameReplace }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XNameReplace.idl b/udkapi/com/sun/star/container/XNameReplace.idl index 2bf18a109..003ae5f1a 100644 --- a/udkapi/com/sun/star/container/XNameReplace.idl +++ b/udkapi/com/sun/star/container/XNameReplace.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNameReplace.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,14 +77,12 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XNameReplace /** This is the generic interface for supporting the replacement of named elements. @@ -94,8 +92,7 @@ interface XNameReplace: com::sun::star::container::XNameAccess { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XNameReplace::replaceByName - /** replaces the element with the specified name. + /** replaces the element with the specified name with the given element. */ void replaceByName( [in] string aName, [in] any aElement ) @@ -109,24 +106,4 @@ interface XNameReplace: com::sun::star::container::XNameAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XNamed.idl b/udkapi/com/sun/star/container/XNamed.idl index 3469ec85c..e54e5d8f7 100644 --- a/udkapi/com/sun/star/container/XNamed.idl +++ b/udkapi/com/sun/star/container/XNamed.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamed.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,14 +65,12 @@ #include <com/sun/star/uno/XInterface.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XNamed /** specifies the name of the object. <p>The name is generally unique in the container of the object.</p> @@ -81,15 +79,13 @@ interface XNamed: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XNamed::getName /** @returns - the programmatic name of the object. + the programmatic name of the object. */ string getName(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XNamed::setName /** sets the programmatic name of the object. */ [oneway] void setName( [in] string aName ); @@ -100,30 +96,4 @@ interface XNamed: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.5 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.3 2000/02/23 14:49:55 mi - missing documentations - - Revision 1.2 2000/02/07 11:24:23 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XSet.idl b/udkapi/com/sun/star/container/XSet.idl index b788ecc84..90a204052 100644 --- a/udkapi/com/sun/star/container/XSet.idl +++ b/udkapi/com/sun/star/container/XSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,14 +77,12 @@ #include <com/sun/star/container/NoSuchElementException.idl> #endif - //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= -// DocMerge from xml: interface com::sun::star::container::XSet /** This is the generic interface for supporting the insertion and removal of elements.@see XContainer */ @@ -92,16 +90,15 @@ interface XSet: com::sun::star::container::XEnumerationAccess { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::container::XSet::has /** @returns - <TRUE/> if the element exists, otherwise <FALSE/>. + <TRUE/> if the given element is a member of this container, + otherwise <FALSE/>. */ - boolean has( [in] any Element ); + boolean has( [in] any aElement ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XSet::insert - /** inserts the element in the container. + /** inserts the given element into this container. */ void insert( [in] any aElement ) raises( com::sun::star::lang::IllegalArgumentException, @@ -109,9 +106,7 @@ interface XSet: com::sun::star::container::XEnumerationAccess //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::container::XSet::remove - /** removes the element at the position of the enumeration - object. + /** removes the given element from this container. */ void remove( [in] any aElement ) raises( com::sun::star::lang::IllegalArgumentException, @@ -123,24 +118,4 @@ interface XSet: com::sun::star::container::XEnumerationAccess }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.4 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:20 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:41 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/container/XUniqueIDAccess.idl b/udkapi/com/sun/star/container/XUniqueIDAccess.idl index cd41b66ac..63ea8a4fa 100644 --- a/udkapi/com/sun/star/container/XUniqueIDAccess.idl +++ b/udkapi/com/sun/star/container/XUniqueIDAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUniqueIDAccess.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,21 +73,21 @@ #include <com/sun/star/lang/WrappedTargetException.idl> #endif - //============================================================================= module com { module sun { module star { module container { -// DocMerge from xml: interface com::sun::star::container::XUniqueIDAccess /** makes it possible to access contents via a unique ID. */ interface XUniqueIDAccess: com::sun::star::uno::XInterface { - /** @missing + /** @returns + the element with the specified unique ID. */ any getByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); - /** @missing + /** removes the element with the specified unique ID from this + container. */ void removeByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); }; @@ -96,24 +96,4 @@ interface XUniqueIDAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:45 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:31 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:04 hjs - initial import - - Revision 1.3 2000/09/11 11:52:17 mi - documentation merged from XML - - Revision 1.1 1999/11/22 17:53:26 tlx - UniqueIDs - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/io/MarkableOutputStream.idl b/udkapi/com/sun/star/io/MarkableOutputStream.idl index 299189ef4..e446c62bd 100644 --- a/udkapi/com/sun/star/io/MarkableOutputStream.idl +++ b/udkapi/com/sun/star/io/MarkableOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: MarkableOutputStream.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,7 +87,12 @@ module com { module sun { module star { module io { */ service MarkableOutputStream { - /** allows to write data at the current position */ + /** allows to write data at the current position. + <p> Flushing the outputstream will only flush data, + which was written before the first non-deleted mark, + because data after the first non-deleted mark + may be modified by later jumpToMark()/writeBytes() calls. + */ interface com::sun::star::io::XOutputStream; /** allows to create marks at the current position diff --git a/udkapi/com/sun/star/io/TextInputStream.idl b/udkapi/com/sun/star/io/TextInputStream.idl index 0e85d3280..4ab0767c1 100644 --- a/udkapi/com/sun/star/io/TextInputStream.idl +++ b/udkapi/com/sun/star/io/TextInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextInputStream.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,20 @@ module com { module sun { module star { module io { //============================================================================= - -// DocMerge from xml: service com::sun::star::io::TextInputStream -/** reads the data through a chained stream. - - @guarantees - thread safe - - @guarantees - allow buffer size is 2 ^ 31 -1 - </ul> +/** provides functionality to read text data from a + <type scope="com::sun::star::io">XInputStream</type> + that initially has to be passed to the method + <member>XActiveDataSink::setInputStream()</member>. + + <p>For details about the text functionality see + <type scope="com::sun::star::io">XTextInputStream</type>. */ service TextInputStream { - // DocMerge: empty anyway + /// Interface to read text data interface com::sun::star::io::XTextInputStream; - // DocMerge: empty anyway + /// Interface to specify the used <type scope="com::sun::star::io">XInputStream</type> interface com::sun::star::io::XActiveDataSink; }; @@ -104,22 +101,4 @@ service TextInputStream }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:36 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:23 hjs - initial import - - Revision 1.3 2000/09/11 11:52:31 mi - documentation merged from XML - - Revision 1.1 2000/08/01 07:13:39 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/io/TextOutputStream.idl b/udkapi/com/sun/star/io/TextOutputStream.idl index f789aacc9..e3ed390a2 100644 --- a/udkapi/com/sun/star/io/TextOutputStream.idl +++ b/udkapi/com/sun/star/io/TextOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: TextOutputStream.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,23 +75,20 @@ module com { module sun { module star { module io { //============================================================================= - -// DocMerge from xml: service com::sun::star::io::TextOutputStream -/** writes its data to a chained <type>XOutputStream</type>. +/** provides functionality to write text data to a + <type scope="com::sun::star::io">XOutputStream</type> + that initially has to be passed to the method + <member>XActiveDataSource::setOutputStream()</member>. - @guarantees - thread safe - - @guarantees - allow buffer size is 2 ^ 31 -1 - </ul> + <p>For details about the text functionality see + <type scope="com::sun::star::io">XTextOutputStream</type>. */ service TextOutputStream { - // DocMerge: empty anyway + /// Interface to write text data interface com::sun::star::io::XTextOutputStream; - // DocMerge: empty anyway + /// Interface to specify the used <type scope="com::sun::star::io">XOutputStream</type> interface com::sun::star::io::XActiveDataSource; }; @@ -100,22 +97,4 @@ service TextOutputStream }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:36 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:23 hjs - initial import - - Revision 1.3 2000/09/11 11:52:31 mi - documentation merged from XML - - Revision 1.1 2000/08/01 07:13:56 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl index 29792f963..29ae4b160 100644 --- a/udkapi/com/sun/star/io/XInputStream.idl +++ b/udkapi/com/sun/star/io/XInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInputStream.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -134,11 +134,20 @@ interface XInputStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XInputStream::readSomeBytes - /** reads the available number of bytes at maximum + /** reads the available number of bytes, at maximum <var>nMaxBytesToRead</var>. - <p>This method blocks the thread until at least one byte is - available. </p> + <p>This method is very similar to the readBytes method, except that + it has different blocking behaviour. + The method blocks as long as at least 1 byte is available or + EOF has been reached. EOF has only been reached, when the method + returns 0 and the corresponding byte sequence is empty. + Otherwise, after the call, aData contains the available, + but no more than nMaxBytesToRead, bytes. + @param aData contains the data read from the stream. + @param nMaxBytesToRead The maximum number of bytes to be read from this + stream during the call. + @see com::sun::star::io::XInputStream::readBytes */ long readSomeBytes( [out] sequence<byte> aData, [in] long nMaxBytesToRead ) @@ -196,6 +205,12 @@ interface XInputStream: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.10.2.1 2002/06/05 16:38:40 jbu + documentation reviewed + + Revision 1.10 2002/01/18 13:41:36 jbu + #96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl + Revision 1.9 2001/11/16 14:45:32 mi proofing by Richard Holt diff --git a/udkapi/com/sun/star/io/XInputStreamProvider.idl b/udkapi/com/sun/star/io/XInputStreamProvider.idl index 76d26e271..91fb1df19 100644 --- a/udkapi/com/sun/star/io/XInputStreamProvider.idl +++ b/udkapi/com/sun/star/io/XInputStreamProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInputStreamProvider.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:45:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * 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 io { //============================================================================= /** Interface for providing an input stream. - When calling createInputStream() you get a fresh input stream to read from, - anytime, providing the same data. + + <p>Every time createInputStream() is called a new input stream + is returned, always pointing to the begin of the same data. All + input streams returned by <member>createInputStream()</member> + are completely independend from each other.</p> */ interface XInputStreamProvider : com::sun::star::uno::XInterface { - /** Creates a new input stream providing the same data. + /** Creates a new input stream, every time providing + the same data. @return a new input stream @@ -88,15 +92,4 @@ interface XInputStreamProvider : com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.2 2001/03/16 15:10:36 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.1 2001/03/14 16:43:47 dbo - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/io/XObjectInputStream.idl b/udkapi/com/sun/star/io/XObjectInputStream.idl index 098450084..93f25ec09 100644 --- a/udkapi/com/sun/star/io/XObjectInputStream.idl +++ b/udkapi/com/sun/star/io/XObjectInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XObjectInputStream.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,15 +80,16 @@ module com { module sun { module star { module io { //============================================================================= -// DocMerge from idl: interface com::sun::star::io::XObjectInputStream -/** makes it possible to load the data and structure of runtime objects. +/** reads XPersistObject implementations from a stream */ interface XObjectInputStream: com::sun::star::io::XDataInputStream { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::io::XObjectInputStream::readObject - /** reads an object from the stream. + /** reads an object from the stream. In general, it + reads the service name, instantiaties the object and + calls read on the XPersistObject interface with itself + as argument. */ com::sun::star::io::XPersistObject readObject() raises( com::sun::star::io::IOException ); @@ -102,6 +103,12 @@ interface XObjectInputStream: com::sun::star::io::XDataInputStream /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.16.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.6 2001/03/16 15:10:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2000/12/11 16:09:49 mi documentation syntax fixed and some minor semantic documentation fixes diff --git a/udkapi/com/sun/star/io/XObjectOutputStream.idl b/udkapi/com/sun/star/io/XObjectOutputStream.idl index b79c7bb44..31d0aa7e7 100644 --- a/udkapi/com/sun/star/io/XObjectOutputStream.idl +++ b/udkapi/com/sun/star/io/XObjectOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XObjectOutputStream.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:43:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,33 +77,18 @@ interface XPersistObject; //============================================================================= -// DocMerge from xml: interface com::sun::star::io::XObjectOutputStream -/** makes it possible to store the data and structure of runtime objects. +/** stores XPersistObject implementations into the stream - <p>In every case all participating objects have to be stored or - loaded at the same time. To be able to load objects, for each object - class in the stream, a factory is needed. These factories are - <type scope="com::sun::star::lang">XMultiServiceFactory</type>, which are - registered at the global service manager. </p> + <p>An implementation of the type <type>XPersistObject</type> + uses this interface to write its internal state into a stream. + Have a look there for the explanation of the concept. - @example - <p>Given: Object A refers to B, B to C and C to A and D. The order - of storing and loading these objects is irrelevant, but it must be - the same for each action: </p> - - <ul> - <li>storing: A,B,C,D; loading: A,B,C,D is correct </li> - <li>storing: B,A,C,D; loading: B,A,C,D is correct </li> - <li>storing: C,A,B,D; loading: A,B,C,D is wrong </li> - <li>storing: A,B,C,D; loading: A,B,C is wrong</li> - </ul> + @see com::sun::star::io::XPersistObject */ interface XObjectOutputStream: XDataOutputStream { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XObjectOutputStream::writeObject /** writes an object to the stream. + @param Object the object, which shall serialize itself into the stream. */ void writeObject( [in] XPersistObject Object ) raises( IOException ); @@ -117,6 +102,12 @@ interface XObjectOutputStream: XDataOutputStream /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.16.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.6 2001/03/16 15:10:36 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2000/12/11 16:09:49 mi documentation syntax fixed and some minor semantic documentation fixes diff --git a/udkapi/com/sun/star/io/XPersistObject.idl b/udkapi/com/sun/star/io/XPersistObject.idl index b4f0a33c3..c4acbcee2 100644 --- a/udkapi/com/sun/star/io/XPersistObject.idl +++ b/udkapi/com/sun/star/io/XPersistObject.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPersistObject.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,22 +79,40 @@ interface XObjectOutputStream; //============================================================================= -// DocMerge from xml: interface com::sun::star::io::XPersistObject -/** makes it possible to write the corresponding object to a stream. +/** allows to make UNO objects persistent + + <p>Every UNO object, that wants to be serializable, should implement + this interface. The object stores stores itself, when the + write method is called. + <p> + The object needs to be created before it deserializes + itself again (by using the read method). Therefor it must be + createable by name via a factory, which is in general + the global service manager. The create and read mechanism + is implemented by the <type>com::sun::star::io::ObjectInputStream</type>. + + <p>The serialization format (the series of strings, integers, objects) must + be specified at the specification of the concrete service. + + <p>The interface does not support any special versioning mechanism. + + @see com::sun::star::io::XObjectOutputStream + @see com::sun::star::io::XObjectInputStream */ interface XPersistObject: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from idl: method com::sun::star::io::XPersistObject::getServiceName - /** @returns + /** gives the service name of the object + + @returns the service name that specifies the behavior and the persistent data format of this implementation. - <p>This name can be used to create such an object by a factory + <p>This name is used to create such an object by a factory during deserialization. </p> - @see XServiceName::getServiceName + @see com::sun::star::lang::XServiceInfo::getAvailableServiceNames */ string getServiceName(); @@ -102,6 +120,10 @@ interface XPersistObject: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XPersistObject::write /** writes all the persistent data of the object to the stream. + <p>The implementation + must write the data in the order documented in the service specification. + @param OutStream the stream, the data shall be written to. The stream + supports simple types and other XPersistObject implementations. */ void write( [in] com::sun::star::io::XObjectOutputStream OutStream ) raises( com::sun::star::io::IOException ); @@ -110,6 +132,12 @@ interface XPersistObject: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XPersistObject::read /** reads all the persistent data of the object from the stream. + <p>In case + other XPersistObjects are read from the stream, the implementation uses a factory + to create these objects (in general the global service manager). + <p> The implementation must read the data in the order documented at + the service specification. + @param InStream the stream, the data shall be read from. */ void read( [in] com::sun::star::io::XObjectInputStream InStream ) raises( com::sun::star::io::IOException ); @@ -123,6 +151,12 @@ interface XPersistObject: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7.2.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.7 2002/01/18 13:41:36 jbu + #96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl + Revision 1.6 2001/03/16 15:10:36 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/io/XTextInputStream.idl b/udkapi/com/sun/star/io/XTextInputStream.idl index c74a64e26..970ed7e7e 100644 --- a/udkapi/com/sun/star/io/XTextInputStream.idl +++ b/udkapi/com/sun/star/io/XTextInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextInputStream.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,58 +75,75 @@ module com { module sun { module star { module io { //============================================================================= - -// DocMerge from xml: interface com::sun::star::io::XTextInputStream -/** makes it possible to read machine-independent simple data types from a - stream. +/** Interface to read strings from a stream. + + <p>This interfaces allows to read strings seperated by + delimiters and to read lines. The character encoding + to be used can be set by <member>setEncoding()</member>. + Default encoding is "utf8".</p> */ interface XTextInputStream: com::sun::star::io::XInputStream { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextInputStream::readLine - /** reads text until a line break (CR, LF, or CR/LF) or EOF is found - and returns it as string (without CR, LF). + /** reads text until a line break (CR, LF, or CR/LF) or + EOF is found and returns it as string (without CR, LF). + + <p>The read characters are converted according to the + encoding defined by <member>setEncoding</member>. If + EOF is already reached before calling this method + an empty string is returned.<p> - <p>The read characters are converted according to the encoding defined - by <member>XTextInputStream::setEncoding</member>. + @see setEncoding + @see isEOF */ string readLine() raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextInputStream::readString - /** reads text until one of the given delimiter characters or EOF is found. + /** reads text until one of the given delimiter characters + or EOF is found and returns it as string (without delimiter). - <p>Important: CR/LF is not used as default delimiter! So if no delimiter - is defined or none of the delimiters is found, the stream will be read - to EOF. The read characters are converted according to the encoding - defined by <member>XTextInputStream::setEncoding</member>. + <p><strong>Important:</strong> CR/LF is not used as default + delimiter! So if no delimiter is defined or none of the + delimiters is found, the stream will be read to EOF. The + read characters are converted according to the encoding + defined by <member>setEncoding</member>. If EOF is already + reached before calling this method an empty string is returned.</p> @see setEncoding + @see isEOF */ string readString( [in] sequence<char> Delimiters, [in] boolean bRemoveDelimiter ) raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextInputStream::isEOF - /** @returns - <TRUE/>, if the end of file is reached, so that no next string can be read. + /** Returns the EOF status. - @see setEncoding + <p>This method has to be used to detect if the end + of the stream is reached.</p> + <p><strong>Important:</strong> + This cannot be detected by asking for an empty string + because that can be a valid return value of <member> + readLine()</member> (if the line is empty) and + readString() (if a delimiter is directly followed + by the next one).</p> + + @returns + <TRUE/>, if the end of file is reached, so that + no next string can be read. <FALSE/> otherwise */ boolean isEOF() raises( com::sun::star::io::IOException ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextInputStream::setEncoding /** sets character encoding. - @incomplete + @param Encoding + sets the character encoding that should be used. + The character encoding names refer to the document + http://www.iana.org/assignments/character-sets. + Which character sets are supported depends on + the implementation. */ void setEncoding( [in] string Encoding ); }; @@ -135,25 +152,4 @@ interface XTextInputStream: com::sun::star::io::XInputStream }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/11 16:09:49 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:36 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:24 hjs - initial import - - Revision 1.3 2000/09/11 11:52:32 mi - documentation merged from XML - - Revision 1.1 2000/08/01 07:18:12 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/io/XTextOutputStream.idl b/udkapi/com/sun/star/io/XTextOutputStream.idl index 44b8cead7..d3027f1c2 100644 --- a/udkapi/com/sun/star/io/XTextOutputStream.idl +++ b/udkapi/com/sun/star/io/XTextOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTextOutputStream.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:45:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:00 $ * * 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 io { //============================================================================= - -// DocMerge from xml: interface com::sun::star::io::XTextOutputStream -/** makes it possible to write machine-independent simple data types to a - stream. +/** Interface to write strings to a stream using a special + character encoding. + + <p>This interfaces allows to write strings to a stream. + The character encoding to be used can be set by <member> + setEncoding()</member>. Default encoding is "utf8".</p> */ interface XTextOutputStream: com::sun::star::io::XOutputStream { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextOutputStream::writeString - /** writes a string using the encoding defined by - <member>XTextOutputStream::setEncoding</member>. + /** writes a string to the stream using the encoding + defined by <member>setEncoding</member>. - <p>Line breaks or delimiters that may be neccessary to support - <member>XTextInputStream::readLine</member> and - <member>XTextInputStream::readString</member> - have to be added manually to the parameter string. + <p>Line breaks or delimiters that may be neccessary + to support <member>XTextInputStream::readLine</member> + and <member>XTextInputStream::readString</member> + have to be added manually to the parameter string.</p> @see setEncoding @see XTextInputStream::readLine @@ -101,11 +101,14 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream raises( com::sun::star::io::IOException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::io::XTextOutputStream::setEncoding /** sets character encoding. - @incomplete + @param Encoding + sets the character encoding that should be used. + The character encoding names refer to the document + http://www.iana.org/assignments/character-sets. + Which character sets are supported depends on + the implementation. */ void setEncoding( [in] string Encoding ); }; @@ -114,30 +117,4 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 15:10:36 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/11 16:09:49 mi - documentation syntax fixed and some minor semantic documentation fixes - - Revision 1.4 2000/11/08 12:28:36 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:24 hjs - initial import - - Revision 1.3 2000/09/11 11:52:32 mi - documentation merged from XML - - Revision 1.1 2000/08/01 07:18:01 ab - new - - Revision 1.1.1.1 1999/11/11 09:48:43 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/lang/XEventListener.idl b/udkapi/com/sun/star/lang/XEventListener.idl index 22b3b55d0..e0e4df884 100644 --- a/udkapi/com/sun/star/lang/XEventListener.idl +++ b/udkapi/com/sun/star/lang/XEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jbu $ $Date: 2002-01-18 13:39:36 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:03 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,6 +91,10 @@ interface XEventListener: com::sun::star::uno::XInterface No method should be invoked anymore on this object ( including <member>XComponent::removeEventListener</member> ). </p> + + <p>This method is called for every listener registration + of derived listener interfaced, not only for registrations + at <type>XComponent</type>. </p> */ void disposing( [in] com::sun::star::lang::EventObject Source ); @@ -103,6 +107,12 @@ interface XEventListener: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7.2.1 2002/03/18 15:48:12 mi + disposing is called even without registering at XComponent + + Revision 1.7 2002/01/18 13:39:36 jbu + #96701# API review + Revision 1.6 2001/03/16 15:10:37 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/lang/XTypeProvider.idl b/udkapi/com/sun/star/lang/XTypeProvider.idl index 62a4cae5e..ab8196d05 100644 --- a/udkapi/com/sun/star/lang/XTypeProvider.idl +++ b/udkapi/com/sun/star/lang/XTypeProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTypeProvider.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:04 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,31 +75,31 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: interface com::sun::star::lang::XTypeProvider /** interface to get information about the types (usually interface types) supported by an object. */ interface XTypeProvider: com::sun::star::uno::XInterface { - - // DocMerge from idl: method com::sun::star::lang::XTypeProvider::getTypes - /** @returns - Sequence of all types (usually interface types) provided by the object. - Important: If the object aggregates other objects the sequence also has - to contain all types supported by the aggregated objects. + + /** returns + a sequence of all types (usually interface types) provided by the object. + Important: If the object aggregates other objects the sequence also has + to contain all types supported by the aggregated objects. */ sequence<type> getTypes(); - // DocMerge from idl: method com::sun::star::lang::XTypeProvider::getImplementationId - /** @returns - a UUID as sequence of 16 bytes as an Id that can be used to unambiguously - to distinguish between two sets of types, e.g., to realise hashing functionality - when the object is introspected. Two objects that return the same UUID also - have to return the same set of types in getTypes(). If a unique implementation - Id cannot be provided this method has to return an empty sequence. - Important: If the object aggregates other objects the UUID has to be unique - for the whole combination of objects. + /** returns + a sequence of bytes with length > 0 that is used as an Id to distinguish + unambiguously between two sets of types, e.g. to realise hashing + functionality when the object is introspected. Two objects that return + the same UUID also have to return the same set of types in getTypes(). + + If a unique implementation Id cannot be provided this method has to return + an empty sequence. + + Important: If the object aggregates other objects the UUID has to be unique + for the whole combination of objects. */ sequence<byte> getImplementationId(); }; @@ -108,33 +108,6 @@ interface XTypeProvider: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/03/16 15:10:37 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.6 2001/01/31 09:45:41 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.5 2000/12/13 15:47:01 mi - symtactical documentation and minor semantic documentation flaws fixed - - Revision 1.4 2000/11/08 12:28:41 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:25 hjs - initial import - - Revision 1.3 2000/09/11 11:52:33 mi - documentation merged from XML - - Revision 1.1 2000/01/14 10:57:01 jsc - #71616# Typumstellung - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl index 1bd64175d..df1445e16 100644 --- a/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl +++ b/udkapi/com/sun/star/loader/CannotActivateFactoryException.idl @@ -2,9 +2,9 @@ * * $RCSfile: CannotActivateFactoryException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:58:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,10 +71,16 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::loader::CannotActivateFactoryException -/** is thrown when an application tries to activate a component factory using the +/** indicates an error during component activation + <p> This exception is thrown when an application tries to + activate a component factory using the <member>XImplementationLoader::activate()</member> method, but the component factory can not be activated. + <p> + Possible reasons for this error is a missing shared library or .jar file, + a badly linked library, a wrong LD_LIBRARY_PATH or PATH, an incomplete + classpath, or a missing java installation. The Message should + contain some more detailed explanations. */ exception CannotActivateFactoryException: com::sun::star::uno::Exception { @@ -87,6 +93,12 @@ exception CannotActivateFactoryException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.5 2001/11/16 14:58:45 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:45 mi moved from api diff --git a/udkapi/com/sun/star/loader/Dynamic.idl b/udkapi/com/sun/star/loader/Dynamic.idl index c7c23e9f3..ab424b829 100644 --- a/udkapi/com/sun/star/loader/Dynamic.idl +++ b/udkapi/com/sun/star/loader/Dynamic.idl @@ -2,9 +2,9 @@ * * $RCSfile: Dynamic.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:58:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,8 @@ interface XImplementationLoader; /** makes it possible to access services accessible via a <code>UnoUrlResolver</code> - E.g., instantiation of services in another process + E.g., instantiation of services in another process. This service is still in an + experimental state and should not be used in a production environment. */ service Dynamic { @@ -89,8 +90,7 @@ service Dynamic interface XImplementationLoader; - /** provides additional information about the implementations - and the services supported by them. + /** gives information about other supported services */ interface com::sun::star::lang::XServiceInfo; }; diff --git a/udkapi/com/sun/star/loader/Java.idl b/udkapi/com/sun/star/loader/Java.idl index 9186d128d..7312ebca0 100644 --- a/udkapi/com/sun/star/loader/Java.idl +++ b/udkapi/com/sun/star/loader/Java.idl @@ -2,9 +2,9 @@ * * $RCSfile: Java.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,21 +71,19 @@ interface XImplementationLoader; // DocMerge from xml: service com::sun::star::loader::Java -/** makes it possible to access the services implemented in a Java class file. +/** allows to access a java component stored with a .jar file */ service Java { - // DocMerge from xml: service com::sun::star::loader::Java: interface com::sun::star::loader::XImplementationLoader /** is used for writing persistent information in the registry for - external implementation and for activating this implementation. + external implementation and for activating this implementation. The + locationUrls must be absolute file urls. */ interface XImplementationLoader; - // DocMerge from xml: service com::sun::star::loader::Java: interface com::sun::star::lang::XServiceInfo - /** provides additional information about the implementations - and the services supported by them. + /** gives information about other supported services */ interface com::sun::star::lang::XServiceInfo; }; @@ -98,6 +96,12 @@ service Java Source Code Control System - Update $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.4 2000/11/08 12:28:45 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:27 hjs initial import diff --git a/udkapi/com/sun/star/loader/SharedLibrary.idl b/udkapi/com/sun/star/loader/SharedLibrary.idl index f72f2ada9..76c6421e1 100644 --- a/udkapi/com/sun/star/loader/SharedLibrary.idl +++ b/udkapi/com/sun/star/loader/SharedLibrary.idl @@ -2,9 +2,9 @@ * * $RCSfile: SharedLibrary.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,11 @@ interface XImplementationLoader; -// DocMerge from xml: service com::sun::star::loader::SharedLibrary -/** makes it possible to access the services implemented in a shared library. +/** allows to access a native component stored in a shared library. */ service SharedLibrary { - // DocMerge from xml: service com::sun::star::loader::SharedLibrary: interface com::sun::star::loader::XImplementationLoader /** is used for writing persistent information in the registry for an external implementation and for activating this implementation. @@ -84,9 +82,7 @@ service SharedLibrary interface XImplementationLoader; - // DocMerge from xml: service com::sun::star::loader::SharedLibrary: interface com::sun::star::lang::XServiceInfo - /** provides additional information about the implementations - and the services supported by them. + /** gives information about other supported services */ interface com::sun::star::lang::XServiceInfo; }; @@ -98,6 +94,12 @@ service SharedLibrary Source Code Control System - Update $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.4 2000/11/08 12:28:45 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/loader/XImplementationLoader.idl b/udkapi/com/sun/star/loader/XImplementationLoader.idl index e9d5af87c..a24c373ee 100644 --- a/udkapi/com/sun/star/loader/XImplementationLoader.idl +++ b/udkapi/com/sun/star/loader/XImplementationLoader.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImplementationLoader.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:05 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,15 +83,40 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::loader::XImplementationLoader -/** defines the interface for classes that manage all the work needed to instantiate an implementation.@see XImplementationRegistration +/** handles activation (loading) of a UNO component. + @see com::sun::star::registry::XImplementationRegistration */ interface XImplementationLoader: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::loader::XImplementationLoader::activate - /** activates an external service factory. + /** activates a concrete implementation within a component. + @param implementationName The name of the implementation, + which shall be instantiated. The method + <member>XImplementationLoader::writeRegistryInfo</member> + writes a list of implementation names hosted by this component. + @param implementationLoaderUrl specification bug, ignore this parameter, please + pass an empty string. + @param locationUrl Points to the location of the file containing + the component (for instance a .jar-file or a shared library). + This parameter + should be in an URL format (= protocol:protocol-dependent-part). + In case the string contains no + leading "protocol:", the implementation in general assumes, + that it is a relative file url. <p>Special loaders may define + their own protocol (for instance an executable loader may need + more than only one file url). + + @param xKey A registry which may be used to read static data previously + written via <method>XImplementationLoader::writeRegistryInfo()</method>. + The use of this parameter is deprecated. + + @return returns a factory interface, which allows to create an instance of + the concrete implementation. In general, the object supports a + <type>com::sun::star::lang::XSingleComponentFactory</type> + and the <type>com::sun::star::lang::XServiceInfo</type> interface. The + XServiceInfo interface informs about the capabilities of the + service implementation, not the factory itself. */ com::sun::star::uno::XInterface activate( [in] string implementationName, [in] string implementationLoaderUrl, @@ -100,11 +125,23 @@ interface XImplementationLoader: com::sun::star::uno::XInterface raises( com::sun::star::loader::CannotActivateFactoryException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::loader::XImplementationLoader::writeRegistryInfo - /** writes information about implementations in the registry. An implementation supports one or more services. This - and more information will be written in the registry. This function is called when an implementation - is registered.@see com::sun::star::repos::XImplementationRegistration + /** writes a list of all implementations hosted by this component into a registry key. + <p>This method is called during registering a component. + @param xKey The registry key, which shall be used to write for each + implementation the implementation name plus a list of supported + services. + @param implementationLoaderUrl specification bug, ignore this parameter, please + pass an empty string. + @param locationUrl Points to the location of the file containing + the component (for instance a .jar-file or a shared library). + This parameter + should be in an URL format (= protocol:protocol-dependent-part). + In case the string contains no + leading "protocol:", the implementation in general assumes, + that it is a relative file url. <p>Special loaders may define + their own protocol (for instance an executable loader may need + more than only one file url). + @see com::sun::star::registry::XImplementationRegistration */ boolean writeRegistryInfo( [in] com::sun::star::registry::XRegistryKey xKey, [in] string implementationLoaderUrl, @@ -120,6 +157,12 @@ interface XImplementationLoader: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/06/05 16:38:41 jbu + documentation reviewed + + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:45 mi moved from api diff --git a/udkapi/com/sun/star/reflection/CoreReflection.idl b/udkapi/com/sun/star/reflection/CoreReflection.idl index bfa7f3adf..eb0593436 100644 --- a/udkapi/com/sun/star/reflection/CoreReflection.idl +++ b/udkapi/com/sun/star/reflection/CoreReflection.idl @@ -2,9 +2,9 @@ * * $RCSfile: CoreReflection.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: dbo $ $Date: 2002-06-14 13:33:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,11 +92,11 @@ service CoreReflection }; /** Accessable singleton to CoreReflection instance. -*/ singleton theCoreReflection { service CoreReflection; }; +*/ //============================================================================= @@ -105,6 +105,9 @@ singleton theCoreReflection /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8 2002/06/14 13:33:02 dbo + #100075# corereflection singleton + Revision 1.7 2002/03/08 17:19:13 dbo #96711# reviewed reflection API documentation diff --git a/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl b/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl index 06ee83244..7b94f6f85 100644 --- a/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl +++ b/udkapi/com/sun/star/registry/CannotRegisterImplementationException.idl @@ -2,9 +2,9 @@ * * $RCSfile: CannotRegisterImplementationException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:15:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,11 +73,16 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::registry::CannotRegisterImplementationException -/** is thrown when an application tries to register an implementation using the +/** is thrown when an application tries to register a new component (implementation) using the <member>XImplementationRegistration::registerImplementation()</member> - method, but the component cannot be registered. - - @see XIdlReflection::forName + method, but the component cannot be registered. The reason for this exception could be:<br> + <br><ul> + <li>the component cannot be found or cannot be loaded (missing path or classpath) + <li>the component doesn't provide the necessary specifactions (exported registration functions for a + C++ component (shared library) or a named registration class with the appropriate methods for + a Java component (normally a jar file)). + </ul><br> + */ exception CannotRegisterImplementationException: com::sun::star::uno::Exception { @@ -90,6 +95,12 @@ exception CannotRegisterImplementationException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.20.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.5 2000/12/19 16:15:28 mi + documentation syntax fixed + Revision 1.4 2000/11/08 12:28:50 mi moved from api diff --git a/udkapi/com/sun/star/registry/ImplementationRegistration.idl b/udkapi/com/sun/star/registry/ImplementationRegistration.idl index c0cca910b..1ad2540b7 100644 --- a/udkapi/com/sun/star/registry/ImplementationRegistration.idl +++ b/udkapi/com/sun/star/registry/ImplementationRegistration.idl @@ -2,9 +2,9 @@ * * $RCSfile: ImplementationRegistration.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,11 +73,10 @@ //============================================================================= // DocMerge from xml: service com::sun::star::registry::ImplementationRegistration -/** is the implementation of the interface XImplementationRegistration. - This service allows installation or deinstallation implementations. Further, it is - possible to check if all needed services are available to create a specified - implementation. - +/** is the implementation of the interface <type>XImplementationRegistration</type>. + This service can be used to install or uninstall components (implementations). + Further, it is possible to check if all runtime dependencies (needed services) are + available to use a specified component. Guarantees: <ul> @@ -98,6 +97,12 @@ service ImplementationRegistration /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.5 2001/11/16 15:05:59 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:50 mi moved from api diff --git a/udkapi/com/sun/star/registry/MergeConflictException.idl b/udkapi/com/sun/star/registry/MergeConflictException.idl index 48ddaad24..5b1260be9 100644 --- a/udkapi/com/sun/star/registry/MergeConflictException.idl +++ b/udkapi/com/sun/star/registry/MergeConflictException.idl @@ -2,9 +2,9 @@ * * $RCSfile: MergeConflictException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,8 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::registry::MergeConflictException -/** is thrown if entries of two registries are contradictory. +/** is thrown if entries of two registries are contradictory in the context of + <member>XSimpleRegistry::mergeKey()e</member> method. */ exception MergeConflictException: com::sun::star::uno::Exception { @@ -86,6 +87,12 @@ exception MergeConflictException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.4 2000/11/08 12:28:50 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:32 hjs initial import diff --git a/udkapi/com/sun/star/registry/NestedRegistry.idl b/udkapi/com/sun/star/registry/NestedRegistry.idl index b80ce1894..823f32f37 100644 --- a/udkapi/com/sun/star/registry/NestedRegistry.idl +++ b/udkapi/com/sun/star/registry/NestedRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: NestedRegistry.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -114,7 +114,7 @@ <br> </dt> - <dt>Functions of XRegistryKey: + <dt>Functions of <type>XRegistryKey</type>: <dl> <dt> <b>openKey</b> </dt> @@ -153,31 +153,22 @@ <b>Note: all write functions only work on registry1.</b> </dt> </dl> - - <br> - </dt> - <dt>How to initialize the registries: - <dl> - <dt> use a sequence of XSimpleRegistry with two elements. The first element must be + </dl> + <br> + How to initialize the registries:<br> + Use a sequence of <type>XSimpleRegistry</type> with two elements. The first element must be the registry which is opened with read/write rights and the second element must be - the read-only one. - </dt> - <dt> Two different ways are possible: - </dt> - <dd> - <dl> - <dt> use createInstanceWithArguments to create an instance of this service where the - value of the any parameter must be the sequence with the two open registries. - </dt> - <dt> use the initialize function of the XInitialization interface where the value of the + the read-only one.<br> + Two different ways are possible:<br> + <ul> + <li> use <member>com.sun.star.lang.XMultiServiceFactory::createInstanceWithArguments()</member> to + create an instance of this service where the value of the any parameter must be the sequence with + the two open registries. + <li> use the initialize function of the <type>XInitialization</type> interface where the value of the any parameter must be the sequence with the two open registries. - </dt> - </dl> - </dd> - </dl> - </dt> - </dl> + </ul> + <br> Guarantees: @@ -201,6 +192,12 @@ service NestedRegistry /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.6 2001/11/16 15:05:59 mi + proofing by Richard Holt + Revision 1.5 2000/12/19 14:17:15 mi documentation sytax fixed diff --git a/udkapi/com/sun/star/registry/SimpleRegistry.idl b/udkapi/com/sun/star/registry/SimpleRegistry.idl index 581ac33c2..465349308 100644 --- a/udkapi/com/sun/star/registry/SimpleRegistry.idl +++ b/udkapi/com/sun/star/registry/SimpleRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: SimpleRegistry.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:50 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:09 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,6 @@ /** makes it possible to create, open, or close a registry. Further, it is possible to merge a registry under a specified key in the open registry. - Guarantees: <ul> <li>-thread safe</li> @@ -96,6 +95,12 @@ service SimpleRegistry /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.4 2000/11/08 12:28:50 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:32 hjs initial import diff --git a/udkapi/com/sun/star/registry/XImplementationRegistration.idl b/udkapi/com/sun/star/registry/XImplementationRegistration.idl index c4063a6ac..73cace09a 100644 --- a/udkapi/com/sun/star/registry/XImplementationRegistration.idl +++ b/udkapi/com/sun/star/registry/XImplementationRegistration.idl @@ -2,9 +2,9 @@ * * $RCSfile: XImplementationRegistration.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:10 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,10 +89,14 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::registerImplementation - /** registers one or more implementations. + /** registers a component which provides one or more implementations. - <p>The location of the implementation is specified with the URL. - </p> + @param aLocation + specifies the location of the component with the URL. + + @param xReg + specifies the registry where the component should be installed. If it is a NULL interface + the component will be installed in the system registry. */ void registerImplementation( [in] string aImplementationLoader, [in] string aLocation, @@ -102,10 +106,14 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::registry::XImplementationRegistration::revokeImplementation - /** revokes one or more implementations from the registry. + /** revokes a component and all their provided implementations from the registry. - <p>The location of the implementation is specified with the URL. - </p> + @param aLocation + specifies the location of the component with the URL. + + @param xReg + specifies the registry where the component should be installed. If it is a NULL interface + the component will be revoked from the system registry. */ boolean revokeImplementation( [in] string aLocation, [in] com::sun::star::registry::XSimpleRegistry xReg ); @@ -115,15 +123,15 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::getImplementations /** @returns - the names of the implementations registered by the url location. + the names of the implementations registered by the url location. - @param aImplementationLoader - specifies the name of the needed loader for this type of implementation. For - example, the loader "com.sun.star.loader.SharedLibrary" for implementations - that are realized as an SharedLibrary. + @param aImplementationLoader + specifies the name of the needed loader for this type of implementation. For + example, the loader "com.sun.star.loader.SharedLibrary" for implementations + that are realized as an SharedLibrary. - @param aLocation - specifies the location of the implementation. + @param aLocation + specifies the location of the component with the URL. */ sequence<string> getImplementations( [in] string aImplementationLoader, [in] string aLocation ); @@ -133,7 +141,10 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::registry::XImplementationRegistration::checkInstantiation /** @returns - a sequence with names of the missing services to create an instance of this implementation. + a sequence with names of the missing services to create an instance of this implementation. + + @param implementationName + specifies the name of the checked implementation. */ sequence<string> checkInstantiation( [in] string implementationName ); @@ -146,6 +157,12 @@ interface XImplementationRegistration: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/03/26 14:24:17 jsc + #98365# reviewed + + Revision 1.6 2001/11/16 15:05:59 mi + proofing by Richard Holt + Revision 1.5 2001/03/16 15:10:39 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/registry/XRegistryKey.idl b/udkapi/com/sun/star/registry/XRegistryKey.idl index 5cfb080fe..dfbca6fe9 100644 --- a/udkapi/com/sun/star/registry/XRegistryKey.idl +++ b/udkapi/com/sun/star/registry/XRegistryKey.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRegistryKey.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:05:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:11 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,9 +92,6 @@ module com { module sun { module star { module registry { <p>This is the main interface for registry keys.<p> - @version 0.1 - @author Juergen Schmidt - @see XSimpleRegistry */ interface XRegistryKey: com::sun::star::uno::XInterface @@ -450,7 +447,7 @@ interface XRegistryKey: com::sun::star::uno::XInterface raises( com::sun::star::registry::InvalidRegistryException ); //------------------------------------------------------------------------- - /** deletes a key from the registry. + /** deletes a link from the registry. @param aLinkName specifies the relative path from the current key to @@ -466,7 +463,7 @@ interface XRegistryKey: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DOCUMENTATION CHANGED FOR XRegistryKey::getLinkTarget /** @returns - the target of the link specified by rLinkName. + the target (complete path of a key) of the link specified by rLinkName. @param rLinKName specifies the relative path from the current key to diff --git a/udkapi/com/sun/star/registry/XSimpleRegistry.idl b/udkapi/com/sun/star/registry/XSimpleRegistry.idl index 8f25b568b..96245893c 100644 --- a/udkapi/com/sun/star/registry/XSimpleRegistry.idl +++ b/udkapi/com/sun/star/registry/XSimpleRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleRegistry.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: jsc $ $Date: 2001-10-31 15:28:27 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:12 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,7 +83,11 @@ module com { module sun { module star { module registry { //============================================================================= -/** +/** allows access to a registry (a persistent data source). + The data is stored in a hierarchical key structure beginning with a root key. + Each key can store a value and can have multiple subkeys. + + @see XRegistryKey */ interface XSimpleRegistry: com::sun::star::uno::XInterface { diff --git a/udkapi/com/sun/star/script/AllEventObject.idl b/udkapi/com/sun/star/script/AllEventObject.idl index 27b805e9f..15b8d4da2 100644 --- a/udkapi/com/sun/star/script/AllEventObject.idl +++ b/udkapi/com/sun/star/script/AllEventObject.idl @@ -2,9 +2,9 @@ * * $RCSfile: AllEventObject.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,93 +75,40 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::AllEventObject /** This event is a wrapper for an original event in a forwarding event. - - <p> Usually the original event is the first argument in the array of arguments. </p> */ struct AllEventObject: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::AllEventObject::Helper - /** This contains a helper object for the implementation. - - + /** A helper value for the implementation that can be used arbitrarily. <p>This field reflects the third parameter of the method - - - - - - .</p> + <member>XAllListenerAdapterService::createAllListerAdapter</member>. + </p> */ any Helper; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::AllEventObject::ListenerType /** contains the type of the original listener. */ type ListenerType; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR AllEventObject::MethodName - - // DocMerge from xml: field com::sun::star::script::AllEventObject::MethodName /** The original method name on which the event was fired. */ string MethodName; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR AllEventObject::Arguments - - // DocMerge from idl: field com::sun::star::script::AllEventObject::Arguments /** The arguments of the original method. */ sequence<any> Arguments; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/01/31 09:45:41 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.7 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.5 2000/04/20 14:14:35 mm - #74031# better documentation - - Revision 1.4 2000/02/23 11:41:17 mi - results from proofreading in layouted version - - Revision 1.3 2000/02/07 11:24:50 mi - zu #70728# missing documentation marked - - Revision 1.2 2000/01/14 11:09:20 jsc - #71616# Typumstellung - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/AllListenerAdapter.idl b/udkapi/com/sun/star/script/AllListenerAdapter.idl index 87d6726ff..9983e4ef0 100644 --- a/udkapi/com/sun/star/script/AllListenerAdapter.idl +++ b/udkapi/com/sun/star/script/AllListenerAdapter.idl @@ -2,9 +2,9 @@ * * $RCSfile: AllListenerAdapter.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-14 12:57:26 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,48 +71,17 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: service com::sun::star::script::AllListenerAdapter /** makes it possible to generate the adapters from specific - interfaces to the interface <type>XAllListener</type>. - - - - <p>To ensure that the unoidl smart compiler generates stub code, use the - "createAllListener" = <TRUE/> switch in the mapping. The switch enables - code generation for the specified interface and all derived interfaces. - - </p> + interfaces to the interface <type>XAllListener</type>. */ service AllListenerAdapter { - // DocMerge: empty anyway + /// interface to create adapters for listener types interface com::sun::star::script::XAllListenerAdapterService; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:22 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/CannotCreateAdapterException.idl b/udkapi/com/sun/star/script/CannotCreateAdapterException.idl index 88de11c3a..8e478f4be 100644 --- a/udkapi/com/sun/star/script/CannotCreateAdapterException.idl +++ b/udkapi/com/sun/star/script/CannotCreateAdapterException.idl @@ -2,9 +2,9 @@ * * $RCSfile: CannotCreateAdapterException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,12 +71,12 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: exception com::sun::star::script::CannotCreateAdapterException /** is thrown by an attacher if an adapter service cannot create the - appropriate adapter.@see com::sun::star::script::XAllListenerAdapterService - @see com::sun::star::script::XEventAttacher - @see com::sun::star::script::XEventAttacherManager + appropriate adapter. + + @see com::sun::star::script::XAllListenerAdapterService + @see com::sun::star::script::XEventAttacher + @see com::sun::star::script::XEventAttacherManager */ exception CannotCreateAdapterException: com::sun::star::uno::Exception { @@ -86,24 +86,4 @@ exception CannotCreateAdapterException: com::sun::star::uno::Exception }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 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:35 hjs - initial import - - Revision 1.3 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/ContextInformation.idl b/udkapi/com/sun/star/script/ContextInformation.idl index 8af23a078..f52318cd7 100644 --- a/udkapi/com/sun/star/script/ContextInformation.idl +++ b/udkapi/com/sun/star/script/ContextInformation.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContextInformation.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,13 +67,12 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::ContextInformation /** provides information about a certain stack frame. + + @deprecated */ struct ContextInformation { - // DocMerge from xml: field com::sun::star::script::ContextInformation::Name /** Full qualified name to adress the module or function associated with the context. If the module or function can't be adressed by name, e.g., in case that a runtime generated eval-module is executed, this string is empty @@ -81,9 +80,6 @@ struct ContextInformation string Name; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ContextInformation::SourceCode - - // DocMerge from xml: field com::sun::star::script::ContextInformation::SourceCode /** Source code of the Module, that is associated with the context. If the source can be accessed using the ModuleName or if the source is unknown (executing compiled code) this string can be empty. @@ -91,13 +87,9 @@ struct ContextInformation string SourceCode; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::ContextInformation::StartLine /** contains the first line in the module's source code associated with the context. - - <p>If "name" addresses a function, all line and column values are nevertheless given relative to the module's source. If source code is not available, this value addresses a binary @@ -109,8 +101,6 @@ struct ContextInformation long StartLine; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::ContextInformation::StartColumn /** contains the first column in the <var>StartLine</var> associated with the context. */ @@ -118,25 +108,19 @@ struct ContextInformation //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::script::ContextInformation::EndLine /** contains the last line in the module's source code associated with the context. */ long EndLine; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::ContextInformation::EndColumn /** contains the first column in the <var>EndLine</var> that is NOT associated with the context. */ long EndColumn; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ContextInformation::LocalVariableNames - - // DocMerge from idl: field com::sun::star::script::ContextInformation::LocalVariableNames - /** * Get all names of the local variable in this context. + /** Get all names of the local variable in this context. */ sequence<string> LocalVariableNames; @@ -146,30 +130,4 @@ struct ContextInformation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/19 16:15:29 mi - documentation syntax fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:35 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/Engine.idl b/udkapi/com/sun/star/script/Engine.idl index 163bc8d2d..39cbb9a75 100644 --- a/udkapi/com/sun/star/script/Engine.idl +++ b/udkapi/com/sun/star/script/Engine.idl @@ -2,9 +2,9 @@ * * $RCSfile: Engine.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,10 +78,12 @@ <p>The implementation of this interface should supply the interfaces com.sun.star.script.XDebugging2 and interface com.sun.star.script.XInvocation.</p> + + @deprecated */ service Engine { - // DocMerge: empty anyway + /// The only interface of this service interface com::sun::star::script::XEngine; }; @@ -90,27 +92,4 @@ service Engine }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - 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:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/01/03 12:03:22 mi - reference manual - - Revision 1.2 1999/12/06 12:44:50 ab - #70472# Invokation -> Invocation - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/FinishEngineEvent.idl b/udkapi/com/sun/star/script/FinishEngineEvent.idl index 13f96b0c9..bda1a94d4 100644 --- a/udkapi/com/sun/star/script/FinishEngineEvent.idl +++ b/udkapi/com/sun/star/script/FinishEngineEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FinishEngineEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,24 +75,19 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::FinishEngineEvent /** event contains the reasons and the data for the <member>XEngineListener::finished()</member> method. + + @deprecated */ struct FinishEngineEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::FinishEngineEvent::Finish /** specifies why the script terminates. */ com::sun::star::script::FinishReason Finish; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FinishEngineEvent::ErrorMessage - - // DocMerge from xml: field com::sun::star::script::FinishEngineEvent::ErrorMessage /** error message. <p>Only valid if Reason is RuntimeError or CompileError.</p> @@ -100,12 +95,8 @@ struct FinishEngineEvent: com::sun::star::lang::EventObject string ErrorMessage; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::FinishEngineEvent::Return /** contains the return value. - - <p>This field is only valid if <member>FinishEngineEvent::Finish</member> is <const>FinishReason::OK</const>.</p> */ @@ -117,24 +108,4 @@ struct FinishEngineEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:35 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/FinishReason.idl b/udkapi/com/sun/star/script/FinishReason.idl index d18b3351f..507287e8d 100644 --- a/udkapi/com/sun/star/script/FinishReason.idl +++ b/udkapi/com/sun/star/script/FinishReason.idl @@ -2,9 +2,9 @@ * * $RCSfile: FinishReason.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:16 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,32 +67,23 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: enum com::sun::star::script::FinishReason /** contains the response for a scripting engine termination. + + @deprecated */ enum FinishReason { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FinishReason:: OK, - - // DocMerge from xml: value com::sun::star::script::FinishReason::OK /** script in the engine terminated normally. */ OK, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FinishReason:: Cancel, - - // DocMerge from xml: value com::sun::star::script::FinishReason::Cancel /** script in the engine was cancelled. */ Cancel, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FinishReason:: Error - - // DocMerge from xml: value com::sun::star::script::FinishReason::Error /** error occurred during script execution or compiling. */ Error @@ -103,27 +94,4 @@ enum FinishReason }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:35 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/InterruptEngineEvent.idl b/udkapi/com/sun/star/script/InterruptEngineEvent.idl index 6e88cd4e0..baf822828 100644 --- a/udkapi/com/sun/star/script/InterruptEngineEvent.idl +++ b/udkapi/com/sun/star/script/InterruptEngineEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: InterruptEngineEvent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,16 +75,13 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::InterruptEngineEvent /** describes an interrupt which occurs in the scripting engine. + + @deprecated */ struct InterruptEngineEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptEngineEvent::Name - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::Name /** fully qualified name to address the module or function affected by the event that took place. @@ -94,9 +91,6 @@ struct InterruptEngineEvent: com::sun::star::lang::EventObject string Name; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptEngineEvent::SourceCode - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::SourceCode /** source code of the Module affected by the event that took place. <p>If the source can @@ -106,8 +100,6 @@ struct InterruptEngineEvent: com::sun::star::lang::EventObject string SourceCode; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::StartLine /** contains the first line in the module's source code that is affected by the event that took place. @@ -124,41 +116,30 @@ struct InterruptEngineEvent: com::sun::star::lang::EventObject long StartLine; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::StartColumn /** contains the first column in the "StartLine" that is affected by the event that took place. */ long StartColumn; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::EndLine /** contains the last line in the module's source code that is affected by the event that took place. */ long EndLine; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::EndColumn /** contains the first column in the "EndLine" which is NOT affected by the event that took place. */ long EndColumn; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptEngineEvent::ErrorMessage - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::ErrorMessage /** error message. <p>Only valid if Reason is RuntimeError or CompileError.</p> */ string ErrorMessage; //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::InterruptEngineEvent::Reason /** contains the interrupt reason. */ com::sun::star::script::InterruptReason Reason; @@ -169,30 +150,4 @@ struct InterruptEngineEvent: com::sun::star::lang::EventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/19 16:15:29 mi - documentation syntax fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:35 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/InterruptReason.idl b/udkapi/com/sun/star/script/InterruptReason.idl index 00522c85b..03af8bec3 100644 --- a/udkapi/com/sun/star/script/InterruptReason.idl +++ b/udkapi/com/sun/star/script/InterruptReason.idl @@ -2,9 +2,9 @@ * * $RCSfile: InterruptReason.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,73 +67,49 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: enum com::sun::star::script::InterruptReason /** values used to specify the response for a scripting engine interrupt. + + @deprecated */ enum InterruptReason { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: Cancel, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::Cancel /** script execution was cancelled. */ Cancel, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: RuntimeError, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::RuntimeError /** runtime error occurred during script execution. */ RuntimeError, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: CompileError, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::CompileError /** script has invalid syntax. */ CompileError, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: BreakPoint, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::BreakPoint /** script stopped at a breakpoint. */ BreakPoint, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: Step, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::Step /** script stops because only one scripting engine command was executed. */ Step, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: StepOver, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::StepOver /** script stops because one step was executed. */ StepOver, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: StepOut, - - // DocMerge from xml: value com::sun::star::script::InterruptReason::StepOut /** script stops because it leaves a function. */ StepOut, //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR InterruptReason:: StepStatement - - // DocMerge from xml: value com::sun::star::script::InterruptReason::StepStatement /** script stop because one step was executed. */ StepStatement @@ -144,27 +120,4 @@ enum InterruptReason }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/Invocation.idl b/udkapi/com/sun/star/script/Invocation.idl index 7ff4dafa5..0b0f6fd93 100644 --- a/udkapi/com/sun/star/script/Invocation.idl +++ b/udkapi/com/sun/star/script/Invocation.idl @@ -2,9 +2,9 @@ * * $RCSfile: Invocation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,17 +71,20 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: service com::sun::star::script::Invocation /** factory service that allows construction of Invocation objects. <p>Invoke createInstanceWithArguments() of XSingleServiceFactory - to create an Invocation adapter for your object; - invoking createInstance() will fail.</p> + to create an Invocation adapter for the passed object (Invoking + createInstance() will fail).</p> + + <p> + The adapter has to support <type scope="com::sun::star::script">XInvocation</type>. + The adapter may also support <type scope="com::sun::star::script">XInvocation2</type>. + </p> */ service Invocation { - // DocMerge: empty anyway + /// Interface to specify the object to be mapped by the invocation service. interface com::sun::star::lang::XSingleServiceFactory; }; @@ -90,21 +93,4 @@ service Invocation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:22 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/InvocationAdapterFactory.idl b/udkapi/com/sun/star/script/InvocationAdapterFactory.idl index 4f1696064..5f646df11 100644 --- a/udkapi/com/sun/star/script/InvocationAdapterFactory.idl +++ b/udkapi/com/sun/star/script/InvocationAdapterFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvocationAdapterFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,23 @@ module com { module sun { module star { module script { //============================================================================= - -/** Service to create adapter objects giving types to be supported and a - an invocation interface incoming calls are delegated to. -*/ +/** Provides functionality to create an adapter that supports (a) + special interface type(s) and maps calls to the interface's + methods to an invocation interface. + + <p> + An adapter like this allows generic dispatch interfaces to + meet interface requirements, e.g. if a specific listener + interface has to be passed to an add...Listener method. + </p> + + <p> + The adapter has to support + <type scope="com::sun::star::script">XInvocationAdapterFactory</type>. + The adapter may also support + <type scope="com::sun::star::script">XInvocationAdapterFactory2</type>. + </p> + */ service InvocationAdapterFactory { /** Interface for creating adapter objects. @@ -86,6 +99,7 @@ service InvocationAdapterFactory @deprecated */ interface com::sun::star::script::XInvocationAdapterFactory; + /** Interface for creating adapter objects. */ interface com::sun::star::script::XInvocationAdapterFactory2; @@ -95,21 +109,4 @@ service InvocationAdapterFactory }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.3 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.1 1999/11/11 13:36:27 dbo - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/InvocationInfo.idl b/udkapi/com/sun/star/script/InvocationInfo.idl index 0e5239aa2..ffe82a392 100644 --- a/udkapi/com/sun/star/script/InvocationInfo.idl +++ b/udkapi/com/sun/star/script/InvocationInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvocationInfo.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -125,19 +125,4 @@ struct InvocationInfo }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.1 2000/09/15 11:49:02 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/JavaScript.idl b/udkapi/com/sun/star/script/JavaScript.idl index e3db9f3f7..fb795be97 100644 --- a/udkapi/com/sun/star/script/JavaScript.idl +++ b/udkapi/com/sun/star/script/JavaScript.idl @@ -2,9 +2,9 @@ * * $RCSfile: JavaScript.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:17 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,39 +71,21 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: service com::sun::star::script::JavaScript /** service is implementation of a JavaScript interpreter. <p>The interpreter should be similar to JavaScript 1.1. The exact behavior will be specified in future.</p> + + @deprecated */ service JavaScript { - // DocMerge: empty anyway + /// Parent service service com::sun::star::script::Engine; - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 2000/01/03 12:03:22 mi - reference manual - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/MemberType.idl b/udkapi/com/sun/star/script/MemberType.idl index 6463091b7..13e38f912 100644 --- a/udkapi/com/sun/star/script/MemberType.idl +++ b/udkapi/com/sun/star/script/MemberType.idl @@ -2,9 +2,9 @@ * * $RCSfile: MemberType.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,8 @@ module com { module sun { module star { module script { //============================================================================= -/** These values are used to specify a member accessible by XInvocation +/** These values are used to specify a member accessible by + <type>XInvocation</type>. */ enum MemberType { @@ -81,17 +82,5 @@ enum MemberType }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.1 2000/09/15 11:48:50 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/ScriptEvent.idl b/udkapi/com/sun/star/script/ScriptEvent.idl index dd221f824..ad139c8ef 100644 --- a/udkapi/com/sun/star/script/ScriptEvent.idl +++ b/udkapi/com/sun/star/script/ScriptEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ScriptEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,31 +71,19 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::ScriptEvent /** script event that gets delivered whenever a script event takes place. - - - - <p>For that to happen, a "ScriptEventDescriptor" must be registered at and attached to - an object by an <type>XEventAttacherManager</type>. - - </p> + + <p>For that to happen, a "ScriptEventDescriptor" must be registered at + and attached to an object by an <type>XEventAttacherManager</type>.</p> */ struct ScriptEvent: com::sun::star::script::AllEventObject { //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEvent::ScriptType - - // DocMerge from xml: field com::sun::star::script::ScriptEvent::ScriptType /** type of the script language as string; for example, "Basic" or "StarScript". */ string ScriptType; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEvent::ScriptCode - - // DocMerge from xml: field com::sun::star::script::ScriptEvent::ScriptCode /** script code as string. <p>The code has to correspond with the language @@ -109,24 +97,4 @@ struct ScriptEvent: com::sun::star::script::AllEventObject }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/ScriptEventDescriptor.idl b/udkapi/com/sun/star/script/ScriptEventDescriptor.idl index c45d92b4e..fac270d20 100644 --- a/udkapi/com/sun/star/script/ScriptEventDescriptor.idl +++ b/udkapi/com/sun/star/script/ScriptEventDescriptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: ScriptEventDescriptor.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,31 +67,22 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: struct com::sun::star::script::ScriptEventDescriptor /** describes an effect, especially a script to be executed, for a certain event given by the listener type and the name of the event method. */ struct ScriptEventDescriptor { - // DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ListenerType /** listener type as string, same as listener-XIdlClass.getName(). */ string ListenerType; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEventDescriptor::EventMethod - - // DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::EventMethod /** event method as string. */ string EventMethod; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEventDescriptor::AddListenerParam - - // DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::AddListenerParam /** data to be used if the addListener method needs an additional parameter. <p>If the type of this parameter is different from string, @@ -100,17 +91,11 @@ struct ScriptEventDescriptor string AddListenerParam; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEventDescriptor::ScriptType - - // DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ScriptType /** type of the script language as string; for example, "Basic" or "StarScript". */ string ScriptType; //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ScriptEventDescriptor::ScriptCode - - // DocMerge from xml: field com::sun::star::script::ScriptEventDescriptor::ScriptCode /** script code as string (the code has to correspond with the language defined by ScriptType). */ @@ -122,27 +107,4 @@ struct ScriptEventDescriptor }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.5 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.3 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XAllListener.idl b/udkapi/com/sun/star/script/XAllListener.idl index bd41c458c..1759f6802 100644 --- a/udkapi/com/sun/star/script/XAllListener.idl +++ b/udkapi/com/sun/star/script/XAllListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAllListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,64 +79,31 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XAllListener /** specifies a listener combining all methods of a listener interface in a single generic call. - - <p>Without any output parameters, it is possible to adapt any interface if the <type>XAllListenerAdapterService</type> can generate an adapter.</p> */ interface XAllListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XAllListener::firing /** gets called when an event occurs at the object. */ [oneway] void firing( [in] com::sun::star::script::AllEventObject iaEvent ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XAllListener::approveFiring /** gets called when a "vetoable event" occurs at the object. - - <p>That happens when the listener method raises an exception, - has a return value declared, or is not "oneway". - - </p> + has a return value declared, or is not "oneway".</p> */ any approveFiring( [in] com::sun::star::script::AllEventObject aEvent ) raises( com::sun::star::reflection::InvocationTargetException ); - }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 1999/12/06 12:45:16 ab - #70472# Invokation -> Invocation - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XAllListenerAdapterService.idl b/udkapi/com/sun/star/script/XAllListenerAdapterService.idl index 91149678e..483506872 100644 --- a/udkapi/com/sun/star/script/XAllListenerAdapterService.idl +++ b/udkapi/com/sun/star/script/XAllListenerAdapterService.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAllListenerAdapterService.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,22 +79,19 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XAllListenerAdapterService /** allows the generation of adapters from specific - interfaces to the <type>XAllListener</type>. + interfaces to the <type>XAllListener</type> interface. */ interface XAllListenerAdapterService: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XAllListenerAdapterService::createAllListerAdapter /** creates a wrapper from the listener of type <var>xListenerType</var> to the <type>XAllListener</type> listener. - You must call <code>return-&gt;queryInterface( ListenerType.getUik() )</code> - to get the correct listener interface. + To get the correct listener interface the returned + <type>com::sun::star::uno::XInterface</type> has to + be queried for it. */ com::sun::star::uno::XInterface createAllListerAdapter( [in] type xListenerType, [in] com::sun::star::script::XAllListener xListener, @@ -106,27 +103,4 @@ interface XAllListenerAdapterService: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/01/31 09:45:41 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 2000/01/14 11:09:20 jsc - #71616# Typumstellung - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XDebugging.idl b/udkapi/com/sun/star/script/XDebugging.idl index accd1d2ca..44de68452 100644 --- a/udkapi/com/sun/star/script/XDebugging.idl +++ b/udkapi/com/sun/star/script/XDebugging.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDebugging.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,14 +78,13 @@ // DocMerge from xml: interface com::sun::star::script::XDebugging /** makes it possible to set breakpoints in an interpreter. + + @deprecated */ interface XDebugging: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XDebugging::setBreakPoint - /** @returns - the source code line where the breakpoint was set. + /** returns the source code line where the breakpoint was set. <p>The value can differ from the parameter <var>nSourceCodeLine</var> when this is not a valid line to @@ -97,17 +96,15 @@ interface XDebugging: com::sun::star::uno::XInterface [in] boolean bOn ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::clearAllBreakPoints /** clears all breakpoints in the module set by "setBreakPoint". */ void clearAllBreakPoints( [in] string aModuleName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDebugging::eval - - // DocMerge from idl: method com::sun::star::script::XDebugging::eval - /** + /** Evaluates an expression. + + @returns the value of the expression as string. + @param CallStackPos Position in the call stack for which the expression should be evaluated. 0 is the top/actual position in the call in the call stack, 1 the next and so on. @@ -116,18 +113,12 @@ interface XDebugging: com::sun::star::uno::XInterface [in] short nCallStackPos ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDebugging::getStackTrace - - // DocMerge from idl: method com::sun::star::script::XDebugging::getStackTrace - /** Return the engine's stack trace of the current execute position. Line break is the delimiter. + /** Returns the engine's stack trace of the current execute position. Line break is the delimiter. */ sequence<string> getStackTrace(); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XDebugging::getContextInformation - /** @returns - more detailed information about a specified stack frame. + /** returns more detailed information about a specified stack frame. @param nCallStackPos specifies the position in the call stack for the @@ -136,17 +127,12 @@ interface XDebugging: com::sun::star::uno::XInterface com::sun::star::script::ContextInformation getContextInformation( [in] short nCallStackPos ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XDebugging::dumpVariable - - // DocMerge from xml: method com::sun::star::script::XDebugging::dumpVariable /** returns the value of the variable at the given stack position. */ string dumpVariable( [in] string aVariableName, [in] short nCallStackPos ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::setVariable /** sets the value of the specified variable within the specified stack frame. */ @@ -155,17 +141,12 @@ interface XDebugging: com::sun::star::uno::XInterface [in] short nCallStackPos ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XDebugging::isVariable - /** @returns - whether the given variable exists within the specified stack frame. + /** returns whether the given variable exists within the specified stack frame. */ boolean isVariable( [in] string aVariableName, [in] short nCallStackPos ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::stop /** stops the execution of the interpreter. <p>To continue with the execution, call <method>XDebugging::doContinue</method>. @@ -173,39 +154,27 @@ interface XDebugging: com::sun::star::uno::XInterface void stop(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::stepOver /** executes the next and only the next statement. - - <p>If the next statement is a function call, the function is executed completely.</p> */ void stepOver(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::stepIn /** executes the next and only the next statement. - - <p>If the next statement is a function call, only the function entered.</p> */ void stepIn(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::stepOut /** executes the program until the next return from this stack frame. */ void stepOut(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XDebugging::doContinue /** continues the program execution. */ void doContinue(); @@ -216,33 +185,4 @@ interface XDebugging: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.6 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.4 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.3 2000/02/23 11:41:17 mi - results from proofreading in layouted version - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XEngine.idl b/udkapi/com/sun/star/script/XEngine.idl index d13e19e4d..72d959157 100644 --- a/udkapi/com/sun/star/script/XEngine.idl +++ b/udkapi/com/sun/star/script/XEngine.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEngine.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:33:59 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,22 +76,18 @@ //============================================================================= - module com { module sun { module star { module script { +module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XEngine /** makes it possible to control a scripting engine. + + @deprecated */ interface XEngine: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::setRoot /** sets an interface to an object as a scripting root. - - <p>If the root object implements the XInvocation interface, then the engine uses this interface to set/get properties and call methods. @@ -100,22 +96,16 @@ interface XEngine: com::sun::star::uno::XInterface void setRoot( [in] com::sun::star::uno::XInterface xRoot ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::getRoot /** gets an interface to the object which is the scripting root. */ com::sun::star::uno::XInterface getRoot(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::setLibraryAccess /** sets an access object to get external functions. */ void setLibraryAccess( [in] com::sun::star::script::XLibraryAccess Library ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::compile /** compiles a script module in the scope of the root object. */ boolean compile( [in] string ModuleName, @@ -123,12 +113,8 @@ interface XEngine: com::sun::star::uno::XInterface [in] boolean CreateDebugInfo ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::run /** runs a script specified by a string. - - <p>The arguments given in <var>aArgs</var> can be ignored by the engine. The Script is executed synchronously.</p> */ @@ -137,12 +123,8 @@ interface XEngine: com::sun::star::uno::XInterface [in] sequence<any> aArgs ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::runAsync /** runs the script specified by a string and makes callbacks. - - <p>The arguments given in <var>aArgs</var> can be ignored by the engine. The script is executed asynchronously. @@ -154,25 +136,13 @@ interface XEngine: com::sun::star::uno::XInterface [in] com::sun::star::script::XEngineListener xCallback ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::cancel /** terminates the execution of the running script. - - - <p>The waiting queue (see - - - - - ) is - cleared too.</p> + <p>The waiting queue is cleared too.</p> */ void cancel(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::addEngineListener /** adds an engine listener. <p>It is suggested to allow multiple registration of the same listener, @@ -181,8 +151,6 @@ interface XEngine: com::sun::star::uno::XInterface void addEngineListener( [in] com::sun::star::script::XEngineListener Listener ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngine::removeEngineListener /** removes an engine listener. <p>It is suggested to allow multiple registration of the same listener, @@ -195,28 +163,5 @@ interface XEngine: com::sun::star::uno::XInterface //============================================================================= }; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 1999/12/06 12:45:40 ab - #70472# Invokation -> Invocation - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ + #endif diff --git a/udkapi/com/sun/star/script/XEngineListener.idl b/udkapi/com/sun/star/script/XEngineListener.idl index 278ba11d4..9e02070db 100644 --- a/udkapi/com/sun/star/script/XEngineListener.idl +++ b/udkapi/com/sun/star/script/XEngineListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEngineListener.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,40 +83,28 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XEngineListener /** makes it possible to receive events from a scripting engine. + + @deprecated */ interface XEngineListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngineListener::interrupt /** gets fired when an interrupt occurs during the script execution. - <p>If you call the method - - <!-- jrh: Does something go here? --> - - - , the - execution stops. So in this situation, the stack and variable - values are still available by using the appropriate <type>XDebugging</type> - methods. + <p>If you call the method, the execution stops. So in this situation, + the stack and variable values are still available by using the + appropriate <type>XDebugging</type> methods. </p> */ void interrupt( [in] com::sun::star::script::InterruptEngineEvent Evt ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngineListener::running /** gets fired when the script gets into execution state. */ void running( [in] com::sun::star::lang::EventObject Evt ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEngineListener::finished /** gets fired when the script execution has finished. */ void finished( [in] com::sun::star::script::FinishEngineEvent Evt ); @@ -127,24 +115,4 @@ interface XEngineListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.3 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XEventAttacher.idl b/udkapi/com/sun/star/script/XEventAttacher.idl index dfd9cda0d..d834c1087 100644 --- a/udkapi/com/sun/star/script/XEventAttacher.idl +++ b/udkapi/com/sun/star/script/XEventAttacher.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventAttacher.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -95,16 +95,12 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XEventAttacher /** makes it possible to attach script events given by a sequence of <type>ScriptEventDescriptor</type> structures to a given interface. */ interface XEventAttacher: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacher::attachListener /** registers the given "AllListener" object as a listener at the given interface by creating a suitable listener adapter and calling the "addListener" method corresponding to the @@ -121,24 +117,12 @@ interface XEventAttacher: com::sun::star::uno::XInterface com::sun::star::lang::ServiceNotRegisteredException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacher::attachSingleEventListener /** registers an object as a listener at the given interface by creating a suitable listener adapter and calling the method - -<!-- jrh: Why all the empty space? --> - - - - which corresponds to the - listener type. - - + which corresponds to the listener type. <p>Only the event corresponding to the given event method - will be delegated to <var>xAllListener</var>. - - </p> + will be delegated to <var>xAllListener</var>.</p> */ com::sun::star::lang::XEventListener attachSingleEventListener( [in] com::sun::star::uno::XInterface xTarget, [in] com::sun::star::script::XAllListener xAllListener, @@ -152,16 +136,10 @@ interface XEventAttacher: com::sun::star::uno::XInterface com::sun::star::lang::ServiceNotRegisteredException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacher::removeListener /** removes a listener object as a listener from the given interface. - - <p> This method can and should be used as a contrary method - to the two attach methods. - - </p> + to the two attach methods.</p> */ void removeListener( [in] com::sun::star::uno::XInterface xTarget, [in] string aListenerType, @@ -176,27 +154,4 @@ interface XEventAttacher: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:35 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - 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:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XEventAttacherManager.idl b/udkapi/com/sun/star/script/XEventAttacherManager.idl index de127f054..e90675cf9 100644 --- a/udkapi/com/sun/star/script/XEventAttacherManager.idl +++ b/udkapi/com/sun/star/script/XEventAttacherManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventAttacherManager.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2002-08-05 09:34:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,84 +87,66 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XEventAttacherManager /** registers listeners for specified events. */ interface XEventAttacherManager: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::registerScriptEvent /** registers one event for an object identified by its index. - - <p>If any object is attached under this index, then this - event is attached automatically. - - </p> - <p> + event is attached automatically.</p> + + <p>Exceptions of type <type scope="com::sun::star::beans">IntrospectionException</type> and <type scope="com::sun::star::script">CannotCreateAdapterException</type> - are thrown by <type>XEventAttacher</type> and are caught and ignored. - - </p> + that can be thrown by methods of <type>XEventAttacher</type> are caught + and ignored.</p> */ void registerScriptEvent( [in] long nIndex, [in] com::sun::star::script::ScriptEventDescriptor aScriptEvent ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::registerScriptEvents /** registers several events for an object identified by its index. - - - <p>The result is the same as if the method - - - - - - - were called once for each <type>ScriptEventDescriptor</type> - in the sequence. - - </p> + <p>The result is the same as if the method <member>registerScriptEvent + </member> was called once for each <type>ScriptEventDescriptor</type> + in the sequence.</p> + <p>If any object is attached under this index, then this - event is attached automatically. - <type scope="com::sun::star::beans">IntrospectionException</type> - and <type scope="com::sun::star::script">CannotCreateAdapterException</type> - from the <type>XEventAttacher</type> are caught and ignored. - - </p> + event is attached automatically (see <member>attach</member>)</p> + + <p>Exceptions of type + <type scope="com::sun::star::beans">IntrospectionException</type> and + <type scope="com::sun::star::script">CannotCreateAdapterException</type> + that can be thrown by methods of <type>XEventAttacher</type> are caught + and ignored.</p> + + @see registerScriptEvent + @see attach */ void registerScriptEvents( [in] long nIndex, [in] sequence<com::sun::star::script::ScriptEventDescriptor> aScriptEvents ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::revokeScriptEvent /** revokes the registration of an event. - - <p>The parameters <var>ListenerType</var> and <var>EventMethod</var> are equivalent to the first two members of the <type>ScriptEventDescriptor</type> used to register events. If this event at this index has - been attached to any object, it is detached automatically. - - </p> - <p>The <type scope="com::sun::star::beans">IntrospectionException</type> and the - <type scope="com::sun::star::script">CannotCreateAdapterException</type> - are thrown by the <type>XEventAttacher</type> and are caught - and ignored. - - </p> + been attached to any object, it is detached automatically + (see <member>attach</member>).</p> + + <p>Exceptions of type + <type scope="com::sun::star::beans">IntrospectionException</type> and + <type scope="com::sun::star::script">CannotCreateAdapterException</type> + that can be thrown by methods of <type>XEventAttacher</type> are caught + and ignored.</p> + + @see attach */ void revokeScriptEvent( [in] long nIndex, [in] string aListenerType, @@ -173,55 +155,40 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::revokeScriptEvents /** revokes all events which are registered for the given index. - - - + <p>If the events at this index have been attached to any object, they are detached automatically. - - </p> + (see <member>attach</member>).</p> + + @see attach */ void revokeScriptEvents( [in] long nIndex ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::insertEntry /** creates an empty entry at the given position. - - - + <p>The index <var>n</var> of all entries with <code>n &gt;= - nIndex</code> will be increased by one. - - </p> + nIndex</code> will be increased by one.</p> */ void insertEntry( [in] long nIndex ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::removeEntry /** removes the entry at the given position. - - <p>If any events are registered at this index, they will be revoked, too. So if the events at this index have been attached to any object they are detached automatically. + (see <member>attach</member>).</p> - </p> + @see attach */ void removeEntry( [in] long nIndex ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XEventAttacherManager::getScriptEvents - - // DocMerge from idl: method com::sun::star::script::XEventAttacherManager::getScriptEvents /** @eturns all events registered for the given object index. @@ -235,17 +202,14 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::attach /** attaches all the <type>ScriptEvent</type>s which are registered for the given index to the given object. - <p> - <type scope="com::sun::star::beans">IntrospectionException</type> and - <type scope="com::sun::star::script">CannotCreateAdapterException</type> - are thrown by the <type>XEventAttacher</type> and are caught - and ignored. - </p> + <p>Exceptions of type + <type scope="com::sun::star::beans">IntrospectionException</type> and + <type scope="com::sun::star::script">CannotCreateAdapterException</type> + that can be thrown by methods of <type>XEventAttacher</type> are caught + and ignored.</p> */ void attach( [in] long nIndex, [in] com::sun::star::uno::XInterface xObject, @@ -254,29 +218,22 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface com::sun::star::lang::ServiceNotRegisteredException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::detach /** detaches all the <type>ScriptEvent</type>s from the given object which are registered at this object for the given index. - - - - <p> - <type scope="com::sun::star::beans">IntrospectionException</type> and - "com::sun::star::script::CannotCreateAdapterException" from the - XEventAttacher are caught and ignored. - - </p> + + <p>Exceptions of type + <type scope="com::sun::star::beans">IntrospectionException</type> and + <type scope="com::sun::star::script">CannotCreateAdapterException</type> + that can be thrown by methods of <type>XEventAttacher</type> are caught + and ignored.</p> */ void detach( [in] long nIndex, [in] com::sun::star::uno::XInterface xObject ) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::addScriptListener /** adds an <type>XScriptListener</type> that will be notified when an - event takes place. For that a + event takes place. For that a <type>ScriptEventDescriptor</type> is registered at and attached to an object by an <type>XEventAttacherManager</type>. @@ -289,8 +246,6 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XEventAttacherManager::removeScriptListener /** removes a <type>XScriptListener</type> from the listener list. <p>Nothing happens if the listener is not registered. @@ -309,39 +264,4 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/11/16 15:09:06 mi - proofing by Richard Holt - - Revision 1.6 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 15:35:58 mi - documentation syntax fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.6 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.4 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.3 2000/02/23 11:41:17 mi - results from proofreading in layouted version - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XInvocation.idl b/udkapi/com/sun/star/script/XInvocation.idl index 8f8193434..4777188a3 100644 --- a/udkapi/com/sun/star/script/XInvocation.idl +++ b/udkapi/com/sun/star/script/XInvocation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocation.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,12 +91,10 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XInvocation -/** makes it possible to invoke methods and set/get properties at an object - which corresponds with the object which implements this interface. - - Container access is available through <type scope="com::sun::star::container">XIndexContainer</type>, +/** gives access to an object's methods and properties. + + Container access is available through + <type scope="com::sun::star::container">XIndexContainer</type>, <type scope="com::sun::star::container">XNameContainer</type> and <type scope="com::sun::star::container">XEnumerationAccess</type>. </p> @@ -104,23 +102,26 @@ interface XInvocation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XInvocation::getIntrospection - /** @returns - the introspection from this object or <NULL/> if the object - does not provide this information. + /** returns the introspection from this object or <NULL/> + if the object does not provide this information. */ com::sun::star::beans::XIntrospectionAccess getIntrospection(); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XInvocation::invoke - /** provides access to properties and methods exposed by an object. + /** provides access to methods exposed by an object. - @param aParams all parameters; pure, out params are undefined in sequence, - i.e., the value has to be ignored by the callee - @param aOutParamIndex out indices - @param aOutParam out parameters + @param aParams all parameters; pure out params are undefined in sequence, + the value has to be ignored by the callee + @param aOutParamIndex This sequence contains the indices of all parameters + that are specified as out or inout. + @param aOutParam This sequence contains the values of all parameters that + are specified as out or inout and corresponds with the + indices provided by the aOutParamIndex sequence. + + Example: aOutParamIndex == { 1, 4 } means that + aOutParam[0] contains the out value of the aParams[1] + parameter and aOutParam[1] contains the out value of + the aParams[4] parameter. */ any invoke( [in] string aFunctionName, [in] sequence<any> aParams, @@ -131,13 +132,12 @@ interface XInvocation: com::sun::star::uno::XInterface com::sun::star::reflection::InvocationTargetException ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XInvocation::setValue /** sets a value to the property with the specified name. <p> If the underlying object implements an - <type scope="com::sun::star::container">XNameContainer</type>, then this method will insert the - value if there is no such <var>aPropertyName</var>. + <type scope="com::sun::star::container">XNameContainer</type>, + then this method will insert the value if there is no such + <var>aPropertyName</var>. </p> */ @@ -148,36 +148,28 @@ interface XInvocation: com::sun::star::uno::XInterface com::sun::star::reflection::InvocationTargetException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XInvocation::getValue - /** @returns - the value of the property with the specified name. + /** returns the value of the property with the specified name. - @param aPropertyName - specifies the name of the property. + @param aPropertyName + specifies the name of the property. */ any getValue( [in] string aPropertyName ) raises( com::sun::star::beans::UnknownPropertyException ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XInvocation::hasMethod - /** @returns - <TRUE/> if the method with the specified name exists. + /** returns <TRUE/> if the method with the specified name exists, else <FALSE/>. - <p>This optimizes the calling sequence - ( <member>XInvocation::hasMethod</member>, <member>XInvocation::invoke</member> )! + <p>This optimizes the calling sequence + ( <member>XInvocation::hasMethod</member>, + <member>XInvocation::invoke</member> )!</p> @param aName - specifies the name of the method. + specifies the name of the method. */ boolean hasMethod( [in] string aName ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XInvocation::hasProperty - /** @returns - <TRUE/> if the property with the specified name exists. + /** returns <TRUE/> if the property with the specified name exists, else <FALSE/>. <p>This optimizes the calling sequence ( <member>XInvocation::hasProperty</member>, @@ -186,7 +178,7 @@ interface XInvocation: com::sun::star::uno::XInterface ( <member>XInvocation::hasProperty</member>, <member>XInvocation::setValue</member> )! - @param aName + @param aName specifies the name of the property. */ boolean hasProperty( [in] string aName ); @@ -197,42 +189,4 @@ interface XInvocation: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 15:32:25 mi - documentation syntax fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.2 2000/10/06 14:43:29 dbo - added doc for XInvocation::invoke() - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.4 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1 1999/12/06 12:47:55 ab - #70472# Invokation -> Invocation - - Revision 1.3 1999/11/24 17:48:18 mi - documentation welformed - - Revision 1.2 1999/11/11 13:35:24 dbo - doc - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XInvocation2.idl b/udkapi/com/sun/star/script/XInvocation2.idl index d98ab7b0b..0d3af3698 100644 --- a/udkapi/com/sun/star/script/XInvocation2.idl +++ b/udkapi/com/sun/star/script/XInvocation2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocation2.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,20 +84,17 @@ interface XInvocation2: com::sun::star::script::XInvocation { - /** @returns - The names of all methods and properties accessable via XInvocation. + /** returns the names of all methods and properties accessable via XInvocation. */ sequence< string > getMemberNames(); - /** @returns - Information items for all methods and properties accessable via XInvocation. + /** returns information items for all methods and properties accessable via XInvocation. @see com::sun::star::script::Invocation */ sequence< InvocationInfo > getInfo(); - /** @returns - Information item for the method or property defined by aName + /** returns information item for the method or property defined by aName @param aName specifies the name of the method or property @@ -119,22 +116,4 @@ interface XInvocation2: com::sun::star::script::XInvocation }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2000/12/19 15:35:58 mi - documentation syntax fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.1 2000/09/15 11:48:06 ab - new - - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl b/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl index 7ac8519bf..a3d0a4d0d 100644 --- a/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl +++ b/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocationAdapterFactory.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,6 +84,7 @@ */ interface XInvocationAdapterFactory: com::sun::star::uno::XInterface { + //------------------------------------------------------------------------- /** Creates an adapter interface of given type for calling the given <type>XInvocation</type> interface. @@ -96,45 +97,11 @@ interface XInvocationAdapterFactory: com::sun::star::uno::XInterface adapter interface; this interface can be queried for XInterface and given type */ - com::sun::star::uno::XInterface createAdapter( - [in]XInvocation Invocation, - [in]type aType ); + com::sun::star::uno::XInterface createAdapter( [in]XInvocation Invocation, [in]type aType ); }; //============================================================================= }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2001/01/31 09:45:41 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.6 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.4 2000/08/22 11:58:31 dbo - added XInvocationAdapterFactory2 - - Revision 1.3 2000/01/14 11:09:20 jsc - #71616# Typumstellung - - Revision 1.2 1999/12/06 12:46:07 ab - #70472# Invokation -> Invocation - - Revision 1.1 1999/11/11 13:36:21 dbo - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl index fb33ae0cd..b7a3c7bf5 100644 --- a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl +++ b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocationAdapterFactory2.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,39 +100,4 @@ interface XInvocationAdapterFactory2 : com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.7 2001/11/16 15:09:06 mi - proofing by Richard Holt - - Revision 1.6 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2001/01/31 09:45:41 mi - TYPE_XIDLCLASS is now 'type' - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.1 2000/09/11 11:52:38 mi - documentation merged from XML - - Revision 1.4 2000/08/22 11:58:31 dbo - added XInvocationAdapterFactory2 - - Revision 1.3 2000/01/14 11:09:20 jsc - #71616# Typumstellung - - Revision 1.2 1999/12/06 12:46:07 ab - #70472# Invokation -> Invocation - - Revision 1.1 1999/11/11 13:36:21 dbo - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XLibraryAccess.idl b/udkapi/com/sun/star/script/XLibraryAccess.idl index 2bbe3b918..24d5e6959 100644 --- a/udkapi/com/sun/star/script/XLibraryAccess.idl +++ b/udkapi/com/sun/star/script/XLibraryAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLibraryAccess.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,24 +71,19 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XLibraryAccess /** provides access to additional scripting code. - - <p>This code is organized in modules and these modules contain the functions. It is possible to get just the code from a function, but you can also get the whole code of a module with all functions in it.</p> + + @deprecated */ interface XLibraryAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XLibraryAccess::isFunction - /** @returns - <TRUE/>, if the function is accessible through this library; - otherwise it returns <FALSE/>. + /** returns <TRUE/>, if the function is accessible through this library; + otherwise it returns <FALSE/>. @param aFunctionName the fully qualified name of a funtion. @@ -97,10 +92,7 @@ interface XLibraryAccess: com::sun::star::uno::XInterface boolean isFunction( [in] string aFunctionName ); //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::script::XLibraryAccess::isValidPath - /** @returns - <TRUE/> if a fully qualified function name begins with this name. + /** returns <TRUE/> if a fully qualified function name begins with this name. @param aPathName a part of a function name (e.g., "UtilLibrary"). @@ -108,26 +100,17 @@ interface XLibraryAccess: com::sun::star::uno::XInterface boolean isValidPath( [in] string aPathName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleNames - - // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getModuleNames /** Return all module names which contain code. e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... } */ sequence<string> getModuleNames(); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleSource - - // DocMerge from xml: method com::sun::star::script::XLibraryAccess::getModuleSource /** get the source code of a module. */ string getModuleSource( [in] string aModulName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XLibraryAccess::getModuleCode - - // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getModuleCode /** Get the hole compiled code of a module. @param ModuleName the full qualified name of a module. @@ -138,17 +121,11 @@ interface XLibraryAccess: com::sun::star::uno::XInterface sequence<byte> getModuleCode( [in] string aModuleName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XLibraryAccess::getFunctionSource - - // DocMerge from xml: method com::sun::star::script::XLibraryAccess::getFunctionSource /** get the source code of a function. */ string getFunctionSource( [in] string aFunctionName ); //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XLibraryAccess::getFunctionCode - - // DocMerge from idl: method com::sun::star::script::XLibraryAccess::getFunctionCode /** Get the compiled code of a function. @param FunctionName the full qualified name of a function. @@ -163,36 +140,4 @@ interface XLibraryAccess: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 15:10:40 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/19 13:49:38 mi - syntax errors in documentation fixed - - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.6 2000/09/11 11:52:39 mi - documentation merged from XML - - Revision 1.4 2000/04/20 14:14:36 mm - #74031# better documentation - - Revision 1.3 2000/02/23 11:41:17 mi - results from proofreading in layouted version - - Revision 1.2 2000/02/07 11:24:51 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XScriptEventsAttacher.idl b/udkapi/com/sun/star/script/XScriptEventsAttacher.idl index 0003e4252..ad2cf40f5 100644 --- a/udkapi/com/sun/star/script/XScriptEventsAttacher.idl +++ b/udkapi/com/sun/star/script/XScriptEventsAttacher.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScriptEventsAttacher.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -118,7 +118,6 @@ interface XScriptEventsAttacher: com::sun::star::uno::XInterface passed to the XScriptListener as Helper property in the <type>ScriptEvent</type>. */ - void attachEvents( [in] sequence< com::sun::star::uno::XInterface > Objects, [in] com::sun::star::script::XScriptListener xListener, [in] any Helper ) diff --git a/udkapi/com/sun/star/script/XScriptEventsSupplier.idl b/udkapi/com/sun/star/script/XScriptEventsSupplier.idl index c244fa87e..6ff65e2b9 100644 --- a/udkapi/com/sun/star/script/XScriptEventsSupplier.idl +++ b/udkapi/com/sun/star/script/XScriptEventsSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScriptEventsSupplier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,18 +77,16 @@ //============================================================================= /** - Gives access to an event container represented by an XNameContainer. - containing ScriptEventDescriptor instances + Gives access to an event container represented by an + XNameContainer containing ScriptEventDescriptor instances. */ interface XScriptEventsSupplier: com::sun::star::uno::XInterface { - - /* - Returns a XNameContainer containing instances + /** + Returns an XNameContainer containing instances of <type>ScriptEventDescriptor</type> */ com::sun::star::container::XNameContainer getEvents(); - }; //============================================================================= diff --git a/udkapi/com/sun/star/script/XScriptListener.idl b/udkapi/com/sun/star/script/XScriptListener.idl index f4329e9ee..deb72d64c 100644 --- a/udkapi/com/sun/star/script/XScriptListener.idl +++ b/udkapi/com/sun/star/script/XScriptListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XScriptListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,15 +79,11 @@ module com { module sun { module star { module script { //============================================================================= - -// DocMerge from xml: interface com::sun::star::script::XScriptListener /** makes it possible to receive <type>ScriptEvent</type>s. */ interface XScriptListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XScriptListener::firing /** gets called when an event takes place. For that a <type>ScriptEventDescriptor</type> is registered at and attached to an object by an <type>XEventAttacherManager</type>. @@ -95,8 +91,6 @@ interface XScriptListener: com::sun::star::lang::XEventListener void firing( [in] com::sun::star::script::ScriptEvent aEvent ); //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XScriptListener::approveFiring /** gets called when a "vetoable event" occurs at the object. */ any approveFiring( [in] com::sun::star::script::ScriptEvent aEvent ) @@ -108,24 +102,4 @@ interface XScriptListener: com::sun::star::lang::XEventListener }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/11/08 12:28:52 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:36 hjs - initial import - - Revision 1.4 2000/09/11 11:52:39 mi - documentation merged from XML - - Revision 1.2 1999/12/06 12:47:12 ab - #70472# Invokation -> Invocation - - Revision 1.1.1.1 1999/11/11 09:48:45 jsc - new - - -=============================================================================*/ #endif diff --git a/udkapi/com/sun/star/script/XStarBasicAccess.idl b/udkapi/com/sun/star/script/XStarBasicAccess.idl index 13431b744..3036527f5 100644 --- a/udkapi/com/sun/star/script/XStarBasicAccess.idl +++ b/udkapi/com/sun/star/script/XStarBasicAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStarBasicAccess.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,12 +73,14 @@ //============================================================================= /** Interface representing a library and provides access to its modules + + @deprecated */ interface XStarBasicAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - The library container giving access to the libraries stored in a document + /** returns + the library container giving access to the libraries stored in a document or basic library file. */ com::sun::star::container::XNameContainer getLibraryContainer(); diff --git a/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl b/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl index 0b8dfa9e1..f83e43b42 100644 --- a/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl +++ b/udkapi/com/sun/star/script/XStarBasicDialogInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStarBasicDialogInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,18 +74,18 @@ //============================================================================= /** Interface describing old style basic dialog (SI controls) in binary data + + @deprecated */ interface XStarBasicDialogInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - Name of the dialog + /** returns the name of the dialog */ string getName(); //------------------------------------------------------------------------- - /** @returns - binary data describing the SIDialog in SBX stream format + /** returns binary data describing the SIDialog in SBX stream format */ sequence< byte > getData(); diff --git a/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl b/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl index 53fcf1264..28a0abd3c 100644 --- a/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl +++ b/udkapi/com/sun/star/script/XStarBasicLibraryInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStarBasicLibraryInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,18 +73,19 @@ //============================================================================= /** Interface representing a library and provides access to its modules + + @deprecated */ interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - The library's name + /** returns the library's name */ string getName(); //------------------------------------------------------------------------- - /** @returns - The module container giving access to the modules stored in the library. + /** returns + the module container giving access to the modules stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked. @@ -94,8 +95,8 @@ interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface com::sun::star::container::XNameContainer getModuleContainer(); //------------------------------------------------------------------------- - /** @returns - The dialog container giving access to the dialogs stored in the library. + /** returns + the dialog container giving access to the dialogs stored in the library. The container has to be returned in any case, no matter if the library is stored embedded, external, or linked. @@ -105,14 +106,14 @@ interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface com::sun::star::container::XNameContainer getDialogContainer(); //------------------------------------------------------------------------- - /** @returns - The password, if the library is protected with one, + /** returns + the password, if the library is protected with one, an empty string otherwise. */ string getPassword(); //------------------------------------------------------------------------- - /** @returns + /** returns an URL describing the location where the library is stored if the library is stored seperately (for example not in the main XML file but in a special library format file), an empty string otherwise. @@ -122,12 +123,12 @@ interface XStarBasicLibraryInfo: com::sun::star::uno::XInterface string getExternalSourceURL(); //------------------------------------------------------------------------- - /** @returns + /** returns an URL describing the location of the library linked to. - HINT: This method can be removed when there is a generic interface + <p>HINT: This method can be removed when there is a generic interface for linking. Then the implementation will simply support this - "XLinked" interface and it can be checked by queryInterface(). + "XLinked" interface and it can be checked by queryInterface().</p> */ string getLinkTargetURL(); diff --git a/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl b/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl index 7fc7bceed..727edacf5 100644 --- a/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl +++ b/udkapi/com/sun/star/script/XStarBasicModuleInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStarBasicModuleInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,24 +73,23 @@ //============================================================================= /** Script Module containing some scripting code in a certain scripting language + + @deprecated */ interface XStarBasicModuleInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - Name of the module + /** returns the name of the module */ string getName(); //------------------------------------------------------------------------- - /** @returns - type of the script language as string, for example, "StarBasic" or "JavaScript". + /** returns the type of the script language as string, for example, "StarBasic" or "JavaScript". */ string getLanguage(); //------------------------------------------------------------------------- - /** @returns - script source code as string. + /** returns the script source code as string. <p>The code has to correspond with the language defined by Language.</p> diff --git a/udkapi/com/sun/star/test/TestEvent.idl b/udkapi/com/sun/star/test/TestEvent.idl index 2fec58314..b94efafd4 100644 --- a/udkapi/com/sun/star/test/TestEvent.idl +++ b/udkapi/com/sun/star/test/TestEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: TestEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,7 @@ module com { module sun { module star { module test { //============================================================================= /** This event gets delivered whenever a test event (an error, an exception, a warning) takes place. + @deprecated */ struct TestEvent: com::sun::star::lang::EventObject { diff --git a/udkapi/com/sun/star/test/TestFactory.idl b/udkapi/com/sun/star/test/TestFactory.idl index a7aca9927..ea86aa94b 100644 --- a/udkapi/com/sun/star/test/TestFactory.idl +++ b/udkapi/com/sun/star/test/TestFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: TestFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:57 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,6 +89,7 @@ module com { module sun { module star { module test { @author Markus Meyer @version 0.1 + @deprecated */ service TestFactory { diff --git a/udkapi/com/sun/star/uno/Exception.idl b/udkapi/com/sun/star/uno/Exception.idl index 095a837fe..6dde2714d 100644 --- a/udkapi/com/sun/star/uno/Exception.idl +++ b/udkapi/com/sun/star/uno/Exception.idl @@ -2,9 +2,9 @@ * * $RCSfile: Exception.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:29:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,28 +73,23 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::uno::Exception -/** The basic exception: +/** the base of all UNO exceptions - - - <p>All StarOne exceptions are derived from this exception.</p> + <p>All exceptions defined in UNO idl should derive from this exception.</p> */ exception Exception { - // DocMerge from xml: field com::sun::star::uno::Exception::Message - /** specifies a detailed message of the exception or an empty string - if the callee does not describe the exception. + /** gives a detailed description of the reason, why the exception was thrown. + <p> + The description should be as detailed as possible. + */ string Message; //------------------------------------------------------------------------- - // DocMerge from xml: field com::sun::star::uno::Exception::Context - /** an object that describes the reason for the exception. - - - - <p>May be NULL if the callee does not describe the exception.</p> + /** should contain a reference to the original, which raised the exception. + <p>May be NULL.</p> */ com::sun::star::uno::XInterface Context; @@ -107,6 +102,12 @@ exception Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.4 2000/11/08 12:29:00 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:36:18 hjs initial import diff --git a/udkapi/com/sun/star/uno/NamingService.idl b/udkapi/com/sun/star/uno/NamingService.idl index 8b267387c..d862bd7e7 100644 --- a/udkapi/com/sun/star/uno/NamingService.idl +++ b/udkapi/com/sun/star/uno/NamingService.idl @@ -2,9 +2,9 @@ * * $RCSfile: NamingService.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-20 10:20:42 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,33 +68,11 @@ module com { module sun { module star { module uno { //============================================================================= - -// DocMerge from xml: service com::sun::star::uno::NamingService -/** provides a collection of global reachable objects. - - - - <p>Normally a uno application exposes its external reachable objects - through this service. It is up to the implementation, how the registered - objects are exposed to the rest of the world. Which objects are - reachable from the outside are implementation specific. +/** a simple named object container. - </p> - <p>To extend the reachability, change the naming service. To access the - process local naming service normally, use your ServiceManager. If you are - outside of UNO you can access the shared library "unonamingservice". This library - exports a c-style function "createComponentFactory". All parameters can be set - to null. Look at the service specification of the shared library loader.<br> - In Java, the class name of the naming component is "com.sun.star.comp.nameservice.NameService". - If Java is embedded in a native system this component should connect to the - native library. - - </p> */ service NamingService { - - // DocMerge from xml: service com::sun::star::uno::NamingService: interface com::sun::star::uno::XNamingService /** through this interface the objects are registered and accessed. */ interface com::sun::star::uno::XNamingService; @@ -109,6 +87,12 @@ service NamingService Source Code Control System - Update $Log: not supported by cvs2svn $ + Revision 1.5.2.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.5 2001/11/20 10:20:42 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:29:00 mi moved from api diff --git a/udkapi/com/sun/star/uno/RuntimeException.idl b/udkapi/com/sun/star/uno/RuntimeException.idl index ddf697fb3..9a5c78611 100644 --- a/udkapi/com/sun/star/uno/RuntimeException.idl +++ b/udkapi/com/sun/star/uno/RuntimeException.idl @@ -2,9 +2,9 @@ * * $RCSfile: RuntimeException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:29:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,13 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::uno::RuntimeException /** This exception or a subclass can occur at every interface method. + <p> + It shall signal an error, which was not covered by the interface + method specification. This exception (or a derived one) is thrown, + when for instance an interprocess bridge to the object broke down, + some explicitly forbidden invalid parameters were passed ( e.g. null + references ) or the called object has been disposed before. */ exception RuntimeException: com::sun::star::uno::Exception { @@ -86,6 +91,12 @@ exception RuntimeException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.24.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.4 2000/11/08 12:29:00 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:36:18 hjs initial import diff --git a/udkapi/com/sun/star/uno/XAdapter.idl b/udkapi/com/sun/star/uno/XAdapter.idl index 8ded7d44a..be5086f07 100644 --- a/udkapi/com/sun/star/uno/XAdapter.idl +++ b/udkapi/com/sun/star/uno/XAdapter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAdapter.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,11 +76,8 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::uno::XAdapter /** This is the server-side interface to a weak adapter. - - <p>The implementation of <type>XAdapter</type> must know but not hold the adapted object, because it must not affect the lifetime of the adapted object. @@ -126,6 +123,12 @@ interface XAdapter: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.5 2001/03/16 15:10:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:29:00 mi moved from api diff --git a/udkapi/com/sun/star/uno/XInterface.idl b/udkapi/com/sun/star/uno/XInterface.idl index 7fda82438..aee08083b 100644 --- a/udkapi/com/sun/star/uno/XInterface.idl +++ b/udkapi/com/sun/star/uno/XInterface.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterface.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,30 +73,81 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::uno::XInterface -/** provides lifetime control - by reference counting and the possibility of querying for other +/** base interface of all UNO interfaces + + <p> It provides lifetime control by reference counting and the + possibility of querying for other interfaces of the same logical object. - <p> - <em>Logical</em> "Object" in this case means that the - interfaces actually can be supported by internal, as in, aggregated physical objects.</p> + "Logical Object" in this case means that the + interfaces actually can be supported by internal (e.g. aggregated) physical objects.</p> + + <p> Deriving from this interface is mandatory for all UNO interfaces. + <p> Each language binding (Java, C++, StarBasic, Python, ... ) may + provide a different mapping of this interface, please look into the language + dependent documention. + + <p> The UNO object does not export the state of the reference count (acquire() and + release() do not have return values). In general, also the UNO object itself + should not make any assumption on the concrete value of the reference count + (except on the transition from one to zero ). + */ interface XInterface { - // DocMerge from xml: method com::sun::star::uno::XInterface::queryInterface /** queries for a new interface to an existing UNO object. + <p> + The queryInterface() method is the entry point to obtain other interfaces which + are exported by the object. The caller asks the implementation of the object, + if it supports the interface specified by the type argument. The call may either + return with a interface reference of the requested type or with a void any. + + <p> + There are certain specifications, a queryInterface() implementation must not violate. + <p> + 1) If queryInterface on a specific object has once returned a valid interface reference + for a given type, it must return a valid reference for any successive queryInterface + calls on this object for the same type. + <p> + 2) If queryInterface on a specific object has once returned a null reference + for a given type, it must always return a null reference for the same type. + <p> + 3) If queryInterface on a reference A returns reference B, queryInterface on + B for Type A must return interface reference A or calls made on the returned + reference must be equivalent to calls made on reference A. + <p> + 4) If queryInterface on a reference A returns reference B, queryInterface on + A and B for XInterface must return the same interface reference (object identity). + + <p> The reason for the strong specification is, that a Uno Runtime Environment (URE) + may choose to cache queryInterface() calls. + <p> As mentioned above, certain language bindings may map this function differently also + with different specifications, please visit the language dependent specification for it. + The current C++ binding sticks to the specification state + <p> + The rules mentioned above are basically identical to the rules of QueryInterface in MS COM. + + @param aType a UNO interface type, for which an object reference shall be obtained. + @return an interface reference in case the requested interface is supported by the object, + a void any otherwise. */ any queryInterface( [in] type aType ); -// boolean queryInterface( [in] com::sun::star::uno::Uik aUik, -// [out] any ifc ); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::uno::XInterface::acquire /** increases the reference counter by one. + + <p>When you have called acquire() on the + UNO object, it is often said, that you have a reference or a hard reference + to the object. + + <p> + It is only allowed to invoke a method on an UNO object, when you keep + a hard reference to it. + + <p> Every call to acquire must be followed by a corresponding call to release + some time later, which may eventually lead to the destruction of the object. */ [oneway] void acquire(); @@ -104,10 +155,9 @@ interface XInterface // DocMerge from xml: method com::sun::star::uno::XInterface::release /** decreases the reference counter by one. - - - <p>When the reference counter reaches 0, the object gets deleted.</p> + <p>Calling release() on the object is often called releasing + or clearing the reference to an object. */ [oneway] void release(); @@ -120,6 +170,12 @@ interface XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.5 2001/03/16 15:10:43 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:29:00 mi moved from api diff --git a/udkapi/com/sun/star/uno/XNamingService.idl b/udkapi/com/sun/star/uno/XNamingService.idl index 4be0c6a04..ffca15ca3 100644 --- a/udkapi/com/sun/star/uno/XNamingService.idl +++ b/udkapi/com/sun/star/uno/XNamingService.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNamingService.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-20 10:20:42 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,25 +73,20 @@ //============================================================================= -// DocMerge from idl: interface com::sun::star::uno::XNamingService -/** This is <B>the<B> interface which should be provided by a naming service. +/** allows to insert, remove and access named objects. */ interface XNamingService: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::uno::XNamingService::getRegisteredObject /** provides a previous registered object. */ com::sun::star::uno::XInterface getRegisteredObject( [in] string Name ) raises (Exception); - // DocMerge from xml: method com::sun::star::uno::XNamingService::registerObject /** registers one object under the specified name. - - - - <p>If any object is registered before, then this + + <p>If any object is registered before, then this object is revoked automatically. </p> @@ -100,8 +95,7 @@ interface XNamingService: com::sun::star::uno::XInterface raises (Exception); - // DocMerge from xml: method com::sun::star::uno::XNamingService::revokeObject - /** revokes the registration of an object. If the object was not + /** revokes the registration of an object. <p>If the object was not previously registered, then this call does nothing. */ void revokeObject( [in]string Name ) @@ -118,6 +112,12 @@ interface XNamingService: com::sun::star::uno::XInterface Source Code Control System - Update $Log: not supported by cvs2svn $ + Revision 1.6.2.1 2002/06/05 16:38:42 jbu + documentation reviewed + + Revision 1.6 2001/11/20 10:20:42 mi + proofing by Richard Holt + Revision 1.5 2001/03/16 15:10:43 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/util/MacroExpander.idl b/udkapi/com/sun/star/util/MacroExpander.idl index df4084b56..653bea073 100644 --- a/udkapi/com/sun/star/util/MacroExpander.idl +++ b/udkapi/com/sun/star/util/MacroExpander.idl @@ -2,9 +2,9 @@ * * $RCSfile: MacroExpander.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2002-06-14 12:47:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 12:44:33 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,7 +101,8 @@ service MacroExpander @see MacroExpander */ -singleton theMacroExpander +//! singleton theMacroExpander +service theMacroExpander { service MacroExpander; }; |