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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/* -*- 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_INC_LAYACT_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
#include <sal/config.h>
#include <vcl/inputtypes.hxx>
#include <tools/color.hxx>
#include <ctime>
#include <memory>
#include <vector>
#include <swrect.hxx>
class OutputDevice;
class SwFrame;
class SwFrameDeleteGuard;
class SwRootFrame;
class SwLayoutFrame;
class SwPageFrame;
class SwFlyFrame;
class SwContentFrame;
class SwTabFrame;
class SwViewShellImp;
class SwContentNode;
class SwWait;
/**
* The usage of LayAction is always the same:
*
* 1. Generation of the LayAction object.
* 2. Specifying the wanted behaviour via the Set-methods
* 3. Calling Action()
* 4. Soon after that the destruction of the object
*
* The object registers at the SwViewShellImp in the ctor and deregisters not until
* the dtor!
* It's a typical stack object.
*/
class SwLayAction
{
SwRootFrame *m_pRoot;
SwViewShellImp *m_pImp; // here the action logs in and off
// For the sake of optimization, so that the tables stick a bit better to
// the Cursor when hitting return/backspace in front of one.
// The first TabFrame that paints itself (per page) adds itself to the pointer.
// The ContentFrames beneath the page do not need to deregister at the Shell for
// painting.
const SwTabFrame *m_pOptTab;
std::unique_ptr<SwWait> m_pWait;
std::vector<SwFrame*> m_aFrameStack;
std::vector<std::unique_ptr<SwFrameDeleteGuard>> m_aFrameDeleteGuards;
// If a paragraph (or anything else) moved more than one page when
// formatting, it adds its new page number here.
// The InternalAction can then take the appropriate steps.
sal_uInt16 m_nPreInvaPage;
std::clock_t m_nStartTicks; // The Action's starting time; if too much time passes the
// WaitCursor can be enabled via CheckWaitCursor()
VclInputFlags m_nInputType; // Which input should terminate processing
sal_uInt16 m_nEndPage; // StatBar control
sal_uInt16 m_nCheckPageNum; // CheckPageDesc() was delayed if != USHRT_MAX
// check from this page onwards
bool m_bPaint; // painting or only formatting?
bool m_bComplete; // Format everything or just the visible Area?
bool m_bCalcLayout; // Complete reformatting?
bool m_bAgain; // For the automatically repeated Action if Pages are deleted
bool m_bNextCycle; // Reset on the first invalid Page
bool m_bInterrupt; // For terminating processing on interrupt
bool m_bIdle; // True if the LayAction was triggered by the Idler
bool m_bReschedule; // Call Reschedule depending on Progress?
bool m_bCheckPages; // Run CheckPageDescs() or delay it
bool m_bUpdateExpFields; // Is set if, after Formatting, we need to do another round for ExpField
bool m_bBrowseActionStop; // Terminate Action early (as per bInput) and leave the rest to the Idler
bool m_bWaitAllowed; // Waitcursor allowed?
bool m_bPaintExtraData; // Painting line numbers (or similar) enabled?
bool m_bActionInProgress; // Is set in Action() at the beginning and deleted at the end
// OD 14.04.2003 #106346# - new flag for content formatting on interrupt.
bool mbFormatContentOnInterrupt;
void PaintContent( const SwContentFrame *, const SwPageFrame *,
const SwRect &rOldRect, tools::Long nOldBottom );
bool PaintWithoutFlys( const SwRect &, const SwContentFrame *,
const SwPageFrame * );
inline bool PaintContent_( const SwContentFrame *, const SwPageFrame *,
const SwRect & );
bool FormatLayout( OutputDevice* pRenderContext, SwLayoutFrame *, bool bAddRect = true );
bool FormatLayoutTab( SwTabFrame *, bool bAddRect );
bool FormatContent(SwPageFrame * pPage);
void FormatContent_( const SwContentFrame* pContent,
const SwPageFrame* pPage );
bool IsShortCut( SwPageFrame *& );
bool TurboAction();
bool TurboAction_( const SwContentFrame * );
void InternalAction(OutputDevice* pRenderContext);
static SwPageFrame *CheckFirstVisPage( SwPageFrame *pPage );
bool RemoveEmptyBrowserPages();
void PushFormatLayout(SwFrame* pLow);
void PopFormatLayout();
inline void CheckIdleEnd();
public:
SwLayAction( SwRootFrame *pRt, SwViewShellImp *pImp );
~SwLayAction();
void SetIdle ( bool bNew ) { m_bIdle = bNew; }
void SetCheckPages ( bool bNew ) { m_bCheckPages = bNew; }
void SetBrowseActionStop( bool bNew ) { m_bBrowseActionStop = bNew; }
void SetNextCycle ( bool bNew ) { m_bNextCycle = bNew; }
bool IsWaitAllowed() const { return m_bWaitAllowed; }
bool IsNextCycle() const { return m_bNextCycle; }
bool IsPaint() const { return m_bPaint; }
bool IsIdle() const { return m_bIdle; }
bool IsReschedule() const { return m_bReschedule; }
bool IsPaintExtraData() const { return m_bPaintExtraData;}
bool IsInterrupt() const { return m_bInterrupt; }
VclInputFlags GetInputType() const { return m_nInputType; }
// adjusting Action to the wanted behaviour
void SetPaint ( bool bNew ) { m_bPaint = bNew; }
void SetComplete ( bool bNew ) { m_bComplete = bNew; }
void SetStatBar ( bool bNew );
void SetInputType ( VclInputFlags nNew ) { m_nInputType = nNew; }
void SetCalcLayout ( bool bNew ) { m_bCalcLayout = bNew; }
void SetReschedule ( bool bNew ) { m_bReschedule = bNew; }
void SetWaitAllowed ( bool bNew ) { m_bWaitAllowed = bNew; }
void SetAgain(bool bAgain);
void SetUpdateExpFields() {m_bUpdateExpFields = true; }
inline void SetCheckPageNum( sal_uInt16 nNew );
void SetCheckPageNumDirect( sal_uInt16 nNew ) { m_nCheckPageNum = nNew; }
void Action(OutputDevice* pRenderContext); // here it begins
void Reset(); // back to CTor-defaults
bool IsAgain() const { return m_bAgain; }
bool IsComplete() const { return m_bComplete; }
bool IsExpFields() const { return m_bUpdateExpFields; }
bool IsCalcLayout() const { return m_bCalcLayout; }
bool IsCheckPages() const { return m_bCheckPages; }
bool IsBrowseActionStop() const { return m_bBrowseActionStop; }
bool IsActionInProgress() const { return m_bActionInProgress; }
sal_uInt16 GetCheckPageNum() const { return m_nCheckPageNum; }
// others should be able to activate the WaitCursor, too
void CheckWaitCursor();
// #i28701# - method is now public;
// delete 2nd parameter, because it's not used;
void FormatLayoutFly( SwFlyFrame * );
// #i28701# - method is now public
void FormatFlyContent( const SwFlyFrame * );
};
enum class IdleJobType
{
ONLINE_SPELLING,
AUTOCOMPLETE_WORDS,
WORD_COUNT,
SMART_TAGS
};
enum class IdleJobArea
{
ALL,
VISIBLE
};
class SwLayIdle
{
SwRootFrame *m_pRoot;
SwViewShellImp *m_pImp; // The Idler registers and deregisters here
SwContentNode *m_pContentNode; // The current cursor position is saved here
sal_Int32 m_nTextPos;
bool m_bPageValid; // Were we able to evaluate everything on the whole page?
#ifdef DBG_UTIL
bool m_bIndicator;
void ShowIdle( Color eName );
#endif
bool DoIdleJob_( const SwContentFrame*, IdleJobType );
bool DoIdleJob(IdleJobType eJobType, IdleJobArea eJobArea);
static bool isJobEnabled(IdleJobType eJob, const SwViewShell* pViewShell);
public:
SwLayIdle( SwRootFrame *pRt, SwViewShellImp *pImp );
~SwLayIdle();
};
inline void SwLayAction::SetCheckPageNum( sal_uInt16 nNew )
{
if ( nNew < m_nCheckPageNum )
m_nCheckPageNum = nNew;
}
#endif // INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
