diff options
Diffstat (limited to 'comphelper/inc/comphelper/componentfactory.hxx')
-rw-r--r-- | comphelper/inc/comphelper/componentfactory.hxx | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/comphelper/inc/comphelper/componentfactory.hxx b/comphelper/inc/comphelper/componentfactory.hxx new file mode 100644 index 000000000000..2da7de3f3c82 --- /dev/null +++ b/comphelper/inc/comphelper/componentfactory.hxx @@ -0,0 +1,121 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/************************************************************************* + * + * 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 _COMPHELPER_COMPONENTFACTORY_HXX +#define _COMPHELPER_COMPONENTFACTORY_HXX +#include "comphelper/comphelperdllapi.h" + +#include <com/sun/star/lang/XSingleServiceFactory.hpp> + + +/** + * @Descr + * Utilities to get an instance of a component if a ProcessServiceFactory + * is not available like it is the case in "small tools" as the Setup. + */ +#include <com/sun/star/uno/Reference.h> + + +#ifdef UNX +// "libNAMExy.so" (__DLLEXTENSION == "xy.so") +#define LLCF_LIBNAME( name ) "lib" name __DLLEXTENSION +#else +// "NAMExy.dll" (__DLLEXTENSION == "xy") +#define LLCF_LIBNAME( name ) name __DLLEXTENSION ".dll" +#endif + + +namespace rtl { + class OUString; +} +namespace com { namespace sun { namespace star { + namespace uno { + class XInterface; + } + namespace lang { + class XSingleServiceFactory; + class XMultiServiceFactory; + } + namespace registry { + class XRegistryKey; + } +}}} + + +namespace comphelper +{ + +/** + * Get an instance of the component <code>rImplementationName</code> located + * in library <code>rLibraryName</code>. The instance must then be queried + * for the desired interface with a queryInterface call. + * The library name must be constructed with the macro + * <code>LLCF_LIBNAME( name )</code> if it is a library from the normal build + * process which includes build number and platform name. + * + * @example:C++ + * <listing> + + using namespace ::com::sun::star; + using namespace ::com::sun::star::uno; + Reference< whatever::XYourComponent > xComp; + // library name, e.g. xyz603mi.dll or libxyz603.so + ::rtl::OUString aLibName( RTL_CONSTASCII_USTRINGPARAM( LLCF_LIBNAME( "xyz" ) ) ); + ::rtl::OUString aImplName( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.whatever.YourComponent" ) ); + Reference< Xinterface > xI = ::comphelper::getComponentInstance( aLibName, aImplName ); + if ( xI.is() ) + { + Any x = xI->queryInterface( ::getCppuType((const Reference< whatever::XYourComponent >*)0) ); + x >>= xComp; + } + if ( !xComp.is() ) + // you're lost + + * </listing> + */ +COMPHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > + getComponentInstance( + const ::rtl::OUString & rLibraryName, + const ::rtl::OUString & rImplementationName + ); + + +::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > + loadLibComponentFactory( + const ::rtl::OUString & rLibraryName, + const ::rtl::OUString & rImplementationName, + const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > & xSF, + const ::com::sun::star::uno::Reference< ::com::sun::star::registry::XRegistryKey > & xKey + ); + + +} // namespace comphelper + +#endif // _COMPHELPER_COMPONENTFACTORY_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |