office-gobmx/svx/source/inc/fmtextcontrolfeature.hxx
2011-03-29 21:40:28 +01:00

107 lines
4.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
#define SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
/** === begin UNO includes === **/
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/util/URL.hpp>
/** === end UNO includes === **/
#include <cppuhelper/implbase1.hxx>
#include "fmslotinvalidator.hxx"
//........................................................................
namespace svx
{
//........................................................................
//====================================================================
//= FmTextControlFeature
//====================================================================
typedef ::cppu::WeakImplHelper1 < ::com::sun::star::frame::XStatusListener
> FmTextControlFeature_Base;
class FmTextControlFeature : public FmTextControlFeature_Base
{
private:
::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch >
m_xDispatcher;
::com::sun::star::util::URL m_aFeatureURL;
::com::sun::star::uno::Any m_aFeatureState;
SfxSlotId m_nSlotId;
ISlotInvalidator* m_pInvalidator;
bool m_bFeatureEnabled;
public:
/** constructs an FmTextControlFeature object
@param _rxDispatcher
the dispatcher which the instance should work with
@param _rFeatureURL
the URL which the instance should be responsible for
*/
FmTextControlFeature(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch >& _rxDispatcher,
const ::com::sun::star::util::URL& _rFeatureURL,
SfxSlotId _nId,
ISlotInvalidator* _pInvalidator
);
/// determines whether the feature we're responsible for is currently enabled
inline bool isFeatureEnabled( ) const { return m_bFeatureEnabled; }
inline const ::com::sun::star::uno::Any& getFeatureState( ) const { return m_aFeatureState; }
/** dispatches the feature URL to the dispatcher
*/
void dispatch() const SAL_THROW(());
/** dispatches the feature URL to the dispatcher, with passing the given arguments
*/
void dispatch( const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArgs ) const SAL_THROW(());
/// releases any resources associated with this instance
void dispose() SAL_THROW(());
protected:
~FmTextControlFeature();
protected:
// XStatusListener
virtual void SAL_CALL statusChanged( const ::com::sun::star::frame::FeatureStateEvent& State ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
};
//........................................................................
} // namespace svx
//........................................................................
#endif // SVX_SOURCE_INC_FMTEXTCONTROLFEATURE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */