chart2/source/controller/main/FeatureCommandDispatchBase.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 #ifndef INCLUDED_CHART2_SOURCE_CONTROLLER_MAIN_FEATURECOMMANDDISPATCHBASE_HXX
  20 #define INCLUDED_CHART2_SOURCE_CONTROLLER_MAIN_FEATURECOMMANDDISPATCHBASE_HXX
  21
  22 #include "CommandDispatch.hxx"
  23
  24 #include <com/sun/star/frame/DispatchInformation.hpp>
  25
  26 namespace chart
  27 {
  28
  29 struct ControllerFeature: public css::frame::DispatchInformation
  30 {
  31     sal_uInt16 nFeatureId;
  32 };
  33
  34 typedef std::map< OUString,
  35                     ControllerFeature > SupportedFeatures;
  36
  37 struct FeatureState
  38 {
  39     bool bEnabled;
  40     css::uno::Any aState;
  41
  42     FeatureState() : bEnabled( false ) { }
  43 };
  44
  45 /** This is a base class for CommandDispatch implementations with feature support.
  46  */
  47 class FeatureCommandDispatchBase: public CommandDispatch
  48 {
  49 public:
  50     explicit FeatureCommandDispatchBase( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  51     virtual ~FeatureCommandDispatchBase() override;
  52
  53     // late initialisation, especially for adding as listener
  54     virtual void initialize() override;
  55
  56     virtual bool isFeatureSupported( const OUString& rCommandURL );
  57
  58 protected:
  59     // XDispatch
  60     virtual void SAL_CALL dispatch( const css::util::URL& URL,
  61         const css::uno::Sequence< css::beans::PropertyValue >& Arguments ) override;
  62
  63     virtual void fireStatusEvent( const OUString& rURL,
  64         const css::uno::Reference< css::frame::XStatusListener >& xSingleListener ) override;
  65
  66     // state of a feature
  67     virtual FeatureState getState( const OUString& rCommand ) = 0;
  68
  69     // execute a feature
  70     virtual void execute( const OUString& rCommand, const css::uno::Sequence< css::beans::PropertyValue>& rArgs ) = 0;
  71
  72     // all the features which should be handled by this class
  73     virtual void describeSupportedFeatures() = 0;
  74
  75     /** describes a feature supported by the controller
  76
  77         Must not be called outside <member>describeSupportedFeatures</member>.
  78
  79         @param pAsciiCommandURL
  80             the URL of the feature command
  81         @param nId
  82             the id of the feature. Later references to this feature usually happen by id, not by
  83             URL.
  84         @param nGroup
  85             the command group of the feature. This is important for configuring the controller UI
  86             by the user, see also <type scope="css::frame">CommandGroup</type>.
  87     */
  88     void implDescribeSupportedFeature( const sal_Char* pAsciiCommandURL, sal_uInt16 nId,
  89         sal_Int16 nGroup );
  90
  91     mutable SupportedFeatures m_aSupportedFeatures;
  92
  93     sal_uInt16 m_nFeatureId;
  94 };
  95
  96 } //  namespace chart
  97
  98 // INCLUDED_CHART2_SOURCE_CONTROLLER_MAIN_FEATURECOMMANDDISPATCHBASE_HXX
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */