svx/source/inc/formfeaturedispatcher.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SVX_FMDISPATCH_HXX
  21 #define SVX_FMDISPATCH_HXX
  22
  23 #include <com/sun/star/frame/XDispatch.hpp>
  24 #include <com/sun/star/lang/DisposedException.hpp>
  25 #include <com/sun/star/form/runtime/XFormOperations.hpp>
  26
  27 #include <cppuhelper/implbase1.hxx>
  28 #include <cppuhelper/interfacecontainer.hxx>
  29
  30 //........................................................................
  31 namespace svx
  32 {
  33 //........................................................................
  34
  35     //====================================================================
  36     //= OSingleFeatureDispatcher
  37     //====================================================================
  38     typedef ::cppu::WeakImplHelper1 <   ::com::sun::star::frame::XDispatch
  39                                     >   OSingleFeatureDispatcher_Base;
  40
  41     class OSingleFeatureDispatcher : public OSingleFeatureDispatcher_Base
  42     {
  43     private:
  44         ::osl::Mutex&                       m_rMutex;
  45         ::cppu::OInterfaceContainerHelper   m_aStatusListeners;
  46         ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >
  47                                             m_xFormOperations;
  48         const ::com::sun::star::util::URL   m_aFeatureURL;
  49         ::com::sun::star::uno::Any          m_aLastKnownState;
  50         const sal_Int16                     m_nFormFeature;
  51         sal_Bool                            m_bLastKnownEnabled;
  52         sal_Bool                            m_bDisposed;
  53
  54     public:
  55         /** constructs the dispatcher
  56
  57             @param _rFeatureURL
  58                 the URL of the feature which this instance is responsible for
  59
  60             @param _nFeatureId
  61                 the feature which this instance is responsible for
  62
  63             @param _rController
  64                 the controller which is responsible for providing the state of feature of this instance,
  65                 and for executing it. After disposing the dispatcher instance, the controller will
  66                 not be accessed anymore
  67
  68             @see dispose
  69         */
  70         OSingleFeatureDispatcher(
  71             const ::com::sun::star::util::URL& _rFeatureURL,
  72             const sal_Int16 _nFormFeature,
  73             const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >& _rxFormOperations,
  74             ::osl::Mutex& _rMutex
  75         );
  76
  77         /** notifies all our listeners of the current state
  78         */
  79         void    updateAllListeners();
  80
  81     protected:
  82         // XDispatch
  83         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);
  84         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);
  85         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);
  86
  87     protected:
  88         /** notifies our current state to one or all listeners
  89
  90             @param _rxListener
  91                 the listener to notify. May be NULL, in this case all our listeners will be
  92                 notified with the current state
  93
  94             @param _rFreeForNotification
  95                 a guard which currently locks our mutex, and which is to be cleared
  96                 for actually doing the notification(s)
  97         */
  98         void    notifyStatus(
  99                     const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxListener,
 100                     ::osl::ClearableMutexGuard& _rFreeForNotification
 101                 );
 102
 103     private:
 104         /** checks whether our instance is alive
 105
 106             If the instance already received a <member>dispose</member> call, then a
 107             <type scope="com::sun::star::lang">DisposedException</type> is thrown.
 108
 109             @precond
 110                 our Mutex is locked - else calling the method would not make sense, since
 111                 it's result could be out-of-date as soon as it's returned to the caller.
 112         */
 113         void    checkAlive() const SAL_THROW((::com::sun::star::lang::DisposedException));
 114
 115         /** retrieves the current status of our feature, in a format which can be used
 116             for UNO notifications
 117
 118             @precond
 119                 our mutex is locked
 120         */
 121         void    getUnoState( ::com::sun::star::frame::FeatureStateEvent& /* [out] */ _rState ) const;
 122     };
 123
 124 //........................................................................
 125 }   // namespace svx
 126 //........................................................................
 127
 128 #endif
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */