diff options
| author | Michael Hönnig <mi@openoffice.org> | 2000-12-11 15:09:49 +0000 |
|---|---|---|
| committer | Michael Hönnig <mi@openoffice.org> | 2000-12-11 15:09:49 +0000 |
| commit | 8336084b60122e6ecff0ff949460b37136751557 (patch) | |
| tree | 81af224fc95beba0a3091a531ef19a65bbda9361 | |
| parent | f98dd4864f1c6d3d9d9f6182dfabe20dbd80312f (diff) | |
documentation syntax fixed and some minor semantic documentation fixes
122 files changed, 1522 insertions, 1506 deletions
diff --git a/udkapi/com/sun/star/beans/IllegalTypeException.idl b/udkapi/com/sun/star/beans/IllegalTypeException.idl index 493b65ffe..17512f163 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,11 +76,9 @@ /** This exception is thrown to indicate the use of a type which is not appropriate. - - - <p>This problem occurs if you use <atom>any</atom>. - - </p>@see PropertyContainer + <p>This problem can occur, if you use <atom>any</atom>. </p> + + @see PropertyContainer */ exception IllegalTypeException: com::sun::star::uno::Exception { @@ -93,6 +91,9 @@ exception IllegalTypeException: 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 diff --git a/udkapi/com/sun/star/beans/Introspection.idl b/udkapi/com/sun/star/beans/Introspection.idl index e8ac3cf61..0c0bd9427 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,16 +76,7 @@ /** makes it possible to inspect an object concerning its properties and functions. - - - <p>For details see method - - - - - . - - </p> + <p>For details see method <member>XIntrospection::inspect</member>. </p> */ service Introspection { @@ -101,6 +92,9 @@ 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 diff --git a/udkapi/com/sun/star/beans/IntrospectionException.idl b/udkapi/com/sun/star/beans/IntrospectionException.idl index 78bbbb6c8..0733cffcb 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,14 +76,11 @@ /** 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 + a method name or an attribute name. </p> + + @see PropertyContainer */ exception IntrospectionException: com::sun::star::uno::Exception { @@ -96,6 +93,9 @@ 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 diff --git a/udkapi/com/sun/star/beans/MethodConcept.idl b/udkapi/com/sun/star/beans/MethodConcept.idl index 17841153d..df650e1c5 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,9 +87,9 @@ constants MethodConcept //------------------------------------------------------------------------- // 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 ... ) when - called directly by the user. + /** specifies methods which can result in an unstable state + (i.e. deadlock, application crash, security hole ... ) when called + directly by the user. */ const long DANGEROUS = 1; @@ -97,10 +97,10 @@ constants MethodConcept // DocMerge from idl: value com::sun::star::beans::MethodConcept::PROPERTY /** specifies methods which are used to set and get the - value of properties/attributes. + value of properties/attributes. - <p>These methods have the signature <code>type get...()</code>, - <code>void set...()</code> or <code>boolean is...()</code>. + <p>These methods have the signature <code>type get...()</code>, + <code>void set...()</code> or <code>boolean is...()</code>. </p> */ const long PROPERTY = 2; @@ -109,8 +109,8 @@ constants MethodConcept // DocMerge from idl: value com::sun::star::beans::MethodConcept::LISTENER /** specifies methods of the <em>listener concept</em>. - <p>These methods have the signature <code>add...Listener()</code> - or <code>remove...Listener()</code>. + <p>These methods have the signature <code>add...Listener()</code> + or <code>remove...Listener()</code>. </p> */ const long LISTENER = 4; @@ -119,11 +119,12 @@ constants MethodConcept // 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>XEnumeration</type>. Additionally, the method - <method scope="com::sun::star::container">XEnumerationAccess::getElementType()</method> belongs - to this concept. + <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> */ const long ENUMERATION = 8; @@ -132,13 +133,13 @@ constants MethodConcept // 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 - <code>get...Names</code>. In addition, the method - <method>XNameAccess::getElementType()</method> belongs to this - concept. - */ + <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 + <method>XNameAccess::getElementType()</method> belongs to this + concept. </p> + */ const long NAMECONTAINER = 16; //------------------------------------------------------------------------- @@ -146,10 +147,11 @@ constants MethodConcept // 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 - <method scope="com::sun::star::container">XIndexAccess::getCount()</method> also belongs to this concept. + <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 + <method scope="com::sun::star::container">XIndexAccess::getCount()</method> + also belongs to this concept. </p> */ const long INDEXCONTAINER = 32; @@ -162,6 +164,9 @@ constants MethodConcept /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/NotRemoveableException.idl b/udkapi/com/sun/star/beans/NotRemoveableException.idl index 85fa3f7e5..47fdb8c80 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,8 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::beans::NotRemoveableException -/** This exception is thrown to indicate that removing a property from an <type>XPropertyContainer</type> is not - allowed. +/** This exception is thrown to indicate that removing a property from an + <type>XPropertyContainer</type> is not allowed. */ exception NotRemoveableException: com::sun::star::uno::Exception { @@ -87,6 +87,9 @@ exception NotRemoveableException: 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 diff --git a/udkapi/com/sun/star/beans/Property.idl b/udkapi/com/sun/star/beans/Property.idl index 42ad66601..cf4c71a3a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,28 +75,18 @@ // DocMerge from xml: struct com::sun::star::beans::Property /** This structure describes a property. - - - <p>There are three types of properties: - <dl> - <dt>bound properties - </dt> - <dt>constrained properties - </dt> - <dt>free properties + <p>There are three types of properties: </p> <dl> + <dt>bound properties</dt> + <dt>constrained properties</dt> + <dt>free properties</dt> </dl> - </dt> - </dl> - </p> */ struct Property { // DocMerge from xml: field com::sun::star::beans::Property::Name /** specifies the name of the property. - - <p>The name is unique within an <type>XPropertySet</type>.</p> */ string Name; @@ -106,8 +96,6 @@ struct Property // DocMerge from xml: field com::sun::star::beans::Property::Handle /** contains an implementation-specific handle for the property. - - <p>It may be -1 if the implementation has no handle. You can use this handle to get values from the <type>XFastPropertySet</type>.</p> */ @@ -119,8 +107,6 @@ struct Property /** contains an object that identifies the declared type for the property. - - <p>If the property has multiple types or the type is not known, <strong>but not <atom>any</atom></strong>, then <const>void</const> must be returned.</p> @@ -144,6 +130,9 @@ struct Property /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertyAttribute.idl b/udkapi/com/sun/star/beans/PropertyAttribute.idl index 34a7b8222..ca977988a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,7 +78,7 @@ constants PropertyAttribute // DocMerge from idl: value com::sun::star::beans::PropertyAttribute::MAYBEVOID /** indicates that a property value can be void. - <p>It does not mean that the type of the property is void! + <p>It does not mean that the type of the property is void! */ const short MAYBEVOID = 1; @@ -86,8 +86,8 @@ constants PropertyAttribute // DocMerge from idl: value com::sun::star::beans::PropertyAttribute::BOUND /** indicates that a <type>PropertyChangeEvent</type> will be fired - to all registered <type>XPropertyChangeListener</type>s - whenever the value of this property changes. + to all registered <type>XPropertyChangeListener</type>s whenever the + value of this property changes. */ const short BOUND = 2; @@ -95,10 +95,10 @@ constants PropertyAttribute // DocMerge from idl: value com::sun::star::beans::PropertyAttribute::CONSTRAINED /** indicates that a <type>PropertyChangeEvent</type> will be fired - to all registered <type>XVetoableChangeListener</type>s - whenever the value of this property changes. + to all registered <type>XVetoableChangeListener</type>s whenever the + value of this property changes. - <p>This always implies that the property is <em>bound</em>, too. + <p>This always implies that the property is <em>bound</em>, too. </p> */ const short CONSTRAINED = 4; @@ -133,8 +133,8 @@ constants PropertyAttribute //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::beans::PropertyAttribute::REMOVEABLE - /** indicates that the property can be removed (i.e. by calling - <method>XPropertyContainer::removeProperty</method>). + /** indicates that the property can be removed + (i.e. by calling <method>XPropertyContainer::removeProperty</method>). */ const short REMOVEABLE = 128; @@ -151,6 +151,9 @@ constants PropertyAttribute /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertyChangeEvent.idl b/udkapi/com/sun/star/beans/PropertyChangeEvent.idl index e7c4f7945..5510a4ade 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,22 +73,17 @@ //============================================================================= // DocMerge from xml: struct com::sun::star::beans::PropertyChangeEvent -/** gets delivered whenever a "bound" or "constrained" - property is changed. - - +/** gets delivered whenever a "bound" or "constrained" property is changed. <p>A <type>PropertyChangeEvent</type> object is sent as an argument to the methods of <type>XPropertyChangeListener</type> - and <type>XVetoableChangeListener</type>. + and <type>XVetoableChangeListener</type>. </p> - </p> <p>Normally such events contain the name and the old and new - value of the changed property. - - </p> + value of the changed property. </p> + <p>Void values may be provided for the old and the new values if their - true values are not known.</p> + true values are not known. </p> */ struct PropertyChangeEvent: com::sun::star::lang::EventObject { @@ -102,7 +97,7 @@ struct PropertyChangeEvent: com::sun::star::lang::EventObject //------------------------------------------------------------------------- // DocMerge from xml: field com::sun::star::beans::PropertyChangeEvent::Further - /** contains <true></true> if further events in the same transaction occur. + /** contains <true/> if further events in the same transaction occur. */ boolean Further; @@ -111,8 +106,6 @@ struct PropertyChangeEvent: com::sun::star::lang::EventObject // DocMerge from xml: field com::sun::star::beans::PropertyChangeEvent::PropertyHandle /** contains the implementation handle for the property. - - <p>May be -1 if the implementation has no handle. You can use this handle to get values from the <type>XFastPropertySet</type>.</p> */ @@ -141,6 +134,9 @@ struct PropertyChangeEvent: com::sun::star::lang::EventObject /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertyConcept.idl b/udkapi/com/sun/star/beans/PropertyConcept.idl index 332516868..2afb42560 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,10 +70,10 @@ // DocMerge from idl: constants com::sun::star::beans::PropertyConcept /** These constants are used to specify concepts of the introspection - which apply to properties and to the methods which represent attributes. + 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>This list is not necessarily complete; new constants may be added + (by the author). </p> */ constants PropertyConcept { @@ -88,8 +88,8 @@ constants PropertyConcept // DocMerge from idl: value com::sun::star::beans::PropertyConcept::DANGEROUS /** specifies that the change or retrieval of this - property directly by the user can result in an unstable - state (deadlock, application crash, security hole ... ). + property directly by the user can result in an unstable + state (deadlock, application crash, security hole ... ). */ const long DANGEROUS = 1; @@ -97,27 +97,25 @@ constants PropertyConcept // DocMerge from idl: value com::sun::star::beans::PropertyConcept::PROPERTYSET /** specifies all properties which are reachable by - <type>XPropertySet</type>, <type>XFastPropertySet</type> or - <type>XMultiPropertySet</type>. + <type>XPropertySet</type>, <type>XFastPropertySet</type> or + <type>XMultiPropertySet</type>. */ const long PROPERTYSET = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::beans::PropertyConcept::ATTRIBUTES - /** specifies all properties which are actually attributes - of interfaces. + /** specifies all properties which are actually attributes of interfaces. */ const long ATTRIBUTES = 4; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::beans::PropertyConcept::METHODS - /** specifies all properties which are represented by - getter or setter methods. + /** 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>These methods have the signature <code>type get...()</code>, + <code>void set...()</code> or <code>boolean is...()</code>. </p> */ const long METHODS = 8; @@ -130,6 +128,9 @@ constants PropertyConcept /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertyExistException.idl b/udkapi/com/sun/star/beans/PropertyExistException.idl index 7ea84f017..b30dde982 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,9 @@ // DocMerge from xml: exception com::sun::star::beans::PropertyExistException /** This exception is thrown to indicate that the property already exists - in the object.@see PropertyContainer + in the object. + + @see PropertyContainer */ exception PropertyExistException: com::sun::star::uno::Exception { @@ -87,6 +89,9 @@ exception PropertyExistException: 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 diff --git a/udkapi/com/sun/star/beans/PropertySetInfoChange.idl b/udkapi/com/sun/star/beans/PropertySetInfoChange.idl index 918971a5a..c9c2ed8b0 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,8 +71,8 @@ // DocMerge from idl: constants com::sun::star::beans::PropertySetInfoChange /** specifies reasons for sending <type>PropertySetInfoChangeEvent</type>s. - @see PropertySetInfoChangeEvent - @see XPropertySetInfo + @see PropertySetInfoChangeEvent + @see XPropertySetInfo */ constants PropertySetInfoChange { @@ -98,6 +98,9 @@ constants PropertySetInfoChange /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl b/udkapi/com/sun/star/beans/PropertySetInfoChangeEvent.idl index 529a04f3c..73bd99ac8 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,6 @@ /** gets delivered whenever an <type>XPropertySetInfo</type> is changed. - - <p>A <type>PropertySetInfoChangeEvent</type> object is sent to <type>XPropertySetInfoChangeListener</type>s.</p> */ @@ -95,8 +93,6 @@ struct PropertySetInfoChangeEvent: com::sun::star::lang::EventObject // DocMerge from xml: field com::sun::star::beans::PropertySetInfoChangeEvent::Handle /** contains the implementation handle for the property. - - <p>May be -1 if the implementation has no handle.</p> */ long Handle; @@ -104,7 +100,9 @@ struct PropertySetInfoChangeEvent: com::sun::star::lang::EventObject //------------------------------------------------------------------------- // DocMerge from xml: field com::sun::star::beans::PropertySetInfoChangeEvent::Reason - /** contains the reason for the event.@see PropertySetInfoChange + /** contains the reason for the event. + + @see PropertySetInfoChange */ long Reason; }; @@ -116,6 +114,9 @@ struct PropertySetInfoChangeEvent: com::sun::star::lang::EventObject /*============================================================================= $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 diff --git a/udkapi/com/sun/star/beans/PropertyState.idl b/udkapi/com/sun/star/beans/PropertyState.idl index a9d328034..4ca86f222 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,18 +71,15 @@ // DocMerge from xml: enum com::sun::star::beans::PropertyState /** This enumeration lists the states that a property value can have. - - - <p>The state consists of two aspects: - </p> + <p>The state consists of two aspects: </p> <ol> - <li>whether a value is available or void, - </li> - <li>whether the value is stored in the property set itself or is a - default or ambiguous. - </li> - </ol>@see interface XPropertyState - @see struct Property + <li>whether a value is available or void, </li> + <li>whether the value is stored in the property set itself or is a + default or ambiguous. </li> + </ol> + + @see interface XPropertyState + @see struct Property */ enum PropertyState { @@ -91,13 +88,10 @@ enum PropertyState // DocMerge from xml: value com::sun::star::beans::PropertyState::DIRECT_VALUE /** The value of the property is stored in the PropertySet itself. - - <p>The property value must be available and of the specified type. If the <member>PropertyAttribute</member> field in the struct - <type>Property</type> contains - <const>PropertyAttribute::MAYBEVOID</const>, then the value may - be void.</p> + <type>Property</type> contains <const>PropertyAttribute::MAYBEVOID</const>, + then the value may be void. </p> */ DIRECT_VALUE, @@ -106,15 +100,13 @@ enum PropertyState // DocMerge from xml: value com::sun::star::beans::PropertyState::DEFAULT_VALUE /** The value of the property is available from a master (e.g. template). - - <p>The <member>PropertyAttribute</member> field in the struct <type>Property</type> must contain the <const>PropertyAttribute::MAYBEDEFAULT</const> flag. The property value must be available and of the specified type. If the <member>PropertyAttribute</member> field in the struct <type>Property</type> contains <const>PropertyAttribute::MAYBEVOID</const>, then the - value may be void.</p> + value may be void. </p> */ DEFAULT_VALUE, @@ -124,15 +116,13 @@ enum PropertyState /** The value of the property is only a recommendation because there are multiple values for this property (e.g. from a multi selection). - - <p>The <member>PropertyAttribute</member> field in the struct <type>Property</type> must contain the <const>PropertyAttribute::MAYBEAMBIGUOUS</const> flag. The property value must be available and of the specified type. If the Attribute field in the struct Property contains <const>PropertyAttribute::MAYBEVOID</const>, then the value - may be void.</p> + may be void. </p> */ AMBIGUOUS_VALUE @@ -145,6 +135,9 @@ enum PropertyState /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl b/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl index 78d80e556..cf4703266 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,18 +79,14 @@ // DocMerge from xml: struct com::sun::star::beans::PropertyStateChangeEvent /** gets delivered whenever the state of a "bound" property is changed. - - <p>It is sent as an argument to the method of - <type>XPropertyStateChangeListener</type>. - - </p> + <type>XPropertyStateChangeListener</type>. </p> + <p>Normally these events are accompanied by the name and the old - and new values of the changed property. - - </p> + and new values of the changed property. </p> + <p>Void values may be provided for the old and new values if their - true values are not known.</p> + true values are not known. </p> */ struct PropertyStateChangeEvent: com::sun::star::lang::EventObject { @@ -99,8 +95,6 @@ struct PropertyStateChangeEvent: com::sun::star::lang::EventObject // DocMerge from xml: field com::sun::star::beans::PropertyStateChangeEvent::PropertyName /** specifies the name of the property which changes its value. - - <p>This name identifies the property uniquely within an <type>XPropertySet</type>.</p> */ @@ -111,8 +105,6 @@ struct PropertyStateChangeEvent: com::sun::star::lang::EventObject // DocMerge from xml: field com::sun::star::beans::PropertyStateChangeEvent::PropertyHandle /** contains the implementation handle for the property. - - <p>It may be -1 if the implementation has no handle. You can use this handle to get values from the <type>XFastPropertySet</type> interface.</p> @@ -142,6 +134,9 @@ struct PropertyStateChangeEvent: com::sun::star::lang::EventObject /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/PropertyValue.idl b/udkapi/com/sun/star/beans/PropertyValue.idl index 7d4406754..1d0e462e8 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,8 +84,6 @@ struct PropertyValue // DocMerge from xml: field com::sun::star::beans::PropertyValue::Name /** specifies the name of the property. - - <p>The name is unique within a sequence of <type>PropertyValue</type>s.</p> */ string Name; @@ -95,8 +93,6 @@ struct PropertyValue // DocMerge from xml: field com::sun::star::beans::PropertyValue::Handle /** contains an implementation-specific handle for the property. - - <p>It may be -1 if the implementation has no handle. If available it can be used for fast lookups.</p> */ @@ -105,7 +101,7 @@ struct PropertyValue //------------------------------------------------------------------------- // DocMerge from xml: field com::sun::star::beans::PropertyValue::Value - /** contains the value of the property or <const>void</const> + /** contains the value of the property or <void/>, if no value is available. */ any Value; @@ -127,6 +123,9 @@ struct PropertyValue /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/PropertyValues.idl b/udkapi/com/sun/star/beans/PropertyValues.idl index d4bc931d4..1ace49f61 100644 --- a/udkapi/com/sun/star/beans/PropertyValues.idl +++ b/udkapi/com/sun/star/beans/PropertyValues.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyValues.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ module com { module sun { module star { module beans { //============================================================================= /** specifies a sequence of <type>PropertyValue</type> instances. - <p>Such sequences are especially useful for remote interfaces. + <p>Such sequences are especially useful for remote interfaces. </p> */ typedef sequence<PropertyValue> PropertyValues; diff --git a/udkapi/com/sun/star/beans/PropertyVetoException.idl b/udkapi/com/sun/star/beans/PropertyVetoException.idl index be0ccdd3e..3bb8256a6 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,9 @@ // DocMerge from xml: exception com::sun::star::beans::PropertyVetoException /** This exception is thrown when a proposed change to a - property represents an unacceptable value.@see XPropertySet + property represents an unacceptable value. + + @see XPropertySet */ exception PropertyVetoException: com::sun::star::uno::Exception { @@ -87,6 +89,9 @@ exception PropertyVetoException: 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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/UnknownPropertyException.idl b/udkapi/com/sun/star/beans/UnknownPropertyException.idl index f2199867a..563f6c86a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,9 @@ // DocMerge from xml: exception com::sun::star::beans::UnknownPropertyException /** This exception is thrown to indicate that the property is unknown to - the implementation.@see XPropertySet + the implementation. + + @see XPropertySet */ exception UnknownPropertyException: com::sun::star::uno::Exception { @@ -87,6 +89,9 @@ exception UnknownPropertyException: 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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XExactName.idl b/udkapi/com/sun/star/beans/XExactName.idl index 4ad36e31a..806b6beba 100644 --- a/udkapi/com/sun/star/beans/XExactName.idl +++ b/udkapi/com/sun/star/beans/XExactName.idl @@ -2,9 +2,9 @@ * * $RCSfile: XExactName.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,17 +76,16 @@ /** provides a method of changing names for converting an approximate name to an existing name. - - <p> One field of application is the conversion of case-insensitive - names to the existing names. - - </p> + names to the existing names. </p> + <p>Example: A basic interpreter ignores the case of the names. So it must query the <type>XExactName</type> interface and then call - the method. </p>@see com::sun::star::beans::XPropertySet - @see com::sun::star::beans::XIntrospectionAccess - @see com::sun::star::container::XNameAccess + the method. </p> + + @see com::sun::star::beans::XPropertySet + @see com::sun::star::beans::XIntrospectionAccess + @see com::sun::star::container::XNameAccess */ [ uik(E227A3D5-33D6-11D1-AABE00A0-249D5590), ident( "XExactName", 1.0 ) ] interface XExactName: com::sun::star::uno::XInterface @@ -95,10 +94,10 @@ interface XExactName: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XExactName::getExactName /** @returns - the exact name for a given aprroximate name. + the exact name for a given aprroximate name. - <p>For example "getExactName" could be returned for "GETEXACTNAME" - when "GETEXACTNAME" was used by a case insesitive scripting language. + <p>For example "getExactName" could be returned for "GETEXACTNAME" + when "GETEXACTNAME" was used by a case insesitive scripting language. </p> */ string getExactName( [in] string aApproximateName ); @@ -111,6 +110,9 @@ interface XExactName: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/beans/XFastPropertySet.idl b/udkapi/com/sun/star/beans/XFastPropertySet.idl index d7965f58f..0de6f412c 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,8 +91,6 @@ // DocMerge from xml: interface com::sun::star::beans::XFastPropertySet /** provides a fast way of accessing and changing property values. - - <p>This interface is an extension to the <type>XPropertySet</type> interface. The get and set methods use handles to access the property values instead of character strings.</p> @@ -116,19 +114,18 @@ interface XFastPropertySet: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XFastPropertySet::getFastPropertyValue /** @returns - the value of the property with the name PropertyName. + the value of the property with the name PropertyName. - @param nHandle - contains the implementation handle of the implementation - for the property. + @param nHandle + contains the implementation handle of the implementation for the property. - @throws UnknownPropertyException - if the property does not exist. + @throws UnknownPropertyException + if the property does not exist. - @throws com::sun::star::lang::WrappedTargetException - if the implementation has an internal reason for the exception. - In this case the original exception is wrapped into that - <type scope="com::sun::star::lang">WrappedTargetException</type>. + @throws com::sun::star::lang::WrappedTargetException + if the implementation has an internal reason for the exception. + In this case the original exception is wrapped into that + <type scope="com::sun::star::lang">WrappedTargetException</type>. */ [const] any getFastPropertyValue( [in] long nHandle ) raises( com::sun::star::beans::UnknownPropertyException, @@ -143,6 +140,9 @@ interface XFastPropertySet: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl index a28335ae7..37825cd0c 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -97,21 +97,20 @@ <p> Usually an object that implements this interface also implements <type>XPropertySet</type> and at - least some of the properties have subproperties. - </p> + least some of the properties have subproperties. </p> + <p> This interface allows direct access to subsubproperties, ... up to arbitrary nesting depth. Often the intermediate - elements of the hierarchy implement <type>XProperty</type>. - </p> + elements of the hierarchy implement <type>XProperty</type>. </p> + <p> Each implementation specifies how the hierarchical property names, that are used to access the elements of the hierarchy, - are formed. - </p> + are formed. </p> + <p> Commonly a notation similar to filesystem pathes (separated by '/' slashes) or nested module names - (separated by dots '.' or '::') is used. - </p> + (separated by dots '.' or '::') is used. </p> */ [ uik(7916BF21-A373-11D4-9F6A0050-DA6BA2A6), ident( "XHierarchicalPropertySet", 1.0 ) ] @@ -154,9 +153,8 @@ interface XHierarchicalPropertySet: com::sun::star::uno::XInterface @throws com::sun::star::uno::lang::IllegalArgumentException if <var>aValue</var> is not a legal value for this property or if <var>aHierarchicalPropertyName</var> is not a well-formed - nested name for this hierarchy. - <p> An implementation is not required to detect the latter - condition </p> + nested name for this hierarchy. + An implementation is not required to detect the latter condition. @throws com::sun::star::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. @@ -186,8 +184,8 @@ interface XHierarchicalPropertySet: com::sun::star::uno::XInterface @throws com::sun::star::uno::lang::IllegalArgumentException if <var>aHierarchicalPropertyName</var> is not a well-formed nested name for this hierarchy. - <p> An implementation is not required to detect this - condition </p> + An implementation is not required to detect this + condition. @throws com::sun::star::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. @@ -212,6 +210,9 @@ interface XHierarchicalPropertySet: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:20 mi + moved from api + Revision 1.1 2000/10/19 08:32:35 jb Added HierarchicalPropertySet Interfaces diff --git a/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl b/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl index fe6f9675e..587d87653 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -106,8 +106,8 @@ interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface @throws com::sun::star::uno::lang::IllegalArgumentException if <var>aHierarchicalName</var> is not a well-formed nested name for this hierarchy. - <p> An implementation is not required to detect this - condition </p> + An implementation is not required to detect this + condition. */ [const] com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName ) @@ -125,8 +125,8 @@ interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface @throws com::sun::star::uno::lang::IllegalArgumentException if <var>aHierarchicalName</var> is not a well-formed nested name for this hierarchy. - <p> An implementation is not required to detect this - condition </p> + An implementation is not required to detect this + condition. */ [const] boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName ); @@ -139,6 +139,9 @@ interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:20 mi + moved from api + Revision 1.1 2000/10/19 08:32:42 jb Added HierarchicalPropertySet Interfaces diff --git a/udkapi/com/sun/star/beans/XIntroTest.idl b/udkapi/com/sun/star/beans/XIntroTest.idl index 37a6c9953..86fa92810 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,7 +87,7 @@ interface XPropertiesChangeListener; //============================================================================= /** This is a test interface for introspection. - <p>IMPORTANT: FOR TEST ONLY! + <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, @@ -124,12 +124,12 @@ interface XIntroTest: com::sun::star::uno::XInterface [attribute] short ChildrenCount; //------------------------------------------------------------------------- - /** contains a struct of type Property. + /** contains a struct of type <type>Property</type>. */ [attribute] com::sun::star::beans::Property FirstStruct; //------------------------------------------------------------------------- - /** contains a struct of type PropertyValue. + /** contains a struct of type <type>PropertyValue</type>. */ [attribute] com::sun::star::beans::PropertyValue SecondStruct; diff --git a/udkapi/com/sun/star/beans/XIntrospection.idl b/udkapi/com/sun/star/beans/XIntrospection.idl index a123b318f..9bd658043 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,16 +79,9 @@ // DocMerge from xml: interface com::sun::star::beans::XIntrospection /** allows the inspection of an object's properties and functions. + <p>For details see method <member>XIntrospection::inspect</member>. </p> - - <p>For details see method - - - - - . - - </p>@see XIntrospectionAccess + @see XIntrospectionAccess */ [ uik(E227A4AA-33D6-11D1-AABE00A0-249D5590), ident( "XIntrospection", 1.0 ) ] interface XIntrospection: com::sun::star::uno::XInterface @@ -98,71 +91,55 @@ interface XIntrospection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::XIntrospection::inspect /** inspects the given object. - - <p>It identifies all properties supported by the object - if they are represented in one of the following ways: + if they are represented in one of the following ways: </p> <dl> - <dt>property set - </dt> - <dd>If the object supports an <type>XPropertySet</type> - interface, all its properties are adopted. - - </dd> - <dt>attributes - </dt> - <dd>All of an object's attributes are considered as properties - with same name. If an attribute is read-only, the property - also is read-only. - - </dd> - <dt>get/set methods - </dt> - <dd>Every method <code>RetType getX()</code> defines a - property where "X" stands for the property name and - "RetType" for its type. The method must not have any - parameters, or there is no property access method - and "X" has no property. If there is also a method - <code>void setX( [in] RetType )</code>, the property - "X" also allows write access; otherwise it is read-only. - - </dd> - <dt> - <strong>Important note:</strong> - </dt> - <dd>If an object implements <type scope="com::sun::star::container">XNameAccess</type>, the - items that can be accessed are not considered as properties - of the object and so are not included in the property list - offered by - - - - - . - <type scope="com::sun::star::container">XNameAccess</type> items have to be accessed separately - by - - - - - . - </dd> + <dt>property set </dt> + <dd>If the object supports an <type>XPropertySet</type> + interface, all its properties are adopted. + </dd> + + <dt>attributes </dt> + <dd>All of an object's attributes are considered as properties + with same name. If an attribute is read-only, the property + also is read-only. + </dd> + + <dt>get/set methods </dt> + <dd>Every method <code>RetType getX()</code> defines a + property where "X" stands for the property name and + "RetType" for its type. The method must not have any + parameters, or there is no property access method + and "X" has no property. If there is also a method + <code>void setX( [in] RetType )</code>, the property + "X" also allows write access; otherwise it is read-only. + </dd> + + <dt> <strong>Important note:</strong></dt> + <dd>If an object implements <type scope="com::sun::star::container">XNameAccess</type>, + the items that can be accessed are not considered as properties + of the object and so are not included in the property list offered by + <member>???</member>. + <type scope="com::sun::star::container">XNameAccess</type> items have to be + accessed separately by <member>???</member>. + </dd> </dl> - </p> <p>In addition, the inspect method identifies all listener access methods in the form <code>add...Listener</code>/ <code>remove...Listener</code> (except methods of interface - <type>XPropertySet</type>) where "..." stands for the listener type. - + <type>XPropertySet</type>) where "..." stands for the listener type. </p> + <p>Methods which do not belong to a property nor which represent a listener access nor which are methods of <type>XPropertySet</type>, <type scope="com::sun::star::container">XNameAccess</type>, <type scope="com::sun::star::container">XIndexAccess</type> or <type scope="com::sun::star::container">XEnumerationAccess</type>, are considered to be normal - methods. </p>@see XIntrospectionAccess + methods. </p> + + @see XIntrospectionAccess */ com::sun::star::beans::XIntrospectionAccess inspect( [in] any aObject ); @@ -175,6 +152,9 @@ interface XIntrospection: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XIntrospectionAccess.idl b/udkapi/com/sun/star/beans/XIntrospectionAccess.idl index 27edcf649..cf590cf6c 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,7 +89,6 @@ #include <com/sun/star/beans/IllegalTypeException.idl> #endif - //============================================================================= module com { module sun { module star { module beans { @@ -100,53 +99,39 @@ /** 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> + 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> + 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> - and for the <type>PropertyConcept</type>: + <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> + + and for the <type>PropertyConcept</type>: + <ul> - <li> - <const>PropertyConcept::PROPERTYSET</const>, - </li> - <li> - <const>PropertyConcept::ATTRIBUTES</const> and - </li> - <li> - <const>PropertyConcept::METHODS</const>. - </li> + <li> <const>PropertyConcept::PROPERTYSET</const>, </li> + <li> <const>PropertyConcept::ATTRIBUTES</const> and </li> + <li> <const>PropertyConcept::METHODS</const>. </li> </ul> + 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>@see XPropertySet + <type scope="com::sun::star::container">XNameAccess</type> interface or + <type>XPropertySet</type>. </p> + + @see XPropertySet @see com::sun::star::beans::XExactName */ [ uik(E227A4A9-33D6-11D1-AABE00A0-249D5590), ident( "XIntrospectionAccess", 1.0 ) ] @@ -156,8 +141,7 @@ 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. + zero or more constants of the <type>MethodConcept</type> constants group. */ [const] long getSuppliedMethodConcepts(); @@ -165,8 +149,7 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XIntrospectionAccess::getSuppliedPropertyConcepts /** @returns - zero or more constants of the <type>PropertyConcept</type> - constants group. + zero or more constants of the <type>PropertyConcept</type> constants group. */ [const] long getSuppliedPropertyConcepts(); @@ -174,18 +157,17 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. - - @param aName - the name of the <type>Property</type>. + <TRUE/> if the method exists and fits the + given MethodConcepts; otherwise <FALSE/> is returned. - @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept</type> - constants group. + @param aName + the name of the <type>Property</type>. - @throws NoSuchElementException - when an element under Name does not exist. + @param nPropertyConcepts + zero or more constants of the <type>PropertyConcept</type> constants group. + + @throws NoSuchElementException + when an element under Name does not exist. */ [const] com::sun::star::beans::Property getProperty( [in] string aName, [in] long nPropertyConcepts ) @@ -195,16 +177,14 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + <TRUE/> if the method exists and fits the given <type>PropertyConcept</type>s; + otherwise <FALSE/> is returned. - @param aName - the name of the <type>Property</type>. + @param aName + the name of the <type>Property</type>. - @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. */ [const] boolean hasProperty( [in] string aName, [in] long nPropertyConcepts ); @@ -213,8 +193,8 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + all properties of the introspected object which accord to the + given <type>PropertyConcept</type>s. */ [const] sequence<com::sun::star::beans::Property> getProperties( [in] long nPropertyConcepts ); @@ -223,17 +203,17 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + the method with the given name if it exists and fits the + specified <type>MethodConcept</type>s. - @param aName - the name of the method. + @param aName + the name of the method. - @param nMethodConcepts - zero or more constants of the MethodConcept group. + @param nMethodConcepts + zero or more constants of the <type>MethodConcept</type> group. - @throws NoSuchElementException - if no element with the name <var>Name</var> exists. + @throws NoSuchElementException + if no element with the name <var>Name</var> exists. */ [const] com::sun::star::reflection::XIdlMethod getMethod( [in] string aName, [in] long nMethodConcepts ) @@ -243,16 +223,14 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + <TRUE/> if the method exists and fits the given <type>MethodConcepts</type>s; + otherwise <FALSE/> is returned. - @param aName - the name of the method. + @param aName + 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. */ [const] boolean hasMethod( [in] string aName, [in] long nMethodConcepts ); @@ -261,8 +239,8 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + all methods of the introspected object which accord to the + given <type>MethodConcept</type>s. */ [const] sequence<com::sun::star::reflection::XIdlMethod> getMethods( [in] long nMethodConcepts ); @@ -271,8 +249,8 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface // 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. + a sequence of the types of listener interfaces which are + supported by the introspected object. */ [const] sequence<TYPE_XIDLCLASS> getSupportedListeners(); @@ -282,53 +260,35 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface /** creates an adapter that implements an interface with the specified type. - - - <p>The supplied concepts (see the methods - - - - - - ) - and the - - - - - method - determine the interfaces returned by this method. - - </p> + <p>The supplied concepts (see the methods <member>???</member>) + and the <member>???</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> + 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> + <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 enumeration container, - the introspection should return the <type scope="com::sun::star::container">XEnumerationAccess</type> - interface. - - </p> + <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 the <type scope="com::sun::star::reflection">XIdlArray</type> - interface, the introspection should return this. - - </p> + 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>@see com::sun::star::beans::XExactName + interface, the <type>XExactName</type> interface has to be supported. </p> + + @see com::sun::star::beans::XExactName */ [const] com::sun::star::uno::XInterface queryAdapter( [in] TYPE_XIDLCLASS aInterfaceType ) raises( com::sun::star::beans::IllegalTypeException ); @@ -342,6 +302,9 @@ interface XIntrospectionAccess: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/beans/XMaterialHolder.idl b/udkapi/com/sun/star/beans/XMaterialHolder.idl index 1ef9eb9c5..2919f1dd8 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,9 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::beans::XMaterialHolder -/** allows the inspection of an object's properties and functions.@see method XIntrospectionAccess::inspect() +/** allows the inspection of an object's properties and functions. + + @see method XIntrospectionAccess::inspect() */ [ uik(E227A3DC-33D6-11D1-AABE00A0-249D5590), ident( "XMaterialHolder", 1.0 ) ] interface XMaterialHolder: com::sun::star::uno::XInterface @@ -95,6 +97,9 @@ interface XMaterialHolder: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl index 9cf5881b4..fe758c61b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -119,10 +119,9 @@ interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface <p> The values of the properties must change before bound events are fired. The values of constrained properties should change after the vetoable events are fired, if no - exception occurs. - </p> - <p> Unknown properties are ignored. - </p> + exception occurs. </p> + + <p> Unknown properties are ignored. </p> @param aHierarchicalPropertyNames This parameter specifies the names of the properties. @@ -138,8 +137,8 @@ interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface if one of the values is not a legal value for the corresponding property or if one of the names is not a well-formed nested name for this hierarchy. - <p> An implementation is not required to detect the latter - condition </p> + An implementation is not required to detect the latter + condition. @throws com::sun::star::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. @@ -160,20 +159,19 @@ interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** @returns - a sequence of all values of the properties which are specified - by their nested names. + a sequence of all values of the properties which are specified + by their nested names. - <p> The order of the values in the returned sequence will be the same - as the order of the names in the argument. - </p> - <p> Unknown properties are ignored, in their place <NULL/> will be returned. - </p> + <p> The order of the values in the returned sequence will be the same + as the order of the names in the argument. </p> + + <p> Unknown properties are ignored, in their place <NULL/> will be returned. </p> @throws com::sun::star::uno::lang::IllegalArgumentException if one of the names is not a well-formed nested name for this hierarchy. - <p> An implementation is not required to detect this - condition </p> + An implementation is not required to detect this + condition. @throws com::sun::star::uno::lang::WrappedTargetException if the implementation has an internal reason for the exception. @@ -198,6 +196,9 @@ interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:20 mi + moved from api + Revision 1.1 2000/10/19 08:32:51 jb Added HierarchicalPropertySet Interfaces diff --git a/udkapi/com/sun/star/beans/XMultiPropertySet.idl b/udkapi/com/sun/star/beans/XMultiPropertySet.idl index e8ed75ec2..7be7d947e 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,7 +93,7 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::beans::XMultiPropertySet -/** provides access to multiple properties. +/** provides access to multiple properties with a single call. */ [ uik(E227A45C-33D6-11D1-AABE00A0-249D5590), ident( "XMultiPropertySet", 1.0 ) ] interface XMultiPropertySet: com::sun::star::uno::XInterface @@ -102,12 +102,12 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XMultiPropertySet::getPropertySetInfo /** @returns - the <type>XPropertySetInfo</type> interface, which describes - all properties of the object to which this interface belongs. - <const>NULL</const> is returned if the object cannot or will - not provide information about the properties. + the <type>XPropertySetInfo</type> interface, which describes + all properties of the object to which this interface belongs. + <const>NULL</const> is returned if the object cannot or will + not provide information about the properties. - @see XPropertySet::getPropertySetInfo() + @see XPropertySet::getPropertySetInfo() */ [const] com::sun::star::beans::XPropertySetInfo getPropertySetInfo(); @@ -116,14 +116,10 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::setPropertyValues /** sets the values to the properties with the specified names. - - <p>The values of the properties must change before the bound events are fired. The values of the constrained properties should change after the vetoable events are fired and after if no - exception occur Unknown properties are ignored. - - </p> + exception occur Unknown properties are ignored. </p> */ void setPropertyValues( [in] sequence<string> PropertyNames, [in] sequence<any> Values ) @@ -135,11 +131,10 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XMultiPropertySet::getPropertyValues /** @returns - a sequence of all values of the properties which are specified - by their names. + a sequence of all values of the properties which are specified by their names. - <p>The order of the values in the returned sequence will be the same - as the order of the names in the argument. + <p>The order of the values in the returned sequence will be the same + as the order of the names in the argument. </p> */ [const] sequence<any> getPropertyValues( [in] sequence<string> aPropertyNames ); @@ -149,8 +144,10 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface /** adds an <type>XPropertiesChangeListener</type> to the specified property with the specified names. - The implementation can ignore the names of the properties - and fire the event on all properties.@see removePropertiesChangeListener + <p>The implementation can ignore the names of the properties + and fire the event on all properties. </p> + + @see removePropertiesChangeListener */ [oneway] void addPropertiesChangeListener( [in] sequence<string> aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener ); @@ -158,14 +155,11 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::removePropertiesChangeListener - /** removes an <type>XPropertiesChangeListener</type> from the - listener list. - + /** removes an <type>XPropertiesChangeListener</type> from the listener list. - - <p>It is a "noop" if the listener is not registered. - - </p>@see addPropertiesChangeListener + <p>It is a "noop" if the listener is not registered. </p> + + @see addPropertiesChangeListener */ [oneway] void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener Listener ); @@ -187,6 +181,9 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl index 353750920..51d795596 100644 --- a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl +++ b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiPropertyStates.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,7 +93,7 @@ module com { module sun { module star { module beans { <p>The state contains the information if a value is available or void and if the value is stored in the object itself, or if a default value is to be used and if the value cannot be determined, due to ambiguity - (multi selection with multipe values). + (multi selection with multipe values). </p> */ [ uik(0CF62671-69DF-11d4-9FE50010-5AEF84A7), ident( "XMultiPropertyStates", 1.0 ) ] interface XMultiPropertyStates: com::sun::star::uno::XInterface @@ -117,6 +117,7 @@ interface XMultiPropertyStates: com::sun::star::uno::XInterface If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value. + </p> */ void setAllPropertiesToDefault(); @@ -126,7 +127,7 @@ interface XMultiPropertyStates: com::sun::star::uno::XInterface <p>Each value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you - must fire the vetoable event before you change the property value. + must fire the vetoable event before you change the property value. </p> @param aPropertyNames specifies the names of the properties. @@ -143,7 +144,7 @@ interface XMultiPropertyStates: com::sun::star::uno::XInterface <p>If no default exists, is not known or is void, then the return type at the corresponding position in the - sequence returned is <type>void</type>. + sequence returned is <type>void</type>. </p> @param aPropertyNames specifies the names of the properties. diff --git a/udkapi/com/sun/star/beans/XPropertyAccess.idl b/udkapi/com/sun/star/beans/XPropertyAccess.idl index fcb399cba..e7566b938 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,18 +93,14 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::beans::XPropertyAccess -/** makes it possible to access all multiple property values - and to set them at once. - - +/** makes it possible to access all property values and to set them at once. <p>In most cases this interface will be in addition to <type>XPropertySet</type>. It is especially useful for remote communication because it lessens the number of calls for getting property values; that is especially important because these calls - are necessarily synchronous. - - </p> + are necessarily synchronous. </p> + <p>Another advantage of this method is that conflicts are avoided if property value restrictions depend on the value of other properties.</p> */ @@ -115,8 +111,7 @@ interface XPropertyAccess: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertyAccess::getPropertyValues /** @returns - a sequence of all property values within the object in a single - call. + a sequence of all property values within the object in a single call. */ [const] sequence<com::sun::star::beans::PropertyValue> getPropertyValues(); @@ -125,8 +120,6 @@ interface XPropertyAccess: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::XPropertyAccess::setPropertyValues /** sets the values of given properties. - - <p>All properties which are not contained in the sequence <var>aProps</var> will be left unchanged.</p> */ @@ -145,6 +138,9 @@ interface XPropertyAccess: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XPropertyContainer.idl b/udkapi/com/sun/star/beans/XPropertyContainer.idl index aabc787a6..2a1100e7d 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,8 +104,9 @@ interface XPropertyContainer: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::beans::XPropertyContainer::addProperty - /** adds a property to the object.@see - com::sun::star::beans::PropertyAttribute + /** adds a property to the object. + + @see com::sun::star::beans::PropertyAttribute */ void addProperty( [in] string Name, [in] short Attributes, @@ -131,6 +132,9 @@ interface XPropertyContainer: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XPropertySet.idl b/udkapi/com/sun/star/beans/XPropertySet.idl index 1d40e8e55..27f6a2a05 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -104,27 +104,22 @@ /** provides information about and access to the properties from an implementation. - - - <p>There are three types of properties: - </p> + <p>There are three types of properties: </p> + <ul> - <li>bound properties - </li> - <li>constrained properties - </li> - <li>free properties - </li> + <li>bound properties </li> + <li>constrained properties </li> + <li>free properties </li> </ul> - <p>You can listen to changes of bound properties with the <type>XPropertyChangeListener</type> and you can veto changes - of constrained properties with the <type>XVetoableChangeListener</type>. - - </p> + of constrained properties with the <type>XVetoableChangeListener</type>. </p> + <p>To implement inaccurate name access, you must support the - interface <type>XExactName</type>. </p>@see com::sun::star::beans::XExactName + interface <type>XExactName</type>. </p> + + @see com::sun::star::beans::XExactName */ [ uik(E227A3A8-33D6-11D1-AABE00A0-249D5590), ident( "XPropertySet", 1.0 ) ] interface XPropertySet: com::sun::star::uno::XInterface @@ -133,14 +128,14 @@ interface XPropertySet: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertySet::getPropertySetInfo /** @returns - the <type>XPropertySetInfo</type> interface, which - describes all properties of the object which supplies this - interface. - - @returns - <const>NULL</const> if the implementation cannot or will - not provide information about the properties; otherwise the - interface <type>XPropertySetInfo</type> is returned. + the <type>XPropertySetInfo</type> interface, which + describes all properties of the object which supplies this + interface. + + @returns + <const>NULL</const> if the implementation cannot or will + not provide information about the properties; otherwise the + interface <type>XPropertySetInfo</type> is returned. */ [const] com::sun::star::beans::XPropertySetInfo getPropertySetInfo(); @@ -149,14 +144,10 @@ interface XPropertySet: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::XPropertySet::setPropertyValue /** sets the value of the property with the specified name. - - <p>If it is a bound property the value will be changed before the change event is fired. If it is a constrained property a vetoable event is fired before the property value can be - changed. - - </p> + changed. </p> */ void setPropertyValue( [in] string aPropertyName, [in] any aValue ) @@ -169,18 +160,18 @@ interface XPropertySet: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertySet::getPropertyValue /** @returns - the value of the property with the specified name. - - @param PropertyName - This parameter specifies the name of the property. + the value of the property with the specified name. - @throws UnknownPropertyException - if the property does not exist. + @param PropertyName + This parameter specifies the name of the property. + + @throws UnknownPropertyException + if the property does not exist. - @throws com::sun::star::lang::WrappedTargetException - if the implementation has an internal reason for the exception. - In this case the original exception is wrapped into that - <type scope="com::sun::star::lang">WrappedTargetException</type>. + @throws com::sun::star::lang::WrappedTargetException + if the implementation has an internal reason for the exception. + In this case the original exception is wrapped into that + <type scope="com::sun::star::lang">WrappedTargetException</type>. */ [const] any getPropertyValue( [in] string PropertyName ) raises( com::sun::star::beans::UnknownPropertyException, @@ -189,16 +180,13 @@ interface XPropertySet: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::beans::XPropertySet::addPropertyChangeListener - /** adds an <type>XPropertyChangeListener</type> to the - specified property. - - + /** adds an <type>XPropertyChangeListener</type> to the specified property. <p>An empty name ("") registers the listener to all bound properties. If the property is not bound, the behavior is - not specified. - - </p>@see removePropertyChangeListener + not specified. </p> + + @see removePropertyChangeListener */ void addPropertyChangeListener( [in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener ) @@ -211,11 +199,9 @@ interface XPropertySet: com::sun::star::uno::XInterface /** removes an <type>XPropertyChangeListener</type> from the listener list. - - - <p>It is a "noop" if the listener is not registered. - - </p>@see addPropertyChangeListener + <p>It is a "noop" if the listener is not registered. </p> + + @see addPropertyChangeListener */ void removePropertyChangeListener( [in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener ) @@ -228,13 +214,11 @@ interface XPropertySet: com::sun::star::uno::XInterface /** adds an <type>XVetoableChangeListener</type> to the specified property with the name PropertyName. - - <p>An empty name ("") registers the listener to all constrained properties. If the property is not constrained, - the behavior is not specified. - - </p>@see removeVetoableChangeListener + the behavior is not specified. </p> + + @see removeVetoableChangeListener */ void addVetoableChangeListener( [in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener ) @@ -247,11 +231,9 @@ interface XPropertySet: com::sun::star::uno::XInterface /** removes an <type>XVetoableChangeListener</type> from the listener list. - - - <p>It is a "noop" if the listener is not registered. - - </p>@see addVetoableChangeListener + <p>It is a "noop" if the listener is not registered. </p> + + @see addVetoableChangeListener */ void removeVetoableChangeListener( [in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener ) @@ -267,6 +249,9 @@ interface XPropertySet: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/beans/XPropertySetInfo.idl b/udkapi/com/sun/star/beans/XPropertySetInfo.idl index 55d527e39..39bd7771a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,8 +83,6 @@ // DocMerge from xml: interface com::sun::star::beans::XPropertySetInfo /** specifies a set of properties. - - <p>The specification only describes the properties, it does not contain any values.</p> */ @@ -95,8 +93,8 @@ interface XPropertySetInfo: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertySetInfo::getProperties /** @returns - a sequence with all property descriptors which are specified - within this <type>XPropertySetInfo</type>. + a sequence with all property descriptors which are specified + within this <type>XPropertySetInfo</type>. */ [const] sequence<com::sun::star::beans::Property> getProperties(); @@ -104,13 +102,13 @@ interface XPropertySetInfo: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertySetInfo::getPropertyByName /** @returns - the property with the specified name from the object. + the property with the specified name from the object. - @param aName - specifies the name of the property. + @param aName + specifies the name of the property. - @throws UnknownPropertyException - if the property does not exist. + @throws UnknownPropertyException + if the property does not exist. */ [const] com::sun::star::beans::Property getPropertyByName( [in] string aName ) raises( com::sun::star::beans::UnknownPropertyException ); @@ -119,11 +117,11 @@ interface XPropertySetInfo: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertySetInfo::hasPropertyByName /** @returns - <TRUE/> if a property with the specified name exist; - otherwise <FALSE/> is returned. + <TRUE/> if a property with the specified name exist; + otherwise <FALSE/> is returned. - @param aName - specifies the name of the property. + @param aName + specifies the name of the property. */ [const] boolean hasPropertyByName( [in] string Name ); @@ -136,6 +134,9 @@ interface XPropertySetInfo: com::sun::star::uno::XInterface /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/beans/XPropertyState.idl b/udkapi/com/sun/star/beans/XPropertyState.idl index 01b5fe63f..454d61cd6 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -92,14 +92,12 @@ /** makes it possible to query information about the state of one or more properties. - - <p>The state contains the information if:</p> <ul> - <li>a value is available or void</li> - <li>the value is stored in the object itself, or if a default value is to be used</li> - <li>and if the value cannot be determined, due to ambiguity - (multi selection with multipe values).</li> + <li>a value is available or void</li> + <li>the value is stored in the object itself, or if a default value is to be used</li> + <li>and if the value cannot be determined, due to ambiguity + (multi selection with multipe values).</li> </ul> */ [ uik(E227A393-33D6-11D1-AABE00A0-249D5590), ident( "XPropertyState", 1.0 ) ] @@ -111,11 +109,11 @@ interface XPropertyState: com::sun::star::uno::XInterface /** @returns the state of the property. - @param aPropertyName - specifies the name of the property. + @param aPropertyName + specifies the name of the property. - @throws UnknownPropertyException - if the property does not exist. + @throws UnknownPropertyException + if the property does not exist. */ com::sun::star::beans::PropertyState getPropertyState( [in] string PropertyName ) raises( com::sun::star::beans::UnknownPropertyException ); @@ -124,11 +122,11 @@ interface XPropertyState: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertyState::getPropertyStates /** @returns - a sequence of the states of the properties which are specified - by their names. + a sequence of the states of the properties which are specified + by their names. - <p>The order of the states is correlating to the order of the - given property names. + <p>The order of the states is correlating to the order of the + given property names. */ sequence<com::sun::star::beans::PropertyState> getPropertyStates( [in] sequence<string> aPropertyName ) @@ -139,13 +137,10 @@ interface XPropertyState: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::beans::XPropertyState::setPropertyToDefault /** Sets the property to default value. - - <p>The value depends on the implementation of this interface. If it is a bound property, you must change the value before the change events are fired. If it is a constrained property, you must fire the vetoable event before you change the property value. - </p> */ void setPropertyToDefault( [in] string PropertyName ) @@ -155,21 +150,21 @@ interface XPropertyState: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::beans::XPropertyState::getPropertyDefault /** @returns - the default value of the property with the name PropertyName. - - <p>If no default exists, is not known or is void, - then the return type is <type>void</type>. + the default value of the property with the name PropertyName. - @param aPropertyName - specifies the name of the property. + <p>If no default exists, is not known or is void, + then the return type is <type>void</type>. - @throws UnknownPropertyException - if the property does not exist. - - @throws com::sun::star::lang::WrappedTargetException - if the implementation has an internal reason for the exception. - In this case the original exception is wrapped into that - <type scope="com::sun::star::lang">WrappedTargetException</type>. + @param aPropertyName + specifies the name of the property. + + @throws UnknownPropertyException + if the property does not exist. + + @throws com::sun::star::lang::WrappedTargetException + if the implementation has an internal reason for the exception. + In this case the original exception is wrapped into that + <type scope="com::sun::star::lang">WrappedTargetException</type>. */ [const] any getPropertyDefault( [in] string aPropertyName ) raises( com::sun::star::beans::UnknownPropertyException, @@ -183,6 +178,9 @@ interface XPropertyState: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/beans/XPropertyWithState.idl b/udkapi/com/sun/star/beans/XPropertyWithState.idl index 143f7fa0d..8748d3e45 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -111,8 +111,7 @@ interface XPropertyWithState: com::sun::star::uno::XInterface //------------------------------------------------------------------------- - /** Sets this to its default value. - + /** sets this to its default value. <p> The value depends on the implementation of this interface. If this is a bound property, the value changes before @@ -153,6 +152,9 @@ interface XPropertyWithState: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:20 mi + moved from api + Revision 1.1 2000/10/19 08:33:52 jb Added Interfaces for property objects diff --git a/udkapi/com/sun/star/beans/XVetoableChangeListener.idl b/udkapi/com/sun/star/beans/XVetoableChangeListener.idl index dcc48e0dd..fc50d88e7 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,8 +84,6 @@ /** is used to receive <type>PropertyChangeEvent</type>s whenever a "constrained" property is changed. - - <p>You can register an <type>XVetoableChangeListener</type> with a source object so as to be notified of any constrained property updates.</p> */ @@ -109,6 +107,9 @@ interface XVetoableChangeListener: com::sun::star::lang::XEventListener /*============================================================================= $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:56 hjs initial import diff --git a/udkapi/com/sun/star/bridge/Bridge.idl b/udkapi/com/sun/star/bridge/Bridge.idl index 99fac96b0..aa1016d20 100644 --- a/udkapi/com/sun/star/bridge/Bridge.idl +++ b/udkapi/com/sun/star/bridge/Bridge.idl @@ -2,9 +2,9 @@ * * $RCSfile: Bridge.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,38 +79,36 @@ module com { module sun { module star { module bridge { //============================================================================= -/** - * - * a meta service which allows the bridgefactory service - * to instantiate an interprocess bridge using a certain transfer protocol. - * <p> - * Components, that support a certain protocol, must have at least two - * service names : - * <ul> - * <li> com.sun.star.bridge.Bridge </li> - * <li> arbitrary-module-path.ProtocolnameBridge </li> - * </ul> - * <p> - * The protocol name should be written as common servicenames, first letter is a - * capital letter, the rest in small letters postfixed by Bridge (e.g. : - * com.sun.star.bridge.UrpBridge would be correct servicename for the urp protocol). - * However, the protocol names are compared case insensitive. - * If there exist two services supporting the same protocol, it is arbitrary - * which one is chosen, so this should be omitted. +/** This meta service allows the bridgefactory service to instantiate an + interprocess bridge using a certain transfer protocol. + + <p> Components, that support a certain protocol, must have at least two + service names: </p> + + <ul> + <li> com.sun.star.bridge.Bridge </li> + <li> arbitrary-module-path.ProtocolnameBridge </li> + </ul> + + <p>The protocol name should be written as common servicenames, first letter is a + capital letter, the rest in small letters postfixed by Bridge (e.g.: + <code>com.sun.star.bridge.UrpBridge</code> would be correct servicename for the + "urp" protocol). However, the protocol names are compared case insensitive. + If there exist two services supporting the same protocol, it is arbitrary + which one is chosen, so this should be omitted. </p> */ service Bridge { - /** - * allows to initialize the bridge service with the necessary - * arguments. The sequence<any> must have 4 members. - * - * <ol> - * <li> String : The unique name of the bridge or an empty string</li> - * <li> String : The protocol, that shall be instantiated</li> - * <li> XConnection : The bidirectional connection, the bridge should work on</li> - * <li> XInstanceProvider : The instance provider, that shall be called to access the - * initial object.</li> - * </ol> + /** allows to initialize the bridge service with the necessary + arguments. The sequence<any> must have 4 members. + + <ol> + <li> String: The unique name of the bridge or an empty string</li> + <li> String: The protocol, that shall be instantiated</li> + <li> XConnection: The bidirectional connection, the bridge should work on</li> + <li> XInstanceProvider: + The instance provider, that shall be called to access the initial object.</li> + </ol> */ interface com::sun::star::lang::XInitialization; diff --git a/udkapi/com/sun/star/bridge/BridgeExistsException.idl b/udkapi/com/sun/star/bridge/BridgeExistsException.idl index c8ea8a8f6..8637ca45e 100644 --- a/udkapi/com/sun/star/bridge/BridgeExistsException.idl +++ b/udkapi/com/sun/star/bridge/BridgeExistsException.idl @@ -2,9 +2,9 @@ * * $RCSfile: BridgeExistsException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,12 +63,12 @@ #include <com/sun/star/uno/Exception.idl> - module com { module sun { module star { module bridge { +module com { module sun { module star { module bridge { // DocMerge: empty anyway exception BridgeExistsException: com::sun::star::uno::Exception { - }; +}; };};};}; diff --git a/udkapi/com/sun/star/bridge/BridgeFactory.idl b/udkapi/com/sun/star/bridge/BridgeFactory.idl index edb5873fd..a41c0cddb 100644 --- a/udkapi/com/sun/star/bridge/BridgeFactory.idl +++ b/udkapi/com/sun/star/bridge/BridgeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: BridgeFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,10 +76,12 @@ //============================================================================= /** allows to create new or access existing interprocess bridges. - * <p> - * It enumerates at the servicemanager all services supporting - * the meta service com.sun.star.bridge.Bridge to get to know possible - * protocols ( @see com.sun.star.bridge.Bridge service ). + + <p> It enumerates at the servicemanager all services supporting + the meta service com.sun.star.bridge.Bridge to get to know possible + protocols. + + @see com::sun::star::bridge::Bridge */ service BridgeFactory { diff --git a/udkapi/com/sun/star/bridge/IiopBridge.idl b/udkapi/com/sun/star/bridge/IiopBridge.idl index 916979072..62cb590b8 100644 --- a/udkapi/com/sun/star/bridge/IiopBridge.idl +++ b/udkapi/com/sun/star/bridge/IiopBridge.idl @@ -2,9 +2,9 @@ * * $RCSfile: IiopBridge.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,23 @@ //============================================================================= /** Concrete service of the meta service Bridge for iiop. - * <p> - * This bridge works with the iiop protocol ( - * @see com.sun.star.bridge.Bridge ). + + <p> This bridge works with the iiop protocol. </p> + + @see com.sun.star.bridge.Bridg */ service IiopBridge { - /** - * This interface allows to initialize the bridge service with the necessary - * arguments. The sequence<any> must have 4 members. - * - * <ol> - * <li> String : The unique name of the bridge or an empty string</li> - * <li> String : iiop</li> - * <li> XConnection : The bidirectional connection, the bridge should work on</li> - * <li> XInstanceProvider : The instance provider, that shall be called to access the - * initial object.</li> - * </ol> + /** This interface allows to initialize the bridge service with the necessary + arguments. The sequence<any> must have 4 members. + + <ol> + <li> String: The unique name of the bridge or an empty string</li> + <li> String: iiop</li> + <li> XConnection: The bidirectional connection, the bridge should work on</li> + <li> XInstanceProvider: + The instance provider, that shall be called to access the initial object.</li> + </ol> */ interface com::sun::star::lang::XInitialization; diff --git a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl index dd167a219..4f43af881 100644 --- a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl +++ b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvalidProtocolChangeException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,14 +68,13 @@ module com { module sun { module star { module bridge { exception InvalidProtocolChangeException : com::sun::star::uno::Exception { - /*** - * The first invalid property. - **/ + /** The first invalid property. + */ ProtocolProperty invalidProperty; - /*** - * 1 : unkown (the property name is unknown to the thrower) - * 2 : invalid value (the property's value can't be accepted by the thrower) - ***/ + + /** Contains 1, if the property name is unknown to the thrower; + or contains 2, if the property's value can't be accepted by the thrower. + */ long reason; }; diff --git a/udkapi/com/sun/star/bridge/ModelDependent.idl b/udkapi/com/sun/star/bridge/ModelDependent.idl index 50690a263..077447ca0 100644 --- a/udkapi/com/sun/star/bridge/ModelDependent.idl +++ b/udkapi/com/sun/star/bridge/ModelDependent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ModelDependent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,10 +71,11 @@ // DocMerge from idl: constants com::sun::star::bridge::ModelDependent /** These constants are used to specify model-dependant representations. - <p>They are only used for creating bridges to other component models. - - @see com::sun::star::bridge::XBridgeSupplier - @deprecated + <p>They are only used for creating bridges to other component models. + + @see com::sun::star::bridge::XBridgeSupplier + + @deprecated */ constants ModelDependent { @@ -111,6 +112,9 @@ constants ModelDependent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 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) diff --git a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl index cab3dcfe3..5a3dd9fa6 100644 --- a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl +++ b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleApplicationRegistration.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,22 +75,14 @@ // DocMerge from xml: service com::sun::star::bridge::OleApplicationRegistration /** registers standard UNO objects to OLE Automation. - - <p>It does not provide any specific interface because the UNO object is registered while instanciating this service and deregistered - if the implementation is released. - - </p> - <p> The following UNO objects are provided: - </p> + if the implementation is released. </p> + + <p> The following UNO objects are provided: </p> <ul> - <li> - <type scope="com::sun::star::lang">ServiceManager</type> - </li> - <li> - <type scope="com::sun::star::frame">Desktop</type> - </li> + <li> <type scope="com::sun::star::lang">ServiceManager</type> </li> + <li> <type scope="com::sun::star::frame">Desktop</type> </li> </ul> */ service OleApplicationRegistration @@ -107,6 +99,9 @@ service OleApplicationRegistration /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:56 hjs initial import diff --git a/udkapi/com/sun/star/bridge/OleBridgeSupplier.idl b/udkapi/com/sun/star/bridge/OleBridgeSupplier.idl index d4b2c1d57..5d49b5a04 100644 --- a/udkapi/com/sun/star/bridge/OleBridgeSupplier.idl +++ b/udkapi/com/sun/star/bridge/OleBridgeSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleBridgeSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,14 +75,10 @@ // DocMerge from xml: service com::sun::star::bridge::OleBridgeSupplier /** makes it possible to generate OLE bridges to UNO objects and vice versa. - - <p>The service implements the <type>XBridgeSupplier</type> interface and handles the model types <const>ModelDependent::UNO</const> and <const>ModelDependent::OLE</const>. The service does not specify any - requirements on registering OLE objects and class factories. - - </p> + requirements on registering OLE objects and class factories. </p> */ service OleBridgeSupplier { @@ -98,6 +94,9 @@ service OleBridgeSupplier /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:56 hjs initial import diff --git a/udkapi/com/sun/star/bridge/OleBridgeSupplier2.idl b/udkapi/com/sun/star/bridge/OleBridgeSupplier2.idl index ea3e51d65..fc52d86c4 100644 --- a/udkapi/com/sun/star/bridge/OleBridgeSupplier2.idl +++ b/udkapi/com/sun/star/bridge/OleBridgeSupplier2.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleBridgeSupplier2.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,13 +73,14 @@ module com { module sun { module star { module bridge { //============================================================================= /** maps UNO types to COM types and vice versa. <p> - The COM types are restricted to those types that can be represented + <p>The COM types are restricted to those types that can be represented by a <code>VARIANT</code> except for <code>VT_CY</code> and <code>VT_DATE</code>. An <code>IUnknown</code> interface can only be mapped, if it can be successfully queried for - <code>IDispatch</code>. - Other COM interfaces are not supported. On the other hand UNO objects - and structs are always mapped to COM objects exposing <code>IDispatch</code>. + <code>IDispatch</code>. </p> + + <p>Other COM interfaces are not supported. On the other hand UNO objects + and structs are always mapped to COM objects exposing <code>IDispatch</code>. </p> <p>The service implements the <type>XBridgeSupplier2</type> interface @@ -87,10 +88,11 @@ module com { module sun { module star { module bridge { <const>com::sun::star::bridge::ModelDependent::UNO</const> and <const>com::sun::star::bridge::ModelDependent::OLE</const>. The service does not specify any - requirements for registering OLE objects and class factories. + requirements for registering OLE objects and class factories. </p> @guarantees -thread safe + @guarantees -one instance service */ diff --git a/udkapi/com/sun/star/bridge/OleObjectFactory.idl b/udkapi/com/sun/star/bridge/OleObjectFactory.idl index 9bb7bf7b0..498ff7539 100644 --- a/udkapi/com/sun/star/bridge/OleObjectFactory.idl +++ b/udkapi/com/sun/star/bridge/OleObjectFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: OleObjectFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,24 +75,13 @@ // DocMerge from xml: service com::sun::star::bridge::OleObjectFactory /** makes it possible to create OLE objects as UNO objects. - - <p>Any OLE objects which are accessable via <function>CLSIDFromProgID()</function> and <function>CoCreateInstance()</function> could be created by this service. - The created UNO objects support <type scope="com::sun::star::script">XInvocation</type> if the original OLE objects - support IDispatch. - - </p> - <p>The optional parameters of the method - - + The created UNO objects support <type scope="com::sun::star::script">XInvocation</type> + if the original OLE objects support IDispatch. </p> - - - - are reserved for future use; at this time they are ignored. - - </p> + <p>The optional parameters of the method <member>???</member> + are reserved for future use; at this time they are ignored. </p> */ service OleObjectFactory { @@ -108,6 +97,9 @@ service OleObjectFactory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:57 hjs initial import diff --git a/udkapi/com/sun/star/bridge/ProtocolProperty.idl b/udkapi/com/sun/star/bridge/ProtocolProperty.idl index c9524a004..d6bbe9660 100644 --- a/udkapi/com/sun/star/bridge/ProtocolProperty.idl +++ b/udkapi/com/sun/star/bridge/ProtocolProperty.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProtocolProperty.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,9 +63,16 @@ module com { module sun { module star { module bridge { +/** @missing + */ struct ProtocolProperty { + /** @missing + */ string Name; + + /** @missing + */ any Value; }; diff --git a/udkapi/com/sun/star/bridge/UrpBridge.idl b/udkapi/com/sun/star/bridge/UrpBridge.idl index ea36743d1..7abb0797e 100644 --- a/udkapi/com/sun/star/bridge/UrpBridge.idl +++ b/udkapi/com/sun/star/bridge/UrpBridge.idl @@ -2,9 +2,9 @@ * * $RCSfile: UrpBridge.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,23 @@ //============================================================================= /** Concrete service of the meta service Bridge for the urp protocol. - * <p> - * This bridge works with the urp protocol - * (@see com.sun.star.bridge.Bridge ). + + <p>This bridge works with the urp protocol. + + @see com.sun.star.bridge.Bridge */ service UrpBridge { - /** - * This interface allows to initialize the bridge service with the necessary - * arguments. The sequence<any> must have 4 members. - * - * <ol> - * <li> String : The unique name of the bridge or an empty string</li> - * <li> String : urp</li> - * <li> XConnection : The bidirectional connection, the bridge should work on</li> - * <li> XInstanceProvider : The instance provider, that shall be called to access the - * initial object.</li> - * </ol> + /** This interface allows to initialize the bridge service with the necessary + arguments. The sequence<any> must have 4 members. + + <ol> + <li> String: The unique name of the bridge or an empty string</li> + <li> String: urp</li> + <li> XConnection: The bidirectional connection, the bridge should work on</li> + <li> XInstanceProvider: + The instance provider, that shall be called to access the initial object.</li> + </ol> */ interface com::sun::star::lang::XInitialization; diff --git a/udkapi/com/sun/star/bridge/XBridge.idl b/udkapi/com/sun/star/bridge/XBridge.idl index ed2d1d4b6..7ceea8e59 100644 --- a/udkapi/com/sun/star/bridge/XBridge.idl +++ b/udkapi/com/sun/star/bridge/XBridge.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridge.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,18 +63,18 @@ #include <com/sun/star/uno/XInterface.idl> +module com { module sun { module star { module bridge { - module com { module sun { module star { module bridge { - -// DocMerge: empty anyway +/** @missing + */ [ uik(8E6CB4B0-D3F0-11d3-9EE80050-04D7755D), ident( "XBridge", 1.0 ) ] interface XBridge: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::bridge::XBridge::getInstance /** tries to get an interface from the remote that is known by this name. - In general, this method is called once to get the initial object from the remote, - but it is allowed to call the method multiple times. + + <p>In general, this method is called once to get the initial object from the + remote, but it is allowed to call the method multiple times. </p> */ XInterface getInstance( [in] string sInstanceName ); @@ -86,8 +86,7 @@ interface XBridge: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::bridge::XBridge::getDescription - /** a descriptive string : protocol: + XConnection.getDescription() - This description is unique. + /** a unique descriptive string: protocol + ":" + XConnection.getDescription() */ string getDescription(); }; diff --git a/udkapi/com/sun/star/bridge/XBridgeFactory.idl b/udkapi/com/sun/star/bridge/XBridgeFactory.idl index cf1d095ff..d885aa7cd 100644 --- a/udkapi/com/sun/star/bridge/XBridgeFactory.idl +++ b/udkapi/com/sun/star/bridge/XBridgeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,25 +70,33 @@ module com { module sun { module star { module bridge { -// DocMerge: empty anyway +/** @missing + */ [ uik(4D463C50-D3E8-11d3-9EE80050-04D7755D), ident( "XBridgeFactory", 1.0 ) ] interface XBridgeFactory: com::sun::star::uno::XInterface { - // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::createBridge - /** ****** - * @param sName The name of the bridge. The format should be protocol:connection-description - * (e.g. iiop:socket:localhost:2000). This allows other components to reuse - * an already created bridge (using getBridge). - * @param sProtocol The protocol, the bridge should work on. - * @param aConnection The connection on which the calls will be transfered. - * @param anInstanceProvider gets called, when a request from remote comes in. - * - * @exception BridgeExistsException There is already a bridge registered with this name. - * Use getBridge instead. - * @exception IllegalArgumentException The protocol is unknown. - * - ******* + /** @incomplete + + @param sName + The name of the bridge. The format should be protocol:connection-description + (e.g. iiop:socket:localhost:2000). This allows other components to reuse + an already created bridge (using getBridge). + + @param sProtocol + The protocol, the bridge should work on. + + @param aConnection + The connection on which the calls will be transfered. + + @param anInstanceProvider + gets called, when a request from remote comes in. + + @exception BridgeExistsException + There is already a bridge registered with this name. Use getBridge instead. + + @exception IllegalArgumentException + The protocol is unknown. */ XBridge createBridge( [in] string sName, @@ -103,12 +111,9 @@ interface XBridgeFactory: com::sun::star::uno::XInterface */ XBridge getBridge( [in] string sName ); - - // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::getExistingBridges - /** *** - * @return Sequence of all existing bridges. - *** + /** @returns + Sequence of all existing bridges. */ sequence < XBridge > getExistingBridges( ); }; diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl index 1949a0e45..a0349730a 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,50 +83,40 @@ // DocMerge from xml: interface com::sun::star::bridge::XBridgeSupplier /** defines the interface for creating bridges to other object models. - - <p>Because bridges sometimes can not be generated in an address space, the implementation needs to check the address space of the caller by comparing the machine and process ID against its own. These IDs are - provided by the UNO runtime. - - </p> + provided by the UNO runtime. </p> + <p>All objects, whether they are part of the UNO object model or not, are carried in an <atom>any</atom>. The representation of this object - is heavily model-dependent and has to be specified in the following list: + is heavily model-dependent and has to be specified in the following list: </p> <dl> - <dt>UNO: - </dt> - <dd>The any carries normal UNO types, which can be any base type, - struct, sequence, enum, or interface. - - </dd> - <dt>OLE: - </dt> - <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) - or an <atom>unsigned hyper</atom> (on 64-bit systems), which is - interpreted as a variant pointer. The any does not control the - lifetime of the represented variant. That implies that the caller - has the responsibility of freeing the OLE resources represented - by the any value. - - </dd> - <dt>JAVA: - </dt> - <dd>not yet specified. - - </dd> - <dt>CORBA: - </dt> - <dd>not yet specified. - </dd> + <dt>UNO: </dt> + <dd>The any carries normal UNO types, which can be any base type, + struct, sequence, enum, or interface. </dd> + + <dt>OLE: </dt> + <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) + or an <atom>unsigned hyper</atom> (on 64-bit systems), which is + interpreted as a variant pointer. The any does not control the + lifetime of the represented variant. That implies that the caller + has the responsibility of freeing the OLE resources represented + by the any value. </dd> + + <dt>JAVA: </dt> + <dd>not yet specified. </dd> + + <dt>CORBA: </dt> + <dd>not yet specified. </dd> </dl> - </p> <p>Any implementation can supply its own bridges to other object models by implementing this interface and returning the bridge - when the method is called with itself as the first parameter. </p>@see com::sun::star::bridge::OleBridgeSupplier + when the method is called with itself as the first parameter. </p> + + @see com::sun::star::bridge::OleBridgeSupplier */ [ uik(E227A548-33D6-11D1-AABE00A0-249D5590), ident( "XBridgeSupplier", 1.0 ) ] interface XBridgeSupplier: com::sun::star::uno::XInterface @@ -152,6 +142,9 @@ interface XBridgeSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 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) diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl index 8ae190232..a7b89709f 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeSupplier2.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,57 +83,42 @@ // DocMerge from xml: interface com::sun::star::bridge::XBridgeSupplier2 /** defines the interface for creating bridges to other object models. - <p>Because bridges sometimes can not be generated in an address space, the implementation needs to check the address space of the caller by comparing the process ID against its own. That ID is - provided by the UNO runtime. - - </p> + provided by the UNO runtime. </p> + <p>All objects, whether they are part of the UNO object model or not, are carried in an <atom>any</atom>. The representation of this object - is heavily model-dependent and has to be specified in the following list: + is heavily model-dependent and has to be specified in the following list: </p> <dl> - <dt>UNO: - </dt> - <dd>The any carries normal UNO types, which can be any base type, - struct, sequence, enum or interface. - - </dd> - <dt>OLE: - </dt> - <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) - or an <atom>unsigned hyper</atom> (on 64-bit systems), which is - interpreted as a variant pointer. The any does not control the - lifetime of the represented variant. That implies that the caller - has the responsibility of freeing the OLE resources represented - by the any value. - - </dd> - <dt>JAVA: - </dt> - <dd>not specified yet. - - </dd> - <dt>CORBA: - </dt> - <dd>not specified yet. - </dd> + <dt>UNO: </dt> + <dd>The any carries normal UNO types, which can be any base type, + struct, sequence, enum or interface. </dd> + + <dt>OLE: </dt> + <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) + or an <atom>unsigned hyper</atom> (on 64-bit systems), which is + interpreted as a variant pointer. The any does not control the + lifetime of the represented variant. That implies that the caller + has the responsibility of freeing the OLE resources represented + by the any value. </dd> + + <dt>JAVA: </dt> + <dd>not specified yet. </dd> + + <dt>CORBA: </dt> + <dd>not specified yet. </dd> </dl> </p> <p>Any implementation can supply its own bridges to other object models by implementing this interface and returning the bridge - when the method - - - - - - is called with itself as the first parameter. - - </p>@see com::sun::star::bridge::OleBridgeSupplier2 + when the method <member>???</member> + is called with itself as the first parameter. </p> + + @see com::sun::star::bridge::OleBridgeSupplier2 */ [ uik(5F97D2F0-50F8-11d4-83240050-04526AB4), ident( "XBridgeSupplier2", 1.0 ) ] interface XBridgeSupplier2: com::sun::star::uno::XInterface @@ -158,6 +143,9 @@ interface XBridgeSupplier2: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:57 hjs initial import diff --git a/udkapi/com/sun/star/bridge/XInstanceProvider.idl b/udkapi/com/sun/star/bridge/XInstanceProvider.idl index b97f1dfee..669b876de 100644 --- a/udkapi/com/sun/star/bridge/XInstanceProvider.idl +++ b/udkapi/com/sun/star/bridge/XInstanceProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInstanceProvider.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,13 +66,15 @@ module com { module sun { module star { module bridge { -// DocMerge: empty anyway +/** @missing + */ [ uik(F84614A0-D3F0-11d3-9EE80050-04D7755D), ident("XInstanceProvider", 0.1) ] interface XInstanceProvider: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::bridge::XInstanceProvider::getInstance - /** returns the object associated with the name. + /** @returns + the object associated with the name. */ com::sun::star::uno::XInterface getInstance( [in] string sInstanceName ) raises ( com::sun::star::container::NoSuchElementException ); diff --git a/udkapi/com/sun/star/bridge/XProtocolProperties.idl b/udkapi/com/sun/star/bridge/XProtocolProperties.idl index 96b8c1531..04105baea 100644 --- a/udkapi/com/sun/star/bridge/XProtocolProperties.idl +++ b/udkapi/com/sun/star/bridge/XProtocolProperties.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProtocolProperties.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,60 +66,67 @@ module com { module sun { module star { module bridge { -/****** - * INTERNAL INTERFACE, DO NOT USE IT ELSEWHERE - * Bridge internal interface, that allows to change protocol settings of the remote - * counter part. In general, this interface is implemented by the bridge itself. It must not - * be called from outside the bridge. - *****/ +/** Bridge internal interface, that allows to change protocol settings of the remote + counter part. + + <p>In general, this interface is implemented by the bridge itself. It must not + be called from outside the bridge.</p> + + <p>INTERNAL INTERFACE, DO NOT USE IT ELSEWHERE!</p> +*/ [ uik(A7EF98B1-8D82-11d4-9F1B0050-04D7755D), ident( "XProtocolProperties", 1.0 ) ] interface XProtocolProperties : com::sun::star::uno::XInterface { - /*** - * Called to get a list of bridge internal properties. Which properties can be retrieved, is - * protocol dependend. - * The properties MUST NOT change between a requestChange and a commit change call. - ***/ + /** called to get a list of bridge internal properties. Which properties can be retrieved, + is protocol dependend. + + <p> The properties MUST NOT change between a requestChange and a commit change call.</p> + */ sequence< ProtocolProperty > getProperties( ); - /**** - * Called to initiate a protocol change. This method should always be called in the scope - * of the local bridge setting object, because the remote counter part may do such a call - * at the same time (typically at startup time). - * - * @param nRandomNumber In case both processes call requestChange at the same time, - * the caller with the higher nRandomNumber is allowed to call - * commitChange. - * @returns 1, if the caller may ( and MUST !!!) call commitChange. - * 0, if the caller is not allowed to call commitChange. This can only happen, - * if the other bridge has called requestChange at the same time and - * nRandomNumber is smaller than the other bridge's nRandomNumber. - * The remote counterpart is supposed to call commitChange within a small - * time span. Please call requestChange() after the remote counterpart has - * called commitChange(). - * -1 if the nRandomNumber is of the same value as the previously - * sent requestChange (sent by the remote counterpart). This is a draw :o). - * Generate a new random number and try again. - ****/ + /** called to initiate a protocol change. + + <p>This method should always be called in the scope of the local bridge setting object, + because the remote counter part may do such a call at the same time + (typically at startup time). </p> + + @param nRandomNumber + In case both processes call requestChange at the same time, + the caller with the higher nRandomNumber is allowed to call + commitChange. + + @returns + 1, if the caller may ( and MUST !!!) call commitChange. + 0, if the caller is not allowed to call commitChange. This can only happen, + if the other bridge has called requestChange at the same time and + nRandomNumber is smaller than the other bridge's nRandomNumber. + The remote counterpart is supposed to call commitChange within a small + time span. Please call requestChange() after the remote counterpart has + called commitChange(). + -1 if the nRandomNumber is of the same value as the previously + sent requestChange (sent by the remote counterpart). This is a draw :o). + Generate a new random number and try again. + */ long requestChange( [in] long nRandomNumber ); - /**** - * Called to commit a protocol change. It is only allowed to call commitChange, if - * requestChange has been called previously and the return value was true. - * The new properties are valid after the reply of commitChange has been received. - * Note, that this is difficult for the callee, because it must marshal the reply - * with the old settings. - * All properties not mentioned in the list are unchanged. - * Note that the bridge must be blocked for other threads, - * before commitChange is sent and unblocked - * after the reply has been received. This blocks the bridge. - * - * @raises InvalidProtocolChangeException - * when the remote counterpart could not change - * at least one of the properties. No property - * has been changed. requestChange must be called - * again to initiate a new change of the protocol. - ****/ + /** called to commit a protocol change. + + <p>It is only allowed to call commitChange, if requestChange + has been called previously and the return value was true. The new properties are + valid after the reply of commitChange has been received. + Note, that this is difficult for the callee, because it must marshal the reply + with the old settings. </p> + + <p>All properties not mentioned in the list are unchanged. + Note that the bridge must be blocked for other threads, + before commitChange is sent and unblocked + after the reply has been received. This blocks the bridge.</p> + + @raises InvalidProtocolChangeException + when the remote counterpart could not change at least one of the properties. + No property has been changed. requestChange must be called + again to initiate a new change of the protocol. + */ void commitChange( [in] sequence< ProtocolProperty > newValues ) raises ( com::sun::star::bridge::InvalidProtocolChangeException ); }; diff --git a/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl b/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl index 0e4c31c80..4d651d335 100644 --- a/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl +++ b/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnoUrlResolver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * 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: interface com::sun::star::bridge::XUnoUrlResolver -/** service com.sun.star.bridge.UnoUrlResolver implements this interface. +/** service <type scope="com::sun::star::bridge">UnoUrlResolver</type> + implements this interface. */ [ uik(E2463748-33D6-11D1-AABE00A0-249D5590), ident( "XUnoUrlResolver", 1.0 ) ] interface XUnoUrlResolver: com::sun::star::uno::XInterface @@ -95,6 +96,9 @@ interface XUnoUrlResolver: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:34:57 hjs initial import diff --git a/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl b/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl index 42ea5b4c8..7f118f204 100644 --- a/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl +++ b/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl @@ -2,9 +2,9 @@ * * $RCSfile: AlreadyAcceptingException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,10 +64,11 @@ module com { module sun { module star { module connection { -// DocMerge: empty anyway +/** @missing + */ exception AlreadyAcceptingException: com::sun::star::uno::Exception { - }; +}; };};};}; diff --git a/udkapi/com/sun/star/connection/ConnectionSetupException.idl b/udkapi/com/sun/star/connection/ConnectionSetupException.idl index 0bdee0b96..17b6e162d 100644 --- a/udkapi/com/sun/star/connection/ConnectionSetupException.idl +++ b/udkapi/com/sun/star/connection/ConnectionSetupException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConnectionSetupException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,10 +64,11 @@ module com { module sun { module star { module connection { -// DocMerge: empty anyway +/** @missing + */ exception ConnectionSetupException: com::sun::star::uno::Exception { - }; +}; };};};}; diff --git a/udkapi/com/sun/star/connection/NoConnectException.idl b/udkapi/com/sun/star/connection/NoConnectException.idl index 825cdf770..8b84ef083 100644 --- a/udkapi/com/sun/star/connection/NoConnectException.idl +++ b/udkapi/com/sun/star/connection/NoConnectException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoConnectException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -62,12 +62,13 @@ #define _COM_SUN_STAR_CONNECTION_NOCONNECTEXCEPTION_IDL_ #include <com/sun/star/uno/Exception.idl> - module com { module sun { module star { module connection { +module com { module sun { module star { module connection { -// DocMerge: empty anyway +/** @missing + */ exception NoConnectException: com::sun::star::uno::Exception { - }; +}; };};};}; diff --git a/udkapi/com/sun/star/connection/XAcceptor.idl b/udkapi/com/sun/star/connection/XAcceptor.idl index 6e28bcb21..0fa8a684e 100644 --- a/udkapi/com/sun/star/connection/XAcceptor.idl +++ b/udkapi/com/sun/star/connection/XAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAcceptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,23 +67,17 @@ #include <com/sun/star/connection/XConnection.idl> - module com { module sun { module star { module connection { +module com { module sun { module star { module connection { - - - -// DocMerge from idl: interface com::sun::star::connection::XAcceptor -/** ******* - * - ******** +/** @missing */ [ uik(B1877190-D328-11d3-9EE70050-04D7755D), ident( "XAcceptor", 1.0 ) ] interface XAcceptor: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::connection::XAcceptor::accept /** blocking call. Waits until someone connects. - After the method has been left, it can be reentered. + + <p>After the method has been left, it can be reentered. </p> */ XConnection accept( [in] string sConnectionDescription ) raises( AlreadyAcceptingException, diff --git a/udkapi/com/sun/star/connection/XConnection.idl b/udkapi/com/sun/star/connection/XConnection.idl index fdf0d0ee3..ccd02a97b 100644 --- a/udkapi/com/sun/star/connection/XConnection.idl +++ b/udkapi/com/sun/star/connection/XConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,15 +64,9 @@ #include <com/sun/star/io/IOException.idl> - module com { module sun { module star { module connection { +module com { module sun { module star { module connection { - - - -// DocMerge from idl: interface com::sun::star::connection::XConnection -/** ******* - * - ******** +/** @missing */ [ uik(61F60EB1-D327-11d3-9EE70050-04D7755D), ident( "XConnection", 1.0 ) ] interface XConnection: com::sun::star::uno::XInterface @@ -80,6 +74,8 @@ interface XConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::connection::XConnection::read /** blocking. + + @incomplete */ long read( [out] sequence < byte > aReadBytes , [in] long nBytesToRead ) raises( com::sun::star::io::IOException ); @@ -87,12 +83,15 @@ interface XConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::connection::XConnection::write /** blocking. + + @incomplete */ void write( [in] sequence < byte > aData ) raises( com::sun::star::io::IOException ); - // DocMerge: empty anyway + /** @missing + */ void flush( ) raises( com::sun::star::io::IOException ); @@ -105,10 +104,11 @@ interface XConnection: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::connection::XConnection::getDescription - /** A string describing the connection. This string must be unique and is therefore - different from the arguments to XConnection.accept and XConnector.connect. In - general, the string contains an additional handle value. - For example, "socket:localhost:2000:2324" + /** A unique string describing the connection. + + <p>This string is different from the arguments to <member>XConnection::accept</member> + and <member>XConnector::connect</member>. In general, the string contains an additional + handle value. For example, "socket:localhost:2000:2324". </p> */ string getDescription(); }; diff --git a/udkapi/com/sun/star/connection/XConnectionBroadcaster.idl b/udkapi/com/sun/star/connection/XConnectionBroadcaster.idl index a38408795..934401ad0 100644 --- a/udkapi/com/sun/star/connection/XConnectionBroadcaster.idl +++ b/udkapi/com/sun/star/connection/XConnectionBroadcaster.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnectionBroadcaster.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,9 +70,7 @@ // DocMerge from idl: interface com::sun::star::connection::XConnectionBroadcaster -/** ******* - * - ******** +/** @missing */ [ uik(B4B4B406-6329-4c7a-B8F43822-E9ACC142), ident( "XConnectionBroadcaster", 1.0 ) ] interface XConnectionBroadcaster: com::sun::star::uno::XInterface diff --git a/udkapi/com/sun/star/connection/XConnector.idl b/udkapi/com/sun/star/connection/XConnector.idl index 53130b1a6..ac42451a1 100644 --- a/udkapi/com/sun/star/connection/XConnector.idl +++ b/udkapi/com/sun/star/connection/XConnector.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnector.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,9 +67,7 @@ #include <com/sun/star/connection/XConnection.idl> - module com { module sun { module star { module connection { - - +module com { module sun { module star { module connection { // DocMerge: empty anyway [ uik(4F73C140-D329-11d3-9EE70050-04D7755D), ident( "XConnector", 1.0 ) ] @@ -77,7 +75,7 @@ interface XConnector: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::connection::XConnector::connect - /** creates a new connection. Tries to connect to an XAcceptor. + /** creates a new connection. Tries to connect to an <type>XAcceptor</member>. */ XConnection connect( [in] string sConnectionDescription ) raises( NoConnectException,ConnectionSetupException ); diff --git a/udkapi/com/sun/star/container/ContainerEvent.idl b/udkapi/com/sun/star/container/ContainerEvent.idl index edeaef7c8..55834e9e7 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,9 @@ //============================================================================= // DocMerge from xml: struct com::sun::star::container::ContainerEvent -/** This event is fired when an element is inserted in a container.@see XContainerListener +/** This event is fired when an element is inserted in a container. + + @see XContainerListener */ struct ContainerEvent: com::sun::star::lang::EventObject { @@ -82,8 +84,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> */ any Accessor; @@ -111,6 +111,9 @@ 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 diff --git a/udkapi/com/sun/star/container/ElementExistException.idl b/udkapi/com/sun/star/container/ElementExistException.idl index b8ec34fc7..3ed78ece0 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,14 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::container::ElementExistException -/** is thrown by the - - - - - - method to indicate that there are no more elements in the enumeration.@see XNameContainer - @see XNameContainer#insertByName() +/** is thrown by container methods, if an element is added which is already + child of the container. + + <p>Probably not the same element is already a member, when this exception + is thrown, but a member with the same id or name. </p> + + @see XNameContainer + @see XNameContainer::insertByName */ exception ElementExistException: com::sun::star::uno::Exception { @@ -93,6 +92,9 @@ exception ElementExistException: 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 diff --git a/udkapi/com/sun/star/container/NoSuchElementException.idl b/udkapi/com/sun/star/container/NoSuchElementException.idl index 6b8465da0..e4b49f828 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,14 +73,11 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::container::NoSuchElementException -/** is thrown by the - - - - - - method to indicate that there are no more elements in the enumeration.@see XEnumeration - @see XEnumeration#nextElement() +/** is thrown by child access methods of collections, if the addressed child + does not exist. + + @see XEnumeration + @see XEnumeration::nextElement */ exception NoSuchElementException: com::sun::star::uno::Exception { @@ -93,6 +90,9 @@ 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 diff --git a/udkapi/com/sun/star/container/XChild.idl b/udkapi/com/sun/star/container/XChild.idl index 2d071e56f..d32808cbe 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,6 @@ // 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 exactly one dedicated parent container.</p> */ @@ -97,13 +95,10 @@ interface XChild: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::XChild::setParent - /** sets the parent to this object. The object returns this - parent through the method - - - - - . + /** sets the parent to this object. + + @throws com::sun::star::lang::NoSupportException + if the name of this object cannot be changed. */ void setParent( [in] com::sun::star::uno::XInterface Parent ) raises( com::sun::star::lang::NoSupportException ); @@ -117,6 +112,9 @@ interface XChild: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XComponentEnumeration.idl b/udkapi/com/sun/star/container/XComponentEnumeration.idl index 47119f88b..fe34e6a98 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,10 +90,10 @@ interface XComponentEnumeration: com::sun::star::container::XEnumeration // DocMerge from idl: method com::sun::star::container::XComponentEnumeration::nextComponent /** @returns - the next component of this enumeration. + the next component of this enumeration. - @throws NoSuchElementException - if no more elements exist. + @throws NoSuchElementException + if no more elements exist. */ com::sun::star::lang::XComponent nextComponent() raises( com::sun::star::container::NoSuchElementException ); @@ -107,6 +107,9 @@ interface XComponentEnumeration: com::sun::star::container::XEnumeration /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XContainer.idl b/udkapi/com/sun/star/container/XContainer.idl index 6ea5ad86c..dc0ad4fd1 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,18 +80,18 @@ /** supports quick access to the information if a container currently contains elements. - - <p>The <type>XContainer</type> interface is provided for containers which need to broadcast changes within the container; that means that the actions of adding or removing elements are broadcast to the - listeners. - - </p> + listeners. </p> + <p>This can be useful for UI to enable/disable some functions - without actually accessing the data. - - </p>@see XContent, XIndexAccess, XNameAcces, XEnumerationAccess + without actually accessing the data. </p> + + @see XContent + @see XIndexAccess + @see XNameAcces + @see XEnumerationAccess */ [ uik(E227A527-33D6-11D1-AABE00A0-249D5590), ident( "XContainer", 1.0 ) ] interface XContainer: com::sun::star::uno::XInterface @@ -100,7 +100,9 @@ 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.@see XContainerListener + elements are inserted or removed. + + @see XContainerListener */ [oneway] void addContainerListener( [in] com::sun::star::container::XContainerListener xListener ); @@ -108,7 +110,9 @@ interface XContainer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::XContainer::removeContainerListener /** removes the specified listener so it does not receive - any events from this container.@see XContainerListener + any events from this container. + + @see XContainerListener */ [oneway] void removeContainerListener( [in] com::sun::star::container::XContainerListener xListener ); @@ -121,6 +125,9 @@ interface XContainer: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl index 0a070a270..e9a32f67f 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,15 @@ // 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> + @example + <p>This example prints the names of all tables: </p> + <listing> - xTextTableEnum = xTextDoc.createContentEnumeration( - "com::sun::star::text::TextTable" ) - while xTextTableEnum.hasMoreElements() do - print xTextTableEnum.getNextElement().Name - wend + xTextTableEnum = xTextDoc.createContentEnumeration( + "com::sun::star::text::TextTable" ) + while xTextTableEnum.hasMoreElements() do + print xTextTableEnum.getNextElement().Name + wend </listing> */ [ uik(E227A3F5-33D6-11D1-AABE00A0-249D5590), ident( "XContentEnumerationAccess", 1.0 ) ] @@ -105,8 +97,7 @@ 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. + a new enumeration object for the contents of the specified service type. */ com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName ); @@ -114,11 +105,11 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::XContentEnumerationAccess::getAvailableServiceNames /** @returns - all names of services of which instances exist in this object. + all names of services of which instances exist in this object. - <p><method>XContentEnumerationAccess::createContentEnumeration</method> - creates a non-empty enumeration for all the service names which are - listed here. For all others it creates no enumeration. + <p><method>XContentEnumerationAccess::createContentEnumeration</method> + creates a non-empty enumeration for all the service names which are + listed here. For all others it creates no enumeration. </p> */ sequence<string> getAvailableServiceNames(); @@ -131,6 +122,9 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XElementAccess.idl b/udkapi/com/sun/star/container/XElementAccess.idl index 9cbedf218..3373ba6dd 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= @@ -86,9 +86,9 @@ 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 - with this interface. + the type of the elements. <type>void</type> means that it is a + multi-type container and you cannot determine the exact types + with this interface. */ [const] TYPE_XIDLCLASS getElementType(); @@ -96,8 +96,8 @@ 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>. + <TRUE> if the object contain elements, + otherwise <FALSE>. */ [const] boolean hasElements(); @@ -110,6 +110,9 @@ interface XElementAccess: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XEnumeration.idl b/udkapi/com/sun/star/container/XEnumeration.idl index c5c5a0247..c4c91fb65 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,24 +76,21 @@ //============================================================================= - module com { module sun { module star { module container { +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 generates a series of elements, one at a time. Successive calls to the <code>XEnumeration::nextElement</code> method return successive - elements of the series. - - </p> - <p>For example (Java), to print all elements of a vector <var>aVect</var>: - + elements of the series. </p> + + <p>For example (Java), to print all elements of a vector <var>aVect</var>: </p> + <listing> for ( XEnumeration xEnum = aVect.elements() ; xEnum.hasMoreElements() ; ) @@ -104,9 +101,7 @@ <p> If the object changed, the behavior of the enumeration is - not specified. This is not a remote interface. - - </p> + not specified. This is not a remote interface. </p> */ [ uik(E227A397-33D6-11D1-AABE00A0-249D5590), ident( "XEnumeration", 1.0 ) ] interface XEnumeration: com::sun::star::uno::XInterface @@ -122,15 +117,15 @@ interface XEnumeration: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::XEnumeration::nextElement /** @returns - the next element of this enumeration. + the next element of this enumeration. - @throws NoSuchElementException - if no more elements exist. + @throws NoSuchElementException + if no more elements exist. - @throws com::sun::star::lang::WrappedTargetException - If the implementation has internal reasons for exceptions, - then wrap these in a <type>WrappedTargetException</type> - exception. + @throws com::sun::star::lang::WrappedTargetException + If the implementation has internal reasons for exceptions, + then wrap these in a <type>WrappedTargetException</type> + exception. */ any nextElement() raises( com::sun::star::container::NoSuchElementException, @@ -145,6 +140,9 @@ interface XEnumeration: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/container/XEnumerationAccess.idl b/udkapi/com/sun/star/container/XEnumerationAccess.idl index 05f2a99d9..dcc2c695b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,13 +72,12 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= // DocMerge from xml: interface com::sun::star::container::XEnumerationAccess -/** The <type>XEnumerationAccess</type> interface is used to enumerate - objects in a document or object which contains objects. +/** used to enumerate objects in a container which contains objects. */ [ uik(E227A416-33D6-11D1-AABE00A0-249D5590), ident( "XEnumerationAccess", 1.0 ) ] interface XEnumerationAccess: com::sun::star::container::XElementAccess @@ -87,8 +86,8 @@ 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. + the enumeration object to the objects. + It returns NULL if there are no objects. */ com::sun::star::container::XEnumeration createEnumeration(); @@ -101,6 +100,9 @@ interface XEnumerationAccess: com::sun::star::container::XElementAccess /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XHierarchicalName.idl b/udkapi/com/sun/star/container/XHierarchicalName.idl index c71976069..54bd94992 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,11 +83,10 @@ // 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>@see com::sun::star::container::XHierarchicalNameAccess - @see com::sun::star::container::XNamed + <p>The name is generally globally unique in the hierarchy. </p> + + @see com::sun::star::container::XHierarchicalNameAccess + @see com::sun::star::container::XNamed */ [ uik(C98C6340-4209-11d4-9F5D0050-DA6BA2A6), ident( "XHierarchicalName", 1.0 ) ] interface XHierarchicalName: com::sun::star::uno::XInterface @@ -96,7 +95,7 @@ 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. + the fully qualified hierarchical name of the object. */ [const] string getHierarchicalName(); @@ -105,11 +104,10 @@ 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 - without actually accessing it. - - </p>@see XHierarchicalNameAccess::hasByHierarchicalName + without actually accessing it. </p> + + @see XHierarchicalNameAccess::hasByHierarchicalName */ [const] string composeHierarchicalName( [in] string aRelativeName ) raises( com::sun::star::lang::IllegalArgumentException, @@ -123,6 +121,9 @@ interface XHierarchicalName: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl index 203e9853d..d1ae90dfa 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,12 +78,14 @@ // DocMerge from xml: interface com::sun::star::container::XHierarchicalNameAccess /** is used to have hierarchical access to elements within a container. - You address an object of a specific level in the hierarchy by giving its - fully qualified name, e.g. "com::sun::star::uno::XInterface". + + <p>You address an object of a specific level in the hierarchy by giving its + fully qualified name, e.g. "com::sun::star::uno::XInterface". </p> - - <p>To implement inaccurate name access, support the <type scope="com::sun::star::beans">XExactName</type> - interface. </p>@see com::sun::star::beans::XExactName + <p>To implement inaccurate name access, support the + <type scope="com::sun::star::beans">XExactName</type> interface. </p> + + @see com::sun::star::beans::XExactName */ [ uik(94263A00-7FDE-11D3-87BD00A0-24494732), ident( "XHierarchicalNameAccess", 1.0 ) ] interface XHierarchicalNameAccess: com::sun::star::uno::XInterface @@ -94,11 +96,11 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface /** @returns the object with the specified name. - @param aName - the name of the object. + @param aName + the name of the object. - @throws NoSuchElementException - if an element under Name does not exist. + @throws NoSuchElementException + if an element under Name does not exist. */ [const] any getByHierarchicalName( [in] string aName ) raises( com::sun::star::container::NoSuchElementException ); @@ -107,14 +109,14 @@ 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. + <TRUE/> if an element with this name is in + the container, <FALSE/> otherwise. - In many cases the next call is <method>XNameAccess::getByName</method>. - You should optimize this case. + <p>In many cases the next call is <method>XNameAccess::getByName</method>. + You should optimize this case. - @param aName - the name of the object. + @param aName + the name of the object. */ [const] boolean hasByHierarchicalName( [in] string aName ); @@ -127,6 +129,9 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/container/XIndexAccess.idl b/udkapi/com/sun/star/container/XIndexAccess.idl index c7c951362..0f1c834d4 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ //============================================================================= - module com { module sun { module star { module container { +module com { module sun { module star { module container { //============================================================================= @@ -84,8 +84,6 @@ /** provides access to the elements of a collection through an index. - - <p>This interface should only be used if the data structure, itself, is indexed.</p> */ @@ -104,18 +102,18 @@ 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. + @param Index + specifies the position in the array. The first index is 0. - @throws com::sun::star::lang::IndexOutOfBoundException - if the index is not valid. + @throws com::sun::star::lang::IndexOutOfBoundException + if the index is not valid. - @throws com::sun::star::lang::WrappedTargetException - If the implementation has internal reasons for exceptions, - then wrap these in a <type>WrappedTargetException</type> - exception. + @throws com::sun::star::lang::WrappedTargetException + If the implementation has internal reasons for exceptions, + then wrap these in a <type>WrappedTargetException</type> + exception. */ [const] any getByIndex( [in] long Index ) raises( com::sun::star::lang::IndexOutOfBoundsException, @@ -130,6 +128,9 @@ interface XIndexAccess: com::sun::star::container::XElementAccess /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/container/XIndexContainer.idl b/udkapi/com/sun/star/container/XIndexContainer.idl index 789d2ff61..457e195ee 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,11 +96,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. - - - <p>To append an element, use the index "last index +1". - - </p> + <p>To append an element, use the index "last index +1". </p> */ void insertByIndex( [in] long Index, [in] any Element ) @@ -126,6 +122,9 @@ interface XIndexContainer: com::sun::star::container::XIndexReplace /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XIndexReplace.idl b/udkapi/com/sun/star/container/XIndexReplace.idl index 3ea193d6e..2ce1d122b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,9 @@ // DocMerge from xml: interface com::sun::star::container::XIndexReplace /** This is the generic interface for supporting the replacement of indexed - elements.@see XContainer + elements. + + @see XContainer */ [ uik(E227A422-33D6-11D1-AABE00A0-249D5590), ident( "XIndexReplace", 1.0 ) ] interface XIndexReplace: com::sun::star::container::XIndexAccess @@ -111,6 +113,9 @@ interface XIndexReplace: com::sun::star::container::XIndexAccess /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XNameAccess.idl b/udkapi/com/sun/star/container/XNameAccess.idl index b82c58d24..a71a88f5a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,10 +83,11 @@ // 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 <type scope="com::sun::star::beans">XExactName</type> - interface. </p>@see com::sun::star::beans::XExactName + <p>To implement inaccurate name access, support the + <type scope="com::sun::star::beans">XExactName</type> + interface. </p> + + @see com::sun::star::beans::XExactName */ [ uik(E227A417-33D6-11D1-AABE00A0-249D5590), ident( "XNameAccess", 1.0 ) ] interface XNameAccess: com::sun::star::container::XElementAccess @@ -97,13 +98,13 @@ interface XNameAccess: com::sun::star::container::XElementAccess /** @returns the object with the specified name. - @param aName - the name of the object. + @param aName + the name of the object. - @throws NoSuchElementException - if an element under Name does not exist. + @throws NoSuchElementException + if an element under Name does not exist. - @throws com::sun::star::lang::WrappedTargetException + @throws com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a <type>WrappedTargetException</type> exception. @@ -116,9 +117,9 @@ 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. + a sequence of all element names in this container. - <p>The order of the names is not specified. + <p>The order of the names is not specified. </p> */ [const] sequence<string> getElementNames(); @@ -126,14 +127,14 @@ 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. + <TRUE/> if an element with this name is in + the container, <FALSE/> otherwise. - In many cases the next call is <method>XNameAccess::getByName</method>. - You should optimize this case. + <p>In many cases the next call is <method>XNameAccess::getByName</method>. + You should optimize this case. </p> - @param iaName - the name of the object. + @param iaName + the name of the object. */ [const] boolean hasByName( [in] string aName ); @@ -146,6 +147,9 @@ interface XNameAccess: com::sun::star::container::XElementAccess /*============================================================================= $Log: not supported by cvs2svn $ + 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) diff --git a/udkapi/com/sun/star/container/XNameContainer.idl b/udkapi/com/sun/star/container/XNameContainer.idl index a1241532b..1ea76524a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,7 +90,9 @@ // DocMerge from xml: interface com::sun::star::container::XNameContainer /** This is the generic interface for supporting the insertion and removal of - named elements.@see XContainer + named elements. + + @see XContainer */ [ uik(E227A52A-33D6-11D1-AABE00A0-249D5590), ident( "XNameContainer", 1.0 ) ] interface XNameContainer: com::sun::star::container::XNameReplace @@ -124,6 +126,9 @@ interface XNameContainer: com::sun::star::container::XNameReplace /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XNameReplace.idl b/udkapi/com/sun/star/container/XNameReplace.idl index d2cb06a7b..c65742809 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,9 @@ // DocMerge from xml: interface com::sun::star::container::XNameReplace /** This is the generic interface for supporting the replacement of named - elements.@see XContainer + elements. + + @see XContainer */ [ uik(E227A421-33D6-11D1-AABE00A0-249D5590), ident( "XNameReplace", 1.0 ) ] interface XNameReplace: com::sun::star::container::XNameAccess @@ -111,6 +113,9 @@ interface XNameReplace: com::sun::star::container::XNameAccess /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XNamed.idl b/udkapi/com/sun/star/container/XNamed.idl index 0bf4d7db8..dc3f69f3b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,8 +75,6 @@ // 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> */ [ uik(E227A52D-33D6-11D1-AABE00A0-249D5590), ident( "XNamed", 1.0 ) ] @@ -86,7 +84,7 @@ 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. */ [const] string getName(); @@ -106,6 +104,9 @@ interface XNamed: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/container/XUniqueIDAccess.idl b/udkapi/com/sun/star/container/XUniqueIDAccess.idl index 488126abf..daea3391a 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,7 @@ //============================================================================= - module com { module sun { module star { module container { - +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. @@ -85,10 +84,12 @@ [ uik(965BA025-A0F6-11d3-869B0050-04D8BC00), ident("UniqueIDAccess", 1.0) ] interface XUniqueIDAccess: com::sun::star::uno::XInterface { - // DocMerge: empty anyway + /** @missing + */ any getByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); - // DocMerge: empty anyway + /** @missing + */ void removeByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); }; @@ -99,6 +100,9 @@ interface XUniqueIDAccess: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/corba/corba.idl b/udkapi/com/sun/star/corba/corba.idl index e427f01e9..a767cad31 100644 --- a/udkapi/com/sun/star/corba/corba.idl +++ b/udkapi/com/sun/star/corba/corba.idl @@ -2,9 +2,9 @@ * * $RCSfile: corba.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:34 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,7 @@ module com { module sun { module star { module corba typedef unsigned long ObjectSystemID; typedef sequence< byte > OpaqueData; + /// @missing struct OneThreadID { ObjectSystemID objSysID; @@ -73,27 +74,32 @@ module com { module sun { module star { module corba typedef sequence<OneThreadID> ThreadIDs; + /// @missing struct LogicalThreadID // Service context { ThreadIDs IDs; }; + /// @missing struct CorbaString8 { string theString; }; + /// @missing struct CorbaUnion { long dummy; }; + /// @missing struct ObjectKey { CorbaString8 sOid; CorbaString8 sType; }; + /// @missing enum TCKind { tk_null, tk_void, diff --git a/udkapi/com/sun/star/io/BufferSizeExceededException.idl b/udkapi/com/sun/star/io/BufferSizeExceededException.idl index 857a52715..226fa5780 100644 --- a/udkapi/com/sun/star/io/BufferSizeExceededException.idl +++ b/udkapi/com/sun/star/io/BufferSizeExceededException.idl @@ -2,9 +2,9 @@ * * $RCSfile: BufferSizeExceededException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,15 +68,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: exception com::sun::star::io::BufferSizeExceededException /** is thrown by instances which need to buffer data. - - - + <p>It indicates that not enough system resources are available for extending the buffer. (May also indicate that the internal buffer has grown to a larger size than 2G. Some current implementations do @@ -94,6 +92,9 @@ exception BufferSizeExceededException: com::sun::star::io::IOException /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/DataInputStream.idl b/udkapi/com/sun/star/io/DataInputStream.idl index 31788447d..671e6615b 100644 --- a/udkapi/com/sun/star/io/DataInputStream.idl +++ b/udkapi/com/sun/star/io/DataInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataInputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,14 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::DataInputStream /** reads the data through a chained stream. - - - Guarantees: + + @guarantees <ul> <li> -thread safe</li> <li>-allow buffer size is 2 ^ 31 -1</li> @@ -110,6 +109,9 @@ service DataInputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/DataOutputStream.idl b/udkapi/com/sun/star/io/DataOutputStream.idl index 1a69879c5..862808273 100644 --- a/udkapi/com/sun/star/io/DataOutputStream.idl +++ b/udkapi/com/sun/star/io/DataOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataOutputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,14 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::DataOutputStream /** writes its data to a chained <type>XOutputStream</type>. - - Guarantees: + @guarantees <ul> <li>-thread safe</li> <li>-allow buffer size is 2 ^ 31 -1</li> @@ -103,6 +102,9 @@ service DataOutputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/DataTransferEvent.idl b/udkapi/com/sun/star/io/DataTransferEvent.idl index 57e048fa2..12bbd01a8 100644 --- a/udkapi/com/sun/star/io/DataTransferEvent.idl +++ b/udkapi/com/sun/star/io/DataTransferEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataTransferEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,14 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: struct com::sun::star::io::DataTransferEvent -/** This event is broadcasted by a filter.@see interface XDataTransferEventListener +/** is broadcasted by a filter. + + @see XDataTransferEventListener */ struct DataTransferEvent: com::sun::star::lang::EventObject { @@ -93,6 +95,9 @@ struct DataTransferEvent: com::sun::star::lang::EventObject /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/IOException.idl b/udkapi/com/sun/star/io/IOException.idl index 0b1d521cf..2eb16c2b1 100644 --- a/udkapi/com/sun/star/io/IOException.idl +++ b/udkapi/com/sun/star/io/IOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: IOException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * 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 io { +module com { module sun { module star { module io { //============================================================================= @@ -86,6 +86,9 @@ exception IOException: com::sun::star::uno::Exception /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/MarkableInputStream.idl b/udkapi/com/sun/star/io/MarkableInputStream.idl index c0fa28372..415bc4cbf 100644 --- a/udkapi/com/sun/star/io/MarkableInputStream.idl +++ b/udkapi/com/sun/star/io/MarkableInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: MarkableInputStream.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jbu $ $Date: 2000-11-27 10:05:27 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,12 +76,13 @@ module com { module sun { module star { module io { - +//========================================================================== /** allows to set marks in an InputStream and to later jump back to these marks. - <p>The implementation reads the original data from the inputstream, - that has been set previously at the XActiveDataSink interface. In general - the implementation must buffer the data.</p> + + <p>The implementation reads the original data from the input stream, + that has been set previously at the <type>XActiveDataSink</type> + interface. In general the implementation must buffer the data. </p> */ service MarkableInputStream { diff --git a/udkapi/com/sun/star/io/MarkableOutputStream.idl b/udkapi/com/sun/star/io/MarkableOutputStream.idl index 8c3fdda2f..46e9d5aee 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.2 $ + * $Revision: 1.3 $ * - * last change: $Author: jbu $ $Date: 2000-11-27 10:05:27 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,12 +76,14 @@ module com { module sun { module star { module io { - +//========================================================================== /** allows to set marks in an outputstream and to later jump back to these marks. + <p>The implementation stores the data as long as marks exists and later writes these data into the output stream, - that has been set previously at the XActiveDataSource interface. </p> + that has been set previously at the <type>XActiveDataSource</type> + interface. </p> */ service MarkableInputStream { diff --git a/udkapi/com/sun/star/io/NotConnectedException.idl b/udkapi/com/sun/star/io/NotConnectedException.idl index 157fc8edb..482fcf739 100644 --- a/udkapi/com/sun/star/io/NotConnectedException.idl +++ b/udkapi/com/sun/star/io/NotConnectedException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NotConnectedException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * 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 io { +module com { module sun { module star { module io { //============================================================================= @@ -87,6 +87,9 @@ exception NotConnectedException: com::sun::star::io::IOException /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/ObjectInputStream.idl b/udkapi/com/sun/star/io/ObjectInputStream.idl index c6c0a70b6..6fa14bfa3 100644 --- a/udkapi/com/sun/star/io/ObjectInputStream.idl +++ b/udkapi/com/sun/star/io/ObjectInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: ObjectInputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,42 +87,33 @@ // DocMerge from xml: service com::sun::star::io::ObjectInputStream /** is a stream which allows reading the data of persistent objects. - - <p>Implementations of this service must fulfill the specifications of the <type>DataInputStream</type> service. It must be chained to an <type>XMarkableStream</type>. Therefore, it provides the <type>XMarkableStream</type> interface, and delegates the calls to the - chained object. - - </p> + chained object. </p> + <p>The written objects are held until this instance is destroyed. The references to the objects are read as four-byte integers. Data format reads:</p> - <br> + <pre> - short InfoLength - long ObjectReference // 0 indicates no object - UTF ServiceName // length of 0 indicates this is only a reference - long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data - Object ObjectData // the data of the object - ... // skipping additional data + short InfoLength + long ObjectReference // 0 indicates no object + UTF ServiceName // length of 0 indicates this is only a reference + long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data + Object ObjectData // the data of the object + ... // skipping additional data </pre> - Guarantees: + @guarantees <ul> - <li>-thread safe - </li> - <li>-allow buffer size is 2 ^ 31 -1 - </li> - <li>-maximum object reference identifier must be the number of objects. - </li> - <li>-object reference identifier 0 indicates no object - </li> - <li>-skip addition data - </li> - <li>-set the stream position behind the object data - </li> + <li>-thread safe</li> + <li>-allow buffer size is 2 ^ 31 -1</li> + <li>-maximum object reference identifier must be the number of objects. </li> + <li>-object reference identifier 0 indicates no object</li> + <li>-skip addition data</li> + <li>-set the stream position behind the object data</li> </ul> */ service ObjectInputStream @@ -148,6 +139,9 @@ service ObjectInputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/ObjectOutputStream.idl b/udkapi/com/sun/star/io/ObjectOutputStream.idl index fc48fab60..38a7df605 100644 --- a/udkapi/com/sun/star/io/ObjectOutputStream.idl +++ b/udkapi/com/sun/star/io/ObjectOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: ObjectOutputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,41 +76,35 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::ObjectOutputStream /** is a stream which allows writing the data of persistent objects. - - <p>Implementations of this service must fulfill the specifications of the <type>DataOutputStream</type> service. Futhermore the stream needs to be chained to a <type>XMarkableStream</type>. Therefore, it also provides the <type>XMarkableStream</type> interface, but it delegates the calls to the chained object. The written objects are held until this instance is destroyed. The references to the objects are written as four-byte integers - and begin at 1. Data format is written:<br> - </p> + and begin at 1. Data format is written: </p> + <pre> - short InfoLength - long ObjectReference // 0 indicates no object - UTF ServiceName // length of 0 indicates this is only a reference - long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data - Object ObjectData // the data of the object + short InfoLength + long ObjectReference // 0 indicates no object + UTF ServiceName // length of 0 indicates this is only a reference + long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data + Object ObjectData // the data of the object </pre> - Garantees + @garantees <ul> - <li>-thread safe - </li> - <li>-allow buffer size is 2 ^ 31 -1 - </li> - <li>-maximum object reference identifier is the number of objects. - </li> - <li>-object reference identifier 0 indicates no object - </li> + <li>-thread safe </li> + <li>-allow buffer size is 2 ^ 31 -1 </li> + <li>-maximum object reference identifier is the number of objects. </li> + <li>-object reference identifier 0 indicates no object </li> </ul> */ service ObjectOutputStream @@ -133,6 +127,9 @@ service ObjectOutputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/Pipe.idl b/udkapi/com/sun/star/io/Pipe.idl index de880f5d9..084f83a99 100644 --- a/udkapi/com/sun/star/io/Pipe.idl +++ b/udkapi/com/sun/star/io/Pipe.idl @@ -2,9 +2,9 @@ * * $RCSfile: Pipe.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,23 +72,21 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::Pipe -/** the implementation of an output stream and an input stream. All data - written through the outputstream is buffered until it is read again from the input stream - The buffer grows in 2 ^ x steps. The maximum - size of the buffer is 2 ^ 31 -1. +/** the implementation of an output stream and an input stream. + + <p>All data written through the outputstream is buffered until it is + read again from the input stream. The buffer grows in 2 ^ x steps. + The maximum size of the buffer is 2 ^ 31 -1. </p> - - Guarantees: + @guarantees <ul> - <li>-thread safe - </li> - <li>-allow buffer size is 2 ^ 31 -1 - </li> + <li>-thread safe </li> + <li>-allow buffer size is 2 ^ 31 -1 </li> </ul> */ service Pipe @@ -108,6 +106,9 @@ service Pipe /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/Pump.idl b/udkapi/com/sun/star/io/Pump.idl index 8fae2c133..80e689e03 100644 --- a/udkapi/com/sun/star/io/Pump.idl +++ b/udkapi/com/sun/star/io/Pump.idl @@ -2,9 +2,9 @@ * * $RCSfile: Pump.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,15 +82,14 @@ // DocMerge from xml: service com::sun::star::io::Pump /** the implementation of a data source and a data sink. - A thread will be created that reads from the input stream and writes + + <p>A thread will be created that reads from the input stream and writes the data to the connected output stream. Data will not be buffered by - this service. + this service. </p> - - Guarantees: + @guarantees <ul> - <li>-thread safe - </li> + <li>thread safe</li> </ul> */ service Pump @@ -113,6 +112,9 @@ service Pump /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/TextInputStream.idl b/udkapi/com/sun/star/io/TextInputStream.idl index 73aa9d698..0e85d3280 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,18 +76,18 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::TextInputStream /** reads the data through a chained stream. - - - <h4>guarantees</h4> - <ul> - <li>thread safe</li> - <li>allow buffer size is 2 ^ 31 -1</li> + + @guarantees + thread safe + + @guarantees + allow buffer size is 2 ^ 31 -1 </ul> */ service TextInputStream @@ -107,6 +107,9 @@ 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 diff --git a/udkapi/com/sun/star/io/TextOutputStream.idl b/udkapi/com/sun/star/io/TextOutputStream.idl index 7d5cffd6b..f789aacc9 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,18 @@ //============================================================================= - module com { module sun { module star { module io { +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>. - - <h4>guarantees</h4> - <ul> - <li>thread safe</li> - <li>allow buffer size is 2 ^ 31 -1</li> + @guarantees + thread safe + + @guarantees + allow buffer size is 2 ^ 31 -1 </ul> */ service TextOutputStream @@ -103,6 +103,9 @@ 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 diff --git a/udkapi/com/sun/star/io/UnexpectedEOFException.idl b/udkapi/com/sun/star/io/UnexpectedEOFException.idl index 11cf2308c..17faeb5b6 100644 --- a/udkapi/com/sun/star/io/UnexpectedEOFException.idl +++ b/udkapi/com/sun/star/io/UnexpectedEOFException.idl @@ -2,9 +2,9 @@ * * $RCSfile: UnexpectedEOFException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,13 +68,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: exception com::sun::star::io::UnexpectedEOFException -/** is thrown when the EOF is reached during reading a datatype (long, - string, etc.). +/** is thrown when the <code>EOF/code> is reached during reading a datatype + (<code>long</code>, <code>string</code>, etc.). */ exception UnexpectedEOFException: com::sun::star::io::IOException { @@ -87,6 +87,9 @@ exception UnexpectedEOFException: com::sun::star::io::IOException /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/WrongFormatException.idl b/udkapi/com/sun/star/io/WrongFormatException.idl index a827451bb..673f25e40 100644 --- a/udkapi/com/sun/star/io/WrongFormatException.idl +++ b/udkapi/com/sun/star/io/WrongFormatException.idl @@ -2,9 +2,9 @@ * * $RCSfile: WrongFormatException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,13 +68,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: exception com::sun::star::io::WrongFormatException /** is thrown when inconsistent data comes up while reading a complex - data type (string or object). + data type (<code>string</code> or object). */ exception WrongFormatException: com::sun::star::io::IOException { @@ -87,6 +87,9 @@ exception WrongFormatException: com::sun::star::io::IOException /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XActiveDataControl.idl b/udkapi/com/sun/star/io/XActiveDataControl.idl index b80732527..58b0f04d5 100644 --- a/udkapi/com/sun/star/io/XActiveDataControl.idl +++ b/udkapi/com/sun/star/io/XActiveDataControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActiveDataControl.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,17 +72,15 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XActiveDataControl /** makes it possible to control an active data source. - - <p>This interface should be supported by objects which implement - <member>XActiveDataSource</member> or <member>XActiveDataSink</member>.</p> + <type>XActiveDataSource</type> or <type>XActiveDataSink</type>.</p> */ [ uik(67AD5C28-23FD-11D3-9ECD0010-5A677293), ident( "XActiveDataControl", 1.0 ) ] interface XActiveDataControl: com::sun::star::uno::XInterface @@ -106,12 +104,10 @@ interface XActiveDataControl: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XActiveDataControl::start /** starts I/O. - - <p>Either <member>XActiveDataControl::setInputStream()</member> or <member>XActiveDataControl::setOutputStream()</member> must be called beforehand. - </p> + <p>This method does not block the thread, so reading is generally not finished when the method returns. </p> */ @@ -122,12 +118,10 @@ interface XActiveDataControl: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XActiveDataControl::terminate /** does a weak abort. - - <p>It closes all connected resources and calls - <member>XInputStream::close()</member> or - <member>XOutputStream::close()</member> and fires the - <member>XStreamListener::terminated()</member>-event.</p> + <member>XInputStream::close</member> or + <member>XOutputStream::close</member> and fires the + <member>XStreamListener::terminated</member>-event.</p> */ void terminate(); @@ -140,6 +134,9 @@ interface XActiveDataControl: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XActiveDataSink.idl b/udkapi/com/sun/star/io/XActiveDataSink.idl index eb61dfab4..9b86653a6 100644 --- a/udkapi/com/sun/star/io/XActiveDataSink.idl +++ b/udkapi/com/sun/star/io/XActiveDataSink.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActiveDataSink.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XActiveDataSink /** makes it possible to read the corresponding object from an input stream. - - <p>If you want to allow control from outside, also implement the <type>XActiveDataControl</type> interface. </p> */ @@ -92,8 +90,6 @@ interface XActiveDataSink: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XActiveDataSink::setInputStream /** plugs the input stream. - - <p>If <type>XConnectable</type> is also implemented, this method should query <var>aStream</var> for an <type>XConnectable</type> and connect both.</p> @@ -117,6 +113,9 @@ interface XActiveDataSink: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XActiveDataSource.idl b/udkapi/com/sun/star/io/XActiveDataSource.idl index dcb9e97ae..0359e50dd 100644 --- a/udkapi/com/sun/star/io/XActiveDataSource.idl +++ b/udkapi/com/sun/star/io/XActiveDataSource.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActiveDataSource.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,13 +72,15 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XActiveDataSource /** has to be implemented if the class should be able to write into an output - stream.@see XActiveDataControl. + stream. + + @see XActiveDataControl. */ [ uik(27022EC0-23FD-11D3-9ECD0010-5A677293), ident( "XActiveDataSource", 1.0 ) ] interface XActiveDataSource: com::sun::star::uno::XInterface @@ -88,8 +90,6 @@ interface XActiveDataSource: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XActiveDataSource::setOutputStream /** plugs the output stream. - - <p>If <type>XConnectable</type> is also implemented, this method should query <var>aStream</var> for a <type>XConnectable</type> and connect both. @@ -114,6 +114,9 @@ interface XActiveDataSource: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XActiveDataStreamer.idl b/udkapi/com/sun/star/io/XActiveDataStreamer.idl index 1cec73e21..dbf6f067e 100644 --- a/udkapi/com/sun/star/io/XActiveDataStreamer.idl +++ b/udkapi/com/sun/star/io/XActiveDataStreamer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XActiveDataStreamer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -91,7 +91,6 @@ interface XActiveDataStreamer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XActiveDataStreamer::setStream /** plugs the input/output stream. - <p>If <type>XConnectable</type> is also implemented, this method should query <var>aStream</var> for a <type>XConnectable</type> and connect both.</p> @@ -115,6 +114,9 @@ interface XActiveDataStreamer: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XConnectable.idl b/udkapi/com/sun/star/io/XConnectable.idl index ad1a04559..bd623b730 100644 --- a/udkapi/com/sun/star/io/XConnectable.idl +++ b/udkapi/com/sun/star/io/XConnectable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnectable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,16 +75,13 @@ // DocMerge from xml: interface com::sun::star::io::XConnectable /** makes it possible to connect data sinks and sources. - - <p>The predecessor-member is the element in the connection that is nearer to the source of the data. The successor-member is the element that is further away from the source of the data. (Note that this classification does not depend on whether the class implements <type>XInputStream</type> or <type>XOutputStream</type>; it only - depends on the direction of data flow.) - - </p> + depends on the direction of data flow.) </p> + <p>This interface allows generic services to navigate between arbitrary elements of a connection.</p> */ @@ -102,7 +99,7 @@ interface XConnectable: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor /** @returns - the predecessor of this object. + the predecessor of this object. */ com::sun::star::io::XConnectable getPredecessor(); @@ -117,7 +114,7 @@ interface XConnectable: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor /** @returns - the successor of this object. + the successor of this object. */ com::sun::star::io::XConnectable getSuccessor(); @@ -130,6 +127,9 @@ interface XConnectable: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XDataExporter.idl b/udkapi/com/sun/star/io/XDataExporter.idl index 35a796eed..79a765f6e 100644 --- a/udkapi/com/sun/star/io/XDataExporter.idl +++ b/udkapi/com/sun/star/io/XDataExporter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataExporter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,15 +80,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XDataExporter /** makes it possible to export data from a component into a data sink. - - <p>Exporter objects are registered for specific components and data types. </p> */ @@ -98,7 +96,7 @@ interface XDataExporter: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XDataExporter::exportData - /** exports data for a Component into an output stream. + /** exports data for a component into an output stream. */ [oneway] void exportData( [in] com::sun::star::io::XOutputStream aOutputStream, [in] com::sun::star::lang::XComponent Component, @@ -120,6 +118,9 @@ interface XDataExporter: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XDataImporter.idl b/udkapi/com/sun/star/io/XDataImporter.idl index f14bb4449..1bff9a98a 100644 --- a/udkapi/com/sun/star/io/XDataImporter.idl +++ b/udkapi/com/sun/star/io/XDataImporter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataImporter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,15 +80,13 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XDataImporter /** makes it possible to import data from a data source into a component. - - <p>Importer objects are registered for specific components and data types.</p> */ [ uik(E2280126-33D6-11D1-AABE00A0-249D5590), ident( "XDataImporter", 1.0 ) ] @@ -119,6 +117,9 @@ interface XDataImporter: com::sun::star::uno::XInterface /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XDataInputStream.idl b/udkapi/com/sun/star/io/XDataInputStream.idl index c646822df..cffbdd491 100644 --- a/udkapi/com/sun/star/io/XDataInputStream.idl +++ b/udkapi/com/sun/star/io/XDataInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataInputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -165,6 +165,9 @@ interface XDataInputStream: com::sun::star::io::XInputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XDataOutputStream.idl b/udkapi/com/sun/star/io/XDataOutputStream.idl index a634626dd..6ea927277 100644 --- a/udkapi/com/sun/star/io/XDataOutputStream.idl +++ b/udkapi/com/sun/star/io/XDataOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataOutputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -165,6 +165,9 @@ interface XDataOutputStream: com::sun::star::io::XOutputStream /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XDataTransferEventListener.idl b/udkapi/com/sun/star/io/XDataTransferEventListener.idl index 0de82de51..781f3bc97 100644 --- a/udkapi/com/sun/star/io/XDataTransferEventListener.idl +++ b/udkapi/com/sun/star/io/XDataTransferEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataTransferEventListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -105,6 +105,9 @@ interface XDataTransferEventListener: com::sun::star::lang::XEventListener /*============================================================================= $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 diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl index 091688313..2e533dc88 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -91,15 +91,11 @@ interface XInputStream: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XInputStream::readBytes /** reads the specified number of bytes in the given sequence. - - <p>The return value specifies the number of bytes which have been put into the sequence. A difference between <var>nBytesToRead</var> and the return value indicates that EOF has been reached. This means that the method blocks until the specified number of bytes are - available or the EOF is reached. - - </p> + available or the EOF is reached. </p> */ long readBytes( [out] sequence<byte> aData, [in] long nBytesToRead ) @@ -113,12 +109,8 @@ interface XInputStream: com::sun::star::uno::XInterface /** 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> + available. </p> */ long readSomeBytes( [out] sequence<byte> aData, [in] long nMaxBytesToRead ) @@ -131,12 +123,8 @@ interface XInputStream: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XInputStream::skipBytes /** skips the next <var>nBytesToSkip</var> bytes (must be positive). - - <p>It is up to the implementation whether this method is - blocking the thread or not. - - </p> + blocking the thread or not. </p> */ void skipBytes( [in] long nBytesToSkip ) raises( com::sun::star::io::NotConnectedException, @@ -148,12 +136,8 @@ interface XInputStream: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XInputStream::available /** states how many bytes can be read or skipped without blocking. - - <p>Note: This method offers no information on whether the EOF - has been reached. - - </p> + has been reached. </p> */ long available() raises( com::sun::star::io::NotConnectedException, @@ -165,15 +149,11 @@ interface XInputStream: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XInputStream::closeInput /** closes the stream. - - <p>Users must close the stream explicitly when no further reading should be done. (There may exist ring references to chained objects that can only be released during this call. Thus not calling this method would result in a leak of memory or - external resources.) - - </p> + external resources.) </p> */ void closeInput() raises( com::sun::star::io::NotConnectedException, @@ -188,6 +168,9 @@ interface XInputStream: com::sun::star::uno::XInterface /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XMarkableStream.idl b/udkapi/com/sun/star/io/XMarkableStream.idl index 51d8fbb78..dc6cd999c 100644 --- a/udkapi/com/sun/star/io/XMarkableStream.idl +++ b/udkapi/com/sun/star/io/XMarkableStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMarkableStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -89,8 +89,7 @@ interface XMarkableStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XMarkableStream::createMark - /** creates a mark of the current postion and returns an identifier - to it. + /** creates a mark of the current postion and returns an identifier to it. */ long createMark() raises( com::sun::star::io::IOException ); @@ -98,16 +97,13 @@ interface XMarkableStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XMarkableStream::deleteMark - /** deletes the mark that you previously created with "createMark()". - - + /** deletes the mark that you previously created with + <member>XMarkableStream::createMark</member>. <p>It is an error to delete a mark if other marks after this exist. In this case, for reasons of robustness, the implementation must delete this mark and all others after - this mark. - - </p> + this mark. </p> */ void deleteMark( [in] long Mark ) raises( com::sun::star::io::IOException, @@ -134,18 +130,18 @@ interface XMarkableStream: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::io::XMarkableStream::offsetToMark /** @returns - the offset from the current stream position to the - mark ("current position" - "mark position"). + the offset from the current stream position to the + mark ("current position" - "mark position"). - @param nMark - identifies the mark which is used as a base - to calculate the offset of the current position. + @param nMark + identifies the mark which is used as a base + to calculate the offset of the current position. - @throws IllegalArgumentException - if the mark does not exist or is deleted. + @throws IllegalArgumentException + if the mark does not exist or is deleted. - @throws IOException - if an I/O error has occurred. + @throws IOException + if an I/O error has occurred. */ [const] long offsetToMark( [in] long nMark ) raises( com::sun::star::io::IOException, @@ -160,6 +156,9 @@ interface XMarkableStream: com::sun::star::uno::XInterface /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XObjectInputStream.idl b/udkapi/com/sun/star/io/XObjectInputStream.idl index d9cd37aa9..94807ee6b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -103,6 +103,9 @@ interface XObjectInputStream: com::sun::star::io::XDataInputStream /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XObjectOutputStream.idl b/udkapi/com/sun/star/io/XObjectOutputStream.idl index 92d825aac..255578c58 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { interface XPersistObject; @@ -80,34 +80,23 @@ interface XPersistObject; // DocMerge from xml: interface com::sun::star::io::XObjectOutputStream /** makes it possible to store the data and structure of runtime objects. - - <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> - - + registered at the global service manager. </p> - - - @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> + @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> */ [ uik(DF881FF1-2401-11D3-9ECD0010-5A677293), ident( "XObjectOutputStream", 1.0 ) ] interface XObjectOutputStream: XDataOutputStream @@ -129,6 +118,9 @@ interface XObjectOutputStream: XDataOutputStream /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XOutputStream.idl b/udkapi/com/sun/star/io/XOutputStream.idl index 0219faec3..0a5e8c5f1 100644 --- a/udkapi/com/sun/star/io/XOutputStream.idl +++ b/udkapi/com/sun/star/io/XOutputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XOutputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,7 +76,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -89,7 +89,7 @@ interface XOutputStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XOutputStream::writeBytes - /** writes the whole sequence to the stream. (Blocking call) + /** writes the whole sequence to the stream. (blocking call) */ void writeBytes( [in] sequence<byte> aData ) raises( com::sun::star::io::NotConnectedException, @@ -111,8 +111,6 @@ interface XOutputStream: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput /** gets called to indicate that all data has been written. - - <p>If this method is not yet been called, no attached <type>XInputStream</type> receives an EOF signal. No further bytes may be written after this method has been called.</p> @@ -131,6 +129,9 @@ interface XOutputStream: com::sun::star::uno::XInterface /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XPersist.idl b/udkapi/com/sun/star/io/XPersist.idl index 68bccc3d3..58095fef2 100644 --- a/udkapi/com/sun/star/io/XPersist.idl +++ b/udkapi/com/sun/star/io/XPersist.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPersist.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= diff --git a/udkapi/com/sun/star/io/XPersistObject.idl b/udkapi/com/sun/star/io/XPersistObject.idl index 036df590e..a2aa73504 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { interface XObjectInputStream; interface XObjectOutputStream; @@ -89,13 +89,12 @@ interface XPersistObject: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::io::XPersistObject::getServiceName /** @returns - the service name that specifies the behavior and the - persistent data format of this implementation. + 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 can be used to create such an object by a factory. </p> - - @see XServiceName::getServiceName + @see XServiceName::getServiceName */ [const] string getServiceName(); @@ -124,6 +123,9 @@ interface XPersistObject: com::sun::star::uno::XInterface /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XSeekable.idl b/udkapi/com/sun/star/io/XSeekable.idl index 4504db61f..098db493b 100644 --- a/udkapi/com/sun/star/io/XSeekable.idl +++ b/udkapi/com/sun/star/io/XSeekable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSeekable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,43 +74,46 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XSeekable -/** This is the basic interface seek on a stream.<br> - This interface should be supported if it is possible to access the - data at the new position fast.<br> - For example the access to a file should be fast enough.<br> - You shouldn't support this interface for example if you have a - continuous stream like a video stream. +/** makes it possible to seek to certain position within a stream. + + <p>This interface should be supported if it is possible to access the + data at the new position fast. For example the access to a file should + be fast enough. You should not support this interface, for example, if + you have a continuous stream like a video stream. */ [ uik(A70C54B0-A297-11d3-ABD600A0-249D5590), ident( "XSeekable", 1.0 ) ] interface XSeekable: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::io::XSeekable::seek - /** Changes the seek pointer to a new location relative to the beginning of the stream.<br> - This method changes the seek pointer so subsequent reads and writes can take place at a different + /** changes the seek pointer to a new location relative to the beginning of the stream. + + <p> This method changes the seek pointer so subsequent reads and writes can take place at a different location in the stream object. It is an error to seek before the beginning of the stream. However, it is not an error to seek past the end of the stream. Seeking past the end of the stream is useful for subsequent writes, as the stream will at that time be extended to the seek position - immediately before the write is done. + immediately before the write is done. </p> */ void seek( [in] hyper location ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException ); // DocMerge from xml: method com::sun::star::io::XSeekable::getPosition - /** Returns the current offset in this stream. + /** @returns + the current offset in this stream. */ hyper getPosition() raises( com::sun::star::io::IOException ); // DocMerge from xml: method com::sun::star::io::XSeekable::getLength - /** Returns the length of the storage medium on which the stream works.<br> + /** @returns + the length of the storage medium on which the stream works. */ hyper getLength() raises( com::sun::star::io::IOException ); @@ -123,6 +126,9 @@ interface XSeekable: com::sun::star::uno::XInterface /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XStream.idl b/udkapi/com/sun/star/io/XStream.idl index 2ae259dd1..03b0aaf83 100644 --- a/udkapi/com/sun/star/io/XStream.idl +++ b/udkapi/com/sun/star/io/XStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * 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 io { //============================================================================= // DocMerge from xml: interface com::sun::star::io::XStream -/** This is the basic interface to get read/write acess to a stream +/** offers read and write access to the same stream. */ [ uik(43845612-50AF-11d4-93E50050-DA3F314C), ident( "XStream", 1.0 ) ] interface XStream: com::sun::star::uno::XInterface @@ -88,11 +88,9 @@ interface XStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XStream::getInputStream - /** Returns the XInputStream part of the stream - Closing the returned XInputStream does closes any also XOutputStream part - - @returns - the InputStream + /** @returns + the <type>XInputStream</type> part of the stream. Closing the returned + <type>XInputStream</type> also closes any <type>XOutputStream</type> part. */ XInputStream getInputStream(); @@ -100,11 +98,9 @@ interface XStream: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XStream::getOutputStream - /** Returns the XInputStream part of the stream - Closing the returned XOutputStream does closes the XInputStream part also - - @returns - the OutputStream + /** @returns + the <type>XInputStream</type> part of the stream. Closing the returned + <type>XOutputStream</type> also closes the <type>XInputStream</type> part. */ XOutputStream getOutputStream(); }; @@ -116,6 +112,9 @@ interface XStream: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:36 mi + moved from api + Revision 1.2 2000/10/23 07:50:28 abi Replaced all Methods by getInputStream and getOutputStream, so it fits now better into the io-project diff --git a/udkapi/com/sun/star/io/XStreamListener.idl b/udkapi/com/sun/star/io/XStreamListener.idl index cbd50413a..879e678a0 100644 --- a/udkapi/com/sun/star/io/XStreamListener.idl +++ b/udkapi/com/sun/star/io/XStreamListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStreamListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * 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 io { +module com { module sun { module star { module io { //============================================================================= @@ -91,8 +91,6 @@ interface XStreamListener: com::sun::star::lang::XEventListener /** gets called when data transfer terminates normally or when data transfer is terminated from outside. - - <p>The termination could be done using the method <member>XActiveDataControl::terminate()</member>.</p> */ @@ -110,8 +108,6 @@ interface XStreamListener: com::sun::star::lang::XEventListener // DocMerge from xml: method com::sun::star::io::XStreamListener::error /** gets called when an internal error in source or sink has occurred. - - <p>After the method is called, the close is called on the connected streams.</p> */ @@ -126,6 +122,9 @@ interface XStreamListener: com::sun::star::lang::XEventListener /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XTextInputStream.idl b/udkapi/com/sun/star/io/XTextInputStream.idl index 42aad3f82..b4c7f7695 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -87,8 +87,10 @@ 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). The read characters are - converted according to the encoding defined by setEncoding. + and returns it as string (without CR, LF). + + <p>The read characters are converted according to the encoding defined + by <member>XTextInputStream::setEncoding</member>. */ string readLine() raises( com::sun::star::io::IOException ); @@ -96,11 +98,14 @@ interface XTextInputStream: com::sun::star::io::XInputStream //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XTextInputStream::readString - /** Reads text until one of the given delimiter characters or EOF is found. - Important: CR/LF is not used as default delimiter! So if no delimiter + /** reads text until one of the given delimiter characters or EOF is found. + + <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 setEncoding.@see setEncoding + defined by <member>XTextInputStream::setEncoding</member>. + + @see setEncoding */ string readString( [in] sequence<char> Delimiters, [in] boolean bRemoveDelimiter ) raises( com::sun::star::io::IOException ); @@ -108,8 +113,10 @@ interface XTextInputStream: com::sun::star::io::XInputStream //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XTextInputStream::isEOF - /** Return true, if the end of file is reached, so that no next - string can be read.@see setEncoding + /** @returns + <TRUE/>, if the end of file is reached, so that no next string can be read. + + @see setEncoding */ boolean isEOF() raises( com::sun::star::io::IOException ); @@ -118,7 +125,9 @@ interface XTextInputStream: com::sun::star::io::XInputStream //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XTextInputStream::setEncoding - /** Sets encoding + /** sets character encoding. + + @incomplete */ void setEncoding( [in] string Encoding ); }; @@ -130,6 +139,9 @@ interface XTextInputStream: com::sun::star::io::XInputStream /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XTextOutputStream.idl b/udkapi/com/sun/star/io/XTextOutputStream.idl index 18c8bdac0..1b9e53c8b 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= @@ -86,12 +86,17 @@ 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 setEncoding. - Line breaks or delimiters that may be neccessary to support - XTextInputStream::readLine and XTextInputStream::readString - have to be added manually to the parameter string.@see setEncoding - @see XTextInputStream::readLine - @see XTextInputStream::readString + /** writes a string using the encoding defined by + <member>XTextOutputStream::setEncodingi</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. + + @see setEncoding + @see XTextInputStream::readLine + @see XTextInputStream::readString */ void writeString( [in] string aString ) raises( com::sun::star::io::IOException ); @@ -99,7 +104,9 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::io::XTextOutputStream::setEncoding - /** Sets encoding + /** sets character encoding. + + @incomplete */ void setEncoding( [in] string Encoding ); }; @@ -111,6 +118,9 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream /*============================================================================= $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:24 hjs initial import diff --git a/udkapi/com/sun/star/io/XXMLExtractor.idl b/udkapi/com/sun/star/io/XXMLExtractor.idl index 092f4d8e4..36d6ef3a1 100644 --- a/udkapi/com/sun/star/io/XXMLExtractor.idl +++ b/udkapi/com/sun/star/io/XXMLExtractor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XXMLExtractor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,15 +75,15 @@ module com { module sun { module star { module io { //============================================================================= -/** Offers the capability to extract the XML document stream from a StarOffice - document storage +/** offers the capability to extract the XML document stream from a document + storage. */ [ uik(9A4E4394-875A-4251-906FCA05-D3BEEB32), ident( "XXMLExtractor", 1.0 ) ] interface XXMLExtractor : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Extracts the XML stream from the StarOffice document storage + /** extracts the XML stream from the document storage. @returns the extracted XML stream. |