1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef FORMS_SOLAR_DISPATCHER_HXX 29*cdf0e10cSrcweir #define FORMS_SOLAR_DISPATCHER_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <rtl/ustring.hxx> 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir //......................................................................... 34*cdf0e10cSrcweir namespace frm 35*cdf0e10cSrcweir { 36*cdf0e10cSrcweir //......................................................................... 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir //========================================================================= 39*cdf0e10cSrcweir //= IFeatureDispatcher 40*cdf0e10cSrcweir //========================================================================= 41*cdf0e10cSrcweir class IFeatureDispatcher 42*cdf0e10cSrcweir { 43*cdf0e10cSrcweir public: 44*cdf0e10cSrcweir /** dispatches a feature 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir @param _nFeatureId 47*cdf0e10cSrcweir the id of the feature to dispatch 48*cdf0e10cSrcweir */ 49*cdf0e10cSrcweir virtual void dispatch( sal_Int16 _nFeatureId ) const = 0; 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir /** dispatches a feature, with an additional named parameter 52*cdf0e10cSrcweir 53*cdf0e10cSrcweir @param _nFeatureId 54*cdf0e10cSrcweir the id of the feature to dispatch 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir @param _pParamAsciiName 57*cdf0e10cSrcweir the Ascii name of the parameter of the dispatch call 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir @param _rParamValue 60*cdf0e10cSrcweir the value of the parameter of the dispatch call 61*cdf0e10cSrcweir */ 62*cdf0e10cSrcweir virtual void dispatchWithArgument( 63*cdf0e10cSrcweir sal_Int16 _nFeatureId, 64*cdf0e10cSrcweir const sal_Char* _pParamName, 65*cdf0e10cSrcweir const ::com::sun::star::uno::Any& _rParamValue 66*cdf0e10cSrcweir ) const = 0; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir /** checks whether a given feature is enabled 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir virtual bool isEnabled( sal_Int16 _nFeatureId ) const = 0; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** returns the boolean state of a feature 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir Certain features may support more status information than only the enabled/disabled 75*cdf0e10cSrcweir state. The type of such additional information is fixed relative to a given feature, but 76*cdf0e10cSrcweir may differ between different features. 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir This method allows retrieving status information about features which have an additional 79*cdf0e10cSrcweir boolean information associated with it. 80*cdf0e10cSrcweir */ 81*cdf0e10cSrcweir virtual bool getBooleanState( sal_Int16 _nFeatureId ) const = 0; 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir /** returns the string state of a feature 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir Certain features may support more status information than only the enabled/disabled 86*cdf0e10cSrcweir state. The type of such additional information is fixed relative to a given feature, but 87*cdf0e10cSrcweir may differ between different features. 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir This method allows retrieving status information about features which have an additional 90*cdf0e10cSrcweir string information associated with it. 91*cdf0e10cSrcweir */ 92*cdf0e10cSrcweir virtual ::rtl::OUString getStringState( sal_Int16 _nFeatureId ) const = 0; 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir /** returns the integer state of a feature 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir Certain features may support more status information than only the enabled/disabled 97*cdf0e10cSrcweir state. The type of such additional information is fixed relative to a given feature, but 98*cdf0e10cSrcweir may differ between different features. 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir This method allows retrieving status information about features which have an additional 101*cdf0e10cSrcweir integer information associated with it. 102*cdf0e10cSrcweir */ 103*cdf0e10cSrcweir virtual sal_Int32 getIntegerState( sal_Int16 _nFeatureId ) const = 0; 104*cdf0e10cSrcweir }; 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir //......................................................................... 107*cdf0e10cSrcweir } // namespace frm 108*cdf0e10cSrcweir //......................................................................... 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir #endif // FORMS_SOLAR_DISPATCHER_HXX 111