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 /udkapi/com/sun/star/beans | |
| parent | f98dd4864f1c6d3d9d9f6182dfabe20dbd80312f (diff) | |
documentation syntax fixed and some minor semantic documentation fixes
Diffstat (limited to 'udkapi/com/sun/star/beans')
36 files changed, 543 insertions, 605 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 |