Change-Id: I5399362056276f324fd43eda05d3f606dc6f8c71 Reviewed-on: https://gerrit.libreoffice.org/11011 Reviewed-by: Noel Grandin <noelgrandin@gmail.com> Tested-by: Noel Grandin <noelgrandin@gmail.com>
127 lines
5.3 KiB
C++
127 lines
5.3 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* 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 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_SVX_SOURCE_INC_FORMFEATUREDISPATCHER_HXX
|
|
#define INCLUDED_SVX_SOURCE_INC_FORMFEATUREDISPATCHER_HXX
|
|
|
|
#include <com/sun/star/frame/XDispatch.hpp>
|
|
#include <com/sun/star/lang/DisposedException.hpp>
|
|
#include <com/sun/star/form/runtime/XFormOperations.hpp>
|
|
|
|
#include <cppuhelper/implbase1.hxx>
|
|
#include <cppuhelper/interfacecontainer.hxx>
|
|
|
|
|
|
namespace svx
|
|
{
|
|
|
|
typedef ::cppu::WeakImplHelper1 < ::com::sun::star::frame::XDispatch
|
|
> OSingleFeatureDispatcher_Base;
|
|
|
|
class OSingleFeatureDispatcher : public OSingleFeatureDispatcher_Base
|
|
{
|
|
private:
|
|
::osl::Mutex& m_rMutex;
|
|
::cppu::OInterfaceContainerHelper m_aStatusListeners;
|
|
::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >
|
|
m_xFormOperations;
|
|
const ::com::sun::star::util::URL m_aFeatureURL;
|
|
::com::sun::star::uno::Any m_aLastKnownState;
|
|
const sal_Int16 m_nFormFeature;
|
|
bool m_bLastKnownEnabled;
|
|
bool m_bDisposed;
|
|
|
|
public:
|
|
/** constructs the dispatcher
|
|
|
|
@param _rFeatureURL
|
|
the URL of the feature which this instance is responsible for
|
|
|
|
@param _nFeatureId
|
|
the feature which this instance is responsible for
|
|
|
|
@param _rController
|
|
the controller which is responsible for providing the state of feature of this instance,
|
|
and for executing it. After disposing the dispatcher instance, the controller will
|
|
not be accessed anymore
|
|
|
|
@see dispose
|
|
*/
|
|
OSingleFeatureDispatcher(
|
|
const ::com::sun::star::util::URL& _rFeatureURL,
|
|
const sal_Int16 _nFormFeature,
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >& _rxFormOperations,
|
|
::osl::Mutex& _rMutex
|
|
);
|
|
|
|
/** notifies all our listeners of the current state
|
|
*/
|
|
void updateAllListeners();
|
|
|
|
protected:
|
|
// XDispatch
|
|
virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& _rURL, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArguments ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
virtual void SAL_CALL addStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
virtual void SAL_CALL removeStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
protected:
|
|
/** notifies our current state to one or all listeners
|
|
|
|
@param _rxListener
|
|
the listener to notify. May be NULL, in this case all our listeners will be
|
|
notified with the current state
|
|
|
|
@param _rFreeForNotification
|
|
a guard which currently locks our mutex, and which is to be cleared
|
|
for actually doing the notification(s)
|
|
*/
|
|
void notifyStatus(
|
|
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxListener,
|
|
::osl::ClearableMutexGuard& _rFreeForNotification
|
|
);
|
|
|
|
private:
|
|
/** checks whether our instance is alive
|
|
|
|
If the instance already received a <member>dispose</member> call, then a
|
|
<type scope="com::sun::star::lang">DisposedException</type> is thrown.
|
|
|
|
@precond
|
|
our Mutex is locked - else calling the method would not make sense, since
|
|
its result could be out-of-date as soon as it's returned to the caller.
|
|
*/
|
|
void checkAlive() const;
|
|
|
|
/** retrieves the current status of our feature, in a format which can be used
|
|
for UNO notifications
|
|
|
|
@precond
|
|
our mutex is locked
|
|
*/
|
|
void getUnoState( ::com::sun::star::frame::FeatureStateEvent& /* [out] */ _rState ) const;
|
|
};
|
|
|
|
|
|
} // namespace svx
|
|
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|