1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski #ifndef _FTNBOSS_HXX
24*b1cdbd2cSJim Jagielski #define _FTNBOSS_HXX
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski #include "layfrm.hxx"
27*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski class SwFtnBossFrm;
29*b1cdbd2cSJim Jagielski class SwFtnContFrm;
30*b1cdbd2cSJim Jagielski class SwFtnFrm;
31*b1cdbd2cSJim Jagielski class SwTxtFtn;
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski //Setzen des maximalen Fussnotenbereiches. Restaurieren des alten Wertes im DTor.
35*b1cdbd2cSJim Jagielski //Implementierung im ftnfrm.cxx
36*b1cdbd2cSJim Jagielski class SwSaveFtnHeight
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski SwFtnBossFrm *pBoss;
39*b1cdbd2cSJim Jagielski const SwTwips nOldHeight;
40*b1cdbd2cSJim Jagielski SwTwips nNewHeight;
41*b1cdbd2cSJim Jagielski public:
42*b1cdbd2cSJim Jagielski SwSaveFtnHeight( SwFtnBossFrm *pBs, const SwTwips nDeadLine );
43*b1cdbd2cSJim Jagielski ~SwSaveFtnHeight();
44*b1cdbd2cSJim Jagielski };
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski #define NA_ONLY_ADJUST 0
47*b1cdbd2cSJim Jagielski #define NA_GROW_SHRINK 1
48*b1cdbd2cSJim Jagielski #define NA_GROW_ADJUST 2
49*b1cdbd2cSJim Jagielski #define NA_ADJUST_GROW 3
50*b1cdbd2cSJim Jagielski
51*b1cdbd2cSJim Jagielski class SwFtnBossFrm: public SwLayoutFrm
52*b1cdbd2cSJim Jagielski {
53*b1cdbd2cSJim Jagielski //Fuer die privaten Fussnotenoperationen
54*b1cdbd2cSJim Jagielski friend class SwFrm;
55*b1cdbd2cSJim Jagielski friend class SwSaveFtnHeight;
56*b1cdbd2cSJim Jagielski friend class SwPageFrm; // fuer das Setzen der MaxFtnHeight
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski //Maximale Hoehe des Fussnotencontainers fuer diese Seite.
59*b1cdbd2cSJim Jagielski SwTwips nMaxFtnHeight;
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski SwFtnContFrm *MakeFtnCont();
62*b1cdbd2cSJim Jagielski SwFtnFrm *FindFirstFtn();
63*b1cdbd2cSJim Jagielski sal_uInt8 _NeighbourhoodAdjustment( const SwFrm* pFrm ) const;
64*b1cdbd2cSJim Jagielski protected:
65*b1cdbd2cSJim Jagielski
66*b1cdbd2cSJim Jagielski void InsertFtn( SwFtnFrm * );
67*b1cdbd2cSJim Jagielski static void ResetFtn( const SwFtnFrm *pAssumed );
68*b1cdbd2cSJim Jagielski public:
SwFtnBossFrm(SwFrmFmt * pFmt,SwFrm * pSib)69*b1cdbd2cSJim Jagielski inline SwFtnBossFrm( SwFrmFmt* pFmt, SwFrm* pSib ) : SwLayoutFrm( pFmt, pSib ) {}
70*b1cdbd2cSJim Jagielski
71*b1cdbd2cSJim Jagielski SwLayoutFrm *FindBodyCont();
72*b1cdbd2cSJim Jagielski inline const SwLayoutFrm *FindBodyCont() const;
SetMaxFtnHeight(const SwTwips nNewMax)73*b1cdbd2cSJim Jagielski inline void SetMaxFtnHeight( const SwTwips nNewMax ) { nMaxFtnHeight = nNewMax; }
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski //Fussnotenschnittstelle
76*b1cdbd2cSJim Jagielski void AppendFtn( SwCntntFrm *, SwTxtFtn * );
77*b1cdbd2cSJim Jagielski void RemoveFtn( const SwCntntFrm *, const SwTxtFtn *, sal_Bool bPrep = sal_True );
78*b1cdbd2cSJim Jagielski static SwFtnFrm *FindFtn( const SwCntntFrm *, const SwTxtFtn * );
79*b1cdbd2cSJim Jagielski SwFtnContFrm *FindFtnCont();
80*b1cdbd2cSJim Jagielski inline const SwFtnContFrm *FindFtnCont() const;
81*b1cdbd2cSJim Jagielski const SwFtnFrm *FindFirstFtn( SwCntntFrm* ) const;
82*b1cdbd2cSJim Jagielski SwFtnContFrm *FindNearestFtnCont( sal_Bool bDontLeave = sal_False );
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski void ChangeFtnRef( const SwCntntFrm *pOld, const SwTxtFtn *,
85*b1cdbd2cSJim Jagielski SwCntntFrm *pNew );
86*b1cdbd2cSJim Jagielski void RearrangeFtns( const SwTwips nDeadLine, const sal_Bool bLock = sal_False,
87*b1cdbd2cSJim Jagielski const SwTxtFtn *pAttr = 0 );
88*b1cdbd2cSJim Jagielski
89*b1cdbd2cSJim Jagielski //SS damit der Textformatierer Temporaer die Fussnotenhoehe begrenzen
90*b1cdbd2cSJim Jagielski //kann. DeadLine in Dokumentkoordinaten.
91*b1cdbd2cSJim Jagielski void SetFtnDeadLine( const SwTwips nDeadLine );
GetMaxFtnHeight() const92*b1cdbd2cSJim Jagielski SwTwips GetMaxFtnHeight() const { return nMaxFtnHeight; }
93*b1cdbd2cSJim Jagielski
94*b1cdbd2cSJim Jagielski //Liefert den Wert, der noch uebrig ist, bis der Body seine minimale
95*b1cdbd2cSJim Jagielski //Hoehe erreicht hat.
96*b1cdbd2cSJim Jagielski SwTwips GetVarSpace() const;
97*b1cdbd2cSJim Jagielski
98*b1cdbd2cSJim Jagielski //Layoutseitig benoetigte Methoden
99*b1cdbd2cSJim Jagielski /// OD 03.04.2003 #108446# - add parameters <_bCollectOnlyPreviousFtns> and
100*b1cdbd2cSJim Jagielski /// <_pRefFtnBossFrm> in order to control, if only footnotes, which are positioned
101*b1cdbd2cSJim Jagielski /// before the given reference footnote boss frame have to be collected.
102*b1cdbd2cSJim Jagielski /// Note: if parameter <_bCollectOnlyPreviousFtns> is true, then parameter
103*b1cdbd2cSJim Jagielski /// <_pRefFtnBossFrm> have to be referenced to an object.
104*b1cdbd2cSJim Jagielski static void _CollectFtns( const SwCntntFrm* _pRef,
105*b1cdbd2cSJim Jagielski SwFtnFrm* _pFtn,
106*b1cdbd2cSJim Jagielski SvPtrarr& _rFtnArr,
107*b1cdbd2cSJim Jagielski const sal_Bool _bCollectOnlyPreviousFtns = sal_False,
108*b1cdbd2cSJim Jagielski const SwFtnBossFrm* _pRefFtnBossFrm = NULL);
109*b1cdbd2cSJim Jagielski /// OD 03.04.2003 #108446# - add parameter <_bCollectOnlyPreviousFtns> in
110*b1cdbd2cSJim Jagielski /// order to control, if only footnotes, which are positioned before the
111*b1cdbd2cSJim Jagielski /// footnote boss frame <this> have to be collected.
112*b1cdbd2cSJim Jagielski void CollectFtns( const SwCntntFrm* _pRef,
113*b1cdbd2cSJim Jagielski SwFtnBossFrm* _pOld,
114*b1cdbd2cSJim Jagielski SvPtrarr& _rFtnArr,
115*b1cdbd2cSJim Jagielski const sal_Bool _bCollectOnlyPreviousFtns = sal_False );
116*b1cdbd2cSJim Jagielski void _MoveFtns( SvPtrarr &rFtnArr, sal_Bool bCalc = sal_False );
117*b1cdbd2cSJim Jagielski void MoveFtns( const SwCntntFrm *pSrc, SwCntntFrm *pDest,
118*b1cdbd2cSJim Jagielski SwTxtFtn *pAttr );
119*b1cdbd2cSJim Jagielski // Sollte AdjustNeighbourhood gerufen werden (oder Grow/Shrink)?
NeighbourhoodAdjustment(const SwFrm * pFrm) const120*b1cdbd2cSJim Jagielski sal_uInt8 NeighbourhoodAdjustment( const SwFrm* pFrm ) const
121*b1cdbd2cSJim Jagielski { return IsPageFrm() ? NA_ONLY_ADJUST : _NeighbourhoodAdjustment( pFrm ); }
122*b1cdbd2cSJim Jagielski };
123*b1cdbd2cSJim Jagielski
FindBodyCont() const124*b1cdbd2cSJim Jagielski inline const SwLayoutFrm *SwFtnBossFrm::FindBodyCont() const
125*b1cdbd2cSJim Jagielski {
126*b1cdbd2cSJim Jagielski return ((SwFtnBossFrm*)this)->FindBodyCont();
127*b1cdbd2cSJim Jagielski }
FindFtnCont() const128*b1cdbd2cSJim Jagielski inline const SwFtnContFrm *SwFtnBossFrm::FindFtnCont() const
129*b1cdbd2cSJim Jagielski {
130*b1cdbd2cSJim Jagielski return ((SwFtnBossFrm*)this)->FindFtnCont();
131*b1cdbd2cSJim Jagielski }
132*b1cdbd2cSJim Jagielski
133*b1cdbd2cSJim Jagielski #endif //_FTNBOSS_HXX
134