svx/source/inc/fmtextcontrolfeature.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
  30 #define SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
  31
  32 /** === begin UNO includes === **/
  33 #include <com/sun/star/beans/PropertyValue.hpp>
  34 #include <com/sun/star/frame/XDispatch.hpp>
  35 #include <com/sun/star/frame/XStatusListener.hpp>
  36 #include <com/sun/star/util/URL.hpp>
  37 /** === end UNO includes === **/
  38 #include <cppuhelper/implbase1.hxx>
  39 #include "fmslotinvalidator.hxx"
  40
  41 //........................................................................
  42 namespace svx
  43 {
  44 //........................................................................
  45
  46     //====================================================================
  47     //= FmTextControlFeature
  48     //====================================================================
  49     typedef ::cppu::WeakImplHelper1 <   ::com::sun::star::frame::XStatusListener
  50                                     >   FmTextControlFeature_Base;
  51
  52     class FmTextControlFeature : public FmTextControlFeature_Base
  53     {
  54     private:
  55         ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch >
  56                                         m_xDispatcher;
  57         ::com::sun::star::util::URL     m_aFeatureURL;
  58         ::com::sun::star::uno::Any      m_aFeatureState;
  59         SfxSlotId                       m_nSlotId;
  60         ISlotInvalidator*               m_pInvalidator;
  61         bool                            m_bFeatureEnabled;
  62
  63     public:
  64         /** constructs an FmTextControlFeature object
  65         @param _rxDispatcher
  66             the dispatcher which the instance should work with
  67         @param _rFeatureURL
  68             the URL which the instance should be responsible for
  69         */
  70         FmTextControlFeature(
  71             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch >& _rxDispatcher,
  72             const ::com::sun::star::util::URL& _rFeatureURL,
  73             SfxSlotId _nId,
  74             ISlotInvalidator* _pInvalidator
  75         );
  76
  77         /// determines whether the feature we're responsible for is currently enabled
  78         inline  bool                                isFeatureEnabled( ) const { return m_bFeatureEnabled; }
  79         inline  const ::com::sun::star::uno::Any&   getFeatureState( ) const { return m_aFeatureState; }
  80
  81         /** dispatches the feature URL to the dispatcher
  82         */
  83         void    dispatch() const SAL_THROW(());
  84
  85         /** dispatches the feature URL to the dispatcher, with passing the given arguments
  86         */
  87         void    dispatch( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArgs ) const SAL_THROW(());
  88
  89         /// releases any resources associated with this instance
  90         void    dispose() SAL_THROW(());
  91
  92     protected:
  93         ~FmTextControlFeature();
  94
  95     protected:
  96         // XStatusListener
  97         virtual void SAL_CALL statusChanged( const ::com::sun::star::frame::FeatureStateEvent& State ) throw (::com::sun::star::uno::RuntimeException);
  98         virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
  99     };
 100
 101 //........................................................................
 102 } // namespace svx
 103 //........................................................................
 104
 105 #endif // SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */