diff options
| author | Michael Hönnig <mi@openoffice.org> | 2000-12-13 14:47:01 +0000 |
|---|---|---|
| committer | Michael Hönnig <mi@openoffice.org> | 2000-12-13 14:47:01 +0000 |
| commit | e2193e94b22169d3ea3acf0adfb299a9875119a5 (patch) | |
| tree | 652eade0cf0fbfe7305f2c9fac378fd67dffc1d5 | |
| parent | 3a2142c7d1014c1c8a39a56010f82f80971ef50b (diff) | |
symtactical documentation and minor semantic documentation flaws fixed
35 files changed, 576 insertions, 627 deletions
diff --git a/udkapi/com/sun/star/java/JavaVirtualMachine.idl b/udkapi/com/sun/star/java/JavaVirtualMachine.idl index 8732f2f5c..6bbc54e8c 100644 --- a/udkapi/com/sun/star/java/JavaVirtualMachine.idl +++ b/udkapi/com/sun/star/java/JavaVirtualMachine.idl @@ -2,9 +2,9 @@ * * $RCSfile: JavaVirtualMachine.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:46:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -63,7 +63,7 @@ //============================================================================= - module com { module sun { module star { module java { +module com { module sun { module star { module java { interface XJavaVM; interface XJavaThreadRegister_11; @@ -90,6 +90,9 @@ service JavaVirtualMachine /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/java/XJavaThreadRegister_11.idl b/udkapi/com/sun/star/java/XJavaThreadRegister_11.idl index 7483222e3..f80d93601 100644 --- a/udkapi/com/sun/star/java/XJavaThreadRegister_11.idl +++ b/udkapi/com/sun/star/java/XJavaThreadRegister_11.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJavaThreadRegister_11.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:46:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,12 +68,14 @@ //============================================================================= - module com { module sun { module star { module java { +module com { module sun { module star { module java { //============================================================================= // DocMerge from xml: interface com::sun::star::java::XJavaThreadRegister_11 /** must be implemented by the user of the XJavaThreadRegister_11. + + @incomplete */ [ uik(F7662402-B540-11D2-89480060-0857BB21), ident( "XJavaThreadRegister_11", 1.0 ) ] interface XJavaThreadRegister_11: com::sun::star::uno::XInterface @@ -81,15 +83,16 @@ interface XJavaThreadRegister_11: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::java::XJavaThreadRegister_11::isThreadAttached - /** returns <true></true> if the current thread is already attached to the VM otherwise <false></false>. + /** returns <true/> if the current thread is already attached to the VM otherwise <false/>. */ boolean isThreadAttached(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::java::XJavaThreadRegister_11::registerThread - /** registers the current thread. This method should be called every time - a JNI function is called from Java. + /** registers the current thread. + + <p>This method should be called every time a JNI function is called from Java. </p> */ void registerThread(); @@ -97,8 +100,9 @@ interface XJavaThreadRegister_11: com::sun::star::uno::XInterface //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::java::XJavaThreadRegister_11::revokeThread - /** Revokes the current thread from the list of registerd threads. This method - should be called at the end of every JNI call from Java. + /** revokes the current thread from the list of registerd threads. + + <p>This method should be called at the end of every JNI call from Java. </p> */ void revokeThread(); }; @@ -110,6 +114,9 @@ interface XJavaThreadRegister_11: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/java/XJavaVM.idl b/udkapi/com/sun/star/java/XJavaVM.idl index 61977d1ae..080bc0a88 100644 --- a/udkapi/com/sun/star/java/XJavaVM.idl +++ b/udkapi/com/sun/star/java/XJavaVM.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJavaVM.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:46:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,12 +71,14 @@ //============================================================================= - module com { module sun { module star { module java { +module com { module sun { module star { module java { //============================================================================= // DocMerge from xml: interface com::sun::star::java::XJavaVM /** must be implemented by the user of the XJavaVM. + + @incomplete */ [ uik(F7662401-B540-11D2-89480060-0857BB21), ident( "XJavaVM", 1.0 ) ] interface XJavaVM: com::sun::star::uno::XInterface @@ -85,22 +87,24 @@ interface XJavaVM: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::java::XJavaVM::getJavaVM /** returns the address of the Java Virtual Machine. - If the VM is not already instanciated, it will be now. + + <p>If the VM is not already instanciated, it will be now. </p> */ any getJavaVM( [in] sequence<byte> processID ); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::java::XJavaVM::isVMStarted - /** returns <true></true> if the VM is started successfully otherwise <false></false>. + /** returns <true/> if the VM is started successfully otherwise <false/>. */ boolean isVMStarted(); //------------------------------------------------------------------------- // DocMerge from xml: method com::sun::star::java::XJavaVM::isVMEnabled - /** Returns <true></true> if the VM is enabled. It is only possible to get the - VM if this method return 0. + /** Returns <true/> if the VM is enabled. + + <p>It is only possible to get the VM, if this method return 0. </p> */ boolean isVMEnabled(); @@ -113,6 +117,9 @@ interface XJavaVM: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/lang/ArrayIndexOutOfBoundsException.idl b/udkapi/com/sun/star/lang/ArrayIndexOutOfBoundsException.idl index 4efdc7a86..dc9496394 100644 --- a/udkapi/com/sun/star/lang/ArrayIndexOutOfBoundsException.idl +++ b/udkapi/com/sun/star/lang/ArrayIndexOutOfBoundsException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ArrayIndexOutOfBoundsException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -76,8 +76,6 @@ /** This exception is thrown to indicate that an array has been accessed with an illegal index. - - <p>The index is either negative or greater than or equal to the size of the array. </p> */ @@ -92,6 +90,9 @@ exception ArrayIndexOutOfBoundsException: com::sun::star::lang::IndexOutOfBounds /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/lang/ClassNotFoundException.idl b/udkapi/com/sun/star/lang/ClassNotFoundException.idl index b9dee413a..401c3aad5 100644 --- a/udkapi/com/sun/star/lang/ClassNotFoundException.idl +++ b/udkapi/com/sun/star/lang/ClassNotFoundException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ClassNotFoundException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,24 +68,13 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: exception com::sun::star::lang::ClassNotFoundException /** This exception is thrown when an application tries to load the information on the type through its string name. - - - - <p>This can happen when the - - - - - - method is called, but no definition for the type with the specifed name - can be found.</p> */ exception ClassNotFoundException: com::sun::star::uno::Exception { @@ -98,6 +87,9 @@ exception ClassNotFoundException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/lang/DisposedException.idl b/udkapi/com/sun/star/lang/DisposedException.idl index 7cf1a3918..9467d620c 100644 --- a/udkapi/com/sun/star/lang/DisposedException.idl +++ b/udkapi/com/sun/star/lang/DisposedException.idl @@ -2,9 +2,9 @@ * * $RCSfile: DisposedException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:40 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,8 +75,6 @@ // DocMerge from xml: exception com::sun::star::lang::DisposedException /** This exception occurs if the object behind this interface is invalid. - - <p>The implementation normally should implement the <type scope="com::sun::star::lang">XComponent</type> interface to indicate this possibility. </p> @@ -92,6 +90,9 @@ exception DisposedException: com::sun::star::uno::RuntimeException /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:40 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/lang/IllegalArgumentException.idl b/udkapi/com/sun/star/lang/IllegalArgumentException.idl index cf364cce9..109f38ce3 100644 --- a/udkapi/com/sun/star/lang/IllegalArgumentException.idl +++ b/udkapi/com/sun/star/lang/IllegalArgumentException.idl @@ -2,9 +2,9 @@ * * $RCSfile: IllegalArgumentException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,8 +83,6 @@ exception IllegalArgumentException: com::sun::star::uno::Exception // DocMerge from xml: field com::sun::star::lang::IllegalArgumentException::ArgumentPosition /** identifies the position of the illegal argument. - - <p>This field is -1 if the position is not known.</p> */ short ArgumentPosition; @@ -98,6 +96,9 @@ exception IllegalArgumentException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/IndexOutOfBoundsException.idl b/udkapi/com/sun/star/lang/IndexOutOfBoundsException.idl index b6247fb76..47810b5e0 100644 --- a/udkapi/com/sun/star/lang/IndexOutOfBoundsException.idl +++ b/udkapi/com/sun/star/lang/IndexOutOfBoundsException.idl @@ -2,9 +2,9 @@ * * $RCSfile: IndexOutOfBoundsException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -76,8 +76,6 @@ /** This exception is thrown to indicate that a container has been accessed with an illegal index. - - <p>The index is either negative or greater than or equal to the count of the elements. </p> */ @@ -92,6 +90,9 @@ exception IndexOutOfBoundsException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/InvalidListenerException.idl b/udkapi/com/sun/star/lang/InvalidListenerException.idl index 4dca73880..889defc39 100644 --- a/udkapi/com/sun/star/lang/InvalidListenerException.idl +++ b/udkapi/com/sun/star/lang/InvalidListenerException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvalidListenerException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,19 +68,16 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: exception com::sun::star::lang::InvalidListenerException -/** is thrown by the - - - - - - method to indicate that the listener has not supplied the necessary - interface.@see XConnectionPoint +/** is thrown by the <member>XConnectionPoint::advice</member> method + to indicate that the listener has not supplied the necessary + interface. + + @see XConnectionPoint */ exception InvalidListenerException: com::sun::star::uno::Exception { @@ -93,6 +90,9 @@ exception InvalidListenerException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/ListenerExistException.idl b/udkapi/com/sun/star/lang/ListenerExistException.idl index 1020beab6..4e94e48d8 100644 --- a/udkapi/com/sun/star/lang/ListenerExistException.idl +++ b/udkapi/com/sun/star/lang/ListenerExistException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListenerExistException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,13 +73,10 @@ //============================================================================= // DocMerge from xml: exception com::sun::star::lang::ListenerExistException -/** is thrown by the - - - - - - method to indicate that there is only one listener allowed.@see XConnectionPoint +/** is thrown by the <member>XConnectionPoint::advise</member> method + to indicate that there is only one listener allowed. + + @see XConnectionPoint */ exception ListenerExistException: com::sun::star::uno::Exception { @@ -92,6 +89,9 @@ exception ListenerExistException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/Locale.idl b/udkapi/com/sun/star/lang/Locale.idl index b6bf4363f..028fcb29e 100644 --- a/udkapi/com/sun/star/lang/Locale.idl +++ b/udkapi/com/sun/star/lang/Locale.idl @@ -2,9 +2,9 @@ * * $RCSfile: Locale.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,15 +66,12 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: struct com::sun::star::lang::Locale -/** A <code>Locale</code> object represents a specific geographical, political, - or cultural region. - - +/** object represents a specific geographical, political, or cultural region. <p>An operation that requires a <code>Locale</code> to perform its task is called <em>locale-sensitive</em> and uses the @@ -106,7 +103,8 @@ struct Locale <p>These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as: <br> - <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt"><code>http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</code></a>. + <a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt"> + <code>http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</code></a>. </p> <p>If this field contains an empty string, the meaning depends on the @@ -155,6 +153,9 @@ struct Locale /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.4 2000/10/29 16:19:44 er moved all types except struct Locale to ../i18n/XLocale.idl diff --git a/udkapi/com/sun/star/lang/MultiServiceFactory.idl b/udkapi/com/sun/star/lang/MultiServiceFactory.idl index 64b06e204..dd757036a 100644 --- a/udkapi/com/sun/star/lang/MultiServiceFactory.idl +++ b/udkapi/com/sun/star/lang/MultiServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: MultiServiceFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,44 +72,30 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: service com::sun::star::lang::MultiServiceFactory /** provides a collection of implementations for services. - - <p>The factories for instanciating objects from the implemetations - are accessed with a service name. - - </p> + are accessed with a service name. </p> + <p>The <type scope="com::sun::star::container">XContentEnumerationAccess</type> - interface can be supported optionally. If it is suported, it is - possible to enumerate all implementations that support the service - specified with the argument of the method - - - - - - . + interface can be supported optionally. If it is suported, it is possible to + enumerate all implementations that support the service specified with the + argument of <member scope="com::sun::star::container">XContentEnumerationAccess::createContentEnumeration</member>. The enumerator returns interfaces. The type of the interface is not specified. - Normally these are <type>XSingleServiceFactory</type>. - - </p> + Normally these are <type>XSingleServiceFactory</type>. </p> */ service MultiServiceFactory { - - // DocMerge from xml: service com::sun::star::lang::MultiServiceFactory: interface com::sun::star::lang::XMultiServiceFactory /** uses a service name with this interface to instanciate a component which supports the specified service. */ interface com::sun::star::lang::XMultiServiceFactory; - // DocMerge from xml: service com::sun::star::lang::MultiServiceFactory: interface com::sun::star::lang::XServiceInfo /** A factory, as well as all other services, should always support @@ -127,6 +113,9 @@ service MultiServiceFactory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/NoSuchFieldException.idl b/udkapi/com/sun/star/lang/NoSuchFieldException.idl index 72cf615a5..16eeb86c5 100644 --- a/udkapi/com/sun/star/lang/NoSuchFieldException.idl +++ b/udkapi/com/sun/star/lang/NoSuchFieldException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSuchFieldException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -86,6 +86,9 @@ exception NoSuchFieldException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/NoSuchMethodException.idl b/udkapi/com/sun/star/lang/NoSuchMethodException.idl index 1cf0f88fb..d1f70e637 100644 --- a/udkapi/com/sun/star/lang/NoSuchMethodException.idl +++ b/udkapi/com/sun/star/lang/NoSuchMethodException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSuchMethodException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -86,6 +86,9 @@ exception NoSuchMethodException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/NoSupportException.idl b/udkapi/com/sun/star/lang/NoSupportException.idl index 7d2a64a43..dcd86747c 100644 --- a/udkapi/com/sun/star/lang/NoSupportException.idl +++ b/udkapi/com/sun/star/lang/NoSupportException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoSupportException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -76,13 +76,11 @@ /** This exception is thrown when a method of an interface is not supported. - - <p>An example is a <code>setParent(...)</code> method and the object - does not allow the change. - - </p>@see XEnumeration - @see XContent#setParent() + does not allow the change. </p> + + @see XEnumeration + @see XContent::setParent() */ exception NoSupportException: com::sun::star::uno::Exception { @@ -95,6 +93,9 @@ exception NoSupportException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/NullPointerException.idl b/udkapi/com/sun/star/lang/NullPointerException.idl index 39d003e59..4d1406d47 100644 --- a/udkapi/com/sun/star/lang/NullPointerException.idl +++ b/udkapi/com/sun/star/lang/NullPointerException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NullPointerException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,14 +74,12 @@ // DocMerge from xml: exception com::sun::star::lang::NullPointerException /** This exception is thrown when an application attempts to use - <const>NULL</const> in a case where an object is required. - - + <NULL/> in a case where an object is required. <p>Applications should throw instances of this class to indicate - other illegal uses of the <null></null> object. - - </p>@see IdlReflection#forName() + other illegal uses of the <null/> object. </p> + + @see XIdlReflection::forName() */ exception NullPointerException: com::sun::star::uno::Exception { @@ -94,6 +92,9 @@ exception NullPointerException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/RegistryServiceManager.idl b/udkapi/com/sun/star/lang/RegistryServiceManager.idl index 7078e209b..b080d0369 100644 --- a/udkapi/com/sun/star/lang/RegistryServiceManager.idl +++ b/udkapi/com/sun/star/lang/RegistryServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: RegistryServiceManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,79 +84,52 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: service com::sun::star::lang::RegistryServiceManager /** provides a collection of and a registry for implementations for services. - - <p>The factories are accessed with a service name. It is possible to access the factories with their implementation name, but that should be - avoided. - - </p> - <p>The first argument of the - - - - - - method may be a - reference to a simple registry (<type scope="com::sun::star::registry">XSimpleRegistry</type>). + avoided. </p> + + <p>The first argument of the <member>XInitialization::initialization</member> + method may be a reference to a simple registry (<type scope="com::sun::star::registry">XSimpleRegistry</type>). If it is not initialized with a registry, then the default registry "com::sun::star::registry::DefaultRegistry" is used. If this registry is not - found, then the manager works without a registry. - - </p> - <p>You can get the current registry with - - - - - - . - - </p> - <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> interfaces - should support the following interfaces: + found, then the manager works without a registry. </p> + + <p>You can get the current registry with + <member scope="com::sun::star:beans">XPropertySet::getPropertyValue</member>. </p> + + <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> + interfaces should support the following interfaces: </p> <dl> - <dt> - <type>XServiceInfo</type> - - </dt> - <dd>is used to support access through the implementation with - service names. - - </dd> - <dt> - <type>XSingleServiceFactory</type> - </dt> - <dd>is used to instanciate components from the implementation. - - </dd> - <dt> - <type scope="com::sun::star::beans">XPropertySet</type> (optional) - </dt> - <dd>provides additional information on the implementation. - - </dd> - <dt> - <type>XComponent</type> (optional) - - </dt> - <dd>The service manager calls dispose on the registered - factories. The service manager adds a listener to this - factory. The factory is automatically revoked if the - disposing listener is notified. - - </dd> + <dt> <type>XServiceInfo</type> </dt> + <dd>is used to support access through the implementation with + service names. + </dd> + + <dt> <type>XSingleServiceFactory</type> </dt> + <dd>is used to instanciate components from the implementation. + </dd> + + <dt> <type scope="com::sun::star::beans">XPropertySet</type> (optional) </dt> + <dd>provides additional information on the implementation. + </dd> + + <dt> <type>XComponent</type> (optional) </dt> + <dd>The service manager calls dispose on the registered + factories. The service manager adds a listener to this + factory. The factory is automatically revoked if the + disposing listener is notified. + </dd> </dl> - - </p> + + @suspicious */ service RegistryServiceManager { @@ -187,8 +160,6 @@ service RegistryServiceManager // DocMerge from xml: property com::sun::star::lang::RegistryServiceManager::Registry /** specifies the current registry. - - <p>This property will be initialized by <type>XInitialization</type> or the default registry. </p> @@ -204,6 +175,9 @@ service RegistryServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/ServiceManager.idl b/udkapi/com/sun/star/lang/ServiceManager.idl index 9839d2d45..b70823746 100644 --- a/udkapi/com/sun/star/lang/ServiceManager.idl +++ b/udkapi/com/sun/star/lang/ServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: ServiceManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -87,61 +87,42 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: service com::sun::star::lang::ServiceManager /** provides a collection of implementations for services. - - <p>The factories are accessed with a service name. It is possible to access the factories with their implementation names, but you should - avoid this. - - </p> - <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> interfaces - should support the following interfaces: + avoid this. </p> + + <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> + interfaces should support the following interfaces: </p> <dl> - <dt> - <type>XServiceInfo</type> - - </dt> - <dd>is used to support access through the implementation with - service names. - - </dd> - <dt> - <type>XSingleServiceFactory</type> (optional) - </dt> - <dd>is used to instanciate components from the implementation. - - </dd> - <dt> - <type scope="com::sun::star::beans">XPropertySet</type> (optional) - </dt> - <dd>offers additional information on the implementation. - - </dd> - <dt> - <type>XComponent</type> (optional) - </dt> - <dd>The service manager calls the method - - - - - - - on the registered factories. The service manager adds a - listener to this factory. The factory is automatically - revoked when the disposing listener is notified. - </dd> + <dt> <type>XServiceInfo</type> </dt> + <dd>is used to support access through the implementation with + service names. + </dd> + + <dt> <type>XSingleServiceFactory</type> (optional) </dt> + <dd>is used to instanciate components from the implementation. + </dd> + + <dt> <type scope="com::sun::star::beans">XPropertySet</type> (optional) </dt> + <dd>offers additional information on the implementation. + </dd> + + <dt> <type>XComponent</type> (optional) </dt> + <dd>The service manager calls the method + <member scope="com::sun::star::lang">XComponent::dispose</member> + on the registered factories. The service manager adds a + listener to this factory. The factory is automatically + revoked when the disposing listener is notified. + </dd> </dl> - - </p> */ service ServiceManager { @@ -151,59 +132,59 @@ service ServiceManager // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XComponent /** Normally you should call the method - <method scope="com::sun::star::util">XComponent::dispose</method> - at the service manager just before the application terminates. - - <p>The service manager first broadcasts the - <method scope="com::sun::star::util">XEventListener::disposing()</method> - message to all registered listeners. In this state you can still get all - factories from the service manager, but it is not possible to - add disposing listeners. Second the service manager calls - <method scope="com::sun::star::util">XComponent::dispose</method> - at all registered factories that implement <type>XComponent</type>. - In this second state the service manager does not provide any factory. - This is called a two-phase shut down. + <method scope="com::sun::star::util">XComponent::dispose</method> + at the service manager just before the application terminates. + + <p>The service manager first broadcasts the + <method scope="com::sun::star::util">XEventListener::disposing()</method> + message to all registered listeners. In this state you can still get all + factories from the service manager, but it is not possible to + add disposing listeners. Second the service manager calls + <method scope="com::sun::star::util">XComponent::dispose</method> + at all registered factories that implement <type>XComponent</type>. + In this second state the service manager does not provide any factory. + This is called a two-phase shut down. </p> */ interface com::sun::star::lang::XComponent; // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::container::XSet /** The implementations are managed with this interface. - The supported services (<type>XServiceInfo</type> is used) - are registered automatically. + The supported services (<type>XServiceInfo</type> is used) + are registered automatically. */ interface com::sun::star::container::XSet; // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::container::XContentEnumerationAccess /** It is possible to enumerate all implementations that support the - service specified with the argument of the - <method>XContentEnumerationAccess::createContentEnumeration</method> method. - - <p>The enumerator returns interfaces. The type of interfaces - are not specified. Normally these are - <type>XSingleServiceFactory</type>. + service specified with the argument of the + <method>XContentEnumerationAccess::createContentEnumeration</method> method. + + <p>The enumerator returns interfaces. The type of interfaces + are not specified. Normally these are + <type>XSingleServiceFactory</type>. */ interface com::sun::star::container::XContentEnumerationAccess; // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XMultiServiceFactory /** Use a service name or an implementation name to instanciate a - component with this interface. - - <p>First the service manager gets the factory registered - under the service name. Then - <method>XMultiServiceFactory::createInstance</type> or - <method>XMultiServiceFactory::createInstanceWithArguments</method> - of this factory is called. + component with this interface. + + <p>First the service manager gets the factory registered + under the service name. Then + <method>XMultiServiceFactory::createInstance</type> or + <method>XMultiServiceFactory::createInstanceWithArguments</method> + of this factory is called. */ interface com::sun::star::lang::XMultiServiceFactory; // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XServiceInfo /** Services should always support this interface. For a - <type>RegistryServiceManager</type>, at least the service - "com.sun.star.lang.RegistryServiceManager" must be supported. + <type>RegistryServiceManager</type>, at least the service + "com.sun.star.lang.RegistryServiceManager" must be supported. */ interface com::sun::star::lang::XServiceInfo; @@ -216,6 +197,9 @@ service ServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/ServiceNotRegisteredException.idl b/udkapi/com/sun/star/lang/ServiceNotRegisteredException.idl index 21223ac34..16f3277d0 100644 --- a/udkapi/com/sun/star/lang/ServiceNotRegisteredException.idl +++ b/udkapi/com/sun/star/lang/ServiceNotRegisteredException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ServiceNotRegisteredException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,18 +68,15 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: exception com::sun::star::lang::ServiceNotRegisteredException /** This exception is thrown when a needed service is not found. - - - + <p>Applications should throw instances of this class to indicate - that a needed service is not registered. - </p> + that a needed service is not registered. </p> */ exception ServiceNotRegisteredException: com::sun::star::uno::Exception { @@ -92,6 +89,9 @@ exception ServiceNotRegisteredException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/SystemDependent.idl b/udkapi/com/sun/star/lang/SystemDependent.idl index 69609c4cc..2c35470df 100644 --- a/udkapi/com/sun/star/lang/SystemDependent.idl +++ b/udkapi/com/sun/star/lang/SystemDependent.idl @@ -2,9 +2,9 @@ * * $RCSfile: SystemDependent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,28 +64,30 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from idl: constants com::sun::star::lang::SystemDependent /** These constants are used to specify systems which depend on return values. - <p> You should avoid system-dependent methods if possible. - - @example:C++ - - <listing> - #ifdef __WINDOW // Microsoft Windows - HWND hWin = (HWND)xInterface->getWindowHandle(SystemDependentWIN32); - if( hWin ) ... - #elif( ... ) // other systems - ... - #endif - </listing> - The Symbols are now prepended with SYSTEM_ thus we avoid collisions - with system headers. - @see com::sun::star::awt::XSystemDependentWindowPeer + <p> You should avoid system-dependent methods if possible. + + @example:C++ + + <listing> + #ifdef __WINDOW // Microsoft Windows + HWND hWin = (HWND)xInterface->getWindowHandle(SystemDependentWIN32); + if( hWin ) ... + #elif( ... ) // other systems + ... + #endif + </listing> + + <p>The Symbols are now prepended with SYSTEM_ thus we avoid collisions + with system headers. </p> + + @see com::sun::star::awt::XSystemDependentWindowPeer */ constants SystemDependent { @@ -93,8 +95,9 @@ constants SystemDependent // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_WIN32 /** The called interface method returns a value specified for the - 32-bit Windows systems. - <p>These are Windows NT, Windows 95, Windows 98 or higher. + 32-bit Windows systems. + + <p>These are Windows NT, Windows 95, Windows 98 or higher. </p> */ const short SYSTEM_WIN32 = 1; @@ -102,48 +105,44 @@ constants SystemDependent // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_WIN16 /** The called interface method returns a value specified for - the 16-bit Windows system. + the 16-bit Windows system. - <p>This is Windows 3.11. + <p>This is Windows 3.11. </p> */ const short SYSTEM_WIN16 = 2; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_JAVA - /** The called interface method returns a value specified for - the system java. - - <p>These are <em>JRE 1.1</em>, <em>JRE 1.2</em>, <em>JDK 1.1</em>, - <em>JDK 1.2</em> or higher. + /** The called interface method returns a value specified for the system java. - <p>The return should be a handle to a java object locked with - the call <code>JavaEnvironment->NewGlobalRef( ... )</code> - by the callee. + <p>These are <em>JRE 1.1</em>, <em>JRE 1.2</em>, <em>JDK 1.1</em>, + <em>JDK 1.2</em> or higher. </p> + + <p>The return should be a handle to a java object locked with + the call <code>JavaEnvironment->NewGlobalRef( ... )</code> + by the callee. </p> */ const short SYSTEM_JAVA = 3; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_OS2 - /** The called interface method returns a value specified for - the <em>OS/2</em> system. + /** The called interface method returns a value specified for the <em>OS/2</em> system. */ const short SYSTEM_OS2 = 4; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_MAC - /** The called interface method returns a value specified for - the <em>MAC-OS</em> system. + /** The called interface method returns a value specified for the <em>MAC-OS</em> system. */ const short SYSTEM_MAC = 5; //------------------------------------------------------------------------- // DocMerge from idl: value com::sun::star::lang::SystemDependent::SYSTEM_XWINDOW - /** The called interface method returns a value specified for - the <em>X Window System</em>. + /** The called interface method returns a value specified for the <em>X Window System</em>. */ const short SYSTEM_XWINDOW = 6; @@ -156,6 +155,9 @@ constants SystemDependent /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/WrappedTargetException.idl b/udkapi/com/sun/star/lang/WrappedTargetException.idl index e2cb592e7..39c0e77eb 100644 --- a/udkapi/com/sun/star/lang/WrappedTargetException.idl +++ b/udkapi/com/sun/star/lang/WrappedTargetException.idl @@ -2,9 +2,9 @@ * * $RCSfile: WrappedTargetException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,21 +68,19 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: exception com::sun::star::lang::WrappedTargetException /** This is a checked exception that wraps an exception thrown by the original target. - - - - <p>Normally this exception is declared for generic methods. - - </p>@see com::sun::star::container::XIndexAccess - @see com::sun::star::container::XNameAccess - @see com::sun::star::beans::XPropertySet + + <p>Normally this exception is declared for generic methods. </p> + + @see com::sun::star::container::XIndexAccess + @see com::sun::star::container::XNameAccess + @see com::sun::star::beans::XPropertySet */ exception WrappedTargetException: com::sun::star::uno::Exception { @@ -102,6 +100,9 @@ exception WrappedTargetException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/XComponent.idl b/udkapi/com/sun/star/lang/XComponent.idl index c745c37f2..03e94852b 100644 --- a/udkapi/com/sun/star/lang/XComponent.idl +++ b/udkapi/com/sun/star/lang/XComponent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,7 +67,7 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { interface XEventListener; @@ -76,15 +76,12 @@ interface XEventListener; // DocMerge from xml: interface com::sun::star::lang::XComponent /** controls the lifetime of components. - - <p>Actually the real lifetime of an UNO object is controlled by references kept on interfaces of this object. But there are two distinct meanings in keeping a reference to an interface: 1st to own the object and 2nd to know the object. Especially in case - of cyclic references, the objects would never get destroyed. - - </p> + of cyclic references, the objects would never get destroyed. </p> + <p>You are only allowed to keep references of interfaces to UNO objects if you are by definition the owner of that object or your reference is very temporary or you have registered an @@ -99,68 +96,39 @@ interface XComponent: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XComponent::dispose /** The owner of a component calls this method to get rid of it. - - <p>Only the owner of this object calls the dispose method if the object should be destroyed. All objects and components must release the references to the objects. If the object is a broadcaster, then all listeners are removed and the method - - - - - - is called on all - listeners. - - </p> + <member>XEventListener::disposing</member> + is called on all listeners. </p> + <p>Due to the importance of the concept of the method - - - - - - , we provide a figurative - example: - - </p> + <member>XComponent::dispose</member>, we provide a figurative + example: </p> + <blockquote> - Imagine there was a hole in the floor and some people - around it are holding a <em>box</em> (our component). - Everyone who holds the box for a longer time than just - temporaryly (i.e. to put something in or get something - out) has to watch a light bulb which is attached to - the box (listening to the - - - - - - event). - Now, when the owner of the box switches the light on - (calling - - - - - ), - everybody holding the box has to take his hands off - (clear the interface handles). If and only if everyone - does that, then the box falls (getting deleted). - But only the owner is allowed to switch the light on! + Imagine there was a hole in the floor and some people + around it are holding a <em>box</em> (our component). + Everyone who holds the box for a longer time than just + temporaryly (i.e. to put something in or get something + out) has to watch a light bulb which is attached to + the box (listening to the <member>XEventListener::disposing</member> + event). Now, when the owner of the box switches the light on + (calling <member>XComponent::dispose</member>), + everybody holding the box has to take his hands off + (clear the interface handles). If and only if everyone + does that, then the box falls (getting deleted). + But only the owner is allowed to switch the light on! </blockquote> <p>After this method is called the instance has to throw the - <type>DisposedException</type> for - all calls not non-event-methods; event-methods have to be ignored. - - </p> + <type>DisposedException</type> for all calls not non-event-methods; + event-methods have to be ignored. </p> - - - - @example <listing> + @example + <listing> void dispose() { // make a copy @@ -184,17 +152,10 @@ interface XComponent: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XComponent::addEventListener /** adds an event listener to the object. - - <p>The broadcaster fires the disposing method of this listener - if the - - - - - method is called. - - </p>@see removeEventListener() + if the <member>XComponent::dispose</member> method is called. </p> + + @see removeEventListener() */ void addEventListener( [in] XEventListener xListener ); @@ -202,12 +163,10 @@ interface XComponent: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XComponent::removeEventListener /** removes an event listener from the listener list. - - - - <p>It is a "noop" if the specified listener is not registered. - - </p>@see addEventListener() + + <p>It is a "noop" if the specified listener is not registered. </p> + + @see addEventListener() */ void removeEventListener( [in] XEventListener aListener ); @@ -220,6 +179,9 @@ interface XComponent: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XConnectionPoint.idl b/udkapi/com/sun/star/lang/XConnectionPoint.idl index 84cadfa60..c1ea4ede6 100644 --- a/udkapi/com/sun/star/lang/XConnectionPoint.idl +++ b/udkapi/com/sun/star/lang/XConnectionPoint.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnectionPoint.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,62 +84,66 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from idl: interface com::sun::star::lang::XConnectionPoint /** supports connection points for connectable objects. - <p>Connectable objects support the following features: - <ul> - <li>outgoing interfaces, such as event sets; + <p>Connectable objects support the following features: </p> + + <ul> + <li>outgoing interfaces, such as event sets; </li> <li>the ability to enumerate the types of the outgoing interfaces; <li>the ability to connect and disconnect sinks to the object - for those outgoing types; + for those outgoing types; </li> <li>the ability to enumerate the connections that exist to a - particular outgoing interface. - </ul> - - <h4>When to Implement?<h4> - - <p>To create a connectable object, you need to implement objects - that provide two related interfaces: - <ul> - <li><type>XConnectionPointContainer</type> - <li><type>XConnectionPoint</type> - </ul> - - The <type>XConnectionPointContainer</type> interface is implemented - on the connectable object to indicate the existence of the outgoing - interfaces. It provides a sequence of sub-objects. It also provides - access to all the connection point sub-objects, each of which - implements the <type>XConnectionPoint</type> interface. The - <type>XConnectionPoint</type> interface provides a sequence of - sub-objects. - - <p>Each connection point is a separate sub-object to avoid circular - reference counting problems. A connection point controls how many - connections (one or more) it will allow in its implementation of - <method>XConnectionPoint::advise()</method>. - - <h4>When to use?</h4> - - <p>A client can use the <type>XConnectionPointContainer</type> interface: - <UL> - <LI>to get a sequence of connection points for each outgoing type. + particular outgoing interface. </li> + </ul> + + <h4>When to Implement?<h4> + + <p>To create a connectable object, you need to implement objects + that provide two related interfaces: </p> + + <ul> + <li><type>XConnectionPointContainer</type> </li> + <li><type>XConnectionPoint</type> </li> + </ul> + + <p>The <type>XConnectionPointContainer</type> interface is implemented + on the connectable object to indicate the existence of the outgoing + interfaces. It provides a sequence of sub-objects. It also provides + access to all the connection point sub-objects, each of which + implements the <type>XConnectionPoint</type> interface. The + <type>XConnectionPoint</type> interface provides a sequence of + sub-objects. </p> + + <p>Each connection point is a separate sub-object to avoid circular + reference counting problems. A connection point controls how many + connections (one or more) it will allow in its implementation of + <method>XConnectionPoint::advise()</method>. </p> + + <h4>When to use?</h4> + + <p>A client can use the <type>XConnectionPointContainer</type> interface: </p> + + <UL> + + <LI>to get a sequence of connection points for each outgoing type. </LI> <LI>to obtain access to connection point sub-objects with the - <type>XConnectionPoint</type> interface for each - outgoing type. Through the IConnectionPoint interface, - a client starts or terminates an advisory loop with the - connectable object and the client's own sink. The - client can also use the <type>XConnectionPoint</type> - interface to get a sequence of the connections that it - knows about. - </UL> - - @see XConnectionPointContainer + <type>XConnectionPoint</type> interface for each + outgoing type. Through the IConnectionPoint interface, + a client starts or terminates an advisory loop with the + connectable object and the client's own sink. The + client can also use the <type>XConnectionPoint</type> + interface to get a sequence of the connections that it + knows about. </LI> + </UL> + + @see XConnectionPointContainer */ [ uik(E227A3D3-33D6-11D1-AABE00A0-249D5590), ident( "XConnectionPoint", 1.0 ) ] interface XConnectionPoint: com::sun::star::uno::XInterface @@ -151,15 +155,15 @@ interface XConnectionPoint: com::sun::star::uno::XInterface the type of the outgoing interface managed by this connection point. - <p>Using the <method>XConnectionPointContainer::getConnectionPoints</method> - method, a client can obtain an <type>XConnectionPoint</type> - interface. Using that interface and this method, the client - can determine the type of each connection point enumerated. The - type returned from this method must enable the caller to access - this same connection point through - <method>XConnectionPointContainer::findConnectionPoint</method>. - - @see IConnectionPointContainer::FindConnectionPoint + <p>Using the <method>XConnectionPointContainer::getConnectionPoints</method> + method, a client can obtain an <type>XConnectionPoint</type> + interface. Using that interface and this method, the client + can determine the type of each connection point enumerated. The + type returned from this method must enable the caller to access + this same connection point through + <method>XConnectionPointContainer::findConnectionPoint</method>. + + @see IConnectionPointContainer::FindConnectionPoint */ [const] TYPE_XIDLCLASS getConnectionType(); @@ -167,10 +171,10 @@ interface XConnectionPoint: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::getConnectionPointContainer /** @returns - the <type>XConnectionPointContainer</type> interface on - the parent connectable object. - - @see IConnectionPointContainer + the <type>XConnectionPointContainer</type> interface on + the parent connectable object. + + @see IConnectionPointContainer */ [const] com::sun::star::lang::XConnectionPointContainer getConnectionPointContainer(); @@ -178,27 +182,27 @@ interface XConnectionPoint: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::advise /** creates a connection between a connection point and a - client's sink, where the sink implements the outgoing interface - supported by this connection point. - - <p>A few <code>add...Listener</code> methods need additional parameters - to add listeners or throw exceptions. One of these methods is - <method scope="com::sun::star::beans">XPropertySet::addPropertyChangeListener</method>. - We ignore the problem in this interface. A solution must be provided - in an additional <type>XConnectionPoint</type> interface. - - @param xListener - specifies the listener interface on the client's advise sink. - The client's sink receives outgoing calls from the - connection point container. - - @throws ListenerExistException - if it is a unicast broadcaster and a listener is already set. - - @throws InvalidListenerException - if the listener does not supply the needed interfaces. + client's sink, where the sink implements the outgoing interface + supported by this connection point. - @see com::sun::star::beans::XPropertySet::addPropertyChangeListener + <p>A few <code>add...Listener</code> methods need additional parameters + to add listeners or throw exceptions. One of these methods is + <method scope="com::sun::star::beans">XPropertySet::addPropertyChangeListener</method>. + We ignore the problem in this interface. A solution must be provided + in an additional <type>XConnectionPoint</type> interface. </p> + + @param xListener + specifies the listener interface on the client's advise sink. + The client's sink receives outgoing calls from the + connection point container. + + @throws ListenerExistException + if it is a unicast broadcaster and a listener is already set. + + @throws InvalidListenerException + if the listener does not supply the needed interfaces. + + @see com::sun::star::beans::XPropertySet::addPropertyChangeListener */ void advise( [in] com::sun::star::uno::XInterface xListener ) raises( com::sun::star::lang::ListenerExistException, @@ -209,17 +213,16 @@ interface XConnectionPoint: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::unadvise /** terminates a notification previously set up with advise. - <p>A few <code>remove...Listener</code> methods need additional - parameters to add listeners or throw exceptions. One of these methods - is <method scope="com::sun::star::beans">XPropertySet::removePropertyChangeListener</method>. - We ignore the problem in this interface. A solution must be - provided in an additional <type>XConnectionPoint</type> interface. - - @param listener - specifies the listener interface on the client's - advise sink. - - @see com::sun::star::beans::XPropertySet::removePropertyChangeListener + <p>A few <code>remove...Listener</code> methods need additional + parameters to add listeners or throw exceptions. One of these methods + is <method scope="com::sun::star::beans">XPropertySet::removePropertyChangeListener</method>. + We ignore the problem in this interface. A solution must be + provided in an additional <type>XConnectionPoint</type> interface. </p> + + @param listener + specifies the listener interface on the client's advise sink. + + @see com::sun::star::beans::XPropertySet::removePropertyChangeListener */ void unadvise( [in] com::sun::star::uno::XInterface xListener ); @@ -227,7 +230,7 @@ interface XConnectionPoint: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPoint::getConnections /** @returns - a sequence of all currently advised connections. + a sequence of all currently advised connections. */ [const] sequence<com::sun::star::uno::XInterface> getConnections(); @@ -240,6 +243,9 @@ interface XConnectionPoint: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/XConnectionPointContainer.idl b/udkapi/com/sun/star/lang/XConnectionPointContainer.idl index fae2073f8..1d21090bd 100644 --- a/udkapi/com/sun/star/lang/XConnectionPointContainer.idl +++ b/udkapi/com/sun/star/lang/XConnectionPointContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnectionPointContainer.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { interface XConnectionPoint; @@ -81,14 +81,12 @@ interface XConnectionPoint; /** makes it possible to locate a specific connection point for a specified UIK and manages a sequence of connections points. - - <p>An implementation of this interface <strong>must</strong> - support the <type scope="com::sun::star::uno">XWeak</type> interface. Look at the language - binding for a superclass or something else. - - </p>@see XConnectionPoint - @see com::sun::star::uno::XWeak + support the <type scope="com::sun::star::uno">XWeak</type> interface. + Look at the language binding for a superclass or something else. </p> + + @see XConnectionPoint + @see com::sun::star::uno::XWeak */ [ uik(E227A3D4-33D6-11D1-AABE00A0-249D5590), ident( "XConnectionPointContainer", 1.0 ) ] interface XConnectionPointContainer: com::sun::star::uno::XInterface @@ -97,8 +95,8 @@ interface XConnectionPointContainer: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPointContainer::getConnectionPointTypes /** @returns - a sequence of all outgoing type spefifies which are supported - by this connectable object. + a sequence of all outgoing type spefifies which are supported + by this connectable object. */ [const] sequence<TYPE_XIDLCLASS> getConnectionPointTypes(); @@ -106,13 +104,13 @@ interface XConnectionPointContainer: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XConnectionPointContainer::queryConnectionPoint /** @returns - an <type>XConnectionPoint</type> interface of a - connection point for a specified type if that type - describes a supported outgoing interface. It is - <const>NULL</const> on failure of the call. + an <type>XConnectionPoint</type> interface of a + connection point for a specified type if that type + describes a supported outgoing interface. It is + <const>NULL</const> on failure of the call. - @param aType - specifies the connection point's type. + @param aType + specifies the connection point's type. */ XConnectionPoint queryConnectionPoint( [in] TYPE_XIDLCLASS aType ); @@ -123,18 +121,15 @@ interface XConnectionPointContainer: com::sun::star::uno::XInterface client's sink, where the sink implements the outgoing interface specified with ID. - - <p>The interface is advised under the connection point you - get with <code>queryConnectionPoint( id )</code>. - - </p> + get with <code>queryConnectionPoint( id )</code>. </p> + <p>Use this method instead of the advise method at the connection point only if you know that the broadcaster supports the outgoing interface or if it does not matter that the - outgoing interface is not supported. - - </p>@see XConnectionPoint::advise + outgoing interface is not supported. </p> + + @see XConnectionPoint::advise */ [oneway] void advise( [in] TYPE_XIDLCLASS aType, [in] com::sun::star::uno::XInterface xListener ); @@ -143,7 +138,9 @@ interface XConnectionPointContainer: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XConnectionPointContainer::unadvise /** terminates a notification previously set up with - advise at the container or at the suitable connection point.@see XConnectionPoint::unadvise + advise at the container or at the suitable connection point. + + @see XConnectionPoint::unadvise */ [oneway] void unadvise( [in] TYPE_XIDLCLASS aType, [in] com::sun::star::uno::XInterface xListener ); @@ -157,6 +154,9 @@ interface XConnectionPointContainer: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.2 2000/10/09 14:24:57 mi #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) diff --git a/udkapi/com/sun/star/lang/XEventListener.idl b/udkapi/com/sun/star/lang/XEventListener.idl index 42c389a62..85a47da4e 100644 --- a/udkapi/com/sun/star/lang/XEventListener.idl +++ b/udkapi/com/sun/star/lang/XEventListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -87,8 +87,6 @@ interface XEventListener: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XEventListener::disposing /** gets called when the broadcaster is about to be disposed. - - <p>All listeners and all other objects which reference the broadcaster should release the references.</p> */ @@ -103,6 +101,9 @@ interface XEventListener: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XInitialization.idl b/udkapi/com/sun/star/lang/XInitialization.idl index 3ea170663..685201da2 100644 --- a/udkapi/com/sun/star/lang/XInitialization.idl +++ b/udkapi/com/sun/star/lang/XInitialization.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInitialization.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -80,18 +80,15 @@ /** This is the only interface for initializing an object directly after its creation. - - <p>This interface works together with factories. If you want to initialize the object after creation, you <strong>must</strong> support this interface and you may support other type save - interfaces to initialize. - - </p> + interfaces to initialize. </p> + <p>The object must work without an initializing call. In this case - it must use a meaningful default. - - </p>@see XProducer + it must use a meaningful default. </p> + + @see XProducer */ [ uik(E227A3DF-33D6-11D1-AABE00A0-249D5590), ident( "XInitialization", 1.0 ) ] interface XInitialization: com::sun::star::uno::XInterface @@ -101,11 +98,7 @@ interface XInitialization: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XInitialization::initialize /** initializes the object. - - - <p> It should be called directly after the object is created. - - </p> + <p>It should be called directly after the object is created. </p> */ void initialize( [in] sequence<any> aArguments ) raises( com::sun::star::uno::Exception ); @@ -119,6 +112,9 @@ interface XInitialization: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XLocalizable.idl b/udkapi/com/sun/star/lang/XLocalizable.idl index 252b1f659..c94c796d9 100644 --- a/udkapi/com/sun/star/lang/XLocalizable.idl +++ b/udkapi/com/sun/star/lang/XLocalizable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XLocalizable.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -90,7 +90,7 @@ interface XLocalizable: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XLocalizable::getLocale /** @returns - the locale, which ich used by this object. + the locale, which ich used by this object. */ [const] Locale getLocale(); }; @@ -102,6 +102,9 @@ interface XLocalizable: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XMain.idl b/udkapi/com/sun/star/lang/XMain.idl index f102304b5..477a02c1a 100644 --- a/udkapi/com/sun/star/lang/XMain.idl +++ b/udkapi/com/sun/star/lang/XMain.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMain.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -85,7 +85,6 @@ interface XMain: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XMain::run /** This method is called to run the component. - <br> */ long run( [in] sequence< string > aArguments ); }; @@ -97,6 +96,9 @@ interface XMain: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 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/lang/XMultiServiceFactory.idl b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl index 79f853b5c..20299aa1f 100644 --- a/udkapi/com/sun/star/lang/XMultiServiceFactory.idl +++ b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiServiceFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -80,42 +80,32 @@ /** Factory objects support this interface for creating components by a specifying string, for example, the service name. + <p>This specifying string is not necessarily a service name. </p> + + @example - - <p>This specifying string is not necessarily a service name. - - </p> - <p>Example: - - </p> <ol> - <li>You want to load data from a location specified with a URL - (file://..., http://..., ...). - - </li> - <li>You get the factory that can create loader components. - - </li> - <li>You call the <member>XMultiServiceFactory::createInstance()</member> - method with arguments like "file", "http" or something else. - - </li> - <li>The factory knows something about this string and specifies that - <ul> - <li>"file" means for example the service "com::sun::star::url::File" - </li> - <li>"http" means for example the service "com::sun::star::url::Http" - </li> - <li>"javascript" means for example the service "com::netscape::url::.JavaScript" - </li> - </ul> - or something else. - - </li> - <li>Finally you start the download with <code>start( URL )</code> - at the newly created component. - </li> - </ol>@see XInitialization + <li>You want to load data from a location specified with a URL + (file://..., http://..., ...). </li> + + <li>You get the factory that can create loader components. </li> + + <li>You call the <member>XMultiServiceFactory::createInstance()</member> + method with arguments like "file", "http" or something else. </li> + + <li>The factory knows something about this string and specifies that + <ul> + <li>"file" means for example the service "com::sun::star::url::File" </li> + <li>"http" means for example the service "com::sun::star::url::Http" </li> + <li>"javascript" means for example the service "com::netscape::url::.JavaScript" </li> + </ul> + or something else. </li> + + <li>Finally you start the download with <code>start( URL )</code> + at the newly created component. </li> + </ol> + + @see XInitialization @see XSingleServiceFactory */ [ uik(E227A3DE-33D6-11D1-AABE00A0-249D5590), ident( "XMultiServiceFactory", 1.0 ) ] @@ -134,7 +124,9 @@ interface XMultiServiceFactory: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments /** creates an instance of a component which supports the - services specified by the factory, and initializes the new object with given arguments.@see XInitialization::init + services specified by the factory, and initializes the new object with given arguments. + + @see XInitialization::init */ com::sun::star::uno::XInterface createInstanceWithArguments( [in] string ServiceSpecifier, [in] sequence<any> Arguments ) @@ -144,7 +136,7 @@ interface XMultiServiceFactory: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XMultiServiceFactory::getAvailableServiceNames /** @returns - a sequence of all service identifiers which can be instanciated. + a sequence of all service identifiers which can be instanciated. */ sequence<string> getAvailableServiceNames(); @@ -157,6 +149,9 @@ interface XMultiServiceFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XServiceDisplayName.idl b/udkapi/com/sun/star/lang/XServiceDisplayName.idl index 15d0c1c2b..a2239c4e1 100644 --- a/udkapi/com/sun/star/lang/XServiceDisplayName.idl +++ b/udkapi/com/sun/star/lang/XServiceDisplayName.idl @@ -2,9 +2,9 @@ * * $RCSfile: XServiceDisplayName.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= /** provides a name for the service to be used in displays. diff --git a/udkapi/com/sun/star/lang/XServiceInfo.idl b/udkapi/com/sun/star/lang/XServiceInfo.idl index ff5d9e134..2f1ad9ecf 100644 --- a/udkapi/com/sun/star/lang/XServiceInfo.idl +++ b/udkapi/com/sun/star/lang/XServiceInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XServiceInfo.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -83,10 +83,10 @@ interface XServiceInfo: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XServiceInfo::getImplementationName /** @returns - an identifier for the implementation of this object. + an identifier for the implementation of this object. - <p>In general this should be a qualified identifier like - "com.sun.star.comp.office.writer.SwTextDocument". + <p>In general this should be a qualified identifier like + "com.sun.star.comp.office.writer.SwTextDocument". */ string getImplementationName(); @@ -101,10 +101,10 @@ interface XServiceInfo: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XServiceInfo::getSupportedServiceNames /** @returns - a sequence of the names of all supported services. + a sequence of the names of all supported services. - <p>This includes the services which are indirectly supported because - they are part of the specification of directly supported services. + <p>This includes the services which are indirectly supported because + they are part of the specification of directly supported services. </p> */ sequence<string> getSupportedServiceNames(); @@ -117,6 +117,9 @@ interface XServiceInfo: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XServiceName.idl b/udkapi/com/sun/star/lang/XServiceName.idl index bfe4690e0..78b3ba146 100644 --- a/udkapi/com/sun/star/lang/XServiceName.idl +++ b/udkapi/com/sun/star/lang/XServiceName.idl @@ -2,9 +2,9 @@ * * $RCSfile: XServiceName.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,10 +83,10 @@ interface XServiceName: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XServiceName::getServiceName /** @returns - the service name that can be used to create such an object - by a factory. + the service name that can be used to create such an object + by a factory. - @see XPersistObject::getServiceName + @see XPersistObject::getServiceName */ [const] string getServiceName(); @@ -99,6 +99,9 @@ interface XServiceName: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XSingleServiceFactory.idl b/udkapi/com/sun/star/lang/XSingleServiceFactory.idl index 16917d112..61540d4eb 100644 --- a/udkapi/com/sun/star/lang/XSingleServiceFactory.idl +++ b/udkapi/com/sun/star/lang/XSingleServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSingleServiceFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,17 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= // DocMerge from xml: interface com::sun::star::lang::XSingleServiceFactory /** A factory supports this interface if the component which is created by this factory implements the service specification defined by the - factory.@see XInitialization - @see XMultiServiceFactory + factory. + + @see XInitialization + @see XMultiServiceFactory */ [ uik(E227A3DD-33D6-11D1-AABE00A0-249D5590), ident( "XSingleServiceFactory", 1.0 ) ] interface XSingleServiceFactory: com::sun::star::uno::XInterface @@ -90,8 +92,6 @@ interface XSingleServiceFactory: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XSingleServiceFactory::createInstance /** creates an instance of a component. - - <p>This component must support the services specified by the factory.</p> */ com::sun::star::uno::XInterface createInstance() @@ -103,11 +103,9 @@ interface XSingleServiceFactory: com::sun::star::uno::XInterface /** creates an instance of a component and initializes the component with some arguments. - - - <p>This component must support the services specified by the factory. - - </p>@see XInitialization::init + <p>This component must support the services specified by the factory. </p> + + @see XInitialization::init */ com::sun::star::uno::XInterface createInstanceWithArguments( [in] sequence<any> aArguments ) raises( com::sun::star::uno::Exception ); @@ -121,6 +119,9 @@ interface XSingleServiceFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XTypeProvider.idl b/udkapi/com/sun/star/lang/XTypeProvider.idl index 3e07b0054..8c82bdd51 100644 --- a/udkapi/com/sun/star/lang/XTypeProvider.idl +++ b/udkapi/com/sun/star/lang/XTypeProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTypeProvider.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * 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 lang { +module com { module sun { module star { module lang { //============================================================================= @@ -85,22 +85,22 @@ interface XTypeProvider: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::lang::XTypeProvider::getTypes /** @returns - Sequence of all types (usually interface types) provided by the object. - Important: If the object aggregates other objects the sequence also has - to contain all types supportet by the aggregated objects. + Sequence of all types (usually interface types) provided by the object. + Important: If the object aggregates other objects the sequence also has + to contain all types supportet by the aggregated objects. */ sequence<TYPE_XIDLCLASS> getTypes(); // DocMerge from idl: method com::sun::star::lang::XTypeProvider::getImplementationId /** @returns - a UUID as sequence of 16 bytes as an Id that can be used to unambiguously - distinguish between two sets of types, e.g. to realise hashing functionality - when the object is introspected. Two objects that return the same UUID also - have to return the same set of types in getTypes(). If an unique implementation - Id cannot be provided this method has to return an empty sequence. - Important: If the object aggregates other objects the UUID has to be unique - for the whole combination of objects. + a UUID as sequence of 16 bytes as an Id that can be used to unambiguously + distinguish between two sets of types, e.g. to realise hashing functionality + when the object is introspected. Two objects that return the same UUID also + have to return the same set of types in getTypes(). If an unique implementation + Id cannot be provided this method has to return an empty sequence. + Important: If the object aggregates other objects the UUID has to be unique + for the whole combination of objects. */ sequence<byte> getImplementationId(); }; @@ -112,6 +112,9 @@ interface XTypeProvider: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import diff --git a/udkapi/com/sun/star/lang/XUnoTunnel.idl b/udkapi/com/sun/star/lang/XUnoTunnel.idl index 7e3f34746..4827fbf75 100644 --- a/udkapi/com/sun/star/lang/XUnoTunnel.idl +++ b/udkapi/com/sun/star/lang/XUnoTunnel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnoTunnel.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:41 $ + * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,7 +69,7 @@ //============================================================================= - module com { module sun { module star { module lang { +module com { module sun { module star { module lang { //============================================================================= @@ -85,8 +85,7 @@ interface XUnoTunnel: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::lang::XUnoTunnel::getSomething /** call this method to get something which is not specified in UNO. - <p> - The identifier specifies how the return is specified. The identifier + <p>The identifier specifies how the return is specified. The identifier must be global unique, because it is unknown where the implementation lies.</p> */ @@ -101,6 +100,9 @@ interface XUnoTunnel: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:41 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:25 hjs initial import |