blob: 4d11df03843e39fadfbd2731e4df5a17af7842ec [file] [log] [blame]
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef __FRAMEWORK_SERVICES_DISPATCHHELPER_HXX_
#define __FRAMEWORK_SERVICES_DISPATCHHELPER_HXX_
//_______________________________________________
// my own includes
#include <threadhelp/threadhelpbase.hxx>
#include <macros/generic.hxx>
#include <macros/debug.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <macros/xserviceinfo.hxx>
#include <general.h>
//_______________________________________________
// interface includes
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/frame/XDispatchHelper.hpp>
#include <com/sun/star/frame/XDispatchResultListener.hpp>
#include <com/sun/star/frame/DispatchResultEvent.hpp>
//_______________________________________________
// other includes
#include <cppuhelper/implbase3.hxx>
#include <osl/conditn.hxx>
//_______________________________________________
// 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 ThreadHelpBase // must be the first base class!
,public ::cppu::WeakImplHelper3< ::com::sun::star::lang::XServiceInfo,::com::sun::star::frame::XDispatchHelper,::com::sun::star::frame::XDispatchResultListener >
{
//-------------------------------------------
// 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
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