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 <vcl/TaskStopwatch.hxx>
26 #include <tools/color.hxx>
27 
28 #include <ctime>
29 #include <memory>
30 
31 #include <swrect.hxx>
32 
33 class OutputDevice;
34 class SwRootFrame;
35 class SwLayoutFrame;
36 class SwPageFrame;
37 class SwFlyFrame;
38 class SwContentFrame;
39 class SwTabFrame;
40 class SwViewShellImp;
41 class SwContentNode;
42 class SwWait;
43 
57 {
59  SwViewShellImp *m_pImp; // here the action logs in and off
61 
62  // For the sake of optimization, so that the tables stick a bit better to
63  // the Cursor when hitting return/backspace in front of one.
64  // The first TabFrame that paints itself (per page) adds itself to the pointer.
65  // The ContentFrames beneath the page do not need to deregister at the Shell for
66  // painting.
68 
69  std::unique_ptr<SwWait> m_pWait;
70 
71  // If a paragraph (or anything else) moved more than one page when
72  // formatting, it adds its new page number here.
73  // The InternalAction can then take the appropriate steps.
74  sal_uInt16 m_nPreInvaPage;
75 
76  std::clock_t m_nStartTicks; // The Action's starting time; if too much time passes the
77  // WaitCursor can be enabled via CheckWaitCursor()
78 
79  sal_uInt16 m_nEndPage; // StatBar control
80  sal_uInt16 m_nCheckPageNum; // CheckPageDesc() was delayed if != USHRT_MAX
81  // check from this page onwards
82 
83  bool m_bPaint; // painting or only formatting?
84  bool m_bComplete; // Format everything or just the visible Area?
85  bool m_bCalcLayout; // Complete reformatting?
86  bool m_bAgain; // For the automatically repeated Action if Pages are deleted
87  bool m_bNextCycle; // Reset on the first invalid Page
88  bool m_bReschedule; // Call Reschedule depending on Progress?
89  bool m_bInterrupt; // For termination the layouting
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, 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 public:
128  SwLayAction(SwRootFrame *pRt, SwViewShellImp *pImp, TaskStopwatch* pWatch = nullptr);
129  ~SwLayAction();
130 
131  void SetCheckPages ( bool bNew ) { m_bCheckPages = bNew; }
132  void SetBrowseActionStop( bool bNew ) { m_bBrowseActionStop = bNew; }
133  void SetNextCycle ( bool bNew ) { m_bNextCycle = bNew; }
134 
135  bool IsWaitAllowed() const { return m_bWaitAllowed; }
136  bool IsNextCycle() const { return m_bNextCycle; }
137  bool IsPaint() const { return m_bPaint; }
138  bool IsReschedule() const { return m_bReschedule; }
139  bool IsIdle() const { return m_pWatch != nullptr; }
140  bool IsPaintExtraData() const { return m_bPaintExtraData; }
141  bool IsInterrupt();
142 
143  // adjusting Action to the wanted behaviour
144  void SetPaint ( bool bNew ) { m_bPaint = bNew; }
145  void SetComplete ( bool bNew ) { m_bComplete = bNew; }
146  void SetStatBar ( bool bNew );
147  void SetCalcLayout ( bool bNew ) { m_bCalcLayout = bNew; }
148  void SetReschedule ( bool bNew ) { m_bReschedule = bNew; }
149  void SetWaitAllowed ( bool bNew ) { m_bWaitAllowed = bNew; }
150 
151  void SetAgain() { m_bAgain = true; }
152  void SetUpdateExpFields() {m_bUpdateExpFields = true; }
153 
154  inline void SetCheckPageNum( sal_uInt16 nNew );
155  void SetCheckPageNumDirect( sal_uInt16 nNew ) { m_nCheckPageNum = nNew; }
156 
157  void Action(OutputDevice* pRenderContext); // here it begins
158  void Reset(); // back to CTor-defaults
159 
160  bool IsAgain() const { return m_bAgain; }
161  bool IsComplete() const { return m_bComplete; }
162  bool IsExpFields() const { return m_bUpdateExpFields; }
163  bool IsCalcLayout() const { return m_bCalcLayout; }
164  bool IsCheckPages() const { return m_bCheckPages; }
165  bool IsBrowseActionStop() const { return m_bBrowseActionStop; }
166  bool IsActionInProgress() const { return m_bActionInProgress; }
167 
168  sal_uInt16 GetCheckPageNum() const { return m_nCheckPageNum; }
169 
170  // others should be able to activate the WaitCursor, too
171  void CheckWaitCursor();
172 
173  // #i28701# - method is now public;
174  // delete 2nd parameter, because it's not used;
175  void FormatLayoutFly( SwFlyFrame * );
176  // #i28701# - method is now public
177  void FormatFlyContent( const SwFlyFrame * );
178 
179 };
180 
182 {
185  SwViewShellImp *pImp; // The Idler registers and deregisters here
186  SwContentNode *pContentNode; // The current cursor position is saved here
187  sal_Int32 nTextPos;
188  bool bPageValid; // Were we able to evaluate everything on the whole page?
189 #ifdef DBG_UTIL
191 
192  void ShowIdle( Color eName );
193 #endif
194 
195  bool IsInterrupt();
197  bool DoIdleJob_( const SwContentFrame*, IdleJobType );
198  bool DoIdleJob( IdleJobType, bool bVisAreaOnly );
199 
200 public:
201  SwLayIdle( SwRootFrame *pRt, SwViewShellImp *pImp );
202  ~SwLayIdle();
203 };
204 
205 inline void SwLayAction::SetCheckPageNum( sal_uInt16 nNew )
206 {
207  if ( nNew < m_nCheckPageNum )
208  m_nCheckPageNum = nNew;
209 }
210 
211 #endif // INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
212 
213 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void InternalAction(OutputDevice *pRenderContext)
Definition: layact.cxx:421
bool IsActionInProgress() const
Definition: layact.hxx:166
TaskStopwatch m_aWatch
Definition: layact.hxx:183
bool PaintWithoutFlys(const SwRect &, const SwContentFrame *, const SwPageFrame *)
Definition: layact.cxx:102
bool m_bBrowseActionStop
Definition: layact.hxx:92
bool m_bCalcLayout
Definition: layact.hxx:85
const SwPageFrame * m_pCurPage
Definition: layact.hxx:101
void SetNextCycle(bool bNew)
Definition: layact.hxx:133
bool FormatLayout(OutputDevice *pRenderContext, SwLayoutFrame *, bool bAddRect=true)
Definition: layact.cxx:1174
void ShowIdle(Color eName)
bool TurboAction_(const SwContentFrame *)
Definition: layact.cxx:777
bool FormatLayoutTab(SwTabFrame *, bool bAddRect)
Definition: layact.cxx:1449
bool m_bComplete
Definition: layact.hxx:84
void FormatFlyContent(const SwFlyFrame *)
Definition: layact.cxx:1810
bool IsWaitAllowed() const
Definition: layact.hxx:135
bool DoIdleJob(IdleJobType, bool bVisAreaOnly)
Definition: layact.cxx:2008
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:89
bool m_bReschedule
Definition: layact.hxx:88
bool IsComplete() const
Definition: layact.hxx:161
SwRootFrame * m_pRoot
Definition: layact.hxx:58
bool m_bPaintExtraData
Definition: layact.hxx:94
Of course Writer needs its own rectangles.
Definition: swrect.hxx:34
The root element of a Writer document layout.
Definition: rootfrm.hxx:79
bool IsCalcLayout() const
Definition: layact.hxx:163
SwRootFrame * pRoot
Definition: layact.hxx:184
bool m_bAgain
Definition: layact.hxx:86
void SetCalcLayout(bool bNew)
Definition: layact.hxx:147
void PaintContent(const SwContentFrame *, const SwPageFrame *, const SwRect &rOldRect, long nOldBottom)
Depending of the type, the Content is output according to its changes, or the area to be outputted is...
Definition: layact.cxx:198
bool IsReschedule() const
Definition: layact.hxx:138
bool RemoveEmptyBrowserPages()
Definition: layact.cxx:294
TaskStopwatch * m_pWatch
Definition: layact.hxx:60
bool m_bWaitAllowed
Definition: layact.hxx:93
bool IsShortCut(SwPageFrame *&)
Definition: layact.cxx:959
bool IsInterrupt()
Definition: layact.cxx:1854
sal_uInt16 GetCheckPageNum() const
Definition: layact.hxx:168
void Action(OutputDevice *pRenderContext)
Definition: layact.cxx:321
~SwLayIdle()
Definition: layact.cxx:2319
sal_uInt16 m_nEndPage
Definition: layact.hxx:79
bool IsNextCycle() const
Definition: layact.hxx:136
void SetBrowseActionStop(bool bNew)
Definition: layact.hxx:132
bool IsCheckPages() const
Definition: layact.hxx:164
bool m_bIndicator
Definition: layact.hxx:190
void SetStatBar(bool bNew)
Definition: layact.cxx:91
sal_Int32 nTextPos
Definition: layact.hxx:187
void CheckWaitCursor()
Definition: layact.cxx:78
void Reset()
Definition: layact.cxx:283
void SetCheckPageNumDirect(sal_uInt16 nNew)
Definition: layact.hxx:155
sal_uInt16 m_nPreInvaPage
Definition: layact.hxx:74
static SwPageFrame * CheckFirstVisPage(SwPageFrame *pPage)
Definition: layact.cxx:367
std::unique_ptr< SwWait > m_pWait
Definition: layact.hxx:69
The usage of LayAction is always the same:
Definition: layact.hxx:56
bool m_bUpdateExpFields
Definition: layact.hxx:91
void SetUpdateExpFields()
Definition: layact.hxx:152
bool IsExpFields() const
Definition: layact.hxx:162
bool mbFormatContentOnInterrupt
Definition: layact.hxx:98
A page of the document layout.
Definition: pagefrm.hxx:40
sal_uInt16 m_nCheckPageNum
Definition: layact.hxx:80
bool m_bActionInProgress
Definition: layact.hxx:95
~SwLayAction()
Definition: layact.cxx:272
void FormatContent_(const SwContentFrame *pContent, const SwPageFrame *pPage)
Definition: layact.cxx:1782
bool m_bPaint
Definition: layact.hxx:83
std::clock_t m_nStartTicks
Definition: layact.hxx:76
bool m_bCheckPages
Definition: layact.hxx:90
bool IsInterrupt()
Definition: layact.cxx:278
SwViewShellImp * m_pImp
Definition: layact.hxx:59
sal_uInt32 m_nCallCount
Definition: layact.hxx:103
bool DoIdleJob_(const SwContentFrame *, IdleJobType)
Definition: layact.cxx:1859
const SwTabFrame * m_pOptTab
Definition: layact.hxx:67
general base class for all free-flowing frames
Definition: flyfrm.hxx:60
SwViewShellImp * pImp
Definition: layact.hxx:185
void SetAgain()
Definition: layact.hxx:151
bool IsBrowseActionStop() const
Definition: layact.hxx:165
bool IsPaintExtraData() const
Definition: layact.hxx:140
void SetComplete(bool bNew)
Definition: layact.hxx:145
void SetReschedule(bool bNew)
Definition: layact.hxx:148
bool IsAgain() const
Definition: layact.hxx:160
void SetWaitAllowed(bool bNew)
Definition: layact.hxx:149
bool PaintContent_(const SwContentFrame *, const SwPageFrame *, const SwRect &)
Definition: layact.cxx:180
bool IsPaint() const
Definition: layact.hxx:137
bool FormatContent(const SwPageFrame *pPage)
Definition: layact.cxx:1597
SwContentNode * pContentNode
Definition: layact.hxx:186
void SetPaint(bool bNew)
Definition: layact.hxx:144
void FormatLayoutFly(SwFlyFrame *)
Definition: layact.cxx:1399
void SetCheckPages(bool bNew)
Definition: layact.hxx:131
SwLayAction(SwRootFrame *pRt, SwViewShellImp *pImp, TaskStopwatch *pWatch=nullptr)
Definition: layact.cxx:248
bool IsIdle() const
Definition: layact.hxx:139
void SetCheckPageNum(sal_uInt16 nNew)
Definition: layact.hxx:205
bool bPageValid
Definition: layact.hxx:188
SwLayIdle(SwRootFrame *pRt, SwViewShellImp *pImp)
Definition: layact.cxx:2125
bool m_bNextCycle
Definition: layact.hxx:87
bool TurboAction()
Definition: layact.cxx:832