sw/inc/dbfld.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_DBFLD_HXX
  20 #define INCLUDED_SW_INC_DBFLD_HXX
  21
  22 #include "swdllapi.h"
  23 #include "fldbas.hxx"
  24 #include "swdbdata.hxx"
  25
  26 class SwDoc;
  27 class SwTextField;
  28 class SwFrame;
  29
  30 // Database field.
  31 class SW_DLLPUBLIC SwDBFieldType : public SwValueFieldType
  32 {
  33     SwDBData    aDBData;
  34     OUString sName;          ///< only used in ::GetName() !
  35     OUString sColumn;
  36     long        nRefCnt;
  37
  38 public:
  39
  40     SwDBFieldType(SwDoc* pDocPtr, const OUString& rColumnName, const SwDBData& rDBData);
  41     virtual ~SwDBFieldType() override;
  42
  43     virtual OUString GetName() const override;
  44     virtual SwFieldType*  Copy() const override;
  45
  46     void     AddRef() { nRefCnt++; }
  47     void            ReleaseRef();
  48
  49     const OUString&     GetColumnName() const {return sColumn;}
  50     const SwDBData& GetDBData() const {return aDBData;}
  51
  52     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
  53     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
  54 };
  55
  56 // Classes derived from SwFields. They overlay the expand-function.
  57 // Content is formatted according to the format (if available).
  58 class SW_DLLPUBLIC SwDBField : public SwValueField
  59 {
  60     OUString aContent;
  61     OUString sFieldCode; ///< contains Word's field code
  62     sal_uInt16  nSubType;
  63     bool    bIsInBodyText    : 1;
  64     bool    bValidValue     : 1;
  65     bool    bInitialized    : 1;
  66
  67     virtual OUString    Expand() const override;
  68     virtual SwField*    Copy() const override;
  69
  70 public:
  71     SwDBField(SwDBFieldType*, sal_uLong nFormat = 0);
  72     virtual ~SwDBField() override;
  73
  74     virtual SwFieldType*    ChgTyp( SwFieldType* ) override;
  75
  76     /// Current text.
  77     inline  void        SetExpansion(const OUString& rStr);
  78
  79     virtual sal_uInt16      GetSubType() const override;
  80     virtual void        SetSubType(sal_uInt16 nType) override;
  81
  82     virtual OUString    GetFieldName() const override;
  83
  84     /// For calculations in expressions.
  85     void                ChgValue( double d, bool bVal );
  86
  87     /// Get the evaluation via DBManager string.
  88     void                Evaluate();
  89
  90     /// Evaluation for header and footer.
  91     void                InitContent();
  92     void                InitContent(const OUString& rExpansion);
  93
  94     inline void         ChgBodyTextFlag( bool bIsInBody );
  95
  96     bool         IsInitialized() const   { return bInitialized; }
  97     void         ClearInitialized()      { bInitialized = false; }
  98     void         SetInitialized()        { bInitialized = true; }
  99
 100     /// Get name.
 101     virtual OUString    GetPar1() const override;
 102
 103     /// access to the command string
 104     void                SetFieldCode(const OUString& rStr) { sFieldCode = rStr; }
 105
 106     /// DBName
 107     const SwDBData&  GetDBData() const { return static_cast<SwDBFieldType*>(GetTyp())->GetDBData(); }
 108     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 109     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 110
 111     static bool FormatValue( SvNumberFormatter* pDocFormatter, OUString &aString, sal_uInt32 nFormat,
 112                              double &aNumber, sal_Int32 nColumnType, SwDBField *pField = nullptr );
 113 };
 114
 115 inline  void SwDBField::SetExpansion(const OUString& rStr)
 116     { aContent = rStr; }
 117
 118 /// set from UpdateExpFields (the Node-Position is known there)
 119 inline void SwDBField::ChgBodyTextFlag( bool bIsInBody )
 120     { bIsInBodyText = bIsInBody; }
 121
 122 // Base class for all other database fields.
 123 class SW_DLLPUBLIC SwDBNameInfField : public SwField
 124 {
 125     SwDBData        aDBData;
 126     sal_uInt16      nSubType;
 127
 128 protected:
 129     const SwDBData& GetDBData() const {return aDBData;}
 130     SwDBData&       GetDBData() {return aDBData;}
 131
 132     SwDBNameInfField(SwFieldType* pTyp, const SwDBData& rDBData, sal_uLong nFormat = 0);
 133
 134 public:
 135     /// DBName
 136     const SwDBData&  GetRealDBData() const { return aDBData; }
 137     SwDBData&        GetRealDBData() { return aDBData; }
 138
 139     SwDBData                GetDBData(SwDoc* pDoc);
 140     void                    SetDBData(const SwDBData& rDBData);
 141
 142     virtual OUString        GetFieldName() const override;
 143
 144     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 145     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 146     virtual sal_uInt16      GetSubType() const override;
 147     virtual void            SetSubType(sal_uInt16 nType) override;
 148 };
 149
 150 // Database field next record.
 151 class SW_DLLPUBLIC SwDBNextSetFieldType : public SwFieldType
 152 {
 153 public:
 154     SwDBNextSetFieldType();
 155
 156     virtual SwFieldType*    Copy() const override;
 157 };
 158
 159 // Next data record with condition.
 160 class SW_DLLPUBLIC SwDBNextSetField : public SwDBNameInfField
 161 {
 162     OUString  aCond;
 163     bool    bCondValid;
 164
 165 public:
 166     SwDBNextSetField( SwDBNextSetFieldType*,
 167                       const OUString& rCond, const SwDBData& rDBData);
 168
 169     virtual OUString        Expand() const override;
 170     virtual SwField*        Copy() const override;
 171
 172     void                    Evaluate(SwDoc*);
 173     inline void             SetCondValid(bool bCond);
 174     inline bool             IsCondValid() const;
 175
 176     // Condition
 177     virtual OUString    GetPar1() const override;
 178     virtual void        SetPar1(const OUString& rStr) override;
 179     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 180     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 181 };
 182
 183 inline bool SwDBNextSetField::IsCondValid() const
 184     { return bCondValid; }
 185
 186 inline void SwDBNextSetField::SetCondValid(bool bCond)
 187     { bCondValid = bCond; }
 188
 189 // Database field next record.
 190 class SwDBNumSetFieldType : public SwFieldType
 191 {
 192 public:
 193     SwDBNumSetFieldType();
 194
 195     virtual SwFieldType*    Copy() const override;
 196 };
 197
 198 // Data record with number xxx.
 199 // Number is in nFormat (bit of a misuse!)
 200 class SwDBNumSetField : public SwDBNameInfField
 201 {
 202     OUString  aCond;
 203     OUString  aPar2;
 204     bool    bCondValid;
 205
 206 public:
 207     SwDBNumSetField(SwDBNumSetFieldType*, const OUString& rCond, const OUString& rDBNum, const SwDBData& rDBData);
 208
 209     virtual OUString        Expand() const override;
 210     virtual SwField*        Copy() const override;
 211
 212     inline bool             IsCondValid() const;
 213     inline void             SetCondValid(bool bCond);
 214     void                    Evaluate(SwDoc*);
 215
 216     // Condition
 217     virtual OUString        GetPar1() const override;
 218     virtual void            SetPar1(const OUString& rStr) override;
 219
 220     // Number of data record.
 221     virtual OUString   GetPar2()   const override;
 222     virtual void            SetPar2(const OUString& rStr) override;
 223
 224     // Number of data record is in nFormat!!
 225     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 226     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 227 };
 228
 229 inline bool SwDBNumSetField::IsCondValid() const
 230     { return bCondValid; }
 231
 232 inline void SwDBNumSetField::SetCondValid(bool bCond)
 233     { bCondValid = bCond; }
 234
 235 // Database name.
 236 class SwDBNameFieldType : public SwFieldType
 237 {
 238         SwDoc *pDoc;
 239 public:
 240     SwDBNameFieldType(SwDoc*);
 241
 242     OUString                Expand() const;
 243     virtual SwFieldType*    Copy() const override;
 244 };
 245
 246 // Database field.
 247 class SW_DLLPUBLIC SwDBNameField : public SwDBNameInfField
 248 {
 249 public:
 250     SwDBNameField(SwDBNameFieldType*, const SwDBData& rDBData);
 251
 252     virtual OUString Expand() const override;
 253     virtual SwField* Copy() const override;
 254     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 255     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 256 };
 257
 258 // Number of data record.
 259 class SW_DLLPUBLIC SwDBSetNumberFieldType : public SwFieldType
 260 {
 261 public:
 262     SwDBSetNumberFieldType();
 263
 264     virtual SwFieldType*    Copy() const override;
 265 };
 266
 267 // Database field.
 268 class SW_DLLPUBLIC SwDBSetNumberField : public SwDBNameInfField
 269 {
 270     long    nNumber;
 271 public:
 272     SwDBSetNumberField(SwDBSetNumberFieldType*, const SwDBData& rDBData, sal_uLong nFormat = 0);
 273
 274     virtual OUString Expand() const override;
 275     virtual         SwField* Copy() const override;
 276     void            Evaluate(SwDoc*);
 277
 278     inline long     GetSetNumber() const;
 279     inline void     SetSetNumber(long nNum);
 280     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 281     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 282 };
 283
 284 inline long SwDBSetNumberField::GetSetNumber() const
 285     { return nNumber; }
 286
 287 inline void SwDBSetNumberField::SetSetNumber(long nNum)
 288     { nNumber = nNum; }
 289
 290 #endif // INCLUDED_SW_INC_DBFLD_HXX
 291
 292 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */