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/TaskStopwatch.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
60 
61  // For the sake of optimization, so that the tables stick a bit better to
62  // the Cursor when hitting return/backspace in front of one.
63  // The first TabFrame that paints itself (per page) adds itself to the pointer.
64  // The ContentFrames beneath the page do not need to deregister at the Shell for
65  // painting.
67 
68  std::unique_ptr<SwWait> m_pWait;
69 
70  // If a paragraph (or anything else) moved more than one page when
71  // formatting, it adds its new page number here.
72  // The InternalAction can then take the appropriate steps.
73  sal_uInt16 m_nPreInvaPage;
74 
75  std::clock_t m_nStartTicks; // The Action's starting time; if too much time passes the
76  // WaitCursor can be enabled via CheckWaitCursor()
77 
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_bReschedule; // Call Reschedule depending on Progress?
88  bool m_bInterrupt; // For termination the layouting
89  bool m_bCheckPages; // Run CheckPageDescs() or delay it
90  bool m_bUpdateExpFields; // Is set if, after Formatting, we need to do another round for ExpField
91  bool m_bBrowseActionStop; // Terminate Action early (as per bInput) and leave the rest to the Idler
92  bool m_bWaitAllowed; // Waitcursor allowed?
93  bool m_bPaintExtraData; // Painting line numbers (or similar) enabled?
94  bool m_bActionInProgress; // Is set in Action() at the beginning and deleted at the end
95 
96  // OD 14.04.2003 #106346# - new flag for content formatting on interrupt.
98 
99  // for loop control by disabling in-row splitting within embedded tables
101  sal_uInt16 m_nTabLevel; // embedding level
102  sal_uInt32 m_nCallCount; // calling FormatLayoutTab on the same page
103 
104  void PaintContent( const SwContentFrame *, const SwPageFrame *,
105  const SwRect &rOldRect, tools::Long nOldBottom );
106  bool PaintWithoutFlys( const SwRect &, const SwContentFrame *,
107  const SwPageFrame * );
108  inline bool PaintContent_( const SwContentFrame *, const SwPageFrame *,
109  const SwRect & );
110 
111  bool FormatLayout( OutputDevice* pRenderContext, SwLayoutFrame *, bool bAddRect = true );
112  bool FormatLayoutTab( SwTabFrame *, bool bAddRect );
113  bool FormatContent( const SwPageFrame* pPage );
114  void FormatContent_( const SwContentFrame* pContent,
115  const SwPageFrame* pPage );
116  bool IsShortCut( SwPageFrame *& );
117 
118  bool TurboAction();
119  bool TurboAction_( const SwContentFrame * );
120  void InternalAction(OutputDevice* pRenderContext);
121 
122  static SwPageFrame *CheckFirstVisPage( SwPageFrame *pPage );
123 
125 
126 public:
127  SwLayAction(SwRootFrame *pRt, SwViewShellImp *pImp, TaskStopwatch* pWatch = nullptr);
128  ~SwLayAction();
129 
130  void SetCheckPages ( bool bNew ) { m_bCheckPages = bNew; }
131  void SetBrowseActionStop( bool bNew ) { m_bBrowseActionStop = bNew; }
132  void SetNextCycle ( bool bNew ) { m_bNextCycle = bNew; }
133 
134  bool IsWaitAllowed() const { return m_bWaitAllowed; }
135  bool IsNextCycle() const { return m_bNextCycle; }
136  bool IsPaint() const { return m_bPaint; }
137  bool IsReschedule() const { return m_bReschedule; }
138  bool IsIdle() const { return m_pWatch != nullptr; }
139  bool IsPaintExtraData() const { return m_bPaintExtraData; }
140  bool IsInterrupt();
141 
142  // adjusting Action to the wanted behaviour
143  void SetPaint ( bool bNew ) { m_bPaint = bNew; }
144  void SetComplete ( bool bNew ) { m_bComplete = bNew; }
145  void SetStatBar ( bool bNew );
146  void SetCalcLayout ( bool bNew ) { m_bCalcLayout = bNew; }
147  void SetReschedule ( bool bNew ) { m_bReschedule = bNew; }
148  void SetWaitAllowed ( bool bNew ) { m_bWaitAllowed = bNew; }
149 
150  void SetAgain() { m_bAgain = true; }
151  void SetUpdateExpFields() {m_bUpdateExpFields = true; }
152 
153  inline void SetCheckPageNum( sal_uInt16 nNew );
154  void SetCheckPageNumDirect( sal_uInt16 nNew ) { m_nCheckPageNum = nNew; }
155 
156  void Action(OutputDevice* pRenderContext); // here it begins
157  void Reset(); // back to CTor-defaults
158 
159  bool IsAgain() const { return m_bAgain; }
160  bool IsComplete() const { return m_bComplete; }
161  bool IsExpFields() const { return m_bUpdateExpFields; }
162  bool IsCalcLayout() const { return m_bCalcLayout; }
163  bool IsCheckPages() const { return m_bCheckPages; }
164  bool IsBrowseActionStop() const { return m_bBrowseActionStop; }
165  bool IsActionInProgress() const { return m_bActionInProgress; }
166 
167  sal_uInt16 GetCheckPageNum() const { return m_nCheckPageNum; }
168 
169  // others should be able to activate the WaitCursor, too
170  void CheckWaitCursor();
171 
172  // #i28701# - method is now public;
173  // delete 2nd parameter, because it's not used;
174  void FormatLayoutFly( SwFlyFrame * );
175  // #i28701# - method is now public
176  void FormatFlyContent( const SwFlyFrame * );
177 
178 };
179 
181 {
184  SwViewShellImp *m_pImp; // The Idler registers and deregisters here
185  SwContentNode *m_pContentNode; // The current cursor position is saved here
186  sal_Int32 m_nTextPos;
187  bool m_bPageValid; // Were we able to evaluate everything on the whole page?
188 #ifdef DBG_UTIL
190 
191  void ShowIdle( Color eName );
192 #endif
193 
194  bool IsInterrupt();
196  bool DoIdleJob_( const SwContentFrame*, IdleJobType );
197  bool DoIdleJob( IdleJobType, bool bVisAreaOnly );
198 
199 public:
200  SwLayIdle( SwRootFrame *pRt, SwViewShellImp *pImp );
201  ~SwLayIdle();
202 };
203 
204 inline void SwLayAction::SetCheckPageNum( sal_uInt16 nNew )
205 {
206  if ( nNew < m_nCheckPageNum )
207  m_nCheckPageNum = nNew;
208 }
209 
210 #endif // INCLUDED_SW_SOURCE_CORE_INC_LAYACT_HXX
211 
212 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void InternalAction(OutputDevice *pRenderContext)
Definition: layact.cxx:420
bool IsActionInProgress() const
Definition: layact.hxx:165
TaskStopwatch m_aWatch
Definition: layact.hxx:182
bool PaintWithoutFlys(const SwRect &, const SwContentFrame *, const SwPageFrame *)
Definition: layact.cxx:101
bool m_bBrowseActionStop
Definition: layact.hxx:91
bool m_bCalcLayout
Definition: layact.hxx:84
const SwPageFrame * m_pCurPage
Definition: layact.hxx:100
void SetNextCycle(bool bNew)
Definition: layact.hxx:132
bool FormatLayout(OutputDevice *pRenderContext, SwLayoutFrame *, bool bAddRect=true)
Definition: layact.cxx:1177
void ShowIdle(Color eName)
bool TurboAction_(const SwContentFrame *)
Definition: layact.cxx:780
bool FormatLayoutTab(SwTabFrame *, bool bAddRect)
Definition: layact.cxx:1473
bool m_bComplete
Definition: layact.hxx:83
void FormatFlyContent(const SwFlyFrame *)
Definition: layact.cxx:1834
bool IsWaitAllowed() const
Definition: layact.hxx:134
bool DoIdleJob(IdleJobType, bool bVisAreaOnly)
Definition: layact.cxx:2032
long Long
sal_uInt16 m_nTabLevel
Definition: layact.hxx:101
SwTabFrame is one table in the document layout, containing rows (which contain cells).
Definition: tabfrm.hxx:30
bool m_bInterrupt
Definition: layact.hxx:88
bool m_bReschedule
Definition: layact.hxx:87
bool IsComplete() const
Definition: layact.hxx:160
SwRootFrame * m_pRoot
Definition: layact.hxx:57
bool m_bPaintExtraData
Definition: layact.hxx:93
Of course Writer needs its own rectangles.
Definition: swrect.hxx:35
The root element of a Writer document layout.
Definition: rootfrm.hxx:82
bool IsCalcLayout() const
Definition: layact.hxx:162
bool m_bAgain
Definition: layact.hxx:85
void SetCalcLayout(bool bNew)
Definition: layact.hxx:146
bool IsReschedule() const
Definition: layact.hxx:137
bool RemoveEmptyBrowserPages()
Definition: layact.cxx:293
TaskStopwatch * m_pWatch
Definition: layact.hxx:59
bool m_bWaitAllowed
Definition: layact.hxx:92
bool IsShortCut(SwPageFrame *&)
Definition: layact.cxx:962
bool IsInterrupt()
Definition: layact.cxx:1878
sal_uInt16 GetCheckPageNum() const
Definition: layact.hxx:167
void Action(OutputDevice *pRenderContext)
Definition: layact.cxx:320
~SwLayIdle()
Definition: layact.cxx:2339
sal_uInt16 m_nEndPage
Definition: layact.hxx:78
bool IsNextCycle() const
Definition: layact.hxx:135
void SetBrowseActionStop(bool bNew)
Definition: layact.hxx:131
bool IsCheckPages() const
Definition: layact.hxx:163
bool m_bIndicator
Definition: layact.hxx:189
void SetStatBar(bool bNew)
Definition: layact.cxx:90
void CheckWaitCursor()
Definition: layact.cxx:77
void Reset()
Definition: layact.cxx:282
void SetCheckPageNumDirect(sal_uInt16 nNew)
Definition: layact.hxx:154
sal_uInt16 m_nPreInvaPage
Definition: layact.hxx:73
static SwPageFrame * CheckFirstVisPage(SwPageFrame *pPage)
Definition: layact.cxx:366
SwViewShellImp * m_pImp
Definition: layact.hxx:184
std::unique_ptr< SwWait > m_pWait
Definition: layact.hxx:68
The usage of LayAction is always the same:
Definition: layact.hxx:55
bool m_bUpdateExpFields
Definition: layact.hxx:90
void SetUpdateExpFields()
Definition: layact.hxx:151
bool IsExpFields() const
Definition: layact.hxx:161
bool mbFormatContentOnInterrupt
Definition: layact.hxx:97
A page of the document layout.
Definition: pagefrm.hxx:41
sal_uInt16 m_nCheckPageNum
Definition: layact.hxx:79
SwContentNode * m_pContentNode
Definition: layact.hxx:185
bool m_bActionInProgress
Definition: layact.hxx:94
~SwLayAction()
Definition: layact.cxx:271
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:197
void FormatContent_(const SwContentFrame *pContent, const SwPageFrame *pPage)
Definition: layact.cxx:1806
bool m_bPaint
Definition: layact.hxx:82
std::clock_t m_nStartTicks
Definition: layact.hxx:75
bool m_bCheckPages
Definition: layact.hxx:89
bool IsInterrupt()
Definition: layact.cxx:277
SwViewShellImp * m_pImp
Definition: layact.hxx:58
sal_uInt32 m_nCallCount
Definition: layact.hxx:102
bool DoIdleJob_(const SwContentFrame *, IdleJobType)
Definition: layact.cxx:1883
const SwTabFrame * m_pOptTab
Definition: layact.hxx:66
general base class for all free-flowing frames
Definition: flyfrm.hxx:60
void SetAgain()
Definition: layact.hxx:150
SwRootFrame * m_pRoot
Definition: layact.hxx:183
bool IsBrowseActionStop() const
Definition: layact.hxx:164
bool IsPaintExtraData() const
Definition: layact.hxx:139
void SetComplete(bool bNew)
Definition: layact.hxx:144
void SetReschedule(bool bNew)
Definition: layact.hxx:147
bool IsAgain() const
Definition: layact.hxx:159
void SetWaitAllowed(bool bNew)
Definition: layact.hxx:148
bool PaintContent_(const SwContentFrame *, const SwPageFrame *, const SwRect &)
Definition: layact.cxx:179
bool IsPaint() const
Definition: layact.hxx:136
bool m_bPageValid
Definition: layact.hxx:187
bool FormatContent(const SwPageFrame *pPage)
Definition: layact.cxx:1621
void SetPaint(bool bNew)
Definition: layact.hxx:143
void FormatLayoutFly(SwFlyFrame *)
Definition: layact.cxx:1423
void SetCheckPages(bool bNew)
Definition: layact.hxx:130
SwLayAction(SwRootFrame *pRt, SwViewShellImp *pImp, TaskStopwatch *pWatch=nullptr)
Definition: layact.cxx:247
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:138
sal_Int32 m_nTextPos
Definition: layact.hxx:186
void SetCheckPageNum(sal_uInt16 nNew)
Definition: layact.hxx:204
SwLayIdle(SwRootFrame *pRt, SwViewShellImp *pImp)
Definition: layact.cxx:2149
bool m_bNextCycle
Definition: layact.hxx:86
bool TurboAction()
Definition: layact.cxx:835