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
|
/* -*- 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_FTNBOSS_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_FTNBOSS_HXX
#include "layfrm.hxx"
class SwFootnoteBossFrame;
class SwFootnoteContFrame;
class SwFootnoteFrame;
class SwTextFootnote;
// Set max. footnote area.
// Restoration of the old value in DTor. Implementation in ftnfrm.cxx
class SwSaveFootnoteHeight
{
SwFootnoteBossFrame *pBoss;
const SwTwips nOldHeight;
SwTwips nNewHeight;
public:
SwSaveFootnoteHeight( SwFootnoteBossFrame *pBs, const SwTwips nDeadLine );
~SwSaveFootnoteHeight();
};
enum class SwNeighbourAdjust {
OnlyAdjust, GrowShrink, GrowAdjust, AdjustGrow
};
typedef std::vector<SwFootnoteFrame*> SwFootnoteFrames;
class SwFootnoteBossFrame: public SwLayoutFrame
{
// for private footnote operations
friend class SwFrame;
friend class SwSaveFootnoteHeight;
friend class SwPageFrame; // for setting of MaxFootnoteHeight
// max. height of the footnote container on this page
SwTwips nMaxFootnoteHeight;
SwFootnoteContFrame *MakeFootnoteCont();
SwFootnoteFrame *FindFirstFootnote();
SwNeighbourAdjust NeighbourhoodAdjustment_( const SwFrame* pFrame ) const;
protected:
void InsertFootnote( SwFootnoteFrame * );
static void ResetFootnote( const SwFootnoteFrame *pAssumed );
public:
inline SwFootnoteBossFrame( SwFrameFormat* pFormat, SwFrame* pSib )
: SwLayoutFrame( pFormat, pSib )
, nMaxFootnoteHeight(0)
{}
SwLayoutFrame *FindBodyCont();
inline const SwLayoutFrame *FindBodyCont() const;
inline void SetMaxFootnoteHeight( const SwTwips nNewMax ) { nMaxFootnoteHeight = nNewMax; }
// footnote interface
void AppendFootnote( SwContentFrame *, SwTextFootnote * );
void RemoveFootnote( const SwContentFrame *, const SwTextFootnote *, bool bPrep = true );
static SwFootnoteFrame *FindFootnote( const SwContentFrame *, const SwTextFootnote * );
SwFootnoteContFrame *FindFootnoteCont();
inline const SwFootnoteContFrame *FindFootnoteCont() const;
const SwFootnoteFrame *FindFirstFootnote( SwContentFrame* ) const;
SwFootnoteContFrame *FindNearestFootnoteCont( bool bDontLeave = false );
static void ChangeFootnoteRef( const SwContentFrame *pOld, const SwTextFootnote *,
SwContentFrame *pNew );
void RearrangeFootnotes( const SwTwips nDeadLine, const bool bLock,
const SwTextFootnote *pAttr = nullptr );
// Set DeadLine (in document coordinates) so that the text formatter can
// temporarily limit footnote height.
void SetFootnoteDeadLine( const SwTwips nDeadLine );
SwTwips GetMaxFootnoteHeight() const { return nMaxFootnoteHeight; }
// returns value for remaining space until the body reaches minimal height
SwTwips GetVarSpace() const;
// methods needed for layouting
// The parameters <_bCollectOnlyPreviousFootnotes> and <_pRefFootnoteBossFrame> control
// if only footnotes that are positioned before the given reference
// footnote boss-frame have to be collected.
// Note: if parameter <_bCollectOnlyPreviousFootnotes> is true, then parameter
// <_pRefFootnoteBossFrame> has to be referenced by an object.
static void CollectFootnotes_( const SwContentFrame* _pRef,
SwFootnoteFrame* _pFootnote,
SwFootnoteFrames& _rFootnoteArr,
const bool _bCollectOnlyPreviousFootnotes = false,
const SwFootnoteBossFrame* _pRefFootnoteBossFrame = nullptr);
// The parameter <_bCollectOnlyPreviousFootnotes> controls if only footnotes
// that are positioned before the footnote boss-frame <this> have to be
// collected.
void CollectFootnotes( const SwContentFrame* _pRef,
SwFootnoteBossFrame* _pOld,
SwFootnoteFrames& _rFootnoteArr,
const bool _bCollectOnlyPreviousFootnotes = false );
void MoveFootnotes_( SwFootnoteFrames &rFootnoteArr, bool bCalc = false );
void MoveFootnotes( const SwContentFrame *pSrc, SwContentFrame *pDest,
SwTextFootnote *pAttr );
// should AdjustNeighbourhood be called (or Grow/Shrink)?
SwNeighbourAdjust NeighbourhoodAdjustment( const SwFrame* pFrame ) const
{ return IsPageFrame() ? SwNeighbourAdjust::OnlyAdjust : NeighbourhoodAdjustment_( pFrame ); }
};
inline const SwLayoutFrame *SwFootnoteBossFrame::FindBodyCont() const
{
return const_cast<SwFootnoteBossFrame*>(this)->FindBodyCont();
}
inline const SwFootnoteContFrame *SwFootnoteBossFrame::FindFootnoteCont() const
{
return const_cast<SwFootnoteBossFrame*>(this)->FindFootnoteCont();
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
