diff options
Diffstat (limited to 'udkapi/com/sun/star/uno')
| -rw-r--r-- | udkapi/com/sun/star/uno/DeploymentException.idl | 53 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/Exception.idl | 71 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/NamingService.idl | 57 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/RuntimeException.idl | 60 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/SecurityException.idl | 51 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/TypeClass.idl | 153 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/Uik.idl | 70 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XAdapter.idl | 92 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XAggregation.idl | 124 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XComponentContext.idl | 69 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XCurrentContext.idl | 61 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XInterface.idl | 134 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XNamingService.idl | 82 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XReference.idl | 71 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XUnloadingPreference.idl | 71 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/XWeak.idl | 123 | ||||
| -rw-r--r-- | udkapi/com/sun/star/uno/makefile.mk | 61 |
17 files changed, 1403 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/uno/DeploymentException.idl b/udkapi/com/sun/star/uno/DeploymentException.idl new file mode 100644 index 000000000000..5cf8e4f48bd7 --- /dev/null +++ b/udkapi/com/sun/star/uno/DeploymentException.idl @@ -0,0 +1,53 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_DeploymentException_idl__ +#define __com_sun_star_uno_DeploymentException_idl__ + +#ifndef __com_sun_star_uno_RuntimeException_idl__ +#include <com/sun/star/uno/RuntimeException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +/** Exception signalling a deployment error. + + @since OOo 1.1.2 +*/ +published exception DeploymentException : com::sun::star::uno::RuntimeException +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/Exception.idl b/udkapi/com/sun/star/uno/Exception.idl new file mode 100644 index 000000000000..1ddfcdd3d8ce --- /dev/null +++ b/udkapi/com/sun/star/uno/Exception.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_Exception_idl__ +#define __com_sun_star_uno_Exception_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +// DocMerge from xml: exception com::sun::star::uno::Exception +/** the base of all UNO exceptions + + <p>All exceptions defined in UNO idl should derive from this exception.</p> + */ +published exception Exception +{ + /** gives a detailed description of the reason, why the exception was thrown. + <p> + The description should be as detailed as possible. + + */ + string Message; + + //------------------------------------------------------------------------- + + /** should contain a reference to the original, which raised the exception. + <p>May be NULL.</p> + */ + com::sun::star::uno::XInterface Context; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/NamingService.idl b/udkapi/com/sun/star/uno/NamingService.idl new file mode 100644 index 000000000000..db77fb65cb4c --- /dev/null +++ b/udkapi/com/sun/star/uno/NamingService.idl @@ -0,0 +1,57 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_NamingService_idl__ +#define __com_sun_star_uno_NamingService_idl__ + +#ifndef __com_sun_star_uno_XNamingService_idl__ +#include <com/sun/star/uno/XNamingService.idl> +#endif + + module com { module sun { module star { module uno { + +//============================================================================= +/** a simple named object container. + + */ +published service NamingService +{ + /** through this interface the objects are registered and accessed. + */ + interface com::sun::star::uno::XNamingService; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + Source Code Control System - Update + +=============================================================================*/ +#endif + diff --git a/udkapi/com/sun/star/uno/RuntimeException.idl b/udkapi/com/sun/star/uno/RuntimeException.idl new file mode 100644 index 000000000000..c5660e0895fc --- /dev/null +++ b/udkapi/com/sun/star/uno/RuntimeException.idl @@ -0,0 +1,60 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_RuntimeException_idl__ +#define __com_sun_star_uno_RuntimeException_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +/** This exception or a subclass can occur at every interface method. + <p> + It shall signal an error, which was not covered by the interface + method specification. This exception (or a derived one) is thrown, + when for instance an interprocess bridge to the object broke down, + some explicitly forbidden invalid parameters were passed ( e.g. null + references ) or the called object has been disposed before. + */ +published exception RuntimeException: com::sun::star::uno::Exception +{ +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/SecurityException.idl b/udkapi/com/sun/star/uno/SecurityException.idl new file mode 100644 index 000000000000..341c79827453 --- /dev/null +++ b/udkapi/com/sun/star/uno/SecurityException.idl @@ -0,0 +1,51 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_SecurityException_idl__ +#define __com_sun_star_uno_SecurityException_idl__ + +#ifndef __com_sun_star_uno_RuntimeException_idl__ +#include <com/sun/star/uno/RuntimeException.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +/** Base exception for all security related exceptions. +*/ +published exception SecurityException : com::sun::star::uno::RuntimeException +{ +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/TypeClass.idl b/udkapi/com/sun/star/uno/TypeClass.idl new file mode 100644 index 000000000000..7d5acb693b56 --- /dev/null +++ b/udkapi/com/sun/star/uno/TypeClass.idl @@ -0,0 +1,153 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_TypeClass_idl__ +#define __com_sun_star_uno_TypeClass_idl__ + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +/** This enum describes all type classes of UNO. Every specific type has a type + class specifying the general context of the reflected type. + + <p> + Example: + A type reflecting the interface <type>XInterface</type> is of type class + INTERFACE and its name is "com.sun.star.uno.XInterface". + </p> +*/ +published enum TypeClass +{ + /** reflecting the void type; denotes no type + */ + VOID, + /** reflecting the 16-bit unicode character type + */ + CHAR, + /** reflecting the boolean type; true and false + */ + BOOLEAN, + /** reflecting the 8-bit ordinal type + */ + BYTE, + /** reflecting the signed 16-bit ordinal type + */ + SHORT, + /** reflecting the unsigned 16-bit ordinal type + */ + UNSIGNED_SHORT, + /** reflecting the signed 32-bit ordinal type + */ + LONG, + /** reflecting the unsigned 32-bit type + */ + UNSIGNED_LONG, + /** reflecting the signed 64-bit ordinal type + */ + HYPER, + /** reflecting the unsigned 64-bit ordinal type + */ + UNSIGNED_HYPER, + /** reflecting the 32-bit floating point type + */ + FLOAT, + /** reflecting the 64-bit floating point type + */ + DOUBLE, + /** reflecting the string type; strings of unicode characters + */ + STRING, + /** reflecting the meta type + */ + TYPE, + /** reflecting the any type; anys can carry any UNO value except of any values + */ + ANY, + /** reflecting enum types + */ + ENUM, + /** reflecting typedefed types referencing other types + */ + TYPEDEF, + /** reflecting compound types + */ + STRUCT, + /** reflecting union types + */ + UNION, + /** reflecting exception types + */ + EXCEPTION, + /** reflecting sequence types + */ + SEQUENCE, + /** reflecting array types + */ + ARRAY, + /** reflecting interface types + */ + INTERFACE, + /** reflecting services + */ + SERVICE, + /** reflecting modules + */ + MODULE, + /** reflecting interface methods + */ + INTERFACE_METHOD, + /** reflecting interface attributes + */ + INTERFACE_ATTRIBUTE, + /** reflecting the unreflectable type + */ + UNKNOWN, + /** reflecting properties + */ + PROPERTY, + /** reflecting constants + */ + CONSTANT, + /** reflecting constants groups + */ + CONSTANTS, + /** reflecting singletons + */ + SINGLETON +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/Uik.idl b/udkapi/com/sun/star/uno/Uik.idl new file mode 100644 index 000000000000..1ef1f776f3df --- /dev/null +++ b/udkapi/com/sun/star/uno/Uik.idl @@ -0,0 +1,70 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_Uik_idl__ +#define __com_sun_star_uno_Uik_idl__ + + +//============================================================================= + + module com { module sun { module star { module uno { + +/** Specifies an universal interface key (globally unique). + + This struct is deprecated. Uiks are not used anymore. + @deprecated +*/ +published struct Uik +{ + /** specifies a 4 byte data block. + */ + unsigned long m_Data1; + + /** specifies a 2 byte data block. + */ + unsigned short m_Data2; + + /** specifies a 2 byte data block. + */ + unsigned short m_Data3; + + /** specifies a 4 byte data block. + */ + unsigned long m_Data4; + + /** specifies a 4 byte data block. + */ + unsigned long m_Data5; +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/XAdapter.idl b/udkapi/com/sun/star/uno/XAdapter.idl new file mode 100644 index 000000000000..875fc71c8113 --- /dev/null +++ b/udkapi/com/sun/star/uno/XAdapter.idl @@ -0,0 +1,92 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XAdapter_idl__ +#define __com_sun_star_uno_XAdapter_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_uno_XReference_idl__ +#include <com/sun/star/uno/XReference.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +/** This is the server-side interface to a weak adapter. + + <p>The implementation of <type>XAdapter</type> must know + but not hold the adapted object, because it must not + affect the lifetime of the adapted object. + + </p>@see XWeak + for description of concepts. + */ +published interface XAdapter: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XAdapter::queryAdapted + /** queries the adapted object if it is alive. + */ + com::sun::star::uno::XInterface queryAdapted(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XAdapter::addReference + /** adds a reference to the adapter. + + + + <p>All added references are called when the adapted object dies. + + </p> + */ + void addReference( [in] com::sun::star::uno::XReference xRef ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XAdapter::removeReference + /** removes a reference from the adapter. + */ + void removeReference( [in] com::sun::star::uno::XReference xRef ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/XAggregation.idl b/udkapi/com/sun/star/uno/XAggregation.idl new file mode 100644 index 000000000000..3fe757bba7b3 --- /dev/null +++ b/udkapi/com/sun/star/uno/XAggregation.idl @@ -0,0 +1,124 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XAggregation_idl__ +#define __com_sun_star_uno_XAggregation_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module uno { + +//============================================================================= +/** Objects which implement this interface can become aggregates of + a delegator. + + <p>That means if an object "A" aggregates "B", "A" can provide all + or some of the interfaces of "B". Whenever the method + <member>XInterface::queryInterface()</member> + is called on either of the objects, the call will be forwarded + to object "A". Object "A" now can determine whether to use the + interfaces of "A" or "B" or neither. Actually, any number of + aggregates can be used, even nested ones (aggregated objects which are + delegators by themselves). + + <p>The following rules are to be observed: + <ol> + <li>All calls to <member>XInterface::acquire()</member> + which are made before the delegator was set (using the method + <member>XAggregation::setDelegator()</member>) must not be taken back + (using the method <member>XInterface::release()</member>) + before the delegation is removed by calling + <code>xAggregation->setDelegator(NULL)</code>. + + <li>The constructor of a delegator has to increment its + own reference count by calling its method + <member>XInterface::acquire()</member> + before it sets itself to any aggregate using the method + <member>XAggregation::setDelegator()</member>. After that + call it has to reset its own reference count without the + destructor getting called. + + <li>The destructor of a delegator has to reset the delegator in + its aggregated objects by calling their method + <member>XAggregation::setDelegator()</member> with + <const>NULL</const> before it releases its reference to + its aggregated objects. + </ol> + + @deprecated + Aggregation will no longer be supported as a high-level concept of UNO. + You may still have the option to implement an UNO object consisting of + several single objects in your specific programming language, though this + depends on your programming language. +*/ +published interface XAggregation: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + /** sets the object to which all calls to the method + <member>XInterface::queryInterface()</member> + have to be forwarded. @ + + @param xDelegator + specifies the object which handles the calls to + <member>XInterface::queryInterface()</member>. + If <var>xDelegator</var> is <const>NULL</const>, the delegator is + removed and thus the object becomes its own delegator and has + to handle calls to the method + <member>XInterface::queryInterface()</member> + itself. + + @see XAggregation::queryAggregation + */ + void setDelegator( [in] com::sun::star::uno::XInterface pDelegator ); + + //------------------------------------------------------------------------- + /** is similar to <member>XInterface::queryInterface()</member>, + but it is to be processed directly without being forwarded to the + delegator. @ + + <p>This method is only called from within an implementation of + <member>XInterface::queryInterface()</member> + or <member>XAggregation::queryAggregation()</member>. This method + is to be called by the delegator if it does not implement the + interface itself. An object which got aggregated cannot depend + on getting its own interface when it calls the method + <member>XInterface::queryInterface()</member>. + + @see XAggregation::setDelegator + */ + any queryAggregation( [in] type aType ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/XComponentContext.idl b/udkapi/com/sun/star/uno/XComponentContext.idl new file mode 100644 index 000000000000..fe43ed62e092 --- /dev/null +++ b/udkapi/com/sun/star/uno/XComponentContext.idl @@ -0,0 +1,69 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XComponentContext_idl__ +#define __com_sun_star_uno_XComponentContext_idl__ + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + +module com { module sun { module star { module lang { + published interface XMultiComponentFactory; +}; }; }; }; + +module com { module sun { module star { module uno { + +/** Component context to be passed to a component via + <type scope="com::sun::star::lang">XSingleComponentFactory</type>. + Arbitrary values (e.g. deployment values) can be retrieved from the context. +*/ +published interface XComponentContext : XInterface +{ + /** Gets a value from the context. + + @param Name + name of value + @return + value + */ + any getValueByName( [in] string Name ); + + /** Gets the service manager instance to be used from key + <code>/singletons/com.sun.star.lang.theServiceManager</code> (maybe null ref). + This method has been added for convenience, because the + service manager is used very often. + + @return + service manager, if any + */ + com::sun::star::lang::XMultiComponentFactory getServiceManager(); +}; + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/XCurrentContext.idl b/udkapi/com/sun/star/uno/XCurrentContext.idl new file mode 100644 index 000000000000..4cd83482afe6 --- /dev/null +++ b/udkapi/com/sun/star/uno/XCurrentContext.idl @@ -0,0 +1,61 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XCurrentContext_idl__ +#define __com_sun_star_uno_XCurrentContext_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + +module com { module sun { module star { module uno { + +/** Task (e.g. thread) local execution context for UNO. + Arbitrary values can be retrieved from the context. + <p> + You have to use UNO runtime functions to obtain the current context + in your target language. + </p> + @attention + In general, do not spread the current context across different tasks. + Values of the current context are destined for that task only. +*/ +published interface XCurrentContext : XInterface +{ + /** Gets a value from the context. + + @param Name + name of value + @return + value + */ + any getValueByName( [in] string Name ); +}; + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/XInterface.idl b/udkapi/com/sun/star/uno/XInterface.idl new file mode 100644 index 000000000000..440b3fe95db1 --- /dev/null +++ b/udkapi/com/sun/star/uno/XInterface.idl @@ -0,0 +1,134 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XInterface_idl__ +#define __com_sun_star_uno_XInterface_idl__ + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::uno::XInterface +/** base interface of all UNO interfaces + + <p> It provides lifetime control by reference counting and the + possibility of querying for other + interfaces of the same logical object. + + + <p> + "Logical Object" in this case means that the + interfaces actually can be supported by internal (e.g. aggregated) physical objects.</p> + + <p> Deriving from this interface is mandatory for all UNO interfaces. + <p> Each language binding (Java, C++, StarBasic, Python, ... ) may + provide a different mapping of this interface, please look into the language + dependent documention. + + <p> The UNO object does not export the state of the reference count (acquire() and + release() do not have return values). In general, also the UNO object itself + should not make any assumption on the concrete value of the reference count + (except on the transition from one to zero ). + + */ +published interface XInterface +{ + /** queries for a new interface to an existing UNO object. + <p> + The queryInterface() method is the entry point to obtain other interfaces which + are exported by the object. The caller asks the implementation of the object, + if it supports the interface specified by the type argument. The call may either + return with a interface reference of the requested type or with a void any. + + <p> + There are certain specifications, a queryInterface() implementation must not violate. + <p> + 1) If queryInterface on a specific object has once returned a valid interface reference + for a given type, it must return a valid reference for any successive queryInterface + calls on this object for the same type. + <p> + 2) If queryInterface on a specific object has once returned a null reference + for a given type, it must always return a null reference for the same type. + <p> + 3) If queryInterface on a reference A returns reference B, queryInterface on + B for Type A must return interface reference A or calls made on the returned + reference must be equivalent to calls made on reference A. + <p> + 4) If queryInterface on a reference A returns reference B, queryInterface on + A and B for XInterface must return the same interface reference (object identity). + + <p> The reason for the strong specification is, that a Uno Runtime Environment (URE) + may choose to cache queryInterface() calls. + <p> As mentioned above, certain language bindings may map this function differently also + with different specifications, please visit the language dependent specification for it. + The current C++ binding sticks to the specification state + <p> + The rules mentioned above are basically identical to the rules of QueryInterface in MS COM. + + @param aType a UNO interface type, for which an object reference shall be obtained. + @return an interface reference in case the requested interface is supported by the object, + a void any otherwise. + */ + any queryInterface( [in] type aType ); + + //------------------------------------------------------------------------- + /** increases the reference counter by one. + + <p>When you have called acquire() on the + UNO object, it is often said, that you have a reference or a hard reference + to the object. + + <p> + It is only allowed to invoke a method on an UNO object, when you keep + a hard reference to it. + + <p> Every call to acquire must be followed by a corresponding call to release + some time later, which may eventually lead to the destruction of the object. + */ + [oneway] void acquire(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XInterface::release + /** decreases the reference counter by one. + <p>When the reference counter reaches 0, the object gets deleted.</p> + <p>Calling release() on the object is often called releasing + or clearing the reference to an object. + */ + [oneway] void release(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/XNamingService.idl b/udkapi/com/sun/star/uno/XNamingService.idl new file mode 100644 index 000000000000..c88da8638696 --- /dev/null +++ b/udkapi/com/sun/star/uno/XNamingService.idl @@ -0,0 +1,82 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XNamingService_idl__ +#define __com_sun_star_uno_XNamingService_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_uno_Exception_idl__ +#include <com/sun/star/uno/Exception.idl> +#endif + + module com { module sun { module star { module uno { + +//============================================================================= + +/** allows to insert, remove and access named objects. + */ +published interface XNamingService: com::sun::star::uno::XInterface +{ + + /** provides a previous registered object. + */ + com::sun::star::uno::XInterface getRegisteredObject( [in] string Name ) + raises (Exception); + + + /** registers one object under the specified name. + + <p>If any object is registered before, then this + object is revoked automatically. + + </p> + */ + void registerObject( [in]string Name, [in]com::sun::star::uno::XInterface Object ) + raises (Exception); + + + /** revokes the registration of an object. <p>If the object was not + previously registered, then this call does nothing. + */ + void revokeObject( [in]string Name ) + raises (Exception); +}; + + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + Source Code Control System - Update + +=============================================================================*/ +#endif + diff --git a/udkapi/com/sun/star/uno/XReference.idl b/udkapi/com/sun/star/uno/XReference.idl new file mode 100644 index 000000000000..540ba053abba --- /dev/null +++ b/udkapi/com/sun/star/uno/XReference.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XReference_idl__ +#define __com_sun_star_uno_XReference_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::uno::XReference +/** must be implemented by anyone who holds the adapter on the client side.@see XWeak + for decription af concepts. + */ +published interface XReference: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XReference::dispose + /** removes all references to the adapter. + + + + <p> This method is called when the adapted object dies. + The implementation of the client-side's weak reference + must include removal of all references to the adapter. + Otherwise, the adapted object will be destroyed, but the + adapter will be alive.</p> + */ + [oneway] void dispose(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/XUnloadingPreference.idl b/udkapi/com/sun/star/uno/XUnloadingPreference.idl new file mode 100644 index 000000000000..e87efd20d253 --- /dev/null +++ b/udkapi/com/sun/star/uno/XUnloadingPreference.idl @@ -0,0 +1,71 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XUnloadingPreference_idl__ +#define __com_sun_star_uno_XUnloadingPreference_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module uno { + +//============================================================================= +/** Components can implement <code>XUnloadingPreference</code> in order to indicate + how they should be treated when their hosting library is to be unloaded. + + When someone calls <code>rtl_unloadUnusedModules</code> then the unloading + listeners are notified by calling previously registered callback + functions. A listener is an entity that employs, registers, and + unregisters the callback functions on its behalf. Upon notification + (the callback function is being called) + a listener may release references to UNO components. Thus, the + loaded libraries can be unloaded, if no one else keeps any + objects from the library alive. <br> + Before a listener releases references, it should ask for this interface. + If the interface is not implemented, then the listener may release the + object; otherwise, it calls <code>releaseOnNotification</code>. If the function + returns false then the listener should keep the reference, otherwise + it may release it. +*/ +published interface XUnloadingPreference: com::sun::star::uno::XInterface +{ + /** + The return value determines if the object wants to stay + alive in case of an unloading procedure. + @return + <FALSE/>do not release references to this object,otherwise + <TRUE/> + */ + boolean releaseOnNotification(); +}; +//============================================================================= + +}; }; }; }; + +#endif diff --git a/udkapi/com/sun/star/uno/XWeak.idl b/udkapi/com/sun/star/uno/XWeak.idl new file mode 100644 index 000000000000..73b73090d286 --- /dev/null +++ b/udkapi/com/sun/star/uno/XWeak.idl @@ -0,0 +1,123 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_uno_XWeak_idl__ +#define __com_sun_star_uno_XWeak_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_uno_XAdapter_idl__ +#include <com/sun/star/uno/XAdapter.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module uno { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::uno::XWeak +/** the server-side interface to a weak object. + + + + <p>This interface is proxy to the adapted object. + In order to make it possible to have weak references to objects, + the <type>XAdapter</type> interface must be implemented to provide + a weak adapter for the clients. + + <h4>Concept of weak referencing:</h4> + + </p> + <p>This module specifies the interfaces for implementing and using + weak references.</p> + <p> + + </p> + <p>The sense of weak references is to hold a reference to an object + without affecting the lifetime of the object. That means that a weak + reference may become invalid, at any time, if the referenced object dies. + + </p> + <p>The following interfaces describe one way to handle weak references + by providing a weak adapter. The weak object has to provide this + adapter if anyone wants to hold a weak reference. To separate their + lifetimes, the adapter and the original object must not share the same + reference counter. The weak reference is in fact only a hard reference + to the adapter, which knows - but does not hold - the original object. + That means that the implementation and synchronization of weak + referencing is the responsibility of the object. The following + interfaces are involved in the concept of weak referencing: + + <dl> + <dt> + <type>XWeak</type> + </dt> + <dd>is the server-side interface of the referred object. This + referred object must support the <type>XAdapter</type> interface. + + </dd> + <dt> + <type>XReference</type> + </dt> + <dd>is a client-side interface which must be implemented by + the holder of any weak reference. It is used for notification + when the adapted object dies. + + </dd> + </dl> + </p> + */ +published interface XWeak: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::uno::XWeak::queryAdapter + /** queries the weak adapter. + + + + <p>It is important that the adapter must know, but not hold + the adapted object. If the adapted object dies, all references + to the adapter have to be notified to release the adapter. + + </p> + */ + com::sun::star::uno::XAdapter queryAdapter(); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif diff --git a/udkapi/com/sun/star/uno/makefile.mk b/udkapi/com/sun/star/uno/makefile.mk new file mode 100644 index 000000000000..d615b367fd5d --- /dev/null +++ b/udkapi/com/sun/star/uno/makefile.mk @@ -0,0 +1,61 @@ +#************************************************************************* +# +# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. +# +# Copyright 2000, 2010 Oracle and/or its affiliates. +# +# OpenOffice.org - a multi-platform office productivity suite +# +# This file is part of OpenOffice.org. +# +# OpenOffice.org is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License version 3 +# only, as published by the Free Software Foundation. +# +# OpenOffice.org is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License version 3 for more details +# (a copy is included in the LICENSE file that accompanied this code). +# +# You should have received a copy of the GNU Lesser General Public License +# version 3 along with OpenOffice.org. If not, see +# <http://www.openoffice.org/license.html> +# for a copy of the LGPLv3 License. +# +#************************************************************************* + +PRJ=..$/..$/..$/.. + +PRJNAME=api + +TARGET=cssuno +PACKAGE=com$/sun$/star$/uno + +# --- Settings ----------------------------------------------------- +.INCLUDE : $(PRJ)$/util$/makefile.pmk + +# ------------------------------------------------------------------------ + +IDLFILES=\ + Exception.idl\ + NamingService.idl\ + RuntimeException.idl\ + SecurityException.idl\ + DeploymentException.idl\ + TypeClass.idl\ + Uik.idl\ + XAdapter.idl\ + XAggregation.idl\ + XInterface.idl\ + XNamingService.idl\ + XReference.idl\ + XWeak.idl\ + XComponentContext.idl\ + XCurrentContext.idl\ + XUnloadingPreference.idl + +# ------------------------------------------------------------------ + +.INCLUDE : target.mk +.INCLUDE : $(PRJ)$/util$/target.pmk |