summaryrefslogtreecommitdiff
path: root/sw/source/core/inc/ftnfrm.hxx
blob: e9b2d3cb23f0ecfa7e97f041c15c1a9898f9813d (plain)
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
138
139
140
141
142
/* -*- 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_FTNFRM_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_FTNFRM_HXX

#include "layfrm.hxx"

class SwContentFrm;
class SwTextFootnote;
class SwBorderAttrs;
class SwFootnoteFrm;

void sw_RemoveFootnotes( SwFootnoteBossFrm* pBoss, bool bPageOnly, bool bEndNotes );

// There exists a special section on a page for footnotes. It's called
// SwFootnoteContFrm. Each footnote is separated by a SwFootnoteFrm which contains
// the paragraphs of a footnote. SwFootnoteFrm can be splitted and will then
// continue on another page.
class SwFootnoteContFrm: public SwLayoutFrm
{
public:
    SwFootnoteContFrm( SwFrameFormat*, SwFrm* );

    const SwFootnoteFrm* FindFootNote() const;

    virtual SwTwips ShrinkFrm( SwTwips, bool bTst = false, bool bInfo = false ) SAL_OVERRIDE;
    virtual SwTwips GrowFrm  ( SwTwips, bool bTst = false, bool bInfo = false ) SAL_OVERRIDE;
    virtual void    Format( const SwBorderAttrs *pAttrs = 0 ) SAL_OVERRIDE;
    virtual void    PaintBorder( const SwRect &, const SwPageFrm *pPage,
                                 const SwBorderAttrs & ) const SAL_OVERRIDE;
    virtual void PaintSubsidiaryLines( const SwPageFrm*, const SwRect& ) const SAL_OVERRIDE;
            void    PaintLine( const SwRect &, const SwPageFrm * ) const;
};

class SwFootnoteFrm: public SwLayoutFrm
{
    // Pointer to FootnoteFrm in which the footnote will be continued:
    //  - 0     no following existent
    //  - this  for the last one
    //  - otherwise the following FootnoteFrm
    SwFootnoteFrm     *pFollow;
    SwFootnoteFrm     *pMaster;      // FootnoteFrm from which I am the following
    SwContentFrm   *pRef;         // in this ContentFrm is the footnote reference
    SwTextFootnote     *pAttr;        // footnote attribute (for recognition)

    // if true paragraphs in this footnote are NOT permitted to flow backwards
    bool bBackMoveLocked : 1;
    // #i49383# - control unlock of position of lower anchored objects.
    bool mbUnlockPosOfLowerObjs : 1;
#ifdef DBG_UTIL
protected:
    virtual SwTwips ShrinkFrm( SwTwips, bool bTst = false, bool bInfo = false ) SAL_OVERRIDE;
    virtual SwTwips GrowFrm  ( SwTwips, bool bTst = false, bool bInfo = false ) SAL_OVERRIDE;
#endif

public:
    SwFootnoteFrm( SwFrameFormat*, SwFrm*, SwContentFrm*, SwTextFootnote* );

    virtual void Cut() SAL_OVERRIDE;
    virtual void Paste( SwFrm* pParent, SwFrm* pSibling = 0 ) SAL_OVERRIDE;

    virtual void PaintSubsidiaryLines( const SwPageFrm*, const SwRect& ) const SAL_OVERRIDE;

    bool operator<( const SwTextFootnote* pTextFootnote ) const;

#ifdef DBG_UTIL
    const SwContentFrm *GetRef() const;
         SwContentFrm  *GetRef();
#else
    const SwContentFrm *GetRef() const    { return pRef; }
         SwContentFrm  *GetRef()          { return pRef; }
#endif
    const SwContentFrm *GetRefFromAttr()  const;
          SwContentFrm *GetRefFromAttr();

    const SwFootnoteFrm *GetFollow() const   { return pFollow; }
          SwFootnoteFrm *GetFollow()         { return pFollow; }

    const SwFootnoteFrm *GetMaster() const   { return pMaster; }
          SwFootnoteFrm *GetMaster()         { return pMaster; }

    const SwTextFootnote   *GetAttr() const   { return pAttr; }
          SwTextFootnote   *GetAttr()         { return pAttr; }

    void SetFollow( SwFootnoteFrm *pNew ) { pFollow = pNew; }
    void SetMaster( SwFootnoteFrm *pNew ) { pMaster = pNew; }
    void SetRef   ( SwContentFrm *pNew ) { pRef = pNew; }

    void InvalidateNxtFootnoteCnts( SwPageFrm* pPage );

    void LockBackMove()     { bBackMoveLocked = true; }
    void UnlockBackMove()   { bBackMoveLocked = false;}
    bool IsBackMoveLocked() { return bBackMoveLocked; }

    // prevents that the last content deletes the SwFootnoteFrm as well (Cut())
    inline void ColLock()       { mbColLocked = true; }
    inline void ColUnlock()     { mbColLocked = false; }

    // #i49383#
    inline void UnlockPosOfLowerObjs()
    {
        mbUnlockPosOfLowerObjs = true;
    }
    inline void KeepLockPosOfLowerObjs()
    {
        mbUnlockPosOfLowerObjs = false;
    }
    inline bool IsUnlockPosOfLowerObjs()
    {
        return mbUnlockPosOfLowerObjs;
    }

    /** search for last content in the current footnote frame

        OD 2005-12-02 #i27138#

        @return SwContentFrm*
        pointer to found last content frame. NULL, if none is found.
    */
    SwContentFrm* FindLastContent();
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */