accportions.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_ACCESS_ACCPORTIONS_HXX
#define INCLUDED_SW_SOURCE_CORE_ACCESS_ACCPORTIONS_HXX
 
#include <SwPortionHandler.hxx>
#include <sal/types.h>
#include <rtl/ustrbuf.hxx>
#include <memory>
#include <vector>
 
class SwTextFrame;
struct SwSpecialPos;
class SwViewOption;
namespace com::sun::star {
    namespace i18n { struct Boundary; }
}
 
class SwAccessiblePortionData : public SwPortionHandler
{
    // the frame this portion is referring to
    SwTextFrame const* m_pTextFrame;
 
    // variables used while collecting the data
    OUStringBuffer m_aBuffer;
    TextFrameIndex m_nViewPosition;
    const SwViewOption* m_pViewOptions;
 
    OUString m_sAccessibleString;
 
    // positions array
    // instances of Position_t must always include the minimum and
    // maximum positions as first/last elements (to simplify the
    // algorithms)
    typedef std::vector<sal_Int32> AccessiblePositions;
    typedef std::vector<TextFrameIndex> FramePositions;
 
    AccessiblePositions m_aLineBreaks; 
    FramePositions m_ViewPositions; 
    AccessiblePositions m_aAccessiblePositions; 
    AccessiblePositions m_aFieldPosition;
 
    std::vector<sal_uInt8> m_aPortionAttrs;   
 
    std::unique_ptr<AccessiblePositions> m_pSentences; 
 
    size_t m_nBeforePortions;     
    bool m_bFinished;
 
    static void FillBoundary(css::i18n::Boundary& rBound,
                      const AccessiblePositions& rPositions,
                      size_t nPos );
 
    bool IsPortionAttrSet( size_t nPortionNo, sal_uInt8 nAttr ) const;
    bool IsSpecialPortion( size_t nPortionNo ) const;
    bool IsGrayPortionType( PortionType nType ) const;
 
    // helper method for GetEditableRange(...):
    void AdjustAndCheck( sal_Int32 nPos, size_t& nPortionNo,
                         TextFrameIndex& rCorePos, bool& bEdit) const;
 
public:
    SwAccessiblePortionData( const SwTextFrame* pTextFrame,
                             const SwViewOption* pViewOpt );
    virtual ~SwAccessiblePortionData() override;
 
    // SwPortionHandler methods
    virtual void Text(TextFrameIndex nLength, PortionType nType) override;
    virtual void Special(TextFrameIndex nLength, const OUString& rText, PortionType nType) override;
    virtual void LineBreak() override;
    virtual void Skip(TextFrameIndex nLength) override;
    virtual void Finish() override;
 
    bool FillBoundaryIFDateField( css::i18n::Boundary& rBound, const sal_Int32 nPos );
    bool IsIndexInFootnode(sal_Int32 nIndex);
    bool IsInGrayPortion( sal_Int32 nPos );
    sal_Int32 GetFieldIndex(sal_Int32 nPos) const;
 
    bool IsZeroCorePositionData();
 
    // access to the portion data
 
    const OUString& GetAccessibleString() const;
 
    void GetLineBoundary( css::i18n::Boundary& rBound,
                          sal_Int32 nPos ) const;
 
    // get start and end position of the last line
    void GetLastLineBoundary( css::i18n::Boundary& rBound ) const;
 
    bool IsValidCorePosition(TextFrameIndex nPos) const;
    TextFrameIndex GetFirstValidCorePosition() const;
    TextFrameIndex GetLastValidCorePosition() const;
 
    sal_Int32 GetAccessiblePosition(TextFrameIndex nPos) const;
 
    // #i89175#
    sal_Int32 GetLineCount() const;
    sal_Int32 GetLineNo( const sal_Int32 nPos ) const;
    void GetBoundaryOfLine( const sal_Int32 nLineNo,
                            css::i18n::Boundary& rLineBound );
 
    TextFrameIndex GetCoreViewPosition(sal_Int32 nPos) const;
 
    TextFrameIndex FillSpecialPos(sal_Int32 nPos,
                           SwSpecialPos& rPos,
                           SwSpecialPos*& rpPos ) const;
 
    // get boundaries of words/sentences. The data structures are
    // created on-demand.
    void GetSentenceBoundary( css::i18n::Boundary& rBound,
                              sal_Int32 nPos );
 
    // get (a) boundary for attribute change
    void GetAttributeBoundary( css::i18n::Boundary& rBound,
                               sal_Int32 nPos ) const;
 
    bool GetEditableRange( sal_Int32 nStart, sal_Int32 nEnd,
           TextFrameIndex& rCoreStart, TextFrameIndex& rCoreEnd) const;
 
private:
    std::vector< std::pair<sal_Int32,sal_Int32> > m_vecPairPos;
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */