richtextimplcontrol.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 "rtattributehandler.hxx"
#include "richtextviewport.hxx"
#include "richtextengine.hxx"
#include <svtools/scrolladaptor.hxx>
#include <editeng/editdata.hxx>
 
#include <map>
 
class EditView;
class EditStatus;
namespace vcl { class Window; }
class SvxScriptSetItem;
 
namespace frm
{
 
 
    class ITextAttributeListener;
    class ITextSelectionListener;
    class RichTextViewPort;
 
    class RichTextControlImpl : public IEngineStatusListener
    {
        typedef ::std::map< AttributeId, AttributeState >                           StateCache;
        typedef ::std::map< AttributeId, ::rtl::Reference< AttributeHandler > >    AttributeHandlerPool;
        typedef ::std::map< AttributeId, ITextAttributeListener* >                  AttributeListenerPool;
 
        StateCache              m_aLastKnownStates;
        AttributeHandlerPool    m_aAttributeHandlers;
        AttributeListenerPool   m_aAttributeListeners;
 
        ESelection              m_aLastKnownSelection;
 
        VclPtr<Control>                m_pAntiImpl;
        VclPtr<RichTextViewPort>       m_pViewport;
        VclPtr<ScrollAdaptor>          m_pHScroll;
        VclPtr<ScrollAdaptor>          m_pVScroll;
        RichTextEngine*         m_pEngine;
        std::unique_ptr<EditView> m_pView;
        ITextAttributeListener* m_pTextAttrListener;
        ITextSelectionListener* m_pSelectionListener;
        bool                    m_bHasEverBeenShown;
 
    public:
        struct GrantAccess { friend class RichTextControl; private: GrantAccess() { } };
        EditView*        getView( const GrantAccess& ) const     { return m_pView.get(); }
        RichTextEngine*  getEngine( const GrantAccess& ) const   { return m_pEngine; }
        vcl::Window*          getViewport( const GrantAccess& ) const { return m_pViewport; }
 
    public:
        RichTextControlImpl( Control* _pAntiImpl, RichTextEngine* _pEngine,
            ITextAttributeListener* _pTextAttrListener, ITextSelectionListener* _pSelectionListener );
        virtual ~RichTextControlImpl();
 
        void    updateAllAttributes( );
 
        void    updateAttribute( AttributeId _nAttribute );
 
        void    enableAttributeNotification( AttributeId _nAttributeId, ITextAttributeListener* _pListener );
 
        void    disableAttributeNotification( AttributeId _nAttributeId );
 
        bool    executeAttribute( const SfxItemSet& _rCurrentAttribs, SfxItemSet& _rNewAttribs, AttributeId _nAttribute, const SfxPoolItem* _pArgument, SvtScriptType _nForScriptType );
 
        AttributeState  getAttributeState( AttributeId _nAttributeId ) const;
 
        void        normalizeScriptDependentAttribute( SvxScriptSetItem& _rScriptSetItem );
 
        // gets the script type of the selection in our edit view (with fallback)
        SvtScriptType  getSelectedScriptType() const;
 
        void    layoutWindow();
 
        void    notifyStyleChanged();
 
        void    notifyZoomChanged();
 
        void    notifyInitShow();
 
        // VCL "overrides"
        void    SetBackgroundColor( );
        void    SetBackgroundColor( const Color& _rColor );
 
        void    SetReadOnly( bool _bReadOnly );
        bool    IsReadOnly() const;
 
        void    SetHideInactiveSelection( bool _bHide );
        bool    GetHideInactiveSelection() const;
 
        void    Draw( OutputDevice* _pDev, const Point& _rPos, const Size& _rSize );
 
        bool    HandleCommand( const CommandEvent& _rEvent );
 
    private:
        // updates the cache with the state provided by the given attribute handler
        void    implUpdateAttribute( const AttributeHandlerPool::const_iterator& _pHandler );
 
        // updates the cache with the given state, and calls listeners (if necessary)
        void    implCheckUpdateCache( AttributeId _nAttribute, const AttributeState& _rState );
 
        // updates range and position of our scrollbars
        void    updateScrollbars();
 
        // determines whether automatic (soft) line breaks are ON
        bool    windowHasAutomaticLineBreak();
 
        void    ensureScrollbars();
 
        void    ensureLineBreakSetting();
 
        bool    hasVScrollBar( ) const { return m_pVScroll != nullptr; }
        bool    hasHScrollBar( ) const { return m_pHScroll != nullptr; }
 
        // IEngineStatusListener overridables
        virtual void EditEngineStatusChanged( const EditStatus& _rStatus ) override;
 
    private:
        DECL_LINK( OnInvalidateAllAttributes, LinkParamNone*, void );
        DECL_LINK( OnHScroll, weld::Scrollbar&, void );
        DECL_LINK( OnVScroll, weld::Scrollbar&, void );
    };
 
 
} // namespace frm
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */