modeltoviewhelper.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_INC_MODELTOVIEWHELPER_HXX
#define INCLUDED_SW_INC_MODELTOVIEWHELPER_HXX
 
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <o3tl/typed_flags_set.hxx>
#include <vector>
 
class SwTextNode;
class SwRootFrame;
 
enum class ExpandMode
{
    PassThrough    = 0x0000,
    ExpandFields   = 0x0001,
    ExpandFootnote = 0x0002,
    HideInvisible  = 0x0004,
    HideDeletions  = 0x0008,
    ReplaceMode    = 0x0010,
    HideFieldmarkCommands = 0x0020,
};
 
namespace o3tl
{
    template<> struct typed_flags<ExpandMode> : is_typed_flags<ExpandMode, 0x003f> {};
}
 
class ModelToViewHelper
{
    struct ConversionMapEntry
    {
        ConversionMapEntry(sal_Int32 nModelPos, sal_Int32 nViewPos, bool bVisible)
            : m_nModelPos(nModelPos)
            , m_nViewPos(nViewPos)
            , m_bVisible(bVisible)
        {
        }
        sal_Int32 m_nModelPos;
        sal_Int32 m_nViewPos;
        bool m_bVisible;
    };
    typedef std::vector< ConversionMapEntry > ConversionMap;
 
    ConversionMap m_aMap;
    std::vector<sal_Int32> m_FieldPositions;
    std::vector<sal_Int32> m_FootnotePositions;
 
    OUString m_aRetText;
 
public:
 
    struct ModelPosition
    {
        sal_Int32 mnPos;
        sal_Int32 mnSubPos;
        bool mbIsField;
 
        ModelPosition() : mnPos(0), mnSubPos(0), mbIsField(false) {}
    };
 
    ModelToViewHelper(const SwTextNode &rNode, SwRootFrame const* pLayout,
            // defaults are appropriate for spell/grammar checking
            ExpandMode eMode = ExpandMode::ExpandFields | ExpandMode::ExpandFootnote | ExpandMode::HideFieldmarkCommands | ExpandMode::ReplaceMode);
    ModelToViewHelper() //pass through filter, view == model
    {
    }
 
    sal_Int32 ConvertToViewPosition( sal_Int32 nModelPos ) const;
 
    ModelPosition ConvertToModelPosition( sal_Int32 nViewPos ) const;
 
    const OUString& getViewText() const { return m_aRetText; }
    std::vector<sal_Int32> const& getFieldPositions() const { return m_FieldPositions; }
    std::vector<sal_Int32> const& getFootnotePositions() const { return m_FootnotePositions;}
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */