| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef CHART2_FEATURECOMMANDDISPATCHBASE_HXX |
| #define CHART2_FEATURECOMMANDDISPATCHBASE_HXX |
| |
| #include "CommandDispatch.hxx" |
| |
| #include <com/sun/star/frame/CommandGroup.hpp> |
| #include <com/sun/star/frame/DispatchInformation.hpp> |
| #include <com/sun/star/util/URL.hpp> |
| |
| namespace chart |
| { |
| |
| struct ControllerFeature: public ::com::sun::star::frame::DispatchInformation |
| { |
| sal_uInt16 nFeatureId; |
| }; |
| |
| typedef ::std::map< ::rtl::OUString, |
| ControllerFeature, |
| ::std::less< ::rtl::OUString > > SupportedFeatures; |
| |
| struct FeatureState |
| { |
| bool bEnabled; |
| ::com::sun::star::uno::Any aState; |
| |
| FeatureState() : bEnabled( false ) { } |
| }; |
| |
| /** This is a base class for CommandDispatch implementations with feature support. |
| */ |
| class FeatureCommandDispatchBase: public CommandDispatch |
| { |
| public: |
| FeatureCommandDispatchBase( const ::com::sun::star::uno::Reference< |
| ::com::sun::star::uno::XComponentContext >& rxContext ); |
| virtual ~FeatureCommandDispatchBase(); |
| |
| // late initialisation, especially for adding as listener |
| virtual void initialize(); |
| |
| virtual bool isFeatureSupported( const ::rtl::OUString& rCommandURL ); |
| |
| protected: |
| // XDispatch |
| virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& URL, |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& Arguments ) |
| throw (::com::sun::star::uno::RuntimeException); |
| |
| virtual void fireStatusEvent( const ::rtl::OUString& rURL, |
| const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& xSingleListener ); |
| |
| // state of a feature |
| virtual FeatureState getState( const ::rtl::OUString& rCommand ) = 0; |
| |
| // execute a feature |
| virtual void execute( const ::rtl::OUString& rCommand, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& rArgs ) = 0; |
| |
| // all the features which should be handled by this class |
| virtual void describeSupportedFeatures() = 0; |
| |
| /** describes a feature supported by the controller |
| |
| Must not be called outside <member>describeSupportedFeatures</member>. |
| |
| @param pAsciiCommandURL |
| the URL of the feature command |
| @param nId |
| the id of the feature. Later references to this feature usually happen by id, not by |
| URL. |
| @param nGroup |
| the command group of the feature. This is important for configuring the controller UI |
| by the user, see also <type scope="com::sun::star::frame">CommandGroup</type>. |
| */ |
| void implDescribeSupportedFeature( const sal_Char* pAsciiCommandURL, sal_uInt16 nId, |
| sal_Int16 nGroup = ::com::sun::star::frame::CommandGroup::INTERNAL ); |
| |
| mutable SupportedFeatures m_aSupportedFeatures; |
| |
| sal_uInt16 m_nFeatureId; |
| |
| private: |
| void fillSupportedFeatures(); |
| }; |
| |
| } // namespace chart |
| |
| // CHART2_FEATURECOMMANDDISPATCHBASE_HXX |
| #endif |