LibreOffice Module sw (master) 1
chpfld.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_CHPFLD_HXX
20#define INCLUDED_SW_INC_CHPFLD_HXX
21
22#include "fldbas.hxx"
23
24class SwFrame;
25class SwContentNode;
26class SwTextNode;
27class SwRootFrame;
28
30{
37};
38
39class SAL_DLLPUBLIC_RTTI SwChapterFieldType final : public SwFieldType
40{
41public:
43
44 virtual std::unique_ptr<SwFieldType> Copy() const override;
45
46};
47
49{
50 friend class SwChapterFieldType;
51 friend class ToxTextGeneratorTest; // the unittest needs to mock the chapter fields.
52
53 struct State
54 {
56 OUString sTitle;
57 OUString sNumber;
59 OUString sPre;
60 OUString sPost;
61 State() : nLevel(0) {}
62 };
65
66 virtual OUString ExpandImpl(SwRootFrame const* pLayout) const override;
67 virtual std::unique_ptr<SwField> Copy() const override;
68
69public:
70 SwChapterField(SwChapterFieldType*, sal_uInt32 nFormat = 0);
71
72 // #i53420#
73 void ChangeExpansion( const SwFrame&,
74 const SwContentNode*,
75 bool bSrchNum = false);
76 void ChangeExpansion(const SwTextNode &rNd, bool bSrchNum, SwRootFrame const* pLayout = nullptr);
77
78 sal_uInt8 GetLevel(SwRootFrame const* pLayout = nullptr) const;
79 void SetLevel(sal_uInt8);
80
81 const OUString& GetNumber(SwRootFrame const* pLayout = nullptr) const;
82 const OUString& GetTitle(SwRootFrame const* pLayout = nullptr) const;
83
84 virtual bool QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
85 virtual bool PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
86};
87
88#endif // INCLUDED_SW_INC_CHPFLD_HXX
89
90/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SwChapterFormat
Definition: chpfld.hxx:30
@ CF_TITLE
only the title
Definition: chpfld.hxx:33
@ CF_NUM_TITLE
number and title
Definition: chpfld.hxx:34
@ CF_BEGIN
Definition: chpfld.hxx:31
@ CF_NUMBER
only the chapter number
Definition: chpfld.hxx:32
@ CF_NUMBER_NOPREPST
only chapter number without post-/prefix
Definition: chpfld.hxx:35
@ CF_NUM_NOPREPST_TITLE
chapter number without post-/prefix and title
Definition: chpfld.hxx:36
State m_State
Definition: chpfld.hxx:63
State m_StateRLHidden
Definition: chpfld.hxx:64
Instances of SwFields and those derived from it occur 0 to n times.
Definition: fldbas.hxx:242
virtual std::unique_ptr< SwFieldType > Copy() const =0
Base class of all fields.
Definition: fldbas.hxx:292
virtual OUString ExpandImpl(SwRootFrame const *pLayout) const =0
virtual bool QueryValue(css::uno::Any &rVal, sal_uInt16 nWhichId) const
Definition: fldbas.cxx:351
virtual bool PutValue(const css::uno::Any &rVal, sal_uInt16 nWhichId)
Definition: fldbas.cxx:369
virtual std::unique_ptr< SwField > Copy() const =0
const OUString & GetTitle() const
Definition: fldbas.hxx:394
Base class of the Writer layout elements.
Definition: frame.hxx:315
The root element of a Writer document layout.
Definition: rootfrm.hxx:82
SwTextNode is a paragraph in the document model.
Definition: ndtxt.hxx:111
sal_uInt8 nLevel
Definition: chpfld.hxx:55
OUString sLabelFollowedBy
Definition: chpfld.hxx:58
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
unsigned char sal_uInt8