From 8336084b60122e6ecff0ff949460b37136751557 Mon Sep 17 00:00:00 2001
From: Michael Hönnig This problem occurs if you use This problem can occur, if you use For details see method
-
-
-
-
- .
-
- For details see method 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.
-
-
-
These methods have the signature type get...()
,
- void set...()
or boolean is...()
.
+
These methods have the signature type get...()
,
+ void set...()
or boolean is...()
.
These methods have the signature add...Listener()
- or remove...Listener()
.
+
These methods have the signature add...Listener()
+ or remove...Listener()
.
These methods have the signature
- create...Enumeration
and return an interface that
- was derived from
These methods have the signature create...Enumeration
+ and return an interface that was derived from
+
These methods have the signature get...ByName()
,
- set...ByName()
, replace...ByName()
,
- remove...ByName()
, has...ByName()
or
- get...Names
. In addition, the method
-
These methods have the signature get...ByName()
,
+ set...ByName()
, replace...ByName()
,
+ remove...ByName()
, has...ByName()
or
+ get...Names
. In addition, the method
+
These methods have the signature get...ByIndex()
,
- insert...ByIndex()
, replace...ByIndex()
or
- remove...ByIndex()
. The method
-
These methods have the signature get...ByIndex()
,
+ insert...ByIndex()
, replace...ByIndex()
or
+ remove...ByIndex()
. The method
+
There are three types of properties: -
There are three types of properties:
The name is unique within an
It may be -1 if the implementation has no handle. You can use
this handle to get values from the
If the property has multiple types or the type is not
known, but not
It does not mean that the type of the property is void! +
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
This always implies that the property is bound, too. +
This always implies that the property is bound, too.
*/ 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 -A
Normally such events contain the name and the old and new - value of the changed property. - -
+ value of the changed property. +Void values may be provided for the old and the new values if their - true values are not known.
+ true values are not known. */ 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 - /** containsMay be -1 if the implementation has no handle. You can use
this handle to get values from the
This list is not necessarily complete; new constants may be added - (by the author). +
This list is not necessarily complete; new constants may be added + (by the author).
*/ 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 -These methods have the signature type get...()
,
- void set...()
or boolean is...()
.
+
These methods have the signature type get...()
,
+ void set...()
or boolean is...()
.
A
May be -1 if the implementation has no handle.
*/ 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. - - -The state consists of two aspects: -
+The state consists of two aspects:
The property value must be available and of the specified type.
If the
The
The
It is sent as an argument to the method of
-
Normally these events are accompanied by the name and the old - and new values of the changed property. - -
+ and new values of the changed property. +Void values may be provided for the old and new values if their - true values are not known.
+ true values are not known. */ 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. - -This name identifies the property uniquely within an
It may be -1 if the implementation has no handle. You can use this
handle to get values from the
The name is unique within a sequence of
It may be -1 if the implementation has no handle. If available it can be used for fast lookups.
*/ @@ -105,7 +101,7 @@ struct PropertyValue //------------------------------------------------------------------------- // DocMerge from xml: field com::sun::star::beans::PropertyValue::Value - /** contains the value of the property orSuch sequences are especially useful for remote interfaces. +
Such sequences are especially useful for remote interfaces.
*/ typedef sequenceOne field of application is the conversion of case-insensitive - names to the existing names. - -
+ names to the existing names. +Example: A basic interpreter ignores the case of the names. So
it must query the
For example "getExactName" could be returned for "GETEXACTNAME" - when "GETEXACTNAME" was used by a case insesitive scripting language. +
For example "getExactName" could be returned for "GETEXACTNAME" + when "GETEXACTNAME" was used by a case insesitive scripting language.
*/ 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. - -This interface is an extension to the
Usually an object that implements this interface
also implements
This interface allows direct access to subsubproperties, ...
up to arbitrary nesting depth. Often the intermediate
- elements of the hierarchy implement
Each implementation specifies how the hierarchical property names, that are used to access the elements of the hierarchy, - are formed. -
+ are formed. +Commonly a notation similar to filesystem pathes (separated by '/' slashes) or nested module names - (separated by dots '.' or '::') is used. -
+ (separated by dots '.' or '::') is used. */ [ 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 aValue is not a legal value for this property or if aHierarchicalPropertyName is not a well-formed - nested name for this hierarchy. -An implementation is not required to detect the latter - condition
+ 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 aHierarchicalPropertyName is not a well-formed nested name for this hierarchy. -An implementation is not required to detect this - condition
+ 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 aHierarchicalName is not a well-formed nested name for this hierarchy. -An implementation is not required to detect this - condition
+ 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 aHierarchicalName is not a well-formed nested name for this hierarchy. -An implementation is not required to detect this - condition
+ 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. -IMPORTANT: FOR TEST ONLY! +
IMPORTANT: FOR TEST ONLY!
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
For details see method
For details see method - - - - - . - -
@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. - -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:
RetType getX()
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
- void setX( [in] RetType )
, the property
- "X" also allows write access; otherwise it is read-only.
-
- RetType getX()
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
+ void setX( [in] RetType )
, the property
+ "X" also allows write access; otherwise it is read-only.
+ In addition, the inspect method identifies all listener
access methods in the form add...Listener
/
remove...Listener
(except methods of interface
-
Methods which do not belong to a property nor which represent
a listener access nor which are methods of
It supports some of the methods that are also defined in
The results of the get..()
and has..()
methods depends on the concepts given in the parameter
nConcepts. The minimum supported concepts should be
- for the
The
The supplied concepts (see the methods - - - - - - ) - and the - - - - - method - determine the interfaces returned by this method. - -
+The supplied concepts (see the methods
To access properties, query for the
If the introspected object implements a name container, the
introspection should return the
If the introspected object implements an index container, the
introspection should return the
If the introspected object implements an enumeration container,
- the introspection should return the
If the introspected object implements an enumeration container, the introspection
+ should return the
If the introspected object implements the
To implement inaccurate name access, at all objects, which
implement the
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. -
-Unknown properties are ignored. -
+ exception occurs. + +Unknown properties are ignored.
@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. -An implementation is not required to detect the latter - condition
+ 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. -The order of the values in the returned sequence will be the same - as the order of the names in the argument. -
- Unknown properties are ignored, in their place
The order of the values in the returned sequence will be the same + as the order of the names in the argument.
+ + Unknown properties are ignored, in their place
An implementation is not required to detect this - condition
+ 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 - theThe 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. - -
+ exception occur Unknown properties are ignored. */ void setPropertyValues( [in] sequenceThe order of the values in the returned sequence will be the same - as the order of the names in the argument. +
The order of the values in the returned sequence will be the same + as the order of the names in the argument.
*/ [const] sequenceThe implementation can ignore the names of the properties + and fire the event on all properties.
+ + @see removePropertiesChangeListener */ [oneway] void addPropertiesChangeListener( [in] sequenceIt is a "noop" if the listener is not registered. - -
@see addPropertiesChangeListener +It is a "noop" if the listener is not registered.
+ + @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 {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).
*/ [ 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. + */ void setAllPropertiesToDefault(); @@ -126,7 +127,7 @@ interface XMultiPropertyStates: com::sun::star::uno::XInterfaceEach 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.
@param aPropertyNames specifies the names of the properties. @@ -143,7 +144,7 @@ interface XMultiPropertyStates: com::sun::star::uno::XInterfaceIf no default exists, is not known or is void,
then the return type at the corresponding position in the
- sequence returned is
In most cases this interface will be in addition to
Another advantage of this method is that conflicts are avoided if property value restrictions depend on the value of other properties.
*/ @@ -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] sequenceAll properties which are not contained in the sequence aProps will be left unchanged.
*/ @@ -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. - - -There are three types of properties: -
+There are three types of properties:
+You can listen to changes of bound properties with the
To implement inaccurate name access, you must support the
- interface
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. - -
+ changed. */ 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 -An empty name ("") registers the listener to all bound properties. If the property is not bound, the behavior is - not specified. - -
@see removePropertyChangeListener + not specified. + + @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 anIt is a "noop" if the listener is not registered. - -
@see addPropertyChangeListener +It is a "noop" if the listener is not registered.
+ + @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 anAn empty name ("") registers the listener to all constrained properties. If the property is not constrained, - the behavior is not specified. - -
@see removeVetoableChangeListener + the behavior is not specified. + + @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 anIt is a "noop" if the listener is not registered. - -
@see addVetoableChangeListener +It is a "noop" if the listener is not registered.
+ + @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. - -The specification only describes the properties, it does not contain any values.
*/ @@ -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 thisThe state contains the information if:
The order of the states is correlating to the order of the - given property names. +
The order of the states is correlating to the order of the
+ given property names.
*/
sequence 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.
-
If no default exists, is not known or is void,
- then the return type is If no default exists, is not known or is void,
+ then the return type is 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 You can register an
- * Components, that support a certain protocol, must have at least two
- * service names :
- *
- * The protocol name should be written as common servicenames, first letter is a
- * capital letter, the rest in small letters postfixed by Bridge (e.g. :
- * com.sun.star.bridge.UrpBridge would be correct servicename for the urp protocol).
- * However, the protocol names are compared case insensitive.
- * If there exist two services supporting the same protocol, it is arbitrary
- * which one is chosen, so this should be omitted.
+/** This meta service allows the bridgefactory service to instantiate an
+ interprocess bridge using a certain transfer protocol.
+
+ Components, that support a certain protocol, must have at least two
+ service names: The protocol name should be written as common servicenames, first letter is a
+ capital letter, the rest in small letters postfixed by Bridge (e.g.:
+
- * It enumerates at the servicemanager all services supporting
- * the meta service com.sun.star.bridge.Bridge to get to know possible
- * protocols ( @see com.sun.star.bridge.Bridge service ).
+
+ It enumerates at the servicemanager all services supporting
+ the meta service com.sun.star.bridge.Bridge to get to know possible
+ protocols.
+
+ @see com::sun::star::bridge::Bridge
*/
service BridgeFactory
{
diff --git a/udkapi/com/sun/star/bridge/IiopBridge.idl b/udkapi/com/sun/star/bridge/IiopBridge.idl
index 916979072..62cb590b8 100644
--- a/udkapi/com/sun/star/bridge/IiopBridge.idl
+++ b/udkapi/com/sun/star/bridge/IiopBridge.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: IiopBridge.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -79,23 +79,23 @@
//=============================================================================
/** Concrete service of the meta service Bridge for iiop.
- *
- * This bridge works with the iiop protocol (
- * @see com.sun.star.bridge.Bridge ).
+
+ This bridge works with the iiop protocol. They are only used for creating bridges to other component models.
-
- @see com::sun::star::bridge::XBridgeSupplier
- @deprecated
+ They are only used for creating bridges to other component models.
+
+ @see com::sun::star::bridge::XBridgeSupplier
+
+ @deprecated
*/
constants ModelDependent
{
@@ -111,6 +112,9 @@ constants ModelDependent
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:26 mi
+ moved from api
+
Revision 1.2 2000/10/09 14:24:54 mi
#78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
diff --git a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
index cab3dcfe3..5a3dd9fa6 100644
--- a/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
+++ b/udkapi/com/sun/star/bridge/OleApplicationRegistration.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: OleApplicationRegistration.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,22 +75,14 @@
// DocMerge from xml: service com::sun::star::bridge::OleApplicationRegistration
/** registers standard UNO objects to OLE Automation.
-
-
It does not provide any specific interface because the UNO object
is registered while instanciating this service and deregistered
- if the implementation is released.
-
- The following UNO objects are provided:
-
- *
- *
+
+
+ com.sun.star.bridge.UrpBridge
would be correct servicename for the
+ "urp" protocol). However, the protocol names are compared case insensitive.
+ If there exist two services supporting the same protocol, it is arbitrary
+ which one is chosen, so this should be omitted.
- *
+ /** allows to initialize the bridge service with the necessary
+ arguments. The sequence<any> must have 4 members.
+
+
+
*/
interface com::sun::star::lang::XInitialization;
diff --git a/udkapi/com/sun/star/bridge/BridgeExistsException.idl b/udkapi/com/sun/star/bridge/BridgeExistsException.idl
index c8ea8a8f6..8637ca45e 100644
--- a/udkapi/com/sun/star/bridge/BridgeExistsException.idl
+++ b/udkapi/com/sun/star/bridge/BridgeExistsException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: BridgeExistsException.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -63,12 +63,12 @@
#include
- *
+ /** This interface allows to initialize the bridge service with the necessary
+ arguments. The sequence<any> must have 4 members.
+
+
+
*/
interface com::sun::star::lang::XInitialization;
diff --git a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
index dd167a219..4f43af881 100644
--- a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
+++ b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: InvalidProtocolChangeException.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,14 +68,13 @@ module com { module sun { module star { module bridge {
exception InvalidProtocolChangeException : com::sun::star::uno::Exception
{
- /***
- * The first invalid property.
- **/
+ /** The first invalid property.
+ */
ProtocolProperty invalidProperty;
- /***
- * 1 : unkown (the property name is unknown to the thrower)
- * 2 : invalid value (the property's value can't be accepted by the thrower)
- ***/
+
+ /** Contains 1, if the property name is unknown to the thrower;
+ or contains 2, if the property's value can't be accepted by the thrower.
+ */
long reason;
};
diff --git a/udkapi/com/sun/star/bridge/ModelDependent.idl b/udkapi/com/sun/star/bridge/ModelDependent.idl
index 50690a263..077447ca0 100644
--- a/udkapi/com/sun/star/bridge/ModelDependent.idl
+++ b/udkapi/com/sun/star/bridge/ModelDependent.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ModelDependent.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,10 +71,11 @@
// DocMerge from idl: constants com::sun::star::bridge::ModelDependent
/** These constants are used to specify model-dependant representations.
-
The following UNO objects are provided:
The service implements the
- The COM types are restricted to those types that can be represented +
The COM types are restricted to those types that can be represented
by a VARIANT
except for VT_CY
and
VT_DATE
. An IUnknown
interface
can only be mapped, if it can be successfully queried for
- IDispatch
.
- Other COM interfaces are not supported. On the other hand UNO objects
- and structs are always mapped to COM objects exposing IDispatch
.
+ IDispatch
.
Other COM interfaces are not supported. On the other hand UNO objects
+ and structs are always mapped to COM objects exposing IDispatch
.
The service implements the
Any OLE objects which are accessable via
The optional parameters of the method
-
-
+ The created UNO objects support
The optional parameters of the method
- * This bridge works with the urp protocol - * (@see com.sun.star.bridge.Bridge ). + +
This bridge works with the urp protocol. + + @see com.sun.star.bridge.Bridge */ service UrpBridge { - /** - * This interface allows to initialize the bridge service with the necessary - * arguments. The sequence<any> must have 4 members. - * - *
In general, this method is called once to get the initial object from the + remote, but it is allowed to call the method multiple times.
*/ XInterface getInstance( [in] string sInstanceName ); @@ -86,8 +86,7 @@ interface XBridge: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::bridge::XBridge::getDescription - /** a descriptive string : protocol: + XConnection.getDescription() - This description is unique. + /** a unique descriptive string: protocol + ":" + XConnection.getDescription() */ string getDescription(); }; diff --git a/udkapi/com/sun/star/bridge/XBridgeFactory.idl b/udkapi/com/sun/star/bridge/XBridgeFactory.idl index cf1d095ff..d885aa7cd 100644 --- a/udkapi/com/sun/star/bridge/XBridgeFactory.idl +++ b/udkapi/com/sun/star/bridge/XBridgeFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,25 +70,33 @@ module com { module sun { module star { module bridge { -// DocMerge: empty anyway +/** @missing + */ [ uik(4D463C50-D3E8-11d3-9EE80050-04D7755D), ident( "XBridgeFactory", 1.0 ) ] interface XBridgeFactory: com::sun::star::uno::XInterface { - // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::createBridge - /** ****** - * @param sName The name of the bridge. The format should be protocol:connection-description - * (e.g. iiop:socket:localhost:2000). This allows other components to reuse - * an already created bridge (using getBridge). - * @param sProtocol The protocol, the bridge should work on. - * @param aConnection The connection on which the calls will be transfered. - * @param anInstanceProvider gets called, when a request from remote comes in. - * - * @exception BridgeExistsException There is already a bridge registered with this name. - * Use getBridge instead. - * @exception IllegalArgumentException The protocol is unknown. - * - ******* + /** @incomplete + + @param sName + The name of the bridge. The format should be protocol:connection-description + (e.g. iiop:socket:localhost:2000). This allows other components to reuse + an already created bridge (using getBridge). + + @param sProtocol + The protocol, the bridge should work on. + + @param aConnection + The connection on which the calls will be transfered. + + @param anInstanceProvider + gets called, when a request from remote comes in. + + @exception BridgeExistsException + There is already a bridge registered with this name. Use getBridge instead. + + @exception IllegalArgumentException + The protocol is unknown. */ XBridge createBridge( [in] string sName, @@ -103,12 +111,9 @@ interface XBridgeFactory: com::sun::star::uno::XInterface */ XBridge getBridge( [in] string sName ); - - // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::getExistingBridges - /** *** - * @return Sequence of all existing bridges. - *** + /** @returns + Sequence of all existing bridges. */ sequence < XBridge > getExistingBridges( ); }; diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl index 1949a0e45..a0349730a 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,50 +83,40 @@ // DocMerge from xml: interface com::sun::star::bridge::XBridgeSupplier /** defines the interface for creating bridges to other object models. - -Because bridges sometimes can not be generated in an address space, the implementation needs to check the address space of the caller by comparing the machine and process ID against its own. These IDs are - provided by the UNO runtime. - -
+ provided by the UNO runtime. +All objects, whether they are part of the UNO object model or not,
are carried in an
Any implementation can supply its own bridges to other object models by implementing this interface and returning the bridge - when the method is called with itself as the first parameter.
@see com::sun::star::bridge::OleBridgeSupplier + when the method is called with itself as the first parameter. + + @see com::sun::star::bridge::OleBridgeSupplier */ [ uik(E227A548-33D6-11D1-AABE00A0-249D5590), ident( "XBridgeSupplier", 1.0 ) ] interface XBridgeSupplier: com::sun::star::uno::XInterface @@ -152,6 +142,9 @@ interface XBridgeSupplier: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:26 mi + moved from api + Revision 1.2 2000/10/09 14:24:54 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl index 8ae190232..a7b89709f 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XBridgeSupplier2.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,57 +83,42 @@ // DocMerge from xml: interface com::sun::star::bridge::XBridgeSupplier2 /** defines the interface for creating bridges to other object models. -Because bridges sometimes can not be generated in an address space, the implementation needs to check the address space of the caller by comparing the process ID against its own. That ID is - provided by the UNO runtime. - -
+ provided by the UNO runtime. +All objects, whether they are part of the UNO object model or not,
are carried in an
Any implementation can supply its own bridges to other object models by implementing this interface and returning the bridge - when the method - - - - - - is called with itself as the first parameter. - -
@see com::sun::star::bridge::OleBridgeSupplier2 + when the methodIn general, this interface is implemented by the bridge itself. It must not + be called from outside the bridge.
+ +INTERNAL INTERFACE, DO NOT USE IT ELSEWHERE!
+*/ [ uik(A7EF98B1-8D82-11d4-9F1B0050-04D7755D), ident( "XProtocolProperties", 1.0 ) ] interface XProtocolProperties : com::sun::star::uno::XInterface { - /*** - * Called to get a list of bridge internal properties. Which properties can be retrieved, is - * protocol dependend. - * The properties MUST NOT change between a requestChange and a commit change call. - ***/ + /** called to get a list of bridge internal properties. Which properties can be retrieved, + is protocol dependend. + +The properties MUST NOT change between a requestChange and a commit change call.
+ */ sequence< ProtocolProperty > getProperties( ); - /**** - * Called to initiate a protocol change. This method should always be called in the scope - * of the local bridge setting object, because the remote counter part may do such a call - * at the same time (typically at startup time). - * - * @param nRandomNumber In case both processes call requestChange at the same time, - * the caller with the higher nRandomNumber is allowed to call - * commitChange. - * @returns 1, if the caller may ( and MUST !!!) call commitChange. - * 0, if the caller is not allowed to call commitChange. This can only happen, - * if the other bridge has called requestChange at the same time and - * nRandomNumber is smaller than the other bridge's nRandomNumber. - * The remote counterpart is supposed to call commitChange within a small - * time span. Please call requestChange() after the remote counterpart has - * called commitChange(). - * -1 if the nRandomNumber is of the same value as the previously - * sent requestChange (sent by the remote counterpart). This is a draw :o). - * Generate a new random number and try again. - ****/ + /** called to initiate a protocol change. + +This method should always be called in the scope of the local bridge setting object, + because the remote counter part may do such a call at the same time + (typically at startup time).
+ + @param nRandomNumber + In case both processes call requestChange at the same time, + the caller with the higher nRandomNumber is allowed to call + commitChange. + + @returns + 1, if the caller may ( and MUST !!!) call commitChange. + 0, if the caller is not allowed to call commitChange. This can only happen, + if the other bridge has called requestChange at the same time and + nRandomNumber is smaller than the other bridge's nRandomNumber. + The remote counterpart is supposed to call commitChange within a small + time span. Please call requestChange() after the remote counterpart has + called commitChange(). + -1 if the nRandomNumber is of the same value as the previously + sent requestChange (sent by the remote counterpart). This is a draw :o). + Generate a new random number and try again. + */ long requestChange( [in] long nRandomNumber ); - /**** - * Called to commit a protocol change. It is only allowed to call commitChange, if - * requestChange has been called previously and the return value was true. - * The new properties are valid after the reply of commitChange has been received. - * Note, that this is difficult for the callee, because it must marshal the reply - * with the old settings. - * All properties not mentioned in the list are unchanged. - * Note that the bridge must be blocked for other threads, - * before commitChange is sent and unblocked - * after the reply has been received. This blocks the bridge. - * - * @raises InvalidProtocolChangeException - * when the remote counterpart could not change - * at least one of the properties. No property - * has been changed. requestChange must be called - * again to initiate a new change of the protocol. - ****/ + /** called to commit a protocol change. + +It is only allowed to call commitChange, if requestChange + has been called previously and the return value was true. The new properties are + valid after the reply of commitChange has been received. + Note, that this is difficult for the callee, because it must marshal the reply + with the old settings.
+ +All properties not mentioned in the list are unchanged. + Note that the bridge must be blocked for other threads, + before commitChange is sent and unblocked + after the reply has been received. This blocks the bridge.
+ + @raises InvalidProtocolChangeException + when the remote counterpart could not change at least one of the properties. + No property has been changed. requestChange must be called + again to initiate a new change of the protocol. + */ void commitChange( [in] sequence< ProtocolProperty > newValues ) raises ( com::sun::star::bridge::InvalidProtocolChangeException ); }; diff --git a/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl b/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl index 0e4c31c80..4d651d335 100644 --- a/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl +++ b/udkapi/com/sun/star/bridge/XUnoUrlResolver.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnoUrlResolver.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,8 @@ //============================================================================= // DocMerge from xml: interface com::sun::star::bridge::XUnoUrlResolver -/** service com.sun.star.bridge.UnoUrlResolver implements this interface. +/** serviceAfter the method has been left, it can be reentered.
*/ XConnection accept( [in] string sConnectionDescription ) raises( AlreadyAcceptingException, diff --git a/udkapi/com/sun/star/connection/XConnection.idl b/udkapi/com/sun/star/connection/XConnection.idl index fdf0d0ee3..ccd02a97b 100644 --- a/udkapi/com/sun/star/connection/XConnection.idl +++ b/udkapi/com/sun/star/connection/XConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnection.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,15 +64,9 @@ #includeThis string is different from the arguments to
The type and the value of the accessor depends on the service.
*/ any Accessor; @@ -111,6 +111,9 @@ struct ContainerEvent: com::sun::star::lang::EventObject /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/ElementExistException.idl b/udkapi/com/sun/star/container/ElementExistException.idl index b8ec34fc7..3ed78ece0 100644 --- a/udkapi/com/sun/star/container/ElementExistException.idl +++ b/udkapi/com/sun/star/container/ElementExistException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ElementExistException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,14 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::container::ElementExistException -/** is thrown by the - - - - - - method to indicate that there are no more elements in the enumeration.@see XNameContainer - @see XNameContainer#insertByName() +/** is thrown by container methods, if an element is added which is already + child of the container. + +Probably not the same element is already a member, when this exception + is thrown, but a member with the same id or name.
+ + @see XNameContainer + @see XNameContainer::insertByName */ exception ElementExistException: com::sun::star::uno::Exception { @@ -93,6 +92,9 @@ exception ElementExistException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/NoSuchElementException.idl b/udkapi/com/sun/star/container/NoSuchElementException.idl index 6b8465da0..e4b49f828 100644 --- a/udkapi/com/sun/star/container/NoSuchElementException.idl +++ b/udkapi/com/sun/star/container/NoSuchElementException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSuchElementException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,14 +73,11 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::container::NoSuchElementException -/** is thrown by the - - - - - - method to indicate that there are no more elements in the enumeration.@see XEnumeration - @see XEnumeration#nextElement() +/** is thrown by child access methods of collections, if the addressed child + does not exist. + + @see XEnumeration + @see XEnumeration::nextElement */ exception NoSuchElementException: com::sun::star::uno::Exception { @@ -93,6 +90,9 @@ exception NoSuchElementException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XChild.idl b/udkapi/com/sun/star/container/XChild.idl index 2d071e56f..d32808cbe 100644 --- a/udkapi/com/sun/star/container/XChild.idl +++ b/udkapi/com/sun/star/container/XChild.idl @@ -2,9 +2,9 @@ * * $RCSfile: XChild.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,6 @@ // DocMerge from xml: interface com::sun::star::container::XChild /** provides access to the parent of the object. - -This interface normally is only supported if the objects all have exactly one dedicated parent container.
*/ @@ -97,13 +95,10 @@ interface XChild: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::container::XChild::setParent - /** sets the parent to this object. The object returns this - parent through the method - - - - - . + /** sets the parent to this object. + + @throws com::sun::star::lang::NoSupportException + if the name of this object cannot be changed. */ void setParent( [in] com::sun::star::uno::XInterface Parent ) raises( com::sun::star::lang::NoSupportException ); @@ -117,6 +112,9 @@ interface XChild: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XComponentEnumeration.idl b/udkapi/com/sun/star/container/XComponentEnumeration.idl index 47119f88b..fe34e6a98 100644 --- a/udkapi/com/sun/star/container/XComponentEnumeration.idl +++ b/udkapi/com/sun/star/container/XComponentEnumeration.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentEnumeration.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,10 +90,10 @@ interface XComponentEnumeration: com::sun::star::container::XEnumeration // DocMerge from idl: method com::sun::star::container::XComponentEnumeration::nextComponent /** @returns - the next component of this enumeration. + the next component of this enumeration. - @throws NoSuchElementException - if no more elements exist. + @throws NoSuchElementException + if no more elements exist. */ com::sun::star::lang::XComponent nextComponent() raises( com::sun::star::container::NoSuchElementException ); @@ -107,6 +107,9 @@ interface XComponentEnumeration: com::sun::star::container::XEnumeration /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XContainer.idl b/udkapi/com/sun/star/container/XContainer.idl index 6ea5ad86c..dc0ad4fd1 100644 --- a/udkapi/com/sun/star/container/XContainer.idl +++ b/udkapi/com/sun/star/container/XContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,18 +80,18 @@ /** supports quick access to the information if a container currently contains elements. - -The
This can be useful for UI to enable/disable some functions - without actually accessing the data. - -
@see XContent, XIndexAccess, XNameAcces, XEnumerationAccess + without actually accessing the data. + + @see XContent + @see XIndexAccess + @see XNameAcces + @see XEnumerationAccess */ [ uik(E227A527-33D6-11D1-AABE00A0-249D5590), ident( "XContainer", 1.0 ) ] interface XContainer: com::sun::star::uno::XInterface @@ -100,7 +100,9 @@ interface XContainer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::XContainer::addContainerListener /** adds the specified listener to receive events when - elements are inserted or removed.@see XContainerListener + elements are inserted or removed. + + @see XContainerListener */ [oneway] void addContainerListener( [in] com::sun::star::container::XContainerListener xListener ); @@ -108,7 +110,9 @@ interface XContainer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::XContainer::removeContainerListener /** removes the specified listener so it does not receive - any events from this container.@see XContainerListener + any events from this container. + + @see XContainerListener */ [oneway] void removeContainerListener( [in] com::sun::star::container::XContainerListener xListener ); @@ -121,6 +125,9 @@ interface XContainer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl index 0a070a270..e9a32f67f 100644 --- a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl +++ b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentEnumerationAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,23 +79,15 @@ // DocMerge from xml: interface com::sun::star::container::XContentEnumerationAccess /** allows access to the collections of all content types within the object. - - - - - - - - - @exampleThis example prints the names of all tables: - -
+ @example +This example prints the names of all tables:
+An object that implements the XEnumeration::nextElement
method return successive
- elements of the series.
-
-
For example (Java), to print all elements of a vector aVect: - + elements of the series.
+ +For example (Java), to print all elements of a vector aVect:
+If the object changed, the behavior of the enumeration is - not specified. This is not a remote interface. - -
+ not specified. This is not a remote interface. */ [ uik(E227A397-33D6-11D1-AABE00A0-249D5590), ident( "XEnumeration", 1.0 ) ] interface XEnumeration: com::sun::star::uno::XInterface @@ -122,15 +117,15 @@ interface XEnumeration: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::XEnumeration::nextElement /** @returns - the next element of this enumeration. + the next element of this enumeration. - @throws NoSuchElementException - if no more elements exist. + @throws NoSuchElementException + if no more elements exist. - @throws com::sun::star::lang::WrappedTargetException - If the implementation has internal reasons for exceptions, - then wrap these in aThe name is generally globally unique in the hierarchy. - -
@see com::sun::star::container::XHierarchicalNameAccess - @see com::sun::star::container::XNamed +The name is generally globally unique in the hierarchy.
+ + @see com::sun::star::container::XHierarchicalNameAccess + @see com::sun::star::container::XNamed */ [ uik(C98C6340-4209-11d4-9F5D0050-DA6BA2A6), ident( "XHierarchicalName", 1.0 ) ] interface XHierarchicalName: com::sun::star::uno::XInterface @@ -96,7 +95,7 @@ interface XHierarchicalName: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::XHierarchicalName::getHierarchicalName /** @returns - the fully qualified hierarchical name of the object. + the fully qualified hierarchical name of the object. */ [const] string getHierarchicalName(); @@ -105,11 +104,10 @@ interface XHierarchicalName: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::XHierarchicalName::composeHierarchicalName /** builds the hierarchical name of an object, given a relative name -Can be used to find the name of a descendant object in the hierarchy - without actually accessing it. - -
@see XHierarchicalNameAccess::hasByHierarchicalName + without actually accessing it. + + @see XHierarchicalNameAccess::hasByHierarchicalName */ [const] string composeHierarchicalName( [in] string aRelativeName ) raises( com::sun::star::lang::IllegalArgumentException, @@ -123,6 +121,9 @@ interface XHierarchicalName: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl index 203e9853d..d1ae90dfa 100644 --- a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl +++ b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalNameAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,12 +78,14 @@ // DocMerge from xml: interface com::sun::star::container::XHierarchicalNameAccess /** is used to have hierarchical access to elements within a container. - You address an object of a specific level in the hierarchy by giving its - fully qualified name, e.g. "com::sun::star::uno::XInterface". + +You address an object of a specific level in the hierarchy by giving its + fully qualified name, e.g. "com::sun::star::uno::XInterface".
- -To implement inaccurate name access, support the
To implement inaccurate name access, support the
+
In many cases the next call is
This interface should only be used if the data structure, itself, is indexed.
*/ @@ -104,18 +102,18 @@ interface XIndexAccess: com::sun::star::container::XElementAccess // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex /** @returns - the element at the specified index + the element at the specified index - @param Index - specifies the position in the array. The first index is 0. + @param Index + specifies the position in the array. The first index is 0. - @throws com::sun::star::lang::IndexOutOfBoundException - if the index is not valid. + @throws com::sun::star::lang::IndexOutOfBoundException + if the index is not valid. - @throws com::sun::star::lang::WrappedTargetException - If the implementation has internal reasons for exceptions, - then wrap these in aTo append an element, use the index "last index +1". - -
+To append an element, use the index "last index +1".
*/ void insertByIndex( [in] long Index, [in] any Element ) @@ -126,6 +122,9 @@ interface XIndexContainer: com::sun::star::container::XIndexReplace /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XIndexReplace.idl b/udkapi/com/sun/star/container/XIndexReplace.idl index 3ea193d6e..2ce1d122b 100644 --- a/udkapi/com/sun/star/container/XIndexReplace.idl +++ b/udkapi/com/sun/star/container/XIndexReplace.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndexReplace.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,9 @@ // DocMerge from xml: interface com::sun::star::container::XIndexReplace /** This is the generic interface for supporting the replacement of indexed - elements.@see XContainer + elements. + + @see XContainer */ [ uik(E227A422-33D6-11D1-AABE00A0-249D5590), ident( "XIndexReplace", 1.0 ) ] interface XIndexReplace: com::sun::star::container::XIndexAccess @@ -111,6 +113,9 @@ interface XIndexReplace: com::sun::star::container::XIndexAccess /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XNameAccess.idl b/udkapi/com/sun/star/container/XNameAccess.idl index b82c58d24..a71a88f5a 100644 --- a/udkapi/com/sun/star/container/XNameAccess.idl +++ b/udkapi/com/sun/star/container/XNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNameAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,10 +83,11 @@ // DocMerge from xml: interface com::sun::star::container::XNameAccess /** is used to access named objects within a container. - - -To implement inaccurate name access, support the
To implement inaccurate name access, support the
+
The order of the names is not specified. +
The order of the names is not specified.
*/ [const] sequenceIn many cases the next call is
The name is generally unique in the container of the object.
*/ [ uik(E227A52D-33D6-11D1-AABE00A0-249D5590), ident( "XNamed", 1.0 ) ] @@ -86,7 +84,7 @@ interface XNamed: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::XNamed::getName /** @returns - the programmatic name of the object. + the programmatic name of the object. */ [const] string getName(); @@ -106,6 +104,9 @@ interface XNamed: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/container/XUniqueIDAccess.idl b/udkapi/com/sun/star/container/XUniqueIDAccess.idl index 488126abf..daea3391a 100644 --- a/udkapi/com/sun/star/container/XUniqueIDAccess.idl +++ b/udkapi/com/sun/star/container/XUniqueIDAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUniqueIDAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:31 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,8 +76,7 @@ //============================================================================= - module com { module sun { module star { module container { - +module com { module sun { module star { module container { // DocMerge from xml: interface com::sun::star::container::XUniqueIDAccess /** makes it possible to access contents via a unique ID. @@ -85,10 +84,12 @@ [ uik(965BA025-A0F6-11d3-869B0050-04D8BC00), ident("UniqueIDAccess", 1.0) ] interface XUniqueIDAccess: com::sun::star::uno::XInterface { - // DocMerge: empty anyway + /** @missing + */ any getByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); - // DocMerge: empty anyway + /** @missing + */ void removeByUniqueID( [in] string ID ) raises( com::sun::star::container::NoSuchElementException ); }; @@ -99,6 +100,9 @@ interface XUniqueIDAccess: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:31 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:04 hjs initial import diff --git a/udkapi/com/sun/star/corba/corba.idl b/udkapi/com/sun/star/corba/corba.idl index e427f01e9..a767cad31 100644 --- a/udkapi/com/sun/star/corba/corba.idl +++ b/udkapi/com/sun/star/corba/corba.idl @@ -2,9 +2,9 @@ * * $RCSfile: corba.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:34 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:48 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,7 @@ module com { module sun { module star { module corba typedef unsigned long ObjectSystemID; typedef sequence< byte > OpaqueData; + /// @missing struct OneThreadID { ObjectSystemID objSysID; @@ -73,27 +74,32 @@ module com { module sun { module star { module corba typedef sequenceIt indicates that not enough system resources are available for extending the buffer. (May also indicate that the internal buffer has grown to a larger size than 2G. Some current implementations do @@ -94,6 +92,9 @@ exception BufferSizeExceededException: com::sun::star::io::IOException /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:36 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:23 hjs initial import diff --git a/udkapi/com/sun/star/io/DataInputStream.idl b/udkapi/com/sun/star/io/DataInputStream.idl index 31788447d..671e6615b 100644 --- a/udkapi/com/sun/star/io/DataInputStream.idl +++ b/udkapi/com/sun/star/io/DataInputStream.idl @@ -2,9 +2,9 @@ * * $RCSfile: DataInputStream.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $ + * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,14 @@ //============================================================================= - module com { module sun { module star { module io { +module com { module sun { module star { module io { //============================================================================= // DocMerge from xml: service com::sun::star::io::DataInputStream /** reads the data through a chained stream. - - - Guarantees: + + @guarantees
The implementation reads the original data from the inputstream, - that has been set previously at the XActiveDataSink interface. In general - the implementation must buffer the data.
+ +The implementation reads the original data from the input stream,
+ that has been set previously at the
The implementation stores the data as long as marks exists and later writes these data into the output stream, - that has been set previously at the XActiveDataSource interface.
+ that has been set previously at theImplementations of this service must fulfill the specifications of the
The written objects are held until this instance is destroyed. The references to the objects are read as four-byte integers. Data format reads:
-- short InfoLength - long ObjectReference // 0 indicates no object - UTF ServiceName // length of 0 indicates this is only a reference - long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data - Object ObjectData // the data of the object - ... // skipping additional data + short InfoLength + long ObjectReference // 0 indicates no object + UTF ServiceName // length of 0 indicates this is only a reference + long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data + Object ObjectData // the data of the object + ... // skipping additional data- Guarantees: + @guarantees
Implementations of this service must fulfill the specifications of the
-
- short InfoLength - long ObjectReference // 0 indicates no object - UTF ServiceName // length of 0 indicates this is only a reference - long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data - Object ObjectData // the data of the object + short InfoLength + long ObjectReference // 0 indicates no object + UTF ServiceName // length of 0 indicates this is only a reference + long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data + Object ObjectData // the data of the object- Garantees + @garantees
All data written through the outputstream is buffered until it is + read again from the input stream. The buffer grows in 2 ^ x steps. + The maximum size of the buffer is 2 ^ 31 -1.
- - Guarantees: + @guaranteesA thread will be created that reads from the input stream and writes the data to the connected output stream. Data will not be buffered by - this service. + this service.
- - Guarantees: + @guaranteesEOF/code> is reached during reading a datatype
+ (long
, string
, etc.).
*/
exception UnexpectedEOFException: com::sun::star::io::IOException
{
@@ -87,6 +87,9 @@ exception UnexpectedEOFException: com::sun::star::io::IOException
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/WrongFormatException.idl b/udkapi/com/sun/star/io/WrongFormatException.idl
index a827451bb..673f25e40 100644
--- a/udkapi/com/sun/star/io/WrongFormatException.idl
+++ b/udkapi/com/sun/star/io/WrongFormatException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: WrongFormatException.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,13 +68,13 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: exception com::sun::star::io::WrongFormatException
/** is thrown when inconsistent data comes up while reading a complex
- data type (string or object).
+ data type (string
or object).
*/
exception WrongFormatException: com::sun::star::io::IOException
{
@@ -87,6 +87,9 @@ exception WrongFormatException: com::sun::star::io::IOException
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XActiveDataControl.idl b/udkapi/com/sun/star/io/XActiveDataControl.idl
index b80732527..58b0f04d5 100644
--- a/udkapi/com/sun/star/io/XActiveDataControl.idl
+++ b/udkapi/com/sun/star/io/XActiveDataControl.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XActiveDataControl.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,17 +72,15 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XActiveDataControl
/** makes it possible to control an active data source.
-
-
This interface should be supported by objects which implement
- XActiveDataSource or XActiveDataSink .
+ XActiveDataSource or XActiveDataSink .
*/
[ uik(67AD5C28-23FD-11D3-9ECD0010-5A677293), ident( "XActiveDataControl", 1.0 ) ]
interface XActiveDataControl: com::sun::star::uno::XInterface
@@ -106,12 +104,10 @@ interface XActiveDataControl: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XActiveDataControl::start
/** starts I/O.
-
-
Either XActiveDataControl::setInputStream() or
XActiveDataControl::setOutputStream() must be called beforehand.
-
+
This method does not block the thread, so reading is
generally not finished when the method returns.
*/
@@ -122,12 +118,10 @@ interface XActiveDataControl: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XActiveDataControl::terminate
/** does a weak abort.
-
-
It closes all connected resources and calls
- XInputStream::close() or
- XOutputStream::close() and fires the
- XStreamListener::terminated() -event.
+ XInputStream::close or
+ XOutputStream::close and fires the
+ XStreamListener::terminated -event.
*/
void terminate();
@@ -140,6 +134,9 @@ interface XActiveDataControl: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XActiveDataSink.idl b/udkapi/com/sun/star/io/XActiveDataSink.idl
index eb61dfab4..9b86653a6 100644
--- a/udkapi/com/sun/star/io/XActiveDataSink.idl
+++ b/udkapi/com/sun/star/io/XActiveDataSink.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XActiveDataSink.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,15 +72,13 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XActiveDataSink
/** makes it possible to read the corresponding object from an input stream.
-
-
If you want to allow control from outside, also implement the
XActiveDataControl interface.
*/
@@ -92,8 +90,6 @@ interface XActiveDataSink: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XActiveDataSink::setInputStream
/** plugs the input stream.
-
-
If XConnectable is also implemented, this
method should query aStream for an
XConnectable and connect both.
@@ -117,6 +113,9 @@ interface XActiveDataSink: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XActiveDataSource.idl b/udkapi/com/sun/star/io/XActiveDataSource.idl
index dcb9e97ae..0359e50dd 100644
--- a/udkapi/com/sun/star/io/XActiveDataSource.idl
+++ b/udkapi/com/sun/star/io/XActiveDataSource.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XActiveDataSource.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,13 +72,15 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XActiveDataSource
/** has to be implemented if the class should be able to write into an output
- stream.@see XActiveDataControl.
+ stream.
+
+ @see XActiveDataControl.
*/
[ uik(27022EC0-23FD-11D3-9ECD0010-5A677293), ident( "XActiveDataSource", 1.0 ) ]
interface XActiveDataSource: com::sun::star::uno::XInterface
@@ -88,8 +90,6 @@ interface XActiveDataSource: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XActiveDataSource::setOutputStream
/** plugs the output stream.
-
-
If XConnectable is also implemented, this
method should query aStream for a
XConnectable and connect both.
@@ -114,6 +114,9 @@ interface XActiveDataSource: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XActiveDataStreamer.idl b/udkapi/com/sun/star/io/XActiveDataStreamer.idl
index 1cec73e21..dbf6f067e 100644
--- a/udkapi/com/sun/star/io/XActiveDataStreamer.idl
+++ b/udkapi/com/sun/star/io/XActiveDataStreamer.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XActiveDataStreamer.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -91,7 +91,6 @@ interface XActiveDataStreamer: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XActiveDataStreamer::setStream
/** plugs the input/output stream.
-
If XConnectable is also implemented, this
method should query aStream for a
XConnectable and connect both.
@@ -115,6 +114,9 @@ interface XActiveDataStreamer: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XConnectable.idl b/udkapi/com/sun/star/io/XConnectable.idl
index ad1a04559..bd623b730 100644
--- a/udkapi/com/sun/star/io/XConnectable.idl
+++ b/udkapi/com/sun/star/io/XConnectable.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XConnectable.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,16 +75,13 @@
// DocMerge from xml: interface com::sun::star::io::XConnectable
/** makes it possible to connect data sinks and sources.
-
-
The predecessor-member is the element in the connection that is
nearer to the source of the data. The successor-member is the element
that is further away from the source of the data. (Note that this
classification does not depend on whether the class implements
XInputStream or XOutputStream ; it only
- depends on the direction of data flow.)
-
-
+ depends on the direction of data flow.)
+
This interface allows generic services to navigate between
arbitrary elements of a connection.
*/
@@ -102,7 +99,7 @@ interface XConnectable: com::sun::star::uno::XInterface
// DocMerge from idl: method com::sun::star::io::XConnectable::getPredecessor
/** @returns
- the predecessor of this object.
+ the predecessor of this object.
*/
com::sun::star::io::XConnectable getPredecessor();
@@ -117,7 +114,7 @@ interface XConnectable: com::sun::star::uno::XInterface
// DocMerge from idl: method com::sun::star::io::XConnectable::getSuccessor
/** @returns
- the successor of this object.
+ the successor of this object.
*/
com::sun::star::io::XConnectable getSuccessor();
@@ -130,6 +127,9 @@ interface XConnectable: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XDataExporter.idl b/udkapi/com/sun/star/io/XDataExporter.idl
index 35a796eed..79a765f6e 100644
--- a/udkapi/com/sun/star/io/XDataExporter.idl
+++ b/udkapi/com/sun/star/io/XDataExporter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDataExporter.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,15 +80,13 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XDataExporter
/** makes it possible to export data from a component into a data sink.
-
-
Exporter objects are registered for specific components and data types.
*/
@@ -98,7 +96,7 @@ interface XDataExporter: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XDataExporter::exportData
- /** exports data for a Component into an output stream.
+ /** exports data for a component into an output stream.
*/
[oneway] void exportData( [in] com::sun::star::io::XOutputStream aOutputStream,
[in] com::sun::star::lang::XComponent Component,
@@ -120,6 +118,9 @@ interface XDataExporter: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XDataImporter.idl b/udkapi/com/sun/star/io/XDataImporter.idl
index f14bb4449..1bff9a98a 100644
--- a/udkapi/com/sun/star/io/XDataImporter.idl
+++ b/udkapi/com/sun/star/io/XDataImporter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDataImporter.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,15 +80,13 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XDataImporter
/** makes it possible to import data from a data source into a component.
-
-
Importer objects are registered for specific components and data types.
*/
[ uik(E2280126-33D6-11D1-AABE00A0-249D5590), ident( "XDataImporter", 1.0 ) ]
@@ -119,6 +117,9 @@ interface XDataImporter: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XDataInputStream.idl b/udkapi/com/sun/star/io/XDataInputStream.idl
index c646822df..cffbdd491 100644
--- a/udkapi/com/sun/star/io/XDataInputStream.idl
+++ b/udkapi/com/sun/star/io/XDataInputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDataInputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -165,6 +165,9 @@ interface XDataInputStream: com::sun::star::io::XInputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XDataOutputStream.idl b/udkapi/com/sun/star/io/XDataOutputStream.idl
index a634626dd..6ea927277 100644
--- a/udkapi/com/sun/star/io/XDataOutputStream.idl
+++ b/udkapi/com/sun/star/io/XDataOutputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDataOutputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -165,6 +165,9 @@ interface XDataOutputStream: com::sun::star::io::XOutputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XDataTransferEventListener.idl b/udkapi/com/sun/star/io/XDataTransferEventListener.idl
index 0de82de51..781f3bc97 100644
--- a/udkapi/com/sun/star/io/XDataTransferEventListener.idl
+++ b/udkapi/com/sun/star/io/XDataTransferEventListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDataTransferEventListener.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -105,6 +105,9 @@ interface XDataTransferEventListener: com::sun::star::lang::XEventListener
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:23 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl
index 091688313..2e533dc88 100644
--- a/udkapi/com/sun/star/io/XInputStream.idl
+++ b/udkapi/com/sun/star/io/XInputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XInputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,7 +76,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -91,15 +91,11 @@ interface XInputStream: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XInputStream::readBytes
/** reads the specified number of bytes in the given sequence.
-
-
The return value specifies the number of bytes which have been
put into the sequence. A difference between nBytesToRead
and the return value indicates that EOF has been reached. This means
that the method blocks until the specified number of bytes are
- available or the EOF is reached.
-
-
+ available or the EOF is reached.
*/
long readBytes( [out] sequence aData,
[in] long nBytesToRead )
@@ -113,12 +109,8 @@ interface XInputStream: com::sun::star::uno::XInterface
/** reads the available number of bytes at maximum
nMaxBytesToRead.
-
-
This method blocks the thread until at least one byte is
- available.
-
-
+ available.
*/
long readSomeBytes( [out] sequence aData,
[in] long nMaxBytesToRead )
@@ -131,12 +123,8 @@ interface XInputStream: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XInputStream::skipBytes
/** skips the next nBytesToSkip bytes (must be positive).
-
-
It is up to the implementation whether this method is
- blocking the thread or not.
-
-
+ blocking the thread or not.
*/
void skipBytes( [in] long nBytesToSkip )
raises( com::sun::star::io::NotConnectedException,
@@ -148,12 +136,8 @@ interface XInputStream: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XInputStream::available
/** states how many bytes can be read or skipped without blocking.
-
-
Note: This method offers no information on whether the EOF
- has been reached.
-
-
+ has been reached.
*/
long available()
raises( com::sun::star::io::NotConnectedException,
@@ -165,15 +149,11 @@ interface XInputStream: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XInputStream::closeInput
/** closes the stream.
-
-
Users must close the stream explicitly when no further
reading should be done. (There may exist ring references to
chained objects that can only be released during this call.
Thus not calling this method would result in a leak of memory or
- external resources.)
-
-
+ external resources.)
*/
void closeInput()
raises( com::sun::star::io::NotConnectedException,
@@ -188,6 +168,9 @@ interface XInputStream: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XMarkableStream.idl b/udkapi/com/sun/star/io/XMarkableStream.idl
index 51d8fbb78..dc6cd999c 100644
--- a/udkapi/com/sun/star/io/XMarkableStream.idl
+++ b/udkapi/com/sun/star/io/XMarkableStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XMarkableStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,7 +76,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -89,8 +89,7 @@ interface XMarkableStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XMarkableStream::createMark
- /** creates a mark of the current postion and returns an identifier
- to it.
+ /** creates a mark of the current postion and returns an identifier to it.
*/
long createMark()
raises( com::sun::star::io::IOException );
@@ -98,16 +97,13 @@ interface XMarkableStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XMarkableStream::deleteMark
- /** deletes the mark that you previously created with "createMark()".
-
-
+ /** deletes the mark that you previously created with
+ XMarkableStream::createMark .
It is an error to delete a mark if other marks after this
exist. In this case, for reasons of robustness, the
implementation must delete this mark and all others after
- this mark.
-
-
+ this mark.
*/
void deleteMark( [in] long Mark )
raises( com::sun::star::io::IOException,
@@ -134,18 +130,18 @@ interface XMarkableStream: com::sun::star::uno::XInterface
// DocMerge from idl: method com::sun::star::io::XMarkableStream::offsetToMark
/** @returns
- the offset from the current stream position to the
- mark ("current position" - "mark position").
+ the offset from the current stream position to the
+ mark ("current position" - "mark position").
- @param nMark
- identifies the mark which is used as a base
- to calculate the offset of the current position.
+ @param nMark
+ identifies the mark which is used as a base
+ to calculate the offset of the current position.
- @throws IllegalArgumentException
- if the mark does not exist or is deleted.
+ @throws IllegalArgumentException
+ if the mark does not exist or is deleted.
- @throws IOException
- if an I/O error has occurred.
+ @throws IOException
+ if an I/O error has occurred.
*/
[const] long offsetToMark( [in] long nMark )
raises( com::sun::star::io::IOException,
@@ -160,6 +156,9 @@ interface XMarkableStream: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XObjectInputStream.idl b/udkapi/com/sun/star/io/XObjectInputStream.idl
index d9cd37aa9..94807ee6b 100644
--- a/udkapi/com/sun/star/io/XObjectInputStream.idl
+++ b/udkapi/com/sun/star/io/XObjectInputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XObjectInputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,7 +76,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -103,6 +103,9 @@ interface XObjectInputStream: com::sun::star::io::XDataInputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XObjectOutputStream.idl b/udkapi/com/sun/star/io/XObjectOutputStream.idl
index 92d825aac..255578c58 100644
--- a/udkapi/com/sun/star/io/XObjectOutputStream.idl
+++ b/udkapi/com/sun/star/io/XObjectOutputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XObjectOutputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,7 +71,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
interface XPersistObject;
@@ -80,34 +80,23 @@ interface XPersistObject;
// DocMerge from xml: interface com::sun::star::io::XObjectOutputStream
/** makes it possible to store the data and structure of runtime objects.
-
-
In every case all participating objects have to be stored or
loaded at the same time. To be able to load objects, for each object
class in the stream, a factory is needed. These factories are
XMultiServiceFactory , which are
- registered at the global service manager.
-
-
-
-
+ registered at the global service manager.
-
-
- @example Given: Object A refers to B, B to C and C to A and D. The order
- of storing and loading these objects is irrelevant, but it must be
- the same for each action:
-
-
-
- - storing: A,B,C,D; loading: A,B,C,D is correct
-
- - storing: B,A,C,D; loading: B,A,C,D is correct
-
- - storing: C,A,B,D; loading: A,B,C,D is wrong
-
- - storing: A,B,C,D; loading: A,B,C is wrong
-
+ @example
+ Given: Object A refers to B, B to C and C to A and D. The order
+ of storing and loading these objects is irrelevant, but it must be
+ the same for each action:
+
+
+ - storing: A,B,C,D; loading: A,B,C,D is correct
+ - storing: B,A,C,D; loading: B,A,C,D is correct
+ - storing: C,A,B,D; loading: A,B,C,D is wrong
+ - storing: A,B,C,D; loading: A,B,C is wrong
+
*/
[ uik(DF881FF1-2401-11D3-9ECD0010-5A677293), ident( "XObjectOutputStream", 1.0 ) ]
interface XObjectOutputStream: XDataOutputStream
@@ -129,6 +118,9 @@ interface XObjectOutputStream: XDataOutputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XOutputStream.idl b/udkapi/com/sun/star/io/XOutputStream.idl
index 0219faec3..0a5e8c5f1 100644
--- a/udkapi/com/sun/star/io/XOutputStream.idl
+++ b/udkapi/com/sun/star/io/XOutputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XOutputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -76,7 +76,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -89,7 +89,7 @@ interface XOutputStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XOutputStream::writeBytes
- /** writes the whole sequence to the stream. (Blocking call)
+ /** writes the whole sequence to the stream. (blocking call)
*/
void writeBytes( [in] sequence aData )
raises( com::sun::star::io::NotConnectedException,
@@ -111,8 +111,6 @@ interface XOutputStream: com::sun::star::uno::XInterface
// DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput
/** gets called to indicate that all data has been written.
-
-
If this method is not yet been called, no attached
XInputStream receives an EOF signal. No further
bytes may be written after this method has been called.
@@ -131,6 +129,9 @@ interface XOutputStream: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XPersist.idl b/udkapi/com/sun/star/io/XPersist.idl
index 68bccc3d3..58095fef2 100644
--- a/udkapi/com/sun/star/io/XPersist.idl
+++ b/udkapi/com/sun/star/io/XPersist.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XPersist.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
diff --git a/udkapi/com/sun/star/io/XPersistObject.idl b/udkapi/com/sun/star/io/XPersistObject.idl
index 036df590e..a2aa73504 100644
--- a/udkapi/com/sun/star/io/XPersistObject.idl
+++ b/udkapi/com/sun/star/io/XPersistObject.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XPersistObject.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
interface XObjectInputStream;
interface XObjectOutputStream;
@@ -89,13 +89,12 @@ interface XPersistObject: com::sun::star::uno::XInterface
// DocMerge from idl: method com::sun::star::io::XPersistObject::getServiceName
/** @returns
- the service name that specifies the behavior and the
- persistent data format of this implementation.
+ the service name that specifies the behavior and the
+ persistent data format of this implementation.
- This name can be used to create such an object by a factory.
+
This name can be used to create such an object by a factory.
-
- @see XServiceName::getServiceName
+ @see XServiceName::getServiceName
*/
[const] string getServiceName();
@@ -124,6 +123,9 @@ interface XPersistObject: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XSeekable.idl b/udkapi/com/sun/star/io/XSeekable.idl
index 4504db61f..098db493b 100644
--- a/udkapi/com/sun/star/io/XSeekable.idl
+++ b/udkapi/com/sun/star/io/XSeekable.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XSeekable.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,43 +74,46 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XSeekable
-/** This is the basic interface seek on a stream.
- This interface should be supported if it is possible to access the
- data at the new position fast.
- For example the access to a file should be fast enough.
- You shouldn't support this interface for example if you have a
- continuous stream like a video stream.
+/** makes it possible to seek to certain position within a stream.
+
+ This interface should be supported if it is possible to access the
+ data at the new position fast. For example the access to a file should
+ be fast enough. You should not support this interface, for example, if
+ you have a continuous stream like a video stream.
*/
[ uik(A70C54B0-A297-11d3-ABD600A0-249D5590), ident( "XSeekable", 1.0 ) ]
interface XSeekable: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::io::XSeekable::seek
- /** Changes the seek pointer to a new location relative to the beginning of the stream.
- This method changes the seek pointer so subsequent reads and writes can take place at a different
+ /** changes the seek pointer to a new location relative to the beginning of the stream.
+
+
This method changes the seek pointer so subsequent reads and writes can take place at a different
location in the stream object. It is an error to seek before the beginning of the stream.
However, it is not an error to seek past the end of the stream. Seeking past the end of the stream
is useful for subsequent writes, as the stream will at that time be extended to the seek position
- immediately before the write is done.
+ immediately before the write is done.
*/
void seek( [in] hyper location )
raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException );
// DocMerge from xml: method com::sun::star::io::XSeekable::getPosition
- /** Returns the current offset in this stream.
+ /** @returns
+ the current offset in this stream.
*/
hyper getPosition()
raises( com::sun::star::io::IOException );
// DocMerge from xml: method com::sun::star::io::XSeekable::getLength
- /** Returns the length of the storage medium on which the stream works.
+ /** @returns
+ the length of the storage medium on which the stream works.
*/
hyper getLength()
raises( com::sun::star::io::IOException );
@@ -123,6 +126,9 @@ interface XSeekable: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XStream.idl b/udkapi/com/sun/star/io/XStream.idl
index 2ae259dd1..03b0aaf83 100644
--- a/udkapi/com/sun/star/io/XStream.idl
+++ b/udkapi/com/sun/star/io/XStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,7 +80,7 @@ module com { module sun { module star { module io {
//=============================================================================
// DocMerge from xml: interface com::sun::star::io::XStream
-/** This is the basic interface to get read/write acess to a stream
+/** offers read and write access to the same stream.
*/
[ uik(43845612-50AF-11d4-93E50050-DA3F314C), ident( "XStream", 1.0 ) ]
interface XStream: com::sun::star::uno::XInterface
@@ -88,11 +88,9 @@ interface XStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XStream::getInputStream
- /** Returns the XInputStream part of the stream
- Closing the returned XInputStream does closes any also XOutputStream part
-
- @returns
- the InputStream
+ /** @returns
+ the XInputStream part of the stream. Closing the returned
+ XInputStream also closes any XOutputStream part.
*/
XInputStream getInputStream();
@@ -100,11 +98,9 @@ interface XStream: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XStream::getOutputStream
- /** Returns the XInputStream part of the stream
- Closing the returned XOutputStream does closes the XInputStream part also
-
- @returns
- the OutputStream
+ /** @returns
+ the XInputStream part of the stream. Closing the returned
+ XOutputStream also closes the XInputStream part.
*/
XOutputStream getOutputStream();
};
@@ -116,6 +112,9 @@ interface XStream: com::sun::star::uno::XInterface
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.2 2000/10/23 07:50:28 abi
Replaced all Methods by getInputStream and getOutputStream,
so it fits now better into the io-project
diff --git a/udkapi/com/sun/star/io/XStreamListener.idl b/udkapi/com/sun/star/io/XStreamListener.idl
index cbd50413a..879e678a0 100644
--- a/udkapi/com/sun/star/io/XStreamListener.idl
+++ b/udkapi/com/sun/star/io/XStreamListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XStreamListener.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,7 +68,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -91,8 +91,6 @@ interface XStreamListener: com::sun::star::lang::XEventListener
/** gets called when data transfer terminates normally or when data
transfer is terminated from outside.
-
-
The termination could be done using the method
XActiveDataControl::terminate() .
*/
@@ -110,8 +108,6 @@ interface XStreamListener: com::sun::star::lang::XEventListener
// DocMerge from xml: method com::sun::star::io::XStreamListener::error
/** gets called when an internal error in source or sink has occurred.
-
-
After the method is called, the close is called on the
connected streams.
*/
@@ -126,6 +122,9 @@ interface XStreamListener: com::sun::star::lang::XEventListener
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XTextInputStream.idl b/udkapi/com/sun/star/io/XTextInputStream.idl
index 42aad3f82..b4c7f7695 100644
--- a/udkapi/com/sun/star/io/XTextInputStream.idl
+++ b/udkapi/com/sun/star/io/XTextInputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XTextInputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -87,8 +87,10 @@ interface XTextInputStream: com::sun::star::io::XInputStream
// DocMerge from xml: method com::sun::star::io::XTextInputStream::readLine
/** reads text until a line break (CR, LF, or CR/LF) or EOF is found
- and returns it as string (without CR, LF). The read characters are
- converted according to the encoding defined by setEncoding.
+ and returns it as string (without CR, LF).
+
+ The read characters are converted according to the encoding defined
+ by XTextInputStream::setEncoding .
*/
string readLine()
raises( com::sun::star::io::IOException );
@@ -96,11 +98,14 @@ interface XTextInputStream: com::sun::star::io::XInputStream
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XTextInputStream::readString
- /** Reads text until one of the given delimiter characters or EOF is found.
- Important: CR/LF is not used as default delimiter! So if no delimiter
+ /** reads text until one of the given delimiter characters or EOF is found.
+
+
Important: CR/LF is not used as default delimiter! So if no delimiter
is defined or none of the delimiters is found, the stream will be read
to EOF. The read characters are converted according to the encoding
- defined by setEncoding.@see setEncoding
+ defined by XTextInputStream::setEncoding .
+
+ @see setEncoding
*/
string readString( [in] sequence Delimiters, [in] boolean bRemoveDelimiter )
raises( com::sun::star::io::IOException );
@@ -108,8 +113,10 @@ interface XTextInputStream: com::sun::star::io::XInputStream
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XTextInputStream::isEOF
- /** Return true, if the end of file is reached, so that no next
- string can be read.@see setEncoding
+ /** @returns
+ , if the end of file is reached, so that no next string can be read.
+
+ @see setEncoding
*/
boolean isEOF()
raises( com::sun::star::io::IOException );
@@ -118,7 +125,9 @@ interface XTextInputStream: com::sun::star::io::XInputStream
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XTextInputStream::setEncoding
- /** Sets encoding
+ /** sets character encoding.
+
+ @incomplete
*/
void setEncoding( [in] string Encoding );
};
@@ -130,6 +139,9 @@ interface XTextInputStream: com::sun::star::io::XInputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XTextOutputStream.idl b/udkapi/com/sun/star/io/XTextOutputStream.idl
index 18c8bdac0..1b9e53c8b 100644
--- a/udkapi/com/sun/star/io/XTextOutputStream.idl
+++ b/udkapi/com/sun/star/io/XTextOutputStream.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XTextOutputStream.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,7 +72,7 @@
//=============================================================================
- module com { module sun { module star { module io {
+module com { module sun { module star { module io {
//=============================================================================
@@ -86,12 +86,17 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XTextOutputStream::writeString
- /** Writes a string using the encoding defined by setEncoding.
- Line breaks or delimiters that may be neccessary to support
- XTextInputStream::readLine and XTextInputStream::readString
- have to be added manually to the parameter string.@see setEncoding
- @see XTextInputStream::readLine
- @see XTextInputStream::readString
+ /** writes a string using the encoding defined by
+ XTextOutputStream::setEncodingi .
+
+ Line breaks or delimiters that may be neccessary to support
+ XTextInputStream::readLine and
+ XTextInputStream::readString
+ have to be added manually to the parameter string.
+
+ @see setEncoding
+ @see XTextInputStream::readLine
+ @see XTextInputStream::readString
*/
void writeString( [in] string aString )
raises( com::sun::star::io::IOException );
@@ -99,7 +104,9 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream
//-------------------------------------------------------------------------
// DocMerge from xml: method com::sun::star::io::XTextOutputStream::setEncoding
- /** Sets encoding
+ /** sets character encoding.
+
+ @incomplete
*/
void setEncoding( [in] string Encoding );
};
@@ -111,6 +118,9 @@ interface XTextOutputStream: com::sun::star::io::XOutputStream
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:36 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:35:24 hjs
initial import
diff --git a/udkapi/com/sun/star/io/XXMLExtractor.idl b/udkapi/com/sun/star/io/XXMLExtractor.idl
index 092f4d8e4..36d6ef3a1 100644
--- a/udkapi/com/sun/star/io/XXMLExtractor.idl
+++ b/udkapi/com/sun/star/io/XXMLExtractor.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XXMLExtractor.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:36 $
+ * last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,15 +75,15 @@
module com { module sun { module star { module io {
//=============================================================================
-/** Offers the capability to extract the XML document stream from a StarOffice
- document storage
+/** offers the capability to extract the XML document stream from a document
+ storage.
*/
[ uik(9A4E4394-875A-4251-906FCA05-D3BEEB32), ident( "XXMLExtractor", 1.0 ) ]
interface XXMLExtractor : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** Extracts the XML stream from the StarOffice document storage
+ /** extracts the XML stream from the document storage.
@returns
the extracted XML stream.
--
cgit v1.2.3