crstate.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_CRSTATE_HXX
#define INCLUDED_SW_INC_CRSTATE_HXX

#include <com/sun/star/text/HoriOrientation.hpp>
#include <tools/gen.hxx>
#include "swrect.hxx"

#include <optional>

enum class SwFillMode
{
    Tab,       
    TabSpace,  
    Space,     
    Margin,    
    Indent     
};

struct SwFillCursorPos
{
    SwRect aCursor;           
    sal_uInt16 nParaCnt;        
    sal_uInt16 nTabCnt;         
    sal_uInt16 nSpaceCnt;       
    sal_uInt16 nSpaceOnlyCnt;   
    sal_uInt16 nColumnCnt;      
    sal_Int16  eOrient;      
    SwFillMode eMode;       
    SwFillCursorPos( SwFillMode eMd ) :
        nParaCnt( 0 ), nTabCnt( 0 ), nSpaceCnt( 0 ), nSpaceOnlyCnt(0), nColumnCnt( 0 ),
        eOrient( css::text::HoriOrientation::NONE ), eMode( eMd )
    {}
};

// Multiportion types: two lines, bidirectional, 270 degrees rotation,
//                     ruby portion and 90 degrees rotation
enum class MultiPortionType : sal_uInt8
{
        TWOLINE  = 0,
        BIDI     = 1,
        ROT_270  = 3,
        RUBY     = 4,
        ROT_90   = 7,
};

struct Sw2LinesPos
{
    SwRect aLine;           
    SwRect aPortion;        
    SwRect aPortion2;       
    MultiPortionType nMultiType;  
};

enum class SwSPExtendRange : sal_uInt8
{
    NONE, BEFORE, BEHIND
};

struct SwSpecialPos
{
    sal_Int32 nCharOfst;
    sal_uInt16 nLineOfst;
    SwSPExtendRange nExtendRange;

    // #i27615#
    SwSpecialPos() : nCharOfst(0), nLineOfst(0),
                     nExtendRange(SwSPExtendRange::NONE)
    {}
};

// CursorTravelling-States (for GetModelPositionForViewPoint)
enum class CursorMoveState
{
    NONE,            
    UpDown,          
    RightMargin,     
    LeftMargin,      
    SetOnlyText,     
    TableSel         
};

// struct for later extensions
struct SwCursorMoveState
{
    SwFillCursorPos   *m_pFill;     
    std::optional<Sw2LinesPos> m_x2Lines;   
    SwSpecialPos*   m_pSpecialPos; 
    Point m_aRealHeight;          
    CursorMoveState m_eState;
    sal_uInt8            m_nCursorBidiLevel;
    bool m_bStop;
    bool m_bRealHeight;           
    bool m_bFieldInfo;            
    bool m_bPosCorr;              
    bool m_bFootnoteNoInfo;            
    bool m_bExactOnly;            
    bool m_bFillRet;              
    bool m_bSetInReadOnly;        
    bool m_bRealWidth;            
    bool m_b2Lines;               
    bool m_bNoScroll;             
    bool m_bPosMatchesBounds;         
    bool m_bContentCheck;           // #i43742# Cursor position over content?

    // #i27615#
    bool m_bInFrontOfLabel;
    bool m_bInNumPortion;         
    int m_nInNumPortionOffset;        

    SwCursorMoveState( CursorMoveState eSt = CursorMoveState::NONE ) :
        m_pFill( nullptr ),
        m_pSpecialPos( nullptr ),
        m_eState( eSt ),
        m_nCursorBidiLevel( 0 ),
        m_bStop( false ),
        m_bRealHeight( false ),
        m_bFieldInfo( false ),
        m_bPosCorr( false ),
        m_bFootnoteNoInfo( false ),
        m_bExactOnly( false ),
        m_bFillRet( false ),
        m_bSetInReadOnly( false ),
        m_bRealWidth( false ),
        m_b2Lines( false ),
        m_bNoScroll( false ),
        m_bPosMatchesBounds( false ),
        m_bContentCheck( false ), // #i43742#
        m_bInFrontOfLabel( false ), // #i27615#
        m_bInNumPortion(false), // #i26726#
        m_nInNumPortionOffset(0) // #i26726#
    {}
    SwCursorMoveState( SwFillCursorPos *pInitFill ) :
        m_pFill( pInitFill ),
        m_pSpecialPos( nullptr ),
        m_eState( CursorMoveState::SetOnlyText ),
        m_nCursorBidiLevel( 0 ),
        m_bStop( false ),
        m_bRealHeight( false ),
        m_bFieldInfo( false ),
        m_bPosCorr( false ),
        m_bFootnoteNoInfo( false ),
        m_bExactOnly( false ),
        m_bFillRet( false ),
        m_bSetInReadOnly( false ),
        m_bRealWidth( false ),
        m_b2Lines( false ),
        m_bNoScroll( false ),
        m_bPosMatchesBounds( false ),
        m_bContentCheck( false ), // #i43742#
        m_bInFrontOfLabel( false ), // #i27615#
        m_bInNumPortion(false), // #i23726#
        m_nInNumPortionOffset(0) // #i23726#
    {}
};

#endif

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