navtoolbar.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 <svtools/recorditemwindow.hxx>
#include <memory>
 
namespace frm
{
    class IFeatureDispatcher;
    class DocumentCommandImageProvider;
    class ICommandDescriptionProvider;
    class ImplNavToolBar;
    typedef std::shared_ptr< const DocumentCommandImageProvider >  PCommandImageProvider;
 
    class NavigationToolBar final : public vcl::Window
    {
    public:
        enum ImageSize
        {
            eSmall,
            eLarge
        };
 
        enum FunctionGroup
        {
            ePosition,
            eNavigation,
            eRecordActions,
            eFilterSort
        };
 
    private:
        const IFeatureDispatcher*       m_pDispatcher;
        const std::shared_ptr< const DocumentCommandImageProvider >
                                        m_pImageProvider;
        ImageSize                       m_eImageSize;
        VclPtr<ImplNavToolBar>          m_pToolbar;
        ::std::vector< VclPtr<vcl::Window> > m_aChildWins;
        const OUString                  m_sModuleId;
 
    public:
        NavigationToolBar(
            vcl::Window* _pParent,
            WinBits _nStyle,
            PCommandImageProvider _pImageProvider,
            OUString sModuleId
        );
        virtual ~NavigationToolBar( ) override;
        virtual void dispose() override;
 
        void    setDispatcher( const IFeatureDispatcher* _pDispatcher );
 
        void    enableFeature( sal_Int16 _nFeatureId, bool _bEnabled );
 
        void    checkFeature( sal_Int16 _nFeatureId, bool _bEnabled );
 
        void    setFeatureText( sal_Int16 _nFeatureId, const OUString& _rText );
 
        ImageSize    GetImageSize( ) const { return m_eImageSize; }
 
        void                SetImageSize( ImageSize _eSize );
 
        void                ShowFunctionGroup( FunctionGroup _eGroup, bool _bShow );
 
        bool                IsFunctionGroupVisible( FunctionGroup _eGroup );
 
        // Window "overridables" (hiding the respective Window methods)
        void                SetControlBackground();
        void                SetControlBackground( const Color& rColor );
        void                SetTextLineColor( );
        void                SetTextLineColor( const Color& rColor );
 
    private:
        // Window overridables
        virtual void        Resize() override;
        virtual void        StateChanged( StateChangedType nType ) override;
 
        void implInit( );
 
        void    implSetImageSize( ImageSize _eSize );
 
        void    implUpdateImages();
 
        void implEnableItem( sal_uInt16 _nItemId, bool _bEnabled );
 
        // iterating through item windows
        typedef void (NavigationToolBar::*ItemWindowHandler) (sal_uInt16, vcl::Window*) const;
        void    forEachItemWindow( ItemWindowHandler _handler );
        typedef void (*ItemWindowHandler2) (sal_uInt16, vcl::Window*, const void*);
        void    forEachItemWindow( ItemWindowHandler2 _handler, const void* _pParam );
 
        static void setItemBackground( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow, const void* _pColor );
        static void setTextLineColor( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow, const void* _pColor );
#if 0
        void setItemWindowZoom( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow, const void* /* _pParam */ ) const;
#endif
        void setItemControlFont( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow ) const;
        void setItemControlForeground( sal_uInt16 /* _nItemId */, vcl::Window* _pItemWindow ) const;
        void adjustItemWindowWidth( sal_uInt16 _nItemId, vcl::Window* _pItemWindow ) const;
        static void enableItemRTL( sal_uInt16 /*_nItemId*/, vcl::Window* _pItemWindow, const void* _pIsRTLEnabled );
    };
 
    class RecordPositionInput final : public RecordItemWindow
    {
    private:
        const IFeatureDispatcher*   m_pDispatcher;
 
    public:
        RecordPositionInput( vcl::Window* _pParent );
 
        void    setDispatcher( const IFeatureDispatcher* _pDispatcher );
 
    private:
        virtual void PositionFired(sal_Int64 nRecord) override;
    };
 
}   // namespace frm
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */