diff options
Diffstat (limited to 'offapi/com/sun/star/frame/XModule.idl')
-rw-r--r-- | offapi/com/sun/star/frame/XModule.idl | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/XModule.idl b/offapi/com/sun/star/frame/XModule.idl new file mode 100644 index 000000000000..c302892d5df5 --- /dev/null +++ b/offapi/com/sun/star/frame/XModule.idl @@ -0,0 +1,79 @@ +/************************************************************************* + * + * 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_frame_XModule_idl__ +#define __com_sun_star_frame_XModule_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ +#include <com/sun/star/lang/IllegalArgumentException.idl> +#endif + +#ifndef __com_sun_star_frame_UnknownModuleException_idl__ +#include <com/sun/star/frame/UnknownModuleException.idl> +#endif + +//=============================================== + +module com { module sun { module star { module frame { + +//=============================================== +/** can be used to overrule identification of office modules. + + <p> + Normaly an office module will be identified by it's service name + in combination with a set of configuration data. + But sometimes whole existing office modules will be used as black box components + to implement a different office module on top of it. Patching a service name + is not possible. So this optional interface can be used to overwrite identification + of a module. + </p> + + @see XModuleManager + + @since OOo 2.3.0 + */ +interface XModule : com::sun::star::uno::XInterface +{ + //------------------------------------------- + /** @param Identifier + a new "name" for this module. + */ + void setIdentifier([in] string Identifier); + + //------------------------------------------- + /** @return the module identifier. + */ + string getIdentifier(); +}; + +}; }; }; }; + +#endif |