sw/inc/docufld.hxx | 5 +++++
1 file changed, 5 insertions(+)
New commits:
commit dc80ad631b46f4f21a0ed052c921f4a3efbe3fbe
Author: Miklos Vajna <[email protected]>
AuthorDate: Wed Dec 3 14:15:46 2025 +0100
Commit: Caolán McNamara <[email protected]>
CommitDate: Thu Dec 4 10:48:34 2025 +0100
sw: document SwFileNameField and SwFileNameFieldType
Where to find on the UI, how the shared SwField::m_nFormat is
interpreted for this field.
Change-Id: I149d3f7d9aeb1a663fc73df470f3292161a57665
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/194959
Tested-by: Jenkins CollaboraOffice <[email protected]>
Reviewed-by: Caolán McNamara <[email protected]>
diff --git a/sw/inc/docufld.hxx b/sw/inc/docufld.hxx
index 9aac8a4bd693..df8955bc824a 100644
--- a/sw/inc/docufld.hxx
+++ b/sw/inc/docufld.hxx
@@ -202,6 +202,7 @@ public:
virtual bool PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich
) override;
};
+/// Provides the expansion of of an SwFileNameField to a string.
class SAL_DLLPUBLIC_RTTI SwFileNameFieldType final : public SwFieldType
{
SwDoc& m_rDoc;
@@ -212,6 +213,10 @@ public:
virtual std::unique_ptr<SwFieldType> Copy() const override;
};
+/// Expands to the current file name. The format is stored in
SwField::m_nFormat and is interpreted
+/// as an SwFileNameFormat.
+///
+/// 'Insert' -> 'Field' -> 'More Fields' -> 'Document' -> 'File name' on the
UI.
class SW_DLLPUBLIC SwFileNameField final : public SwField
{
OUString m_aContent;
