/* -*- 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 <swtypes.hxx>
#include <swrect.hxx>

enum SwFillMode
{
    FILL_TAB,       ///< default, fill with tabs
    FILL_SPACE,     ///< fill with spaces and tabs
    FILL_MARGIN,    ///< only align left, center, right
    FILL_INDENT     ///< by left paragraph indention
};

struct SwFillCrsrPos
{
    SwRect aCrsr;           ///< position and size of the ShadowCursor
    sal_uInt16 nParaCnt;        ///< number of paragraphs to insert
    sal_uInt16 nTabCnt;         ///< number of tabs respectively size of indentation
    sal_uInt16 nSpaceCnt;       ///< number of spaces to insert
    sal_uInt16 nColumnCnt;      ///< number of necessary column breaks
    sal_Int16  eOrient;      ///< paragraph alignment
    SwFillMode eMode;       ///< desired fill-up rule
    SwFillCrsrPos( SwFillMode eMd = FILL_TAB ) :
        nParaCnt( 0 ), nTabCnt( 0 ), nSpaceCnt( 0 ), nColumnCnt( 0 ),
        eOrient( com::sun::star::text::HoriOrientation::NONE ), eMode( eMd )
    {}
};

// Multiportion types: two lines, bidirectional, 270 degrees rotation,
//                     ruby portion and 90 degrees rotation
#define MT_TWOLINE  0
#define MT_BIDI     1
#define MT_ROT_270  3
#define MT_RUBY     4
#define MT_ROT_90   7

struct Sw2LinesPos
{
    SwRect aLine;           ///< Position and size of the line
    SwRect aPortion;        ///< Position and size of the multi portion
    SwRect aPortion2;       ///< needed for nested multi portions
    sal_uInt8 nMultiType;        ///< Multiportion type
};

/**
 *  SwSpecialPos. This structure is used to pass some additional information
 *  during the call of SwTxtFrm::GetCharRect(). An SwSpecialPos defines a position
 *  inside a portion which does not have a representation in the core string or
 *  which is only represented by one position,  e.g., field portions,
 *  number portions, ergo sum and quo vadis portions.
 *
 *  nCharOfst       - The offset inside the special portion. Fields and its
 *                    follow fields are treated as one long special portion.
 *  nLineOfst       - The number of lines between the beginning of the special
 *                    portion and nCharOfst. A line offset required to be
 *                    nCharOfst relative to the beginning of the line.
 *  nExtendRange    - Setting this identifies portions which are in front or
 *                    behind the core string (number portion, quo vadis)
 *
 *  Examples 1)
 *
 *      Get the position of the second character inside a number portion:
 *          nCharOfst = 2; nLineOfst = 0; nExtendRange = SP_EXTEND_RANGE_BEFORE;
 *          Call SwTxtFrm:::GetCharRect with core string position 0.
 *
 *  Example 2)
 *
 *      Field A - Length = 5
 *      Follow field B - Length = 9
 *      Get the position of the third character in follow field B, core position
 *      of field A is 33.
 *          nCharOfst = 7; nLineOfst = 0; nExtendRange = SP_EXTEND_RANGE_NONE;
 *          Call SwTxtFrm:::GetCharRect with core string position 33.
 */

#define SP_EXTEND_RANGE_NONE    0
#define SP_EXTEND_RANGE_BEFORE  1
#define SP_EXTEND_RANGE_BEHIND  2

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

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

// CrsrTravelling-States (for GetCrsrOfst)
enum CrsrMoveState
{
    MV_NONE,            ///< default
    MV_UPDOWN,          ///< Crsr Up/Down
    MV_RIGHTMARGIN,     ///< at right margin
    MV_LEFTMARGIN,      ///< at left margin
    MV_SETONLYTEXT,     ///< stay with the cursor inside text
    MV_TBLSEL           ///< not in repeated headlines
};

// struct for later extensions
struct SwCrsrMoveState
{
    SwFillCrsrPos   *pFill;     ///< for automatic filling with tabs etc
    Sw2LinesPos     *p2Lines;   ///< for selections inside/around 2line portions
    SwSpecialPos*   pSpecialPos; ///< for positions inside fields
    Point aRealHeight;          ///< contains then the position/height of the cursor
    CrsrMoveState eState;
    sal_uInt8            nCursorBidiLevel;
    bool bStop;
    bool bRealHeight;           ///< should the real height be calculated?
    bool bFieldInfo;            ///< should be fields recognized?
    bool bPosCorr;              ///< Point had to be corrected
    bool bFtnNoInfo;            ///< recognized footnote numbering
    bool bExactOnly;            /**< let GetCrsrOfst look for exact matches only,
                                         i.e. never let it run into GetCntntPos */
    bool bFillRet;              ///< only used temporary in FillMode
    bool bSetInReadOnly;        ///< ReadOnly areas may be entered
    bool bRealWidth;            ///< Calculation of the width required
    bool b2Lines;               ///< Check 2line portions and fill p2Lines
    bool bNoScroll;             ///< No scrolling of undersized textframes
    bool bPosMatchesBounds;         /**< GetCrsrOfst should not return the next
                                       position if screen position is inside second
                                       have of bound rect */

    bool bCntntCheck;           // #i43742# Cursor position over content?

    // #i27615#
    /**
       cursor in front of label
     */
    bool bInFrontOfLabel;
    bool bInNumPortion;         ///< point is in number portion #i23726#
    int nInNumPostionOffset;        ///< distance from number portion's start

    SwCrsrMoveState( CrsrMoveState eSt = MV_NONE ) :
        pFill( NULL ),
        p2Lines( NULL ),
        pSpecialPos( NULL ),
        eState( eSt ),
        nCursorBidiLevel( 0 ),
        bStop( false ),
        bRealHeight( false ),
        bFieldInfo( false ),
        bPosCorr( false ),
        bFtnNoInfo( false ),
        bExactOnly( false ),
        bFillRet( false ),
        bSetInReadOnly( false ),
        bRealWidth( false ),
        b2Lines( false ),
        bNoScroll( false ),
        bPosMatchesBounds( false ),
        bCntntCheck( false ), // #i43742#
        bInFrontOfLabel( false ), // #i27615#
        bInNumPortion(false), // #i26726#
        nInNumPostionOffset(0) // #i26726#
    {}
    SwCrsrMoveState( SwFillCrsrPos *pInitFill ) :
        pFill( pInitFill ),
        p2Lines( NULL ),
        pSpecialPos( NULL ),
        eState( MV_SETONLYTEXT ),
        nCursorBidiLevel( 0 ),
        bStop( false ),
        bRealHeight( false ),
        bFieldInfo( false ),
        bPosCorr( false ),
        bFtnNoInfo( false ),
        bExactOnly( false ),
        bFillRet( false ),
        bSetInReadOnly( false ),
        bRealWidth( false ),
        b2Lines( false ),
        bNoScroll( false ),
        bPosMatchesBounds( false ),
        bCntntCheck( false ), // #i43742#
        bInFrontOfLabel( false ), // #i27615#
        bInNumPortion(false), // #i23726#
        nInNumPostionOffset(0) // #i23726#
    {}
};

#endif

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