sw/inc/fmtftntx.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_FMTFTNTX_HXX
  20 #define INCLUDED_SW_INC_FMTFTNTX_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include <editeng/numitem.hxx>
  24 #include "hintids.hxx"
  25 #include "format.hxx"
  26 #include "swdllapi.h"
  27
  28 enum SwFootnoteEndPosEnum
  29 {
  30     FTNEND_ATPGORDOCEND,                ///< at page or document end
  31     FTNEND_ATTXTEND,                    ///< at end of the current text end
  32     FTNEND_ATTXTEND_OWNNUMSEQ,          ///< -""- and with own number sequence
  33     FTNEND_ATTXTEND_OWNNUMANDFMT,       ///< -""- and with own numberformat
  34     FTNEND_ATTXTEND_END
  35 };
  36
  37 /**
  38  * SfxPoolItem subclass that is a wrapper around an SwFootnoteEndPosEnum, i.e. to decide where
  39  * footnotes or endnotes should be collected. Available on the UI as Format -> Sections -> <Name> ->
  40  * Options -> Footnotes/Endnotes. This is the shared base class for both footnotes and endnotes.
  41  */
  42 class SW_DLLPUBLIC SwFormatFootnoteEndAtTextEnd : public SfxEnumItem<SwFootnoteEndPosEnum>
  43 {
  44     OUString m_sPrefix;
  45     OUString m_sSuffix;
  46     SvxNumberType m_aFormat;
  47     sal_uInt16      m_nOffset;
  48
  49 protected:
  50     SwFormatFootnoteEndAtTextEnd( sal_uInt16 nWhichL, SwFootnoteEndPosEnum ePos )
  51         : SfxEnumItem( nWhichL, ePos ), m_nOffset( 0 )
  52     {}
  53
  54 public:
  55     virtual sal_uInt16       GetValueCount() const override;
  56
  57     virtual bool             operator==( const SfxPoolItem& ) const override;
  58
  59     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  60     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  61
  62     virtual bool GetPresentation( SfxItemPresentation ePres,
  63                                   MapUnit eCoreMetric,
  64                                   MapUnit ePresMetric,
  65                                   OUString &rText,
  66                                   const IntlWrapper& rIntl ) const override;
  67
  68     bool IsAtEnd() const { return FTNEND_ATPGORDOCEND != GetValue(); }
  69
  70     SwFormatFootnoteEndAtTextEnd & operator=( const SwFormatFootnoteEndAtTextEnd & rAttr );
  71     SwFormatFootnoteEndAtTextEnd(SwFormatFootnoteEndAtTextEnd const &) = default;
  72         // SfxPoolItem copy function dichotomy
  73
  74     SvxNumType GetNumType() const        { return m_aFormat.GetNumberingType(); }
  75     void SetNumType( SvxNumType eType )  { m_aFormat.SetNumberingType(eType); }
  76
  77     const SvxNumberType& GetSwNumType() const   { return m_aFormat; }
  78
  79     sal_uInt16 GetOffset() const                { return m_nOffset; }
  80     void SetOffset( sal_uInt16 nOff )           { m_nOffset = nOff; }
  81
  82     const OUString& GetPrefix() const      { return m_sPrefix; }
  83     void SetPrefix(const OUString& rSet)   { m_sPrefix = rSet; }
  84
  85     const OUString& GetSuffix() const      { return m_sSuffix; }
  86     void SetSuffix(const OUString& rSet)   { m_sSuffix = rSet; }
  87 };
  88
  89 class SW_DLLPUBLIC SwFormatFootnoteAtTextEnd final : public SwFormatFootnoteEndAtTextEnd
  90 {
  91 public:
  92     SwFormatFootnoteAtTextEnd( SwFootnoteEndPosEnum ePos = FTNEND_ATPGORDOCEND )
  93         : SwFormatFootnoteEndAtTextEnd( RES_FTN_AT_TXTEND, ePos )
  94     {}
  95
  96     virtual SwFormatFootnoteAtTextEnd* Clone( SfxItemPool *pPool = nullptr ) const override;
  97 };
  98
  99 class SW_DLLPUBLIC SwFormatEndAtTextEnd final : public SwFormatFootnoteEndAtTextEnd
 100 {
 101 public:
 102     SwFormatEndAtTextEnd( SwFootnoteEndPosEnum ePos = FTNEND_ATPGORDOCEND )
 103         : SwFormatFootnoteEndAtTextEnd( RES_END_AT_TXTEND, ePos )
 104     {
 105         SetNumType( SVX_NUM_ROMAN_LOWER );
 106     }
 107
 108     virtual SwFormatEndAtTextEnd* Clone( SfxItemPool *pPool = nullptr ) const override;
 109 };
 110
 111 inline const SwFormatFootnoteAtTextEnd &SwAttrSet::GetFootnoteAtTextEnd(bool bInP) const
 112     { return Get( RES_FTN_AT_TXTEND, bInP); }
 113 inline const SwFormatEndAtTextEnd &SwAttrSet::GetEndAtTextEnd(bool bInP) const
 114     { return Get( RES_END_AT_TXTEND, bInP); }
 115
 116 inline const SwFormatFootnoteAtTextEnd &SwFormat::GetFootnoteAtTextEnd(bool bInP) const
 117     { return m_aSet.GetFootnoteAtTextEnd(bInP); }
 118 inline const SwFormatEndAtTextEnd &SwFormat::GetEndAtTextEnd(bool bInP) const
 119     { return m_aSet.GetEndAtTextEnd(bInP); }
 120
 121 #endif
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */