lost documentation from src536 inserted

9 files changed, 163 insertions, 32 deletions

diff --git a/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl b/udkapi/com/sun/star/beans/PropertyStateChangeEvent.idl
index 40cf589be0a8..1fa0577d1f15 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  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 {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -134,6 +134,9 @@ struct PropertyStateChangeEvent: com::sun::star::lang::EventObject
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XFastPropertySet.idl b/udkapi/com/sun/star/beans/XFastPropertySet.idl
index 8c2afdecd4ad..63d74866cae9 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -84,7 +84,7 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -102,6 +102,30 @@ interface XFastPropertySet: com::sun::star::uno::XInterface
 
     // DocMerge from xml: method com::sun::star::beans::XFastPropertySet::setFastPropertyValue
     /** sets the value to the property with the specified name.
+
+        @param nHandle
+            constains the implementation handle of the
+            implementation for the property.
+
+        @param aValue
+            constains the new value of the property.
+
+        @throws UnknownPropertyException
+            if the property does not exist.
+
+        @throws PropertyVetoException
+            if a vetoable listener does not approve the change of
+            a property value.
+
+        @throws IllegalArgumentException
+            if the new value cannot be converted to the type of the
+            underlying property by an identity or widening conversion.
+
+        @throws  stardiv::uno::lang::WrappedTargetException
+            if the implementation has an internal reason for the exception.
+            In this case the original exception is wrapped into this
+            <type scope="com::sun::star::lang">WrappedTargetException</type>.
+
      */
     void setFastPropertyValue( [in] long nHandle,
              [in] any aValue )
@@ -140,6 +164,9 @@ interface XFastPropertySet: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XMultiPropertySet.idl b/udkapi/com/sun/star/beans/XMultiPropertySet.idl
index 285964288324..f5a687ace91b 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -88,7 +88,7 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -120,9 +120,25 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface
         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>
+
+        @param aPropertyNames
+            specifies the names of the properties. All names must be unique.
+            This sequence must be alphabetically sorted.
+
+        @param aValues
+            contains the new values of the properties. The order is the same
+            as in <var>aPropertyNames</var>.
+
+        @throws IllegalArgumentException
+            if one of th enew values cannot be converted to the type
+            of the unterlying property by an identity or widening conversion.
+
+        @throws com::sun::star::lang:WrappedTargetException
+            if the implementation has an internal reason for the exception.
+            In this case the original exception is wrapped.
      */
-    void setPropertyValues( [in] sequence<string> PropertyNames,
-             [in] sequence<any> Values )
+    void setPropertyValues( [in] sequence<string> aPropertyNames,
+             [in] sequence<any> aValues )
             raises( com::sun::star::beans::PropertyVetoException,
                     com::sun::star::lang::IllegalArgumentException,
                     com::sun::star::lang::WrappedTargetException );
@@ -135,6 +151,10 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface
 
         <p>The order of the values in the returned sequence will be the same
         as the order of the names in the argument. </p>
+
+        @param aPropertyNames
+            specifies the names of the properties.
+            This sequence must be alphabetically sorted.
      */
     [const] sequence<any> getPropertyValues( [in] sequence<string> aPropertyNames );
 
@@ -147,6 +167,12 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface
         <p>The implementation can ignore the names of the properties
         and fire the event on all properties. </p>
 
+        @param aPropertyNames
+            specifies the names of the properties.
+
+        @param xListener
+            contains the listener for the property change events.
+
         @see removePropertiesChangeListener
      */
     [oneway] void addPropertiesChangeListener( [in] sequence<string> aPropertyNames,
@@ -159,15 +185,24 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface
 
         <p>It is a "noop" if the listener is not registered.  </p>
 
+        @param
+            contains th elistener to be removed.
+
         @see addPropertiesChangeListener
      */
-    [oneway] void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener Listener );
+    [oneway] void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener xListener );
 
     //-------------------------------------------------------------------------
 
     // DocMerge from xml: method com::sun::star::beans::XMultiPropertySet::firePropertiesChangeEvent
     /** fires a sequence of <type>PropertyChangeEvent</type>s to the specified
         listener.
+
+        @param aPropertynames
+            specifies the sorted names of the properties.
+
+        @param xListener
+            contains the listener for the property change events.
      */
     [oneway] void firePropertiesChangeEvent( [in] sequence<string> aPropertyNames,
              [in] com::sun::star::beans::XPropertiesChangeListener xListener );
@@ -181,6 +216,9 @@ interface XMultiPropertySet: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XPropertiesChangeListener.idl b/udkapi/com/sun/star/beans/XPropertiesChangeListener.idl
index b571210063d4..761350a01ac0 100644
--- a/udkapi/com/sun/star/beans/XPropertiesChangeListener.idl
+++ b/udkapi/com/sun/star/beans/XPropertiesChangeListener.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XPropertiesChangeListener.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-15 16:22:48 $
  *
  *  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 {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -86,8 +86,13 @@ interface XPropertiesChangeListener: com::sun::star::lang::XEventListener
 
     // DocMerge from xml: method com::sun::star::beans::XPropertiesChangeListener::propertiesChange
     /** gets called when bound properties are changed.
+
+        @param aEvent
+            constains a sequence of <type>PropertiesChangeEvent</type> objects
+            which describe the event source and the properites wich have
+            changed.
      */
-    void propertiesChange( [in] sequence<com::sun::star::beans::PropertyChangeEvent> evt );
+    void propertiesChange( [in] sequence<com::sun::star::beans::PropertyChangeEvent> aEvent );
 
 };
 
