txtfly.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_TXTFLY_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_TXTFLY_HXX

#include <editeng/txtrange.hxx>
#include <tools/solar.h>
#include <swtypes.hxx>
#include <swrect.hxx>
#include <com/sun/star/text/WrapTextMode.hpp>
#include <memory>
#include <vector>

class OutputDevice;
class SwPageFrame;
class SdrObject;
class SwFormat;
class SwAnchoredObject;
class SwTextFrame;
class SwDrawTextInfo;
class SwContourCache;

typedef std::vector< SwAnchoredObject* > SwAnchoredObjList;

extern SwContourCache *pContourCache;

#define POLY_CNT 20
#define POLY_MIN 5
#define POLY_MAX 4000

void ClrContourCache( const SdrObject *pObj );

class SwContourCache
{
    friend void ClrContourCache();
    struct CacheItem
    {
        const SdrObject *mpSdrObj;
        std::unique_ptr<TextRanger> mxTextRanger;
    };
    std::vector<CacheItem> mvItems;
    long nPntCnt;
    const SwRect ContourRect( const SwFormat* pFormat, const SdrObject* pObj,
        const SwTextFrame* pFrame, const SwRect &rLine, const long nXPos,
        const bool bRight );

public:
    SwContourCache();
    ~SwContourCache();
    const SdrObject* GetObject( sal_uInt16 nPos ) const{ return mvItems[ nPos ].mpSdrObj; }
    sal_uInt16 GetCount() const { return mvItems.size(); }
    void ClrObject( sal_uInt16 nPos );

    static const SwRect CalcBoundRect( const SwAnchoredObject* pAnchoredObj,
                                       const SwRect &rLine,
                                       const SwTextFrame* pFrame,
                                       const long nXPos,
                                       const bool bRight );
};

class SwTextFly
{
    const SwPageFrame                * pPage;
    const SwAnchoredObject           * mpCurrAnchoredObj;
    const SwTextFrame                * m_pCurrFrame;
    const SwTextFrame                * m_pMaster;
    std::unique_ptr<SwAnchoredObjList> mpAnchoredObjList;

    long nMinBottom;
    long nNextTop;  
    sal_uLong m_nCurrFrameNodeIndex;

    bool bOn : 1;
    bool bTopRule: 1;
    bool mbIgnoreCurrentFrame: 1;
    bool mbIgnoreContour: 1;

    bool mbIgnoreObjsInHeaderFooter: 1;

    SwRect GetFrame_( const SwRect &rPortion ) const;

    SwAnchoredObjList* InitAnchoredObjList();

    SwAnchoredObjList* GetAnchoredObjList() const;

    bool ForEach( const SwRect &rRect, SwRect* pRect, bool bAvoid ) const;

    css::text::WrapTextMode GetSurroundForTextWrap( const SwAnchoredObject* pAnchoredObj ) const;

    void CalcRightMargin( SwRect &rFly,
                          SwAnchoredObjList::size_type nPos,
                          const SwRect &rLine ) const;

    void CalcLeftMargin( SwRect &rFly,
                         SwAnchoredObjList::size_type nPos,
                         const SwRect &rLine ) const;

    SwAnchoredObjList::size_type GetPos( const SwAnchoredObject* pAnchoredObj ) const;

    bool GetTop( const SwAnchoredObject* _pAnchoredObj,
                 const bool bInFootnote,
                 const bool bInFooterOrHeader );

    SwTwips CalcMinBottom() const;

    const SwTextFrame* GetMaster_();

public:

    SwTextFly();
    SwTextFly( const SwTextFrame *pFrame );
    SwTextFly( const SwTextFly& rTextFly );
    ~SwTextFly();

    void CtorInitTextFly( const SwTextFrame *pFrame );

    void SetTopRule();

    SwRect GetFrame( const SwRect &rPortion ) const;
    bool IsOn() const;

    bool Relax( const SwRect &rRect );
    bool Relax();

    SwTwips GetMinBottom() const;
    const SwTextFrame* GetMaster() const;

    // This temporary variable needs to be manipulated in const methods
    long GetNextTop() const;
    void SetNextTop( long nNew ) const;

    SwRect AnchoredObjToRect( const SwAnchoredObject* pAnchoredObj,
                              const SwRect& rRect ) const;

    void DrawTextOpaque( SwDrawTextInfo &rInf );

    void DrawFlyRect( OutputDevice* pOut, const SwRect &rRect );

    bool IsAnyFrame( const SwRect &rLine ) const;

    bool IsAnyFrame() const;

    bool IsAnyObj( const SwRect& rRect ) const;

    void SetIgnoreCurrentFrame( bool bNew );
    void SetIgnoreContour( bool bNew );

    void SetIgnoreObjsInHeaderFooter( const bool bNew );
};

inline SwAnchoredObjList* SwTextFly::GetAnchoredObjList() const
{
    return mpAnchoredObjList
           ? mpAnchoredObjList.get()
           : const_cast<SwTextFly*>(this)->InitAnchoredObjList();
}

inline void SwTextFly::SetTopRule()
{
    bTopRule = false;
}

inline bool SwTextFly::IsOn() const
{
    return bOn;
}

inline bool SwTextFly::Relax( const SwRect &rRect )
{
    if (bOn)
    {
        bOn = IsAnyFrame( rRect );
    }
    return bOn;
}

inline bool SwTextFly::Relax()
{
    if (bOn)
    {
        bOn = IsAnyFrame();
    }
    return bOn;
}

inline SwTwips SwTextFly::GetMinBottom() const
{
    return mpAnchoredObjList ? nMinBottom : CalcMinBottom();
}

inline const SwTextFrame* SwTextFly::GetMaster() const
{
    return m_pMaster ? m_pMaster : const_cast<SwTextFly*>(this)->GetMaster_();
}

inline long SwTextFly::GetNextTop() const
{
    return nNextTop;
}

inline void SwTextFly::SetNextTop( long nNew ) const
{
    const_cast<SwTextFly*>(this)->nNextTop = nNew;
}

inline SwRect SwTextFly::GetFrame( const SwRect &rRect ) const
{
    return bOn ? GetFrame_( rRect ) : SwRect();
}

inline void SwTextFly::SetIgnoreCurrentFrame( bool bNew )
{
    mbIgnoreCurrentFrame = bNew;
}

inline void SwTextFly::SetIgnoreContour( bool bNew )
{
    mbIgnoreContour = bNew;
}

inline void SwTextFly::SetIgnoreObjsInHeaderFooter( const bool bNew )
{
    mbIgnoreObjsInHeaderFooter = bNew;
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */