1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef EXTENSIONS_SOURCE_PROPCTRLR_PCROMPONENTCONTEXT_HXX 29*cdf0e10cSrcweir #define EXTENSIONS_SOURCE_PROPCTRLR_PCROMPONENTCONTEXT_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir /** === begin UNO includes === **/ 32*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp> 33*cdf0e10cSrcweir #include <com/sun/star/lang/XMultiServiceFactory.hpp> 34*cdf0e10cSrcweir /** === end UNO includes === **/ 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir //........................................................................ 37*cdf0e10cSrcweir namespace pcr 38*cdf0e10cSrcweir { 39*cdf0e10cSrcweir //........................................................................ 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir //==================================================================== 42*cdf0e10cSrcweir //= ComponentContext 43*cdf0e10cSrcweir //==================================================================== 44*cdf0e10cSrcweir /** a helper class for working with a component context 45*cdf0e10cSrcweir */ 46*cdf0e10cSrcweir class ComponentContext 47*cdf0e10cSrcweir { 48*cdf0e10cSrcweir private: 49*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > m_xContext; 50*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiComponentFactory > m_xORB; 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir public: 53*cdf0e10cSrcweir /** constructs an instance 54*cdf0e10cSrcweir @param _rxContext 55*cdf0e10cSrcweir the component context to manage 56*cdf0e10cSrcweir @throws ::com::sun::star::lang::NullPointerException 57*cdf0e10cSrcweir if the given context, or its component factory, are <NULL/> 58*cdf0e10cSrcweir */ 59*cdf0e10cSrcweir ComponentContext( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext ); 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir /** returns the ->XComponentContext interface 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir inline ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > 64*cdf0e10cSrcweir getUNOContext() const { return m_xContext; } 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir /** determines whether the context is not <NULL/> 67*cdf0e10cSrcweir */ 68*cdf0e10cSrcweir inline sal_Bool is() const 69*cdf0e10cSrcweir { 70*cdf0e10cSrcweir return m_xContext.is(); 71*cdf0e10cSrcweir } 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir /** creates a component using our component factory/context 74*cdf0e10cSrcweir @throws ::com::sun::star::uno::Exception 75*cdf0e10cSrcweir @return 76*cdf0e10cSrcweir <TRUE/> if and only if the component could be successfully created 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir template < class INTERFACE > 79*cdf0e10cSrcweir bool createComponent( const ::rtl::OUString& _rServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const 80*cdf0e10cSrcweir { 81*cdf0e10cSrcweir _out_rxComponent.clear(); 82*cdf0e10cSrcweir _out_rxComponent = _out_rxComponent.query( 83*cdf0e10cSrcweir m_xORB->createInstanceWithContext( _rServiceName, m_xContext ) 84*cdf0e10cSrcweir ); 85*cdf0e10cSrcweir return _out_rxComponent.is(); 86*cdf0e10cSrcweir } 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir /** creates a component using our component factory/context 89*cdf0e10cSrcweir @throws ::com::sun::star::uno::Exception 90*cdf0e10cSrcweir @return 91*cdf0e10cSrcweir <TRUE/> if and only if the component could be successfully created 92*cdf0e10cSrcweir */ 93*cdf0e10cSrcweir template < class INTERFACE > 94*cdf0e10cSrcweir bool createComponent( const sal_Char* _pAsciiServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const 95*cdf0e10cSrcweir { 96*cdf0e10cSrcweir return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _out_rxComponent ); 97*cdf0e10cSrcweir } 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir /** creates a component using our component factory/context 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir @throws ::com::sun::star::lang::ServiceNotRegisteredException 102*cdf0e10cSrcweir if the given service is not registered 103*cdf0e10cSrcweir @throws Exception 104*cdf0e10cSrcweir if an exception occured during creating the component 105*cdf0e10cSrcweir @return 106*cdf0e10cSrcweir the newly created component. Is never <NULL/>. 107*cdf0e10cSrcweir */ 108*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const ::rtl::OUString& _rServiceName ) const; 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir /** creates a component using our component factory/context 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir @throws ::com::sun::star::lang::ServiceNotRegisteredException 113*cdf0e10cSrcweir if the given service is not registered 114*cdf0e10cSrcweir @throws Exception 115*cdf0e10cSrcweir if an exception occured during creating the component 116*cdf0e10cSrcweir @return 117*cdf0e10cSrcweir the newly created component. Is never <NULL/>. 118*cdf0e10cSrcweir */ 119*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const sal_Char* _pAsciiServiceName ) const 120*cdf0e10cSrcweir { 121*cdf0e10cSrcweir return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ) ); 122*cdf0e10cSrcweir } 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir /** returns the ->XMultiServiceFactory interface of ->m_xORB, for passing to 125*cdf0e10cSrcweir older code which does not yet support ->XMultiComponentFactory 126*cdf0e10cSrcweir @throws ::com::sun::star::uno::RuntimeException 127*cdf0e10cSrcweir if our our component factory does not support this interface 128*cdf0e10cSrcweir */ 129*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > 130*cdf0e10cSrcweir getLegacyServiceFactory() const; 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir /** retrieves a value from our component context 133*cdf0e10cSrcweir @param _rName 134*cdf0e10cSrcweir the name of the value to retrieve 135*cdf0e10cSrcweir @return 136*cdf0e10cSrcweir the context value with the given name 137*cdf0e10cSrcweir @seealso XComponentContext::getValueByName 138*cdf0e10cSrcweir @seealso getContextValueByAsciiName 139*cdf0e10cSrcweir */ 140*cdf0e10cSrcweir ::com::sun::star::uno::Any 141*cdf0e10cSrcweir getContextValueByName( const ::rtl::OUString& _rName ) const; 142*cdf0e10cSrcweir 143*cdf0e10cSrcweir /** retrieves a value from our component context, specified by 8-bit ASCII string 144*cdf0e10cSrcweir @param _rName 145*cdf0e10cSrcweir the name of the value to retrieve, as ASCII character string 146*cdf0e10cSrcweir @return 147*cdf0e10cSrcweir the context value with the given name 148*cdf0e10cSrcweir @seealso XComponentContext::getValueByName 149*cdf0e10cSrcweir @seealso getContextValueByName 150*cdf0e10cSrcweir */ 151*cdf0e10cSrcweir inline ::com::sun::star::uno::Any 152*cdf0e10cSrcweir getContextValueByAsciiName( const sal_Char* _pAsciiName ) const 153*cdf0e10cSrcweir { 154*cdf0e10cSrcweir return getContextValueByName( ::rtl::OUString::createFromAscii( _pAsciiName ) ); 155*cdf0e10cSrcweir } 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir /** retrieve context to create interfaces by the ctors 158*cdf0e10cSrcweir */ 159*cdf0e10cSrcweir ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > getContext() const { return m_xContext;} 160*cdf0e10cSrcweir 161*cdf0e10cSrcweir }; 162*cdf0e10cSrcweir 163*cdf0e10cSrcweir //........................................................................ 164*cdf0e10cSrcweir } // namespace pcr 165*cdf0e10cSrcweir //........................................................................ 166*cdf0e10cSrcweir 167*cdf0e10cSrcweir #endif // EXTENSIONS_SOURCE_PROPCTRLR_PCROMPONENTCONTEXT_HXX 168*cdf0e10cSrcweir 169