@@ -98,6 +103,9 @@ interface XPropertiesChangeListener: com::sun::star::lang::XEventListener
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.4  2000/11/08 12:28:20  mi
+    moved from api
+
     Revision 1.1.1.1  2000/09/18 23:34:56  hjs
     initial import
 
diff --git a/udkapi/com/sun/star/beans/XPropertyAccess.idl b/udkapi/com/sun/star/beans/XPropertyAccess.idl
index d21eef201d28..6b50c3a644cf 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -88,7 +88,7 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -138,6 +138,9 @@ interface XPropertyAccess: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XPropertyContainer.idl b/udkapi/com/sun/star/beans/XPropertyContainer.idl
index 6efe07da5133..16da7262e04c 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -91,7 +91,7 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -106,6 +106,18 @@ interface XPropertyContainer: com::sun::star::uno::XInterface
     // DocMerge from xml: method com::sun::star::beans::XPropertyContainer::addProperty
     /** adds a property to the object.
 
+        @param aName
+            specifies the name of the new property.
+
+        @param xType
+            specifies the type of the new property.
+
+        @throws PropertyExistException
+            if a property with the same name already exists.
+
+        @throws IllegalTypeException
+            if the specified type is not allowed.
+
         @see com::sun::star::beans::PropertyAttribute
      */
     void addProperty( [in] string Name,
@@ -119,6 +131,12 @@ interface XPropertyContainer: com::sun::star::uno::XInterface
 
     // DocMerge from xml: method com::sun::star::beans::XPropertyContainer::removeProperty
     /** removes a property from the object.
+
+        @param aName
+            specified the name of the property.
+
+        @throws UnknownPropertyException
+            if the property does not exist.
      */
     void removeProperty( [in] string Name )
             raises( com::sun::star::beans::UnknownPropertyException,
@@ -132,6 +150,9 @@ interface XPropertyContainer: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XPropertySetInfo.idl b/udkapi/com/sun/star/beans/XPropertySetInfo.idl
index edfcffbc849a..53fbe319b4a3 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -76,13 +76,20 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
 // DocMerge from xml: interface com::sun::star::beans::XPropertySetInfo
 /** specifies a set of properties.
 
+    <p>There are three kinds of properties:
+    <ul>
+        <li>bound properties</li>
+        <li>constrained properties</li>
+        <li>free properties</li>
+    </ul>
+
     <p>The specification only describes the properties, it does not contain
     any values.</p>
  */
@@ -134,6 +141,9 @@ interface XPropertySetInfo: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XPropertyState.idl b/udkapi/com/sun/star/beans/XPropertyState.idl
index b9f260c29c43..62d841313c58 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.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -84,7 +84,7 @@
 
 //=============================================================================
 
- module com {  module sun {  module star {  module beans {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -126,7 +126,13 @@ interface XPropertyState: com::sun::star::uno::XInterface
                 by their names.
 
         <p>The order of the states is correlating to the order of the
-        given property names.
+        given property names. </p>
+
+        @param aPropertyNames
+            contains te sequence of property names.
+
+        @throws UnknownPropertyException
+            if one property does not exist.
      */
     sequence<com::sun::star::beans::PropertyState> getPropertyStates(
             [in] sequence<string> aPropertyName )
@@ -142,6 +148,12 @@ interface XPropertyState: com::sun::star::uno::XInterface
         the change events are fired.  If it is a constrained property, you
         must fire the vetoable event before you change the property value.
         </p>
+
+        @param aPropertyname
+            specifies the name of the property.
+
+        @throws UnknownPropertyException
+            if the property does not exist.
      */
     void setPropertyToDefault( [in] string PropertyName )
             raises( com::sun::star::beans::UnknownPropertyException );
@@ -178,6 +190,9 @@ interface XPropertyState: com::sun::star::uno::XInterface
 /*=============================================================================
 
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:35  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+
     Revision 1.4  2000/11/08 12:28:20  mi
     moved from api
 
diff --git a/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl b/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl
index 6fe5b6658b1f..71e73cf2c56d 100644
--- a/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl
+++ b/udkapi/com/sun/star/beans/XPropertyStateChangeListener.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XPropertyStateChangeListener.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:28:20 $
+ *  last change: $Author: mi $ $Date: 2000-12-15 16:22:48 $
  *
  *  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 {
+module com {  module sun {  module star {  module beans {
 
 //=============================================================================
 
@@ -87,6 +87,9 @@ interface XPropertyStateChangeListener: com::sun::star::lang::XEventListener
 
     // DocMerge from xml: method com::sun::star::beans::XPropertyStateChangeListener::propertyStateChange
     /** gets called when a bound property's state is changed.
+
+        @param aEvent
+            describes the event source and the property that has changed.
      */
     void propertyStateChange( [in] com::sun::star::beans::PropertyStateChangeEvent aEvent );
 
@@ -99,6 +102,9 @@ interface XPropertyStateChangeListener: 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