sw/inc/usrfld.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_USRFLD_HXX
  20 #define INCLUDED_SW_INC_USRFLD_HXX
  21
  22 #include "swdllapi.h"
  23 #include "fldbas.hxx"
  24
  25 class SfxPoolItem;
  26 class SwCalc;
  27 class SwDoc;
  28
  29 /**
  30  * The shared part of a user field.
  31  *
  32  * Tracks the value, but conversion between the float and string representation
  33  * always happens with the system locale.
  34  */
  35 class SW_DLLPUBLIC SwUserFieldType final : public SwValueFieldType
  36 {
  37     bool    m_bValidValue : 1;
  38     bool    m_bDeleted : 1;
  39     /// Float value type.
  40     double  m_nValue;
  41     OUString  m_aName;
  42     /// String value type.
  43     OUString  m_aContent;
  44     /// Language used by m_aContents
  45     OUString m_aContentLang;
  46     sal_uInt16  m_nType;
  47
  48 public:
  49     SwUserFieldType( SwDoc* pDocPtr, const OUString& );
  50
  51     virtual OUString        GetName() const override;
  52     virtual std::unique_ptr<SwFieldType> Copy() const override;
  53
  54     OUString                Expand(sal_uInt32 nFormat, sal_uInt16 nSubType, LanguageType nLng);
  55
  56     OUString                GetContent( sal_uInt32 nFormat = 0 );
  57            void             SetContent( const OUString& rStr, sal_uInt32 nFormat = 0 );
  58
  59     inline bool             IsValid() const;
  60
  61            double           GetValue(SwCalc& rCalc);    // Recalculate member nValue.
  62     inline double           GetValue() const;
  63     inline void             SetValue(const double nVal);
  64
  65     inline sal_uInt16           GetType() const;
  66     inline void             SetType(sal_uInt16);
  67
  68     bool                    IsDeleted() const       { return m_bDeleted; }
  69     void                    SetDeleted( bool b )    { m_bDeleted = b; }
  70
  71     virtual void        QueryValue( css::uno::Any& rVal, sal_uInt16 nMId ) const override;
  72     virtual void        PutValue( const css::uno::Any& rVal, sal_uInt16 nMId ) override;
  73     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  74
  75 private:
  76     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem* pNew ) override;
  77 };
  78
  79 inline bool SwUserFieldType::IsValid() const
  80     { return m_bValidValue; }
  81
  82 inline double SwUserFieldType::GetValue() const
  83     { return m_nValue; }
  84
  85 inline void SwUserFieldType::SetValue(const double nVal)
  86     { m_nValue = nVal; }
  87
  88 inline sal_uInt16 SwUserFieldType::GetType() const
  89     { return m_nType; }
  90
  91 inline void SwUserFieldType::SetType(sal_uInt16 nSub)
  92 {
  93     m_nType = nSub;
  94     EnableFormat(!(nSub & nsSwGetSetExpType::GSE_STRING));
  95 }
  96
  97 /**
  98  * The non-shared part of a user field.
  99  *
 100  * Tracks the number format and the language, conversion between the float and
 101  * string representation is independent from the system locale.
 102  */
 103 class SwUserField final : public SwValueField
 104 {
 105     sal_uInt16  m_nSubType;
 106
 107     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
 108     virtual std::unique_ptr<SwField> Copy() const override;
 109
 110 public:
 111     SwUserField(SwUserFieldType*, sal_uInt16 nSub, sal_uInt32 nFormat);
 112
 113     virtual sal_uInt16      GetSubType() const override;
 114     virtual void            SetSubType(sal_uInt16 nSub) override;
 115
 116     virtual double          GetValue() const override;
 117     virtual void            SetValue( const double& rVal ) override;
 118
 119     virtual OUString        GetFieldName() const override;
 120
 121     // Name cannot be changed.
 122     virtual OUString        GetPar1() const override;
 123
 124     // Content.
 125     virtual OUString        GetPar2() const override;
 126     virtual void            SetPar2(const OUString& rStr) override;
 127     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const override;
 128     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId ) override;
 129     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 130 };
 131
 132 #endif // INCLUDED_SW_INC_USRFLD_HXX
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */