ODFstudio/odfstudio
2
0
Fork 0
Code Issues Packages Activity
Files
main
odfstudio/sw/inc/fldbas.hxx
T
yaswantpenapaka f5e5ac6a44 tdf#143148 replace include guards with pragma once 
Replace include guards with pragma once in selected header files from
sw/inc folder.

Change-Id: Ibd0d5987121fc7e7ade0496c13fc9516625a178e
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/201571
Tested-by: Jenkins
Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2026-03-13 18:57:11 +01:00

486 lines
15 KiB
C++
Raw Permalink Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <i18nlangtag/lang.h>
#include "swdllapi.h"
#include "swtypes.hxx"
#include "calbck.hxx"
#include "nodeoffset.hxx"
#include "names.hxx"
#include <com/sun/star/beans/XPropertySet.hpp>
#include <cppuhelper/weakref.hxx>
#include <editeng/svxenum.hxx>
#include <o3tl/enumarray.hxx>
#include <unotools/weakref.hxx>
#include <rtl/ref.hxx>
#include <vector>
#include <climits>
class SwDoc;
class SwField;
class SwFormatField;
class SwDDETable;
class SwRootFrame;
class SvNumberFormatter;
class IDocumentRedlineAccess;
class SwGetRefField;
class SwXFieldMaster;
enum class ReferencesSubtype : sal_uInt16;
namespace com::sun::star::uno { class Any; }
typedef struct _xmlTextWriter* xmlTextWriterPtr;
enum class SwFieldIds : sal_uInt16 {
/// For old documents the Field-Which IDs must be preserved !!!
Database,
User,
Filename,
DatabaseName,
Date,
Time,
PageNumber,
Author,
Chapter,
DocStat,
GetExp, // 10
SetExp,
GetRef,
HiddenText,
Postit,
FixDate,
FixTime,
Reg,
VarReg,
SetRef,
Input, // 20
Macro,
Dde,
Table,
HiddenPara,
DocInfo,
TemplateName,
DbNextSet,
DbNumSet,
DbSetNumber,
ExtUser, // 30
RefPageSet,
RefPageGet,
Internet,
JumpEdit,
Script,
DateTime,
TableOfAuthorities,
CombinedChars,
Dropdown,
ParagraphSignature, // 40
LAST = ParagraphSignature,
Unknown = USHRT_MAX, // used as default value in some method calls
};
/// List of FieldTypes at UI.
enum class SwFieldTypesEnum : sal_uInt16 {
Begin,
Date = Begin, // 0
Time,
Filename,
DatabaseName,
Chapter,
PageNumber,
DocumentStatistics,
Author,
Set,
Get,
Formel, // 10
HiddenText,
SetRef,
GetRef,
DDE,
Macro,
Input,
HiddenParagraph,
DocumentInfo,
Database,
User, // 20
Postit,
TemplateName,
Sequence,
DatabaseNextSet,
DatabaseNumberSet,
DatabaseSetNumber,
ConditionalText,
NextPage,
PreviousPage,
ExtendedUser, // 30
FixedDate,
FixedTime,
SetInput,
UserInput,
SetRefPage,
GetRefPage,
Internet,
JumpEdit,
Script,
Authority, // 40
CombinedChars,
Dropdown,
Custom, // Unused - necessary for alignment with aSwFields in fldmgr.cxx
ParagraphSignature,
LAST = ParagraphSignature,
Unknown = USHRT_MAX // used by SwFieldMgr::GetCurTypeId
};
// tdf#170392 - this should be aligned with FMT_FF_ARY in sw/source/uibase/fldui/fldmgr.cxx
// including com::sun::star::text::FilenameDisplayFormat
enum class SwFileNameFormat {
// most of the constants are a regular enum
PathName,
Path,
NameNoExt,
Name,
UIName,
UIRange,
End, // marker value, used for asserts
// except for this, which is a flag
Fixed = 0x8000
};
namespace o3tl { template<> struct typed_flags<SwFileNameFormat> : is_typed_flags<SwFileNameFormat, 0x800f> {}; }
enum class SwTableFieldSubType : sal_uInt16
{
String = 0x0001, ///< String
Formula = 0x0010, ///< Formula
Command = 0x0100, ///< Show command.
};
namespace o3tl { template<> struct typed_flags<SwTableFieldSubType> : is_typed_flags<SwTableFieldSubType, 0x0111> {}; }
enum class SwGetSetExpType : sal_uInt16
{
None = 0x0000,
String = 0x0001, ///< String
Expr = 0x0002, ///< Expression
Sequence = 0x0008, ///< Sequence
Formula = 0x0010, ///< Formula
LowerMask = 0x001f,
UpperMask = 0x0300,
Command = 0x0100, ///< Show command.
Invisible = 0x0200 ///< Invisible.
};
namespace o3tl { template<> struct typed_flags<SwGetSetExpType> : is_typed_flags<SwGetSetExpType, 0x031f> {}; }
enum class SwDBFieldSubType : sal_uInt16
{
None = 0x0000,
Invisible = 0x0200, ///< Invisible.
OwnFormat = 0x0400 ///< SwDBField: Don't accept formatting from database.
};
namespace o3tl { template<> struct typed_flags<SwDBFieldSubType> : is_typed_flags<SwDBFieldSubType, 0x0600> {}; }
enum class SwInputFieldSubType : sal_uInt16
{
None = 0x0000,
Text = 0x0001,
User = 0x0002,
Var = 0x0003,
LowerMask = 0x0003,
UpperMask = 0x0200,
Invisible = 0x0200 ///< Invisible.
};
namespace o3tl { template<> struct typed_flags<SwInputFieldSubType> : is_typed_flags<SwInputFieldSubType, 0x0203> {}; }
enum class SwUserType : sal_uInt16 {
None = 0x0000,
String = 0x0001, ///< String
Expr = 0x0002, ///< Expression
LowerMask = 0x0003,
UpperMask = 0x0300,
ShowCommand = 0x0100, ///< Show command.
Invisible = 0x0200, ///< Invisible.
};
namespace o3tl { template<> struct typed_flags<SwUserType> : is_typed_flags<SwUserType, 0x0303> {}; }
enum class SwDateTimeSubType : sal_uInt16 {
None = 0,
Fixed = 1,
Date = 2,
Time = 4
};
namespace o3tl { template<> struct typed_flags<SwDateTimeSubType> : is_typed_flags<SwDateTimeSubType, 0x0007> {}; }
/// General tools.
OUString FormatNumber(sal_uInt32 nNum, SvxNumType nFormat, LanguageType nLang = LANGUAGE_NONE);
SwFieldTypesEnum SwFieldTypeFromString(std::u16string_view rString);
/** Instances of SwFields and those derived from it occur 0 to n times.
For each class there is one instance of the associated type class.
Base class of all field types is SwFieldType. */
class SW_DLLPUBLIC SwFieldType : public sw::BroadcastingModify
{
unotools::WeakReference<SwXFieldMaster> m_wXFieldMaster;
SwFieldIds m_nWhich;
friend void FinitUI(); ///< In order to delete pointer!
static o3tl::enumarray<SwFieldTypesEnum, OUString>* s_pFieldNames;
static void GetFieldName_(); ///< Sets up FieldNames; fldmgr.cxx!
protected:
/// Single argument ctors shall be explicit.
explicit SwFieldType( SwFieldIds nWhichId );
public:
unotools::WeakReference<SwXFieldMaster> const& GetXObject() const {
return m_wXFieldMaster;
}
void SetXObject(rtl::Reference<SwXFieldMaster> const& xFieldMaster);
static const OUString & GetTypeStr( SwFieldTypesEnum nTypeId );
/// Only in derived classes.
virtual UIName GetName() const;
virtual void SetName(const UIName& newName);
virtual std::unique_ptr<SwFieldType> Copy() const = 0;
virtual void QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const;
virtual void PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich );
SwFieldIds Which() const { return m_nWhich; }
void PrintHiddenPara();
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
SwFormatField* FindFormatForField(const SwField*) const;
SwFormatField* FindFormatForPostItId(sal_uInt32 nPostItId) const;
void CollectPostIts(std::vector<SwFormatField*>& rvFormatFields, IDocumentRedlineAccess const& rIDRA, bool HideRedlines);
bool HasHiddenInformationNotes() const;
void GatherNodeIndex(std::vector<SwNodeOffset>& rvNodeIndex);
void GatherRefFields(std::vector<SwGetRefField*>& rvRFields, const ReferencesSubtype nTyp);
void GatherFields(std::vector<SwFormatField*>& rvFormatFields, bool bCollectOnlyInDocNodes=true) const;
void GatherDdeTables(std::vector<SwDDETable*>& rvTables) const;
void UpdateDocPos(const SwTwips nDocPos);
virtual void UpdateFields();
};
/** Base class of all fields.
Type of field is queried via Which.
Expanded content of field is queried via ExpandField(). */
class SW_DLLPUBLIC SwField
{
private:
mutable OUString m_Cache; ///< Cached expansion (for clipboard).
SwFieldType* m_pType;
LanguageType m_nLang; ///< Always change via SetLanguage!
bool m_bUseFieldValueCache; /// control the usage of the cached field value
bool m_bIsAutomaticLanguage;
/// Used for tooltip purposes when it's not-empty.
OUString m_aTitle;
virtual OUString ExpandImpl(SwRootFrame const* pLayout) const = 0;
virtual std::unique_ptr<SwField> Copy() const = 0;
protected:
SwField( SwFieldType* pTyp,
LanguageType nLang = LANGUAGE_SYSTEM,
bool m_bUseFieldValueCache = true );
public:
virtual ~SwField();
SwField(SwField const &) = default;
SwField(SwField &&) = default;
SwField & operator =(SwField const &) = default;
SwField & operator =(SwField &&) = default;
inline SwFieldType* GetTyp() const;
/// Set new type (used for copying among documents).
virtual SwFieldType* ChgTyp( SwFieldType* );
/** expand the field.
@param bCached return cached field value.
@remark most callers should use the cached field value.
this is because various fields need special handing
(ChangeExpansion()) to return correct values, and only
SwTextFormatter::NewFieldPortion() sets things up properly.
@param pLayout the layout to use for expansion; there are a few
fields that expand differently via layout mode.
@return the generated text (suitable for display)
*/
OUString ExpandField(bool bCached, SwRootFrame const* pLayout) const;
/// @return name or content.
virtual OUString GetFieldName() const;
std::unique_ptr<SwField> CopyField() const;
/// ResId
SwFieldIds Which() const
{
assert(m_pType);
return m_pType->Which();
}
// TYP_ID
SwFieldTypesEnum GetTypeId() const;
// for code that is still passing around untyped values
sal_uInt16 GetUntypedSubType() const;
void SetUntypedSubType(sal_uInt16);
/// Language at field position.
inline LanguageType GetLanguage() const;
virtual void SetLanguage(LanguageType nLng);
/// Query parameters for dialog and for BASIC.
virtual OUString GetPar1() const;
virtual OUString GetPar2() const;
virtual OUString GetFormula() const;
virtual void SetPar1(const OUString& rStr);
virtual void SetPar2(const OUString& rStr);
virtual bool QueryValue( css::uno::Any& rVal, sal_uInt16 nWhichId ) const;
virtual bool PutValue( const css::uno::Any& rVal, sal_uInt16 nWhichId );
/// Does the field possess an action on its ClickHandler? (e.g. INetFields, ...).
bool HasClickHdl() const;
bool IsFixed() const;
bool IsAutomaticLanguage() const {
return m_bIsAutomaticLanguage;
}
void SetAutomaticLanguage(bool const bSet) {
m_bIsAutomaticLanguage = bSet;
}
virtual OUString GetDescription() const;
/// Is this field clickable?
bool IsClickable() const;
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
const OUString & GetTitle() const { return m_aTitle; }
void SetTitle(const OUString& rTitle) { m_aTitle = rTitle; }
/// Helpers for those places still passing untyped format ids around for SwField
sal_uInt32 GetUntypedFormat() const;
void SetUntypedFormat(sal_uInt32);
};
inline SwFieldType* SwField::GetTyp() const
{
return m_pType;
}
inline LanguageType SwField::GetLanguage() const
{
return m_nLang;
}
/// Fields containing values that have to be formatted via number formatter.
class SwValueFieldType : public SwFieldType
{
private:
SwDoc* m_pDoc;
bool m_bUseFormat; ///< Use number formatter.
protected:
SwValueFieldType( SwDoc* pDocPtr, SwFieldIds nWhichId );
SwValueFieldType( const SwValueFieldType& rTyp );
public:
SwDoc* GetDoc() const {
return m_pDoc;
}
void SetDoc(SwDoc* pNewDoc) {
m_pDoc = pNewDoc;
}
bool UseFormat() const {
return m_bUseFormat;
}
void EnableFormat(bool bFormat = true) {
m_bUseFormat = bFormat;
}
OUString ExpandValue(const double& rVal, sal_uInt32 nFormat, LanguageType nLng) const;
OUString DoubleToString(const double &rVal, LanguageType eLng) const;
OUString DoubleToString(const double &rVal, sal_uInt32 nFormat) const;
/// Query input or formatted value for dialog.
OUString GetInputOrDateTime( const OUString& rInput, const double& rVal, sal_uInt32 nFormat ) const;
};
class SW_DLLPUBLIC SwValueField : public SwField
{
private:
double m_fValue;
sal_uInt32 m_nFormat;
protected:
SwValueField( SwValueFieldType* pFieldType, sal_uInt32 nFormat, LanguageType nLang = LANGUAGE_SYSTEM, const double fVal = 0.0 );
SwValueField( const SwValueField& rField );
public:
virtual ~SwValueField() override;
sal_uInt32 GetFormat() const { return m_nFormat; }
void SetFormat(sal_uInt32 nFormat) { m_nFormat = nFormat; }
virtual SwFieldType* ChgTyp( SwFieldType* ) override;
virtual void SetLanguage(LanguageType nLng) override;
SwDoc* GetDoc() const {
return static_cast<const SwValueFieldType*>(GetTyp())->GetDoc();
}
virtual double GetValue() const;
virtual void SetValue( const double& rVal );
OUString ExpandValue(const double& rVal, sal_uInt32 nFormat, LanguageType nLng) const {
return static_cast<SwValueFieldType*>(GetTyp())->ExpandValue(rVal, nFormat, nLng);
}
static sal_uInt32 GetSystemFormat(SvNumberFormatter* pFormatter, sal_uInt32 nFormat);
void dumpAsXml(xmlTextWriterPtr pWriter) const override;
};
class SW_DLLPUBLIC SwFormulaField : public SwValueField
{
private:
OUString m_sFormula;
protected:
SwFormulaField( SwValueFieldType* pFieldType, sal_uInt32 nFormat, const double fVal );
SwFormulaField( const SwFormulaField& rField );
public:
virtual OUString GetFormula() const override;
void SetFormula(const OUString& rStr);
void SetExpandedFormula(const OUString& rStr);
OUString GetExpandedFormula() const;
/// Query formula or formatted value for dialog.
OUString GetInputOrDateTime() const;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink