diff options
Diffstat (limited to 'comphelper/inc/comphelper/componentcontext.hxx')
| -rw-r--r-- | comphelper/inc/comphelper/componentcontext.hxx | 254 |
1 files changed, 0 insertions, 254 deletions
diff --git a/comphelper/inc/comphelper/componentcontext.hxx b/comphelper/inc/comphelper/componentcontext.hxx deleted file mode 100644 index 4b7c663d12..0000000000 --- a/comphelper/inc/comphelper/componentcontext.hxx +++ /dev/null @@ -1,254 +0,0 @@ -/* -*- 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_COMPONENTCONTEXT_HXX -#define COMPHELPER_COMPONENTCONTEXT_HXX - -#include <comphelper/comphelperdllapi.h> - -/** === begin UNO includes === **/ -#include <com/sun/star/uno/XComponentContext.hpp> -#include <com/sun/star/lang/XMultiServiceFactory.hpp> -/** === end UNO includes === **/ - -//........................................................................ -namespace comphelper -{ -//........................................................................ - - //==================================================================== - //= ComponentContext - //==================================================================== - /** a helper class for working with a component context - */ - class COMPHELPER_DLLPUBLIC ComponentContext - { - private: - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > m_xContext; - ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiComponentFactory > m_xORB; - - public: - /** constructs an instance - @param _rxContext - the component context to manage - @throws ::com::sun::star::lang::NullPointerException - if the given context, or its component factory, are <NULL/> - */ - ComponentContext( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext ); - - /** constructs an instance - @param _rxLegacyFactory - the legacy service factor to obtain the <type scope="com::sun::star::uno">XComponentContext</type> from - @throws ::com::sun::star::uno::RuntimeException - if the given factory or does not have a DefaultContext property to obtain - a component context - @throws ::com::sun::star::lang::NullPointerException - if the given factory is <NULL/>, or provides a component context being <NULL/>, or provides - a component context whose component factory is <NULL/> - */ - ComponentContext( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxLegacyFactory ); - - /** returns the ->XComponentContext interface - */ - inline ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > - getUNOContext() const { return m_xContext; } - - /** determines whether the context is not <NULL/> - */ - inline sal_Bool is() const - { - return m_xContext.is(); - } - - /** creates a component using our component factory/context - @throws ::com::sun::star::uno::Exception - @return - <TRUE/> if and only if the component could be successfully created - */ - template < typename INTERFACE > - bool createComponent( const ::rtl::OUString& _rServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const - { - _out_rxComponent.clear(); - _out_rxComponent = _out_rxComponent.query( - m_xORB->createInstanceWithContext( _rServiceName, m_xContext ) - ); - return _out_rxComponent.is(); - } - - /** creates a component using our component factory/context - @throws ::com::sun::star::uno::Exception - @return - <TRUE/> if and only if the component could be successfully created - */ - template < typename INTERFACE > - bool createComponent( const sal_Char* _pAsciiServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const - { - return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _out_rxComponent ); - } - - /** creates a component using our component factory/context, passing creation arguments - @throws ::com::sun::star::uno::Exception - @return - <TRUE/> if and only if the component could be successfully created - */ - template < typename INTERFACE > - bool createComponentWithArguments( const ::rtl::OUString& _rServiceName, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const - { - _out_rxComponent.clear(); - _out_rxComponent = _out_rxComponent.query( - m_xORB->createInstanceWithArgumentsAndContext( _rServiceName, _rArguments, m_xContext ) - ); - return _out_rxComponent.is(); - } - - /** creates a component using our component factory/context, passing creation arguments - @throws ::com::sun::star::uno::Exception - @return - <TRUE/> if and only if the component could be successfully created - */ - template < typename INTERFACE > - bool createComponentWithArguments( const sal_Char* _pAsciiServiceName, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const - { - return createComponentWithArguments( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _rArguments, _out_rxComponent ); - } - - /** creates a component using our component factory/context - - @throws ::com::sun::star::lang::ServiceNotRegisteredException - if the given service is not registered - @throws Exception - if an exception occurred during creating the component - @return - the newly created component. Is never <NULL/>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const ::rtl::OUString& _rServiceName ) const; - - /** creates a component using our component factory/context - - @throws ::com::sun::star::lang::ServiceNotRegisteredException - if the given service is not registered - @throws Exception - if an exception occurred during creating the component - @return - the newly created component. Is never <NULL/>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const sal_Char* _pAsciiServiceName ) const - { - return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ) ); - } - - /** creates a component using our component factory/context, passing creation arguments - - @throws ::com::sun::star::lang::ServiceNotRegisteredException - if the given service is not registered - @throws Exception - if an exception occurred during creating the component - @return - the newly created component. Is never <NULL/>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponentWithArguments( - const ::rtl::OUString& _rServiceName, - const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments - ) const; - - /** creates a component using our component factory/context, passing creation arguments - - @throws ::com::sun::star::lang::ServiceNotRegisteredException - if the given service is not registered - @throws Exception - if an exception occurred during creating the component - @return - the newly created component. Is never <NULL/>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponentWithArguments( - const sal_Char* _pAsciiServiceName, - const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments - ) const - { - return createComponentWithArguments( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _rArguments ); - } - - /** retrieves a singleton instance from the context - - Singletons are collected below the <code>/singletons</code> key in a component context, - so accessing them means retrieving the value under <code>/singletons/<instance_name></code>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getSingleton( const ::rtl::OUString& _rInstanceName ) const; - - /** retrieves a singleton instance from the context - - Singletons are collected below the <code>/singletons</code> key in a component context, - so accessing them means retrieving the value under <code>/singletons/<instance_name></code>. - */ - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getSingleton( const sal_Char* _pAsciiInstanceName ) const - { - return getSingleton( ::rtl::OUString::createFromAscii( _pAsciiInstanceName ) ); - } - - /** returns the ->XMultiServiceFactory interface of ->m_xORB, for passing to - older code which does not yet support ->XMultiComponentFactory - @throws ::com::sun::star::uno::RuntimeException - if our our component factory does not support this interface - */ - ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > - getLegacyServiceFactory() const; - - /** retrieves a value from our component context - @param _rName - the name of the value to retrieve - @return - the context value with the given name - @seealso XComponentContext::getValueByName - @seealso getContextValueByAsciiName - */ - ::com::sun::star::uno::Any - getContextValueByName( const ::rtl::OUString& _rName ) const; - - /** retrieves a value from our component context, specified by 8-bit ASCII string - @param _rName - the name of the value to retrieve, as ASCII character string - @return - the context value with the given name - @seealso XComponentContext::getValueByName - @seealso getContextValueByName - */ - inline ::com::sun::star::uno::Any - getContextValueByAsciiName( const sal_Char* _pAsciiName ) const - { - return getContextValueByName( ::rtl::OUString::createFromAscii( _pAsciiName ) ); - } - - }; - -//........................................................................ -} // namespace comphelper -//........................................................................ - -#endif // COMPHELPER_COMPONENTCONTEXT_HXX - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |