LibreOffice Module sw (master) 1
fmthdft.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_INC_FMTHDFT_HXX
20#define INCLUDED_SW_INC_FMTHDFT_HXX
21
22#include "hintids.hxx"
23#include "format.hxx"
24#include <svl/poolitem.hxx>
25#include "calbck.hxx"
26#include "frmfmt.hxx"
27
28class IntlWrapper;
29
33class SW_DLLPUBLIC SwFormatHeader final : public SfxPoolItem, public SwClient
34{
35 bool m_bActive;
36
37public:
38 SwFormatHeader( bool bOn = false );
39 SwFormatHeader( SwFrameFormat *pHeaderFormat );
40 SwFormatHeader( const SwFormatHeader &rCpy );
41 virtual ~SwFormatHeader() override;
43
44
46 virtual bool operator==( const SfxPoolItem& ) const override;
47 virtual SwFormatHeader* Clone( SfxItemPool* pPool = nullptr ) const override;
48 virtual bool GetPresentation( SfxItemPresentation ePres,
49 MapUnit eCoreMetric,
50 MapUnit ePresMetric,
51 OUString &rText,
52 const IntlWrapper& rIntl ) const override;
53
54 const SwFrameFormat *GetHeaderFormat() const { return static_cast<const SwFrameFormat*>(GetRegisteredIn()); }
56
57 void RegisterToFormat( SwFormat& rFormat );
58 bool IsActive() const { return m_bActive; }
59};
60
64class SW_DLLPUBLIC SwFormatFooter final : public SfxPoolItem, public SwClient
65{
66 bool m_bActive; // Only for controlling (creation of content).
67
68public:
69 SwFormatFooter( bool bOn = false );
70 SwFormatFooter( SwFrameFormat *pFooterFormat );
71 SwFormatFooter( const SwFormatFooter &rCpy );
72 virtual ~SwFormatFooter() override;
74
75
77 virtual bool operator==( const SfxPoolItem& ) const override;
78 virtual SwFormatFooter* Clone( SfxItemPool* pPool = nullptr ) const override;
79 virtual bool GetPresentation( SfxItemPresentation ePres,
80 MapUnit eCoreMetric,
81 MapUnit ePresMetric,
82 OUString &rText,
83 const IntlWrapper& rIntl ) const override;
84
85 const SwFrameFormat *GetFooterFormat() const { return static_cast<const SwFrameFormat*>(GetRegisteredIn()); }
87
88 void RegisterToFormat( SwFormat& rFormat );
89 bool IsActive() const { return m_bActive; }
90};
91
92inline const SwFormatHeader &SwAttrSet::GetHeader(bool bInP) const
93 { return Get( RES_HEADER,bInP); }
94inline const SwFormatFooter &SwAttrSet::GetFooter(bool bInP) const
95 { return Get( RES_FOOTER,bInP); }
96
97inline const SwFormatHeader &SwFormat::GetHeader(bool bInP) const
98 { return m_aSet.GetHeader(bInP); }
99inline const SwFormatFooter &SwFormat::GetFooter(bool bInP) const
100 { return m_aSet.GetFooter(bInP); }
101
102#endif
103
104/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
const SfxPoolItem & Get(sal_uInt16 nWhich, bool bSrchInParent=true) const
virtual bool GetPresentation(SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
virtual bool operator==(const SfxPoolItem &) const=0
virtual SfxPoolItem * Clone(SfxItemPool *pPool=nullptr) const=0
const SwFormatHeader & GetHeader(bool=true) const
Definition: fmthdft.hxx:92
const SwFormatFooter & GetFooter(bool=true) const
Definition: fmthdft.hxx:94
const SwModify * GetRegisteredIn() const
Definition: calbck.hxx:166
Footer, for pageformats Client of FrameFormat describing the footer.
Definition: fmthdft.hxx:65
bool m_bActive
Definition: fmthdft.hxx:66
bool IsActive() const
Definition: fmthdft.hxx:89
SwFormatFooter & operator=(const SwFormatFooter &rCpy)
SwFrameFormat * GetFooterFormat()
Definition: fmthdft.hxx:86
const SwFrameFormat * GetFooterFormat() const
Definition: fmthdft.hxx:85
Header, for PageFormats Client of FrameFormat describing the header.
Definition: fmthdft.hxx:34
SwFrameFormat * GetHeaderFormat()
Definition: fmthdft.hxx:55
bool IsActive() const
Definition: fmthdft.hxx:58
bool m_bActive
Only for controlling (creation of content).
Definition: fmthdft.hxx:35
SwFormatHeader & operator=(const SwFormatHeader &rCpy)
const SwFrameFormat * GetHeaderFormat() const
Definition: fmthdft.hxx:54
Base class for various Writer styles.
Definition: format.hxx:47
const SwFormatFooter & GetFooter(bool=true) const
Definition: fmthdft.hxx:99
const SwFormatHeader & GetHeader(bool=true) const
Definition: fmthdft.hxx:97
SwAttrSet m_aSet
Definition: format.hxx:51
Style of a layout element.
Definition: frmfmt.hxx:62
constexpr TypedWhichId< SwFormatHeader > RES_HEADER(96)
constexpr TypedWhichId< SwFormatFooter > RES_FOOTER(97)
MapUnit
SfxItemPresentation
#define SW_DLLPUBLIC
Definition: swdllapi.h:28