formnavigation.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
 
#pragma once
 
#include <com/sun/star/frame/XDispatchProviderInterception.hpp>
#include <com/sun/star/frame/XStatusListener.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <cppuhelper/implbase2.hxx>
#include "featuredispatcher.hxx"
#include "controlfeatureinterception.hxx"
#include <vector>
#include <map>
#include <memory>
 
 
namespace frm
{
 
 
    class UrlTransformer;
 
 
    //= OFormNavigationHelper
 
    typedef ::cppu::ImplHelper2 <   css::frame::XDispatchProviderInterception
                                ,   css::frame::XStatusListener
                                >   OFormNavigationHelper_Base;
 
    class OFormNavigationHelper
                        :public OFormNavigationHelper_Base
                        ,public IFeatureDispatcher
    {
    private:
        struct FeatureInfo
        {
            css::util::URL                                             aURL;
            css::uno::Reference< css::frame::XDispatch >               xDispatcher;
            bool                                                       bCachedState;
            css::uno::Any                                              aCachedAdditionalState;
 
            FeatureInfo() : bCachedState( false ) { }
        };
        typedef ::std::map< sal_Int16, FeatureInfo >    FeatureMap;
 
    private:
        css::uno::Reference< css::uno::XComponentContext >
                            m_xORB;
        ControlFeatureInterception
                            m_aFeatureInterception;
 
        // all supported features
        FeatureMap          m_aSupportedFeatures;
        // all features which we have an external dispatcher for
        sal_Int32           m_nConnectedFeatures;
 
    protected:
        OFormNavigationHelper( const css::uno::Reference< css::uno::XComponentContext >& _rxORB );
        virtual ~OFormNavigationHelper();
 
        // XComponent
        void dispose(  );
 
        // XDispatchProviderInterception
        virtual void SAL_CALL registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor ) override;
        virtual void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor ) override;
 
        // XStatusListener
        virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& State ) override;
 
        // XEventListener
        virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
 
        // IFeatureDispatcher
        virtual void            dispatch( sal_Int16 _nFeatureId ) const override;
        virtual void            dispatchWithArgument( sal_Int16 _nFeatureId, const char* _pParamName, const css::uno::Any& _rParamValue ) const override;
        virtual bool            isEnabled( sal_Int16 _nFeatureId ) const override;
        virtual bool            getBooleanState( sal_Int16 _nFeatureId ) const override;
        virtual OUString getStringState( sal_Int16 _nFeatureId ) const override;
        virtual sal_Int32       getIntegerState( sal_Int16 _nFeatureId ) const override;
 
        // own overridables
        virtual void    interceptorsChanged( );
 
        virtual void    featureStateChanged( sal_Int16 _nFeatureId, bool _bEnabled );
 
        virtual void    allFeatureStatesChanged( );
 
        virtual void    getSupportedFeatures( ::std::vector< sal_Int16 >& /* [out] */ _rFeatureIds ) = 0;
 
    protected:
        void    updateDispatches();
 
        void    connectDispatchers();
 
        void    disconnectDispatchers();
 
        css::uno::Reference< css::frame::XDispatch >
                queryDispatch( const css::util::URL& _rURL );
 
        void    invalidateSupportedFeaturesSet();
 
    private:
        void    initializeSupportedFeatures();
    };
 
    class OFormNavigationMapper
    {
    private:
        ::std::unique_ptr< UrlTransformer >   m_pUrlTransformer;
 
    public:
        OFormNavigationMapper(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB
        );
        ~OFormNavigationMapper( );
 
        static const char* getFeatureURLAscii( sal_Int16 _nFeatureId );
 
        bool        getFeatureURL( sal_Int16 _nFeatureId, css::util::URL& /* [out] */ _rURL );
 
        static sal_Int16 getFeatureId( std::u16string_view _rCompleteURL );
 
    private:
        OFormNavigationMapper( const OFormNavigationMapper& ) = delete;
        OFormNavigationMapper& operator=( const OFormNavigationMapper& ) = delete;
    };
 
 
}   // namespace frm
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */