viewimp.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 .
 */
#ifndef INCLUDED_SW_SOURCE_CORE_INC_VIEWIMP_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_VIEWIMP_HXX
 
#include <tools/color.hxx>
#include <svx/svdtypes.hxx>
#include <swrect.hxx>
#include <swregion.hxx>
#include <memory>
#include <optional>
#include <vector>
 
class OutputDevice;
class SwViewShell;
class SwFlyFrame;
class SwViewOption;
class SwFrame;
class SwLayAction;
class SwLayIdle;
class SwDrawView;
class SdrPageView;
class SwPageFrame;
class SwAccessibleMap;
class SdrObject;
class Fraction;
class SwPrintData;
class SwPagePreviewLayout;
struct PreviewPage;
class SwTextFrame;
// --> OD #i76669#
namespace sdr::contact { class ViewObjectContactRedirector; }
// <--
 
class SwViewShellImp
{
    friend class SwViewShell;
 
    friend class SwLayAction;   // Lay- and IdleAction register and deregister
    friend class SwLayIdle;
 
    // for paint of page preview
    friend class SwPagePreviewLayout;
 
    SwViewShell *m_pShell;           // If someone passes an Imp, but needs a SwViewShell, we
                                // keep a backlink here
 
    std::unique_ptr<SwDrawView> m_pDrawView; // Our DrawView
    SdrPageView *m_pSdrPageView;  // Exactly one Page for our DrawView
 
    SwPageFrame     *m_pFirstVisiblePage; // Always points to the first visible Page
    std::optional<SwRegionRects> m_oPaintRegion; // Collector of Paintrects from the LayAction
 
    std::vector<SwRect> m_pendingLOKInvalidations;
 
    SwLayAction   *m_pLayAction;      // Is set if an Action object exists
                                 // Is registered by the SwLayAction ctor and deregistered by the dtor
    SwLayIdle     *m_pIdleAct;     // The same as SwLayAction for SwLayIdle
 
    std::shared_ptr<SwAccessibleMap> m_pAccessibleMap;
 
    bool m_bFirstPageInvalid : 1; // Pointer to the first Page invalid?
    bool m_bResetHdlHiddenPaint : 1; // Ditto
    bool m_bSmoothUpdate : 1; // For SmoothScroll
    bool m_bStopSmooth : 1;
 
    sal_uInt16 m_nRestoreActions  ; // Count for the Action that need to be restored (UNO)
    SwRect m_aSmoothRect;
 
    std::unique_ptr<SwPagePreviewLayout> m_pPagePreviewLayout;
 
    void SetFirstVisPage(OutputDevice const * pRenderContext); // Recalculate the first visible Page
 
    void StartAction();         // Show handle and hide
    void EndAction();           // Called by SwViewShell::ImplXXXAction
    void LockPaint();           // Ditto; called by SwViewShell::ImplLockPaint
    void UnlockPaint();
 
private:
 
    SwAccessibleMap *CreateAccessibleMap();
 
    void InvalidateAccessibleParaFlowRelation_( const SwTextFrame* _pFromTextFrame,
                                                const SwTextFrame* _pToTextFrame );
 
    void InvalidateAccessibleParaTextSelection_();
 
    void InvalidateAccessibleParaAttrs_( const SwTextFrame& rTextFrame );
 
public:
    SwViewShellImp( SwViewShell * );
    ~SwViewShellImp();
    void Init( const SwViewOption * ); 
 
    const SwViewShell *GetShell() const { return m_pShell; }
          SwViewShell *GetShell()       { return m_pShell; }
 
    Color GetRetoucheColor() const;
 
    const SwPageFrame *GetFirstVisPage(OutputDevice const * pRenderContext) const;
          SwPageFrame *GetFirstVisPage(OutputDevice const * pRenderContext);
    void SetFirstVisPageInvalid() { m_bFirstPageInvalid = true; }
 
    const SwPageFrame* GetLastVisPage(const OutputDevice* pRenderContext) const;
 
    bool AddPaintRect( const SwRect &rRect );
    bool HasPaintRegion()      { return m_oPaintRegion.has_value(); }
    std::optional<SwRegionRects> TakePaintRegion() { auto ret = std::move(m_oPaintRegion); m_oPaintRegion.reset(); return ret; }
    const std::optional<SwRegionRects>& GetPaintRegion() { return m_oPaintRegion; }
    void DeletePaintRegion() { m_oPaintRegion.reset(); }
 
    void AddPendingLOKInvalidation( const SwRect& rRect );
    std::vector<SwRect> TakePendingLOKInvalidations();
 
    bool  HasDrawView()             const { return nullptr != m_pDrawView; }
          SwDrawView* GetDrawView()       { return m_pDrawView.get(); }
    const SwDrawView* GetDrawView() const { return m_pDrawView.get(); }
          SdrPageView*GetPageView()       { return m_pSdrPageView; }
    const SdrPageView*GetPageView() const { return m_pSdrPageView; }
    void MakeDrawView();
 
    void   PaintLayer( const SdrLayerID _nLayerID,
                       SwPrintData const*const pPrintData,
                       SwPageFrame const& rPageFrame,
                       const SwRect& _rRect,
                       const Color* _pPageBackgrdColor,
                       const bool _bIsPageRightToLeft,
                       sdr::contact::ViewObjectContactRedirector* pRedirector );
 
    // Interface Drawing
    bool IsDragPossible( const Point &rPoint );
    void NotifySizeChg( const Size &rNewSz );
 
    bool  IsAction() const                   { return m_pLayAction  != nullptr; }
    bool  IsIdleAction() const               { return m_pIdleAct != nullptr; }
          SwLayAction &GetLayAction()        { return *m_pLayAction; }
    const SwLayAction &GetLayAction() const  { return *m_pLayAction; }
 
    void CheckWaitCursor();
 
    bool IsCalcLayoutProgress() const;
 
    bool IsUpdateExpFields();
 
    void    SetRestoreActions(sal_uInt16 nSet){m_nRestoreActions = nSet;}
    sal_uInt16  GetRestoreActions() const{return m_nRestoreActions;}
 
    void InitPagePreviewLayout();
 
    SwPagePreviewLayout* PagePreviewLayout()
    {
        return m_pPagePreviewLayout.get();
    }
 
    bool IsAccessible() const { return m_pAccessibleMap != nullptr; }
 
    inline SwAccessibleMap& GetAccessibleMap();
 
    void UpdateAccessible();
 
    void DisposeAccessible( const SwFrame *pFrame, const SdrObject *pObj,
                            bool bRecursive, bool bCanSkipInvisible );
    inline void DisposeAccessibleFrame( const SwFrame *pFrame,
                               bool bRecursive = false );
    inline void DisposeAccessibleObj( const SdrObject *pObj, bool bCanSkipInvisible );
 
    void MoveAccessible( const SwFrame *pFrame, const SdrObject *pObj,
                         const SwRect& rOldFrame );
    inline void MoveAccessibleFrame( const SwFrame *pFrame, const SwRect& rOldFrame );
 
    inline void AddAccessibleFrame( const SwFrame *pFrame );
 
    inline void AddAccessibleObj( const SdrObject *pObj );
 
    void InvalidateAccessibleFrameContent( const SwFrame *pFrame );
 
    void InvalidateAccessibleCursorPosition( const SwFrame *pFrame );
 
    void InvalidateAccessibleEditableState( bool bAllShells,
                                               const SwFrame *pFrame=nullptr );
 
    void InvalidateAccessibleRelationSet( const SwFlyFrame *pMaster,
                                          const SwFlyFrame *pFollow );
 
    void UpdateAccessiblePreview( const std::vector<std::unique_ptr<PreviewPage>>& _rPreviewPages,
                                  const Fraction&  _rScale,
                                  const SwPageFrame* _pSelectedPageFrame,
                                  const Size&      _rPreviewWinSize );
 
    void InvalidateAccessiblePreviewSelection( sal_uInt16 nSelPage );
 
    void FireAccessibleEvents();
};
 
inline SwAccessibleMap& SwViewShellImp::GetAccessibleMap()
{
    if( !m_pAccessibleMap )
        CreateAccessibleMap();
 
    return *m_pAccessibleMap;
}
 
inline void SwViewShellImp::DisposeAccessibleFrame( const SwFrame *pFrame,
                               bool bRecursive )
{
    DisposeAccessible( pFrame, nullptr, bRecursive, true );
}
 
inline void SwViewShellImp::DisposeAccessibleObj( const SdrObject *pObj, bool bCanSkipInvisible )
{
    DisposeAccessible( nullptr, pObj, false, bCanSkipInvisible );
}
 
inline void SwViewShellImp::MoveAccessibleFrame( const SwFrame *pFrame,
                                          const SwRect& rOldFrame )
{
    MoveAccessible( pFrame, nullptr, rOldFrame );
}
 
inline void SwViewShellImp::AddAccessibleFrame( const SwFrame *pFrame )
{
    SwRect aEmptyRect;
    MoveAccessible( pFrame, nullptr, aEmptyRect );
}
 
inline void SwViewShellImp::AddAccessibleObj( const SdrObject *pObj )
{
    SwRect aEmptyRect;
    MoveAccessible( nullptr, pObj, aEmptyRect );
}
#endif // INCLUDED_SW_SOURCE_CORE_INC_VIEWIMP_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */