LibreOffice Module sw (master) 1
objectformatterlayfrm.cxx
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
21#include <anchoredobject.hxx>
22#include <sortedobjs.hxx>
23#include <pagefrm.hxx>
24
25#include <layact.hxx>
26#include <osl/diagnose.h>
27
29 const SwPageFrame& _rPageFrame,
30 SwLayAction* _pLayAction )
31 : SwObjectFormatter( _rPageFrame, _pLayAction ),
32 mrAnchorLayFrame( _rAnchorLayFrame )
33{
34}
35
37{
38}
39
40std::unique_ptr<SwObjectFormatterLayFrame> SwObjectFormatterLayFrame::CreateObjFormatter(
41 SwLayoutFrame& _rAnchorLayFrame,
42 const SwPageFrame& _rPageFrame,
43 SwLayAction* _pLayAction )
44{
45 if ( !_rAnchorLayFrame.IsPageFrame() &&
46 !_rAnchorLayFrame.IsFlyFrame() )
47 {
48 OSL_FAIL( "<SwObjectFormatterLayFrame::CreateObjFormatter(..)> - unexpected type of anchor frame " );
49 return nullptr;
50 }
51
52 std::unique_ptr<SwObjectFormatterLayFrame> pObjFormatter;
53
54 // create object formatter, if floating screen objects are registered at
55 // given anchor layout frame.
56 if ( _rAnchorLayFrame.GetDrawObjs() ||
57 ( _rAnchorLayFrame.IsPageFrame() &&
58 static_cast<SwPageFrame&>(_rAnchorLayFrame).GetSortedObjs() ) )
59 {
60 pObjFormatter.reset(
61 new SwObjectFormatterLayFrame( _rAnchorLayFrame, _rPageFrame, _pLayAction ));
62 }
63
64 return pObjFormatter;
65}
66
68{
69 return mrAnchorLayFrame;
70}
71
72// #i40147# - add parameter <_bCheckForMovedFwd>.
73// Not relevant for objects anchored at layout frame.
75 const bool )
76{
77 FormatObj_( _rAnchoredObj );
78
79 // #124218# - consider that the layout action has to be
80 // restarted due to a deleted page frame.
81 return GetLayAction() == nullptr || !GetLayAction()->IsAgain();
82}
83
85{
86 bool bSuccess = FormatObjsAtFrame_();
87
88 if ( bSuccess && GetAnchorFrame().IsPageFrame() )
89 {
90 // anchor layout frame is a page frame.
91 // Thus, format also all anchored objects, which are registered at
92 // this page frame, whose 'anchor' isn't on this page frame and whose
93 // anchor frame is valid.
94 bSuccess = AdditionalFormatObjsOnPage();
95 }
96
97 return bSuccess;
98}
99
107{
108 if ( !GetAnchorFrame().IsPageFrame() )
109 {
110 OSL_FAIL( "<SwObjectFormatterLayFrame::AdditionalFormatObjsOnPage()> - mis-usage of method, call only for anchor frames of type page frame" );
111 return true;
112 }
113
114 // #124218# - consider, if the layout action
115 // has to be restarted due to a delete of a page frame.
116 if ( GetLayAction() && GetLayAction()->IsAgain() )
117 {
118 return false;
119 }
120
121 SwPageFrame& rPageFrame = static_cast<SwPageFrame&>(GetAnchorFrame());
122
123 if ( !rPageFrame.GetSortedObjs() )
124 {
125 // nothing to do, if no floating screen object is registered at the anchor frame.
126 return true;
127 }
128
129 bool bSuccess( true );
130
131 for ( size_t i = 0; i < rPageFrame.GetSortedObjs()->size(); ++i )
132 {
133 SwAnchoredObject* pAnchoredObj = (*rPageFrame.GetSortedObjs())[i];
134
135 // #i51941# - do not format object, which are anchored
136 // inside or at fly frame.
137 if ( pAnchoredObj->GetAnchorFrame()->FindFlyFrame() )
138 {
139 continue;
140 }
141 // #i33751#, #i34060# - method <GetPageFrameOfAnchor()>
142 // is replaced by method <FindPageFrameOfAnchor()>. It's return value
143 // have to be checked.
144 SwPageFrame* pPageFrameOfAnchor = pAnchoredObj->FindPageFrameOfAnchor();
145 // #i26945# - check, if the page frame of the
146 // object's anchor frame isn't the given page frame
147 OSL_ENSURE( pPageFrameOfAnchor,
148 "<SwObjectFormatterLayFrame::AdditionalFormatObjsOnPage()> - missing page frame" );
149 if ( pPageFrameOfAnchor &&
150 // #i35911#
151 pPageFrameOfAnchor->GetPhyPageNum() < rPageFrame.GetPhyPageNum() )
152 {
153 // if format of object fails, stop formatting and pass fail to
154 // calling method via the return value.
155 if ( !DoFormatObj( *pAnchoredObj ) )
156 {
157 bSuccess = false;
158 break;
159 }
160
161 // considering changes at <GetAnchorFrame().GetDrawObjs()> during
162 // format of the object.
163 if ( !rPageFrame.GetSortedObjs() ||
164 i > rPageFrame.GetSortedObjs()->size() )
165 {
166 break;
167 }
168 else
169 {
170 const size_t nActPosOfObj =
171 rPageFrame.GetSortedObjs()->ListPosOf( *pAnchoredObj );
172 if ( nActPosOfObj == rPageFrame.GetSortedObjs()->size() ||
173 nActPosOfObj > i )
174 {
175 --i;
176 }
177 else if ( nActPosOfObj < i )
178 {
179 i = nActPosOfObj;
180 }
181 }
182 }
183 } // end of loop on <rPageFrame.GetSortedObjs()>
184
185 return bSuccess;
186}
187
188/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
wrapper class for the positioning of Writer fly frames and drawing objects
const SwFrame * GetAnchorFrame() const
SwPageFrame * FindPageFrameOfAnchor()
method to determine the page frame, on which the 'anchor' of the given anchored object is.
Base class of the Writer layout elements.
Definition: frame.hxx:315
SwFlyFrame * FindFlyFrame()
Definition: frame.hxx:1111
bool IsPageFrame() const
Definition: frame.hxx:1178
const SwSortedObjs * GetDrawObjs() const
Definition: frame.hxx:564
bool IsFlyFrame() const
Definition: frame.hxx:1210
The usage of LayAction is always the same:
Definition: layact.hxx:59
bool IsAgain() const
Definition: layact.hxx:170
A layout frame is a frame that contains other frames (m_pLower), e.g. SwPageFrame or SwTabFrame.
Definition: layfrm.hxx:36
virtual bool DoFormatObj(SwAnchoredObject &_rAnchoredObj, const bool _bCheckForMovedFwd=false) override
intrinsic method to format a certain floating screen object
static std::unique_ptr< SwObjectFormatterLayFrame > CreateObjFormatter(SwLayoutFrame &_rAnchorLayFrame, const SwPageFrame &_rPageFrame, SwLayAction *_pLayAction)
virtual bool DoFormatObjs() override
intrinsic method to format all floating screen objects
SwObjectFormatterLayFrame(SwLayoutFrame &_rAnchorLayFrame, const SwPageFrame &_rPageFrame, SwLayAction *_pLayAction)
virtual ~SwObjectFormatterLayFrame() override
bool AdditionalFormatObjsOnPage()
method to format all anchored objects, which are registered at the page frame, whose 'anchor' isn't o...
virtual SwFrame & GetAnchorFrame() override
SwLayAction * GetLayAction()
void FormatObj_(SwAnchoredObject &_rAnchoredObj)
performs the intrinsic format of a given floating screen object and its content.
bool FormatObjsAtFrame_(SwTextFrame *_pMasterTextFrame=nullptr)
invokes the intrinsic format method for all floating screen objects, anchored at anchor frame on the ...
A page of the document layout.
Definition: pagefrm.hxx:58
sal_uInt16 GetPhyPageNum() const
Definition: pagefrm.hxx:204
const SwSortedObjs * GetSortedObjs() const
Definition: pagefrm.hxx:132
size_t size() const
Definition: sortedobjs.cxx:43
size_t ListPosOf(const SwAnchoredObject &_rAnchoredObj) const
Position of object <_rAnchoredObj> in sorted list.
Definition: sortedobjs.cxx:277
size
int i