187 lines
6 KiB
C++
187 lines
6 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: dispatchhelper.hxx,v $
|
|
*
|
|
* $Revision: 1.4 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2006-06-19 10:58:47 $
|
|
*
|
|
* 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_SERVICES_DISPATCHHELPER_HXX_
|
|
#define __FRAMEWORK_SERVICES_DISPATCHHELPER_HXX_
|
|
|
|
//_______________________________________________
|
|
// my own includes
|
|
|
|
#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
|
|
#include <threadhelp/threadhelpbase.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
|
|
#include <macros/generic.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
|
|
#include <macros/debug.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
|
|
#include <macros/xinterface.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
|
|
#include <macros/xtypeprovider.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
|
|
#include <macros/xserviceinfo.hxx>
|
|
#endif
|
|
|
|
#ifndef __FRAMEWORK_GENERAL_H_
|
|
#include <general.h>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// interface includes
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
|
|
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHHELPER_HPP_
|
|
#include <com/sun/star/frame/XDispatchHelper.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHRESULTLISTENER_HPP_
|
|
#include <com/sun/star/frame/XDispatchResultListener.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_FRAME_DISPATCHRESULTEVENT_HPP_
|
|
#include <com/sun/star/frame/DispatchResultEvent.hpp>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// other includes
|
|
|
|
#ifndef _CPPUHELPER_WEAK_HXX_
|
|
#include <cppuhelper/weak.hxx>
|
|
#endif
|
|
|
|
#ifndef _OSL_CONDITN_HXX_
|
|
#include <osl/conditn.hxx>
|
|
#endif
|
|
|
|
//_______________________________________________
|
|
// namespace
|
|
|
|
namespace framework{
|
|
|
|
//_______________________________________________
|
|
// exported const
|
|
|
|
//_______________________________________________
|
|
// exported definitions
|
|
|
|
/**
|
|
@short implements an easy way for dispatches
|
|
@descr Dispatches are splitted into different parts:
|
|
- parsing of the URL
|
|
- searching for a dispatcgh object
|
|
- dispatching of the URL
|
|
All these steps are done inside one method call here.
|
|
*/
|
|
|
|
class DispatchHelper : public css::lang::XTypeProvider
|
|
, public css::lang::XServiceInfo
|
|
, public css::frame::XDispatchHelper
|
|
, public css::frame::XDispatchResultListener // => XEventListener
|
|
, public ThreadHelpBase // must be the first base class!
|
|
, public ::cppu::OWeakObject // => XInterface, XWeak
|
|
{
|
|
|
|
//-------------------------------------------
|
|
// member
|
|
|
|
private:
|
|
|
|
/** global uno service manager.
|
|
Can be used to create own needed services. */
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
|
|
|
|
/** used to wait for asynchronous listener callbacks. */
|
|
::osl::Condition m_aBlock;
|
|
|
|
css::uno::Any m_aResult;
|
|
|
|
css::uno::Reference< css::uno::XInterface > m_xBroadcaster;
|
|
|
|
//-------------------------------------------
|
|
// interface
|
|
|
|
public:
|
|
|
|
//---------------------------------------
|
|
// ctor/dtor
|
|
|
|
DispatchHelper( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR );
|
|
virtual ~DispatchHelper( );
|
|
|
|
//---------------------------------------
|
|
// XInterface, XTypeProvider, XServiceInfo
|
|
|
|
FWK_DECLARE_XINTERFACE
|
|
FWK_DECLARE_XTYPEPROVIDER
|
|
DECLARE_XSERVICEINFO
|
|
|
|
//---------------------------------------
|
|
// XDispatchHelper
|
|
virtual css::uno::Any SAL_CALL executeDispatch(
|
|
const css::uno::Reference< css::frame::XDispatchProvider >& xDispatchProvider ,
|
|
const ::rtl::OUString& sURL ,
|
|
const ::rtl::OUString& sTargetFrameName ,
|
|
sal_Int32 nSearchFlags ,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments )
|
|
throw(css::uno::RuntimeException);
|
|
|
|
//---------------------------------------
|
|
// XDispatchResultListener
|
|
virtual void SAL_CALL dispatchFinished(
|
|
const css::frame::DispatchResultEvent& aResult )
|
|
throw(css::uno::RuntimeException);
|
|
|
|
//---------------------------------------
|
|
// XEventListener
|
|
virtual void SAL_CALL disposing(
|
|
const css::lang::EventObject& aEvent )
|
|
throw(css::uno::RuntimeException);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|