LibreOffice Module sw (master)  1
layact.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
20 #define INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
21 
22 #include <sal/config.h>
23 
24 #include <vcl/inputtypes.hxx>
25 #include <tools/color.hxx>
26 
27 #include <ctime>
28 #include <memory>
29 
30 #include <swrect.hxx>
31 
32 class OutputDevice;
33 class SwRootFrame;
34 class SwLayoutFrame;
35 class SwPageFrame;
36 class SwFlyFrame;
37 class SwContentFrame;
38 class SwTabFrame;
39 class SwViewShellImp;
40 class SwContentNode;
41 class SwWait;
42 
56 {
58  SwViewShellImp *m_pImp; // here the action logs in and off
59 
60  // For the sake of optimization, so that the tables stick a bit better to
61  // the Cursor when hitting return/backspace in front of one.
62  // The first TabFrame that paints itself (per page) adds itself to the pointer.
63  // The ContentFrames beneath the page do not need to deregister at the Shell for
64  // painting.
66 
67  std::unique_ptr<SwWait> m_pWait;
68 
69  // If a paragraph (or anything else) moved more than one page when
70  // formatting, it adds its new page number here.
71  // The InternalAction can then take the appropriate steps.
72  sal_uInt16 m_nPreInvaPage;
73 
74  std::clock_t m_nStartTicks; // The Action's starting time; if too much time passes the
75  // WaitCursor can be enabled via CheckWaitCursor()
76 
77  VclInputFlags m_nInputType; // Which input should terminate processing
78  sal_uInt16 m_nEndPage; // StatBar control
79  sal_uInt16 m_nCheckPageNum; // CheckPageDesc() was delayed if != USHRT_MAX
80  // check from this page onwards
81 
82  bool m_bPaint; // painting or only formatting?
83  bool m_bComplete; // Format everything or just the visible Area?
84  bool m_bCalcLayout; // Complete reformatting?
85  bool m_bAgain; // For the automatically repeated Action if Pages are deleted
86  bool m_bNextCycle; // Reset on the first invalid Page
87  bool m_bInterrupt; // For terminating processing on interrupt
88  bool m_bIdle; // True if the LayAction was triggered by the Idler
89  bool m_bReschedule; // Call Reschedule depending on Progress?
90  bool m_bCheckPages; // Run CheckPageDescs() or delay it
91  bool m_bUpdateExpFields; // Is set if, after Formatting, we need to do another round for ExpField
92  bool m_bBrowseActionStop; // Terminate Action early (as per bInput) and leave the rest to the Idler
93  bool m_bWaitAllowed; // Waitcursor allowed?
94  bool m_bPaintExtraData; // Painting line numbers (or similar) enabled?
95  bool m_bActionInProgress; // Is set in Action() at the beginning and deleted at the end
96 
97  // OD 14.04.2003 #106346# - new flag for content formatting on interrupt.
99 
100  // for loop control by disabling in-row splitting within embedded tables
102  sal_uInt16 m_nTabLevel; // embedding level
103  sal_uInt32 m_nCallCount; // calling FormatLayoutTab on the same page
104 
105  void PaintContent( const SwContentFrame *, const SwPageFrame *,
106  const SwRect &rOldRect, tools::Long nOldBottom );
107  bool PaintWithoutFlys( const SwRect &, const SwContentFrame *,
108  const SwPageFrame * );
109  inline bool PaintContent_( const SwContentFrame *, const SwPageFrame *,
110  const SwRect & );
111 
112  bool FormatLayout( OutputDevice* pRenderContext, SwLayoutFrame *, bool bAddRect = true );
113  bool FormatLayoutTab( SwTabFrame *, bool bAddRect );
114  bool FormatContent( const SwPageFrame* pPage );
115  void FormatContent_( const SwContentFrame* pContent,
116  const SwPageFrame* pPage );
117  bool IsShortCut( SwPageFrame *& );
118 
119  bool TurboAction();
120  bool TurboAction_( const SwContentFrame * );
121  void InternalAction(OutputDevice* pRenderContext);
122 
123  static SwPageFrame *CheckFirstVisPage( SwPageFrame *pPage );
124 
126 
127  inline void CheckIdleEnd();
128 
129 public:
130  SwLayAction( SwRootFrame *pRt, SwViewShellImp *pImp );
131  ~SwLayAction();
132 
133  void SetIdle ( bool bNew ) { m_bIdle = bNew; }
134  void SetCheckPages ( bool bNew ) { m_bCheckPages = bNew; }
135  void SetBrowseActionStop( bool bNew ) { m_bBrowseActionStop = bNew; }
136  void SetNextCycle ( bool bNew ) { m_bNextCycle = bNew; }
137 
138  bool IsWaitAllowed() const { return m_bWaitAllowed; }
139  bool IsNextCycle() const { return m_bNextCycle; }
140  bool IsPaint() const { return m_bPaint; }
141  bool IsIdle() const { return m_bIdle; }
142  bool IsReschedule() const { return m_bReschedule; }
143  bool IsPaintExtraData() const { return m_bPaintExtraData;}
144  bool IsInterrupt() const { return m_bInterrupt; }
145 
147 
148  // adjusting Action to the wanted behaviour
149  void SetPaint ( bool bNew ) { m_bPaint = bNew; }
150  void SetComplete ( bool bNew ) { m_bComplete = bNew; }
151  void SetStatBar ( bool bNew );
152  void SetInputType ( VclInputFlags nNew ) { m_nInputType = nNew; }
153  void SetCalcLayout ( bool bNew ) { m_bCalcLayout = bNew; }
154  void SetReschedule ( bool bNew ) { m_bReschedule = bNew; }
155  void SetWaitAllowed ( bool bNew ) { m_bWaitAllowed = bNew; }
156 
157  void SetAgain() { m_bAgain = true; }
158  void SetUpdateExpFields() {m_bUpdateExpFields = true; }
159 
160  inline void SetCheckPageNum( sal_uInt16 nNew );
161  void SetCheckPageNumDirect( sal_uInt16 nNew ) { m_nCheckPageNum = nNew; }
162 
163  void Action(OutputDevice* pRenderContext); // here it begins
164  void Reset(); // back to CTor-defaults
165 
166  bool IsAgain() const { return m_bAgain; }
167  bool IsComplete() const { return m_bComplete; }
168  bool IsExpFields() const { return m_bUpdateExpFields; }
169  bool IsCalcLayout() const { return m_bCalcLayout; }
170  bool IsCheckPages() const { return m_bCheckPages; }
171  bool IsBrowseActionStop() const { return m_bBrowseActionStop; }
172  bool IsActionInProgress() const { return m_bActionInProgress; }
173 
174  sal_uInt16 GetCheckPageNum() const { return m_nCheckPageNum; }
175 
176  // others should be able to activate the WaitCursor, too
177  void CheckWaitCursor();
178 
179  // #i28701# - method is now public;
180  // delete 2nd parameter, because it's not used;
181  void FormatLayoutFly( SwFlyFrame * );
182  // #i28701# - method is now public
183  void FormatFlyContent( const SwFlyFrame * );
184 
185 };
186 
188 {
190  SwViewShellImp *m_pImp; // The Idler registers and deregisters here
191  SwContentNode *m_pContentNode; // The current cursor position is saved here
192  sal_Int32 m_nTextPos;
193  bool m_bPageValid; // Were we able to evaluate everything on the whole page?
194 #ifdef DBG_UTIL
196 
197  void ShowIdle( Color eName );
198 #endif
199 
201  bool DoIdleJob_( const SwContentFrame*, IdleJobType );
202  bool DoIdleJob( IdleJobType, bool bVisAreaOnly );
203 
204 public:
205  SwLayIdle( SwRootFrame *pRt, SwViewShellImp *pImp );
206  ~SwLayIdle();
207 };
208 
209 inline void SwLayAction::SetCheckPageNum( sal_uInt16 nNew )
210 {
211  if ( nNew < m_nCheckPageNum )
212  m_nCheckPageNum = nNew;
213 }
214 
215 #endif // INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
216 
217 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void InternalAction(OutputDevice *pRenderContext)
Definition: layact.cxx:424
bool IsActionInProgress() const
Definition: layact.hxx:172
bool IsInterrupt() const
Definition: layact.hxx:144
bool PaintWithoutFlys(const SwRect &, const SwContentFrame *, const SwPageFrame *)
Definition: layact.cxx:109
bool m_bBrowseActionStop
Definition: layact.hxx:92
bool m_bCalcLayout
Definition: layact.hxx:84
const SwPageFrame * m_pCurPage
Definition: layact.hxx:101
void SetNextCycle(bool bNew)
Definition: layact.hxx:136
bool FormatLayout(OutputDevice *pRenderContext, SwLayoutFrame *, bool bAddRect=true)
Definition: layact.cxx:1183
void ShowIdle(Color eName)
bool TurboAction_(const SwContentFrame *)
Definition: layact.cxx:782
bool FormatLayoutTab(SwTabFrame *, bool bAddRect)
Definition: layact.cxx:1479
void SetInputType(VclInputFlags nNew)
Definition: layact.hxx:152
bool m_bComplete
Definition: layact.hxx:83
void FormatFlyContent(const SwFlyFrame *)
Definition: layact.cxx:1842
bool IsWaitAllowed() const
Definition: layact.hxx:138
bool DoIdleJob(IdleJobType, bool bVisAreaOnly)
Definition: layact.cxx:2036
long Long
sal_uInt16 m_nTabLevel
Definition: layact.hxx:102
SwTabFrame is one table in the document layout, containing rows (which contain cells).
Definition: tabfrm.hxx:30
bool m_bInterrupt
Definition: layact.hxx:87
bool m_bReschedule
Definition: layact.hxx:89
bool IsComplete() const
Definition: layact.hxx:167
SwRootFrame * m_pRoot
Definition: layact.hxx:57
bool m_bPaintExtraData
Definition: layact.hxx:94
Of course Writer needs its own rectangles.
Definition: swrect.hxx:35
The root element of a Writer document layout.
Definition: rootfrm.hxx:82
void SetIdle(bool bNew)
Definition: layact.hxx:133
bool IsCalcLayout() const
Definition: layact.hxx:169
bool m_bAgain
Definition: layact.hxx:85
void SetCalcLayout(bool bNew)
Definition: layact.hxx:153
VclInputFlags
bool IsReschedule() const
Definition: layact.hxx:142
bool RemoveEmptyBrowserPages()
Definition: layact.cxx:297
bool m_bWaitAllowed
Definition: layact.hxx:93
bool IsShortCut(SwPageFrame *&)
Definition: layact.cxx:968
sal_uInt16 GetCheckPageNum() const
Definition: layact.hxx:174
void Action(OutputDevice *pRenderContext)
Definition: layact.cxx:324
~SwLayIdle()
Definition: layact.cxx:2345
sal_uInt16 m_nEndPage
Definition: layact.hxx:78
bool IsNextCycle() const
Definition: layact.hxx:139
void SetBrowseActionStop(bool bNew)
Definition: layact.hxx:135
bool IsCheckPages() const
Definition: layact.hxx:170
bool m_bIndicator
Definition: layact.hxx:195
VclInputFlags m_nInputType
Definition: layact.hxx:77
void SetStatBar(bool bNew)
Definition: layact.cxx:98
void CheckWaitCursor()
Definition: layact.cxx:78
void Reset()
Definition: layact.cxx:285
void SetCheckPageNumDirect(sal_uInt16 nNew)
Definition: layact.hxx:161
sal_uInt16 m_nPreInvaPage
Definition: layact.hxx:72
static SwPageFrame * CheckFirstVisPage(SwPageFrame *pPage)
Definition: layact.cxx:370
SwViewShellImp * m_pImp
Definition: layact.hxx:190
bool m_bIdle
Definition: layact.hxx:88
std::unique_ptr< SwWait > m_pWait
Definition: layact.hxx:67
The usage of LayAction is always the same:
Definition: layact.hxx:55
void CheckIdleEnd()
Definition: layact.cxx:92
VclInputFlags GetInputType() const
Definition: layact.hxx:146
bool m_bUpdateExpFields
Definition: layact.hxx:91
void SetUpdateExpFields()
Definition: layact.hxx:158
bool IsExpFields() const
Definition: layact.hxx:168
bool mbFormatContentOnInterrupt
Definition: layact.hxx:98
SwLayAction(SwRootFrame *pRt, SwViewShellImp *pImp)
Definition: layact.cxx:255
A page of the document layout.
Definition: pagefrm.hxx:41
sal_uInt16 m_nCheckPageNum
Definition: layact.hxx:79
SwContentNode * m_pContentNode
Definition: layact.hxx:191
bool m_bActionInProgress
Definition: layact.hxx:95
~SwLayAction()
Definition: layact.cxx:279
void PaintContent(const SwContentFrame *, const SwPageFrame *, const SwRect &rOldRect, tools::Long nOldBottom)
Depending of the type, the Content is output according to its changes, or the area to be outputted is...
Definition: layact.cxx:205
void FormatContent_(const SwContentFrame *pContent, const SwPageFrame *pPage)
Definition: layact.cxx:1814
bool m_bPaint
Definition: layact.hxx:82
std::clock_t m_nStartTicks
Definition: layact.hxx:74
bool m_bCheckPages
Definition: layact.hxx:90
SwViewShellImp * m_pImp
Definition: layact.hxx:58
sal_uInt32 m_nCallCount
Definition: layact.hxx:103
bool DoIdleJob_(const SwContentFrame *, IdleJobType)
Definition: layact.cxx:1887
const SwTabFrame * m_pOptTab
Definition: layact.hxx:65
general base class for all free-flowing frames
Definition: flyfrm.hxx:60
void SetAgain()
Definition: layact.hxx:157
SwRootFrame * m_pRoot
Definition: layact.hxx:189
bool IsBrowseActionStop() const
Definition: layact.hxx:171
bool IsPaintExtraData() const
Definition: layact.hxx:143
void SetComplete(bool bNew)
Definition: layact.hxx:150
void SetReschedule(bool bNew)
Definition: layact.hxx:154
bool IsAgain() const
Definition: layact.hxx:166
void SetWaitAllowed(bool bNew)
Definition: layact.hxx:155
bool PaintContent_(const SwContentFrame *, const SwPageFrame *, const SwRect &)
Definition: layact.cxx:187
bool IsPaint() const
Definition: layact.hxx:140
bool m_bPageValid
Definition: layact.hxx:193
bool FormatContent(const SwPageFrame *pPage)
Definition: layact.cxx:1627
void SetPaint(bool bNew)
Definition: layact.hxx:149
void FormatLayoutFly(SwFlyFrame *)
Definition: layact.cxx:1429
void SetCheckPages(bool bNew)
Definition: layact.hxx:134
A layout frame is a frame that contains other frames (m_pLower), e.g. SwPageFrame or SwTabFrame...
Definition: layfrm.hxx:35
bool IsIdle() const
Definition: layact.hxx:141
sal_Int32 m_nTextPos
Definition: layact.hxx:192
void SetCheckPageNum(sal_uInt16 nNew)
Definition: layact.hxx:209
SwLayIdle(SwRootFrame *pRt, SwViewShellImp *pImp)
Definition: layact.cxx:2153
bool m_bNextCycle
Definition: layact.hxx:86
bool TurboAction()
Definition: layact.cxx:838