/************************************************************************* * * OpenOffice.org - a multi-platform office productivity suite * * $RCSfile: jobdispatch.hxx,v $ * * $Revision: 1.4 $ * * last change: $Author: hr $ $Date: 2006-06-19 10:56:34 $ * * The Contents of this file are made available subject to * the terms of GNU Lesser General Public License Version 2.1. * * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2005 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * ************************************************************************/ #ifndef __FRAMEWORK_JOBS_JOBDISPATCH_HXX_ #define __FRAMEWORK_JOBS_JOBDISPATCH_HXX_ //_______________________________________ // my own includes #ifndef __FRAMEWORK_CONFIG_CONFIGACCESS_HXX_ #include #endif #ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_ #include #endif #ifndef __FRAMEWORK_MACROS_DEBUG_HXX_ #include #endif #ifndef __FRAMEWORK_STDTYPES_H_ #include #endif #ifndef __FRAMEWORK_GENERAL_H_ #include #endif //_______________________________________ // interface includes #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XNOTIFYINGDISPATCH_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XDISPATCH_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XSTATUSLISTENER_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XDISPATCHRESULTLISTENER_HPP_ #include #endif #ifndef _COM_SUN_STAR_TASK_XJOBLISTENER_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XTERMINATELISTENER_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDER_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_XDESKTOP_HPP_ #include #endif #ifndef _COM_SUN_STAR_UNO_XINTERFACE_HPP_ #include #endif #ifndef _COM_SUN_STAR_BEANS_NAMEDVALUE_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_FEATURESTATEEVENT_HPP_ #include #endif #ifndef _COM_SUN_STAR_FRAME_DISPATCHRESULTEVENT_HPP_ #include #endif #ifndef _COM_SUN_STAR_LANG_XINITIALIZATION_HPP_ #include #endif //_______________________________________ // other includes #ifndef UNOTOOLS_CONFIGPATHES_HXX_INCLUDED #include #endif #ifndef _CPPUHELPER_WEAK_HXX_ #include #endif #ifndef _RTL_USTRING_HXX_ #include #endif //_______________________________________ // namespace namespace framework{ //_______________________________________ // public const //_______________________________________ /** @short implements a dispatch object for jobs @descr Such dispatch object will be used by the generic dispatch mechanism if an URL "vnd.sun.star.job:alias=" occures. Then an instance of this class will be created and used. This new instance will be called within his method dispatch() or dispatchWithNotification() for executing the real job. We do it, control the life cycle of this internal wrapped job and inform any interested listener if it finish. */ class JobDispatch : public css::lang::XTypeProvider , public css::lang::XServiceInfo , public css::lang::XInitialization , public css::frame::XDispatchProvider , public css::frame::XNotifyingDispatch // => XDispatch , private ThreadHelpBase , public ::cppu::OWeakObject { //___________________________________ // member private: /** reference to the uno service manager */ css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR; /** reference to the frame, inside which this dispatch is used */ css::uno::Reference< css::frame::XFrame > m_xFrame; //___________________________________ // native interface methods public: JobDispatch( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ); virtual ~JobDispatch( ); void impl_dispatchEvent ( const ::rtl::OUString& sEvent , const css::uno::Sequence< css::beans::PropertyValue >& lArgs , const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ); void impl_dispatchService( const ::rtl::OUString& sService , const css::uno::Sequence< css::beans::PropertyValue >& lArgs , const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ); void impl_dispatchAlias ( const ::rtl::OUString& sAlias , const css::uno::Sequence< css::beans::PropertyValue >& lArgs , const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ); //___________________________________ // uno interface methods public: // XInterface, XTypeProvider, XServiceInfo FWK_DECLARE_XINTERFACE FWK_DECLARE_XTYPEPROVIDER DECLARE_XSERVICEINFO // Xinitialization virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& lArguments ) throw(css::uno::Exception , css::uno::RuntimeException); // XDispatchProvider virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch ( const css::util::URL& aURL , const ::rtl::OUString& sTargetFrameName , sal_Int32 nSearchFlags ) throw(css::uno::RuntimeException); virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw(css::uno::RuntimeException); // XNotifyingDispatch virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArgs , const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException); // XDispatch virtual void SAL_CALL dispatch ( const css::util::URL& aURL , const css::uno::Sequence< css::beans::PropertyValue >& lArgs ) throw(css::uno::RuntimeException); virtual void SAL_CALL addStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException); virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener , const css::util::URL& aURL ) throw(css::uno::RuntimeException); }; } // namespace framework #endif // __FRAMEWORK_JOBS_JOBDISPATCH_HXX_