summaryrefslogtreecommitdiff
path: root/sw/inc/crstate.hxx
blob: 9b223319fd93c68f7bdd5ba1c804b67d058f251d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/* -*- 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 <memory>

enum class SwFillMode
{
    Tab,       ///< default, fill with tabs
    TabSpace,  ///< fill with spaces and tabs
    Space,     ///< fill with spaces
    Margin,    ///< only align left, center, right
    Indent     ///< by left paragraph indentation
};

struct SwFillCursorPos
{
    SwRect aCursor;           ///< 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 nSpaceOnlyCnt;   ///< number of spaces to insert ("only spaces, no tabs" mode)
    sal_uInt16 nColumnCnt;      ///< number of necessary column breaks
    sal_Int16  eOrient;      ///< paragraph alignment
    SwFillMode eMode;       ///< desired fill-up rule
    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;           ///< Position and size of the line
    SwRect aPortion;        ///< Position and size of the multi portion
    SwRect aPortion2;       ///< needed for nested multi portions
    MultiPortionType nMultiType;  ///< Multiportion type
};

/**
 *  SwSpecialPos. This structure is used to pass some additional information
 *  during the call of SwTextFrame::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 SwTextFrame:::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 SwTextFrame:::GetCharRect with core string position 33.
 */

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,            ///< default
    UpDown,          ///< Cursor Up/Down
    RightMargin,     ///< at right margin
    LeftMargin,      ///< at left margin
    SetOnlyText,     ///< stay with the cursor inside text
    TableSel         ///< not in repeated headlines
};

// struct for later extensions
struct SwCursorMoveState
{
    SwFillCursorPos   *m_pFill;     ///< for automatic filling with tabs etc
    std::unique_ptr<Sw2LinesPos> m_p2Lines;   ///< for selections inside/around 2line portions
    SwSpecialPos*   m_pSpecialPos; ///< for positions inside fields
    Point m_aRealHeight;          ///< contains then the position/height of the cursor
    CursorMoveState m_eState;
    sal_uInt8            m_nCursorBidiLevel;
    bool m_bStop;
    bool m_bRealHeight;           ///< should the real height be calculated?
    bool m_bFieldInfo;            ///< should be fields recognized?
    bool m_bPosCorr;              ///< Point had to be corrected
    bool m_bFootnoteNoInfo;            ///< recognized footnote numbering
    bool m_bExactOnly;            /**< let GetModelPositionForViewPoint look for exact matches only,
                                         i.e. never let it run into GetContentPos */
    bool m_bFillRet;              ///< only used temporary in FillMode
    bool m_bSetInReadOnly;        ///< ReadOnly areas may be entered
    bool m_bRealWidth;            ///< Calculation of the width required
    bool m_b2Lines;               ///< Check 2line portions and fill p2Lines
    bool m_bNoScroll;             ///< No scrolling of undersized textframes
    bool m_bPosMatchesBounds;         /**< GetModelPositionForViewPoint should not return the next
                                       position if screen position is inside second
                                       have of bound rect */

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

    // #i27615#
    /**
       cursor in front of label
     */
    bool m_bInFrontOfLabel;
    bool m_bInNumPortion;         ///< point is in number portion #i23726#
    int m_nInNumPortionOffset;        ///< distance from number portion's start

    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: */