sw/inc/chpfld.hxx

   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
  24 class SwFrame;
  25 class SwContentNode;
  26 class SwTextNode;
  27 class SwRootFrame;
  28
  29 enum SwChapterFormat
  30 {
  31     CF_BEGIN,
  32     CF_NUMBER = CF_BEGIN,       ///< only the chapter number
  33     CF_TITLE,                   ///< only the title
  34     CF_NUM_TITLE,               ///< number and title
  35     CF_NUMBER_NOPREPST,         ///< only chapter number without post-/prefix
  36     CF_NUM_NOPREPST_TITLE,      ///< chapter number without post-/prefix and title
  37 };
  38
  39 class SAL_DLLPUBLIC_RTTI SwChapterFieldType final : public SwFieldType
  40 {
  41 public:
  42     SwChapterFieldType();
  43
  44     virtual std::unique_ptr<SwFieldType> Copy() const override;
  45
  46 };
  47
  48 class SW_DLLPUBLIC SwChapterField final : public SwField
  49 {
  50     friend class SwChapterFieldType;
  51     friend class ToxTextGeneratorTest; // the unittest needs to mock the chapter fields.
  52
  53     struct State
  54     {
  55         sal_uInt8 nLevel;
  56         OUString sTitle;
  57         OUString sNumber;
  58         OUString sPre;
  59         OUString sPost;
  60         State() : nLevel(0) {}
  61     };
  62     State m_State;
  63     State m_StateRLHidden;
  64
  65     virtual OUString ExpandImpl(SwRootFrame const* pLayout) const override;
  66     virtual std::unique_ptr<SwField> Copy() const override;
  67
  68 public:
  69     SwChapterField(SwChapterFieldType*, sal_uInt32 nFormat = 0);
  70
  71     // #i53420#
  72     void ChangeExpansion( const SwFrame&,
  73                           const SwContentNode*,
  74         bool bSrchNum = false);
  75     void ChangeExpansion(const SwTextNode &rNd, bool bSrchNum, SwRootFrame const* pLayout = nullptr);
  76
  77     sal_uInt8 GetLevel(SwRootFrame const* pLayout = nullptr) const;
  78     void SetLevel(sal_uInt8);
  79
  80     const OUString& GetNumber(SwRootFrame const* pLayout = nullptr) const;
  81     const OUString& GetTitle(SwRootFrame const* pLayout = nullptr) const;
  82
  83     virtual bool         QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
  84     virtual bool         PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
  85 };
  86
  87 #endif // INCLUDED_SW_INC_CHPFLD_HXX
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */