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