#include <reffld.hxx>

Inheritance diagram for SwGetRefField:

Collaboration diagram for SwGetRefField:

Public Member Functions
	SwGetRefField (SwGetRefFieldType *, OUString aSetRef, OUString aReferenceLanguage, sal_uInt16 nSubType, sal_uInt16 nSeqNo, sal_uLong nFormat)
	get references More...

virtual	~SwGetRefField () override

virtual OUString	GetFieldName () const override
	get name or content More...

const OUString &	GetSetRefName () const

void	UpdateField (const SwTextField *pFieldTextAttr)
	The <SwTextField> instance, which represents the text attribute for the <SwGetRefField> instance, has to be passed to the method. More...

void	SetExpand (const OUString &rStr)

virtual sal_uInt16	GetSubType () const override
	Get/set sub type. More...

virtual void	SetSubType (sal_uInt16 n) override

bool	IsRefToHeadingCrossRefBookmark () const

bool	IsRefToNumItemCrossRefBookmark () const

const SwTextNode *	GetReferencedTextNode () const

OUString	GetExpandedTextOfReferencedTextNode (SwRootFrame const &rLayout) const

sal_uInt16	GetSeqNo () const
	Get/set SequenceNo (of interest only for REF_SEQUENCEFLD). More...

void	SetSeqNo (sal_uInt16 n)

virtual OUString	GetPar1 () const override
	get reference name More...

virtual void	SetPar1 (const OUString &rStr) override
	set reference name More...

virtual OUString	GetPar2 () const override

virtual bool	QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const override

virtual bool	PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId) override

void	ConvertProgrammaticToUIName ()

virtual OUString	GetDescription () const override

Public Member Functions inherited from SwField
virtual	~SwField ()

	SwField (SwField const &)=default

	SwField (SwField &&)=default

SwField &	operator= (SwField const &)=default

SwField &	operator= (SwField &&)=default

SwFieldType *	GetTyp () const

virtual SwFieldType *	ChgTyp (SwFieldType *)
	Set new type (used for copying among documents). More...

OUString	ExpandField (bool bCached, SwRootFrame const *pLayout) const
	expand the field. More...

virtual OUString	GetFieldName () const
	get name or content More...

std::unique_ptr< SwField >	CopyField () const

SwFieldIds	Which () const
	ResId. More...

SwFieldTypesEnum	GetTypeId () const

virtual sal_uInt16	GetSubType () const

virtual void	SetSubType (sal_uInt16)

LanguageType	GetLanguage () const
	Language at field position. More...

virtual void	SetLanguage (LanguageType nLng)

sal_uInt32	GetFormat () const
	Query parameters for dialog and for BASIC. More...

virtual OUString	GetPar1 () const

virtual OUString	GetPar2 () const

virtual OUString	GetFormula () const

void	ChangeFormat (sal_uInt32 n)

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)

bool	HasClickHdl () const
	Does the field possess an action on its ClickHandler? (e.g. INetFields, ...). More...

bool	IsFixed () const

bool	IsAutomaticLanguage () const

void	SetAutomaticLanguage (bool const bSet)

virtual OUString	GetDescription () const

bool	IsClickable () const
	Is this field clickable? More...

virtual void	dumpAsXml (xmlTextWriterPtr pWriter) const

const OUString &	GetTitle () const

void	SetTitle (const OUString &rTitle)

Private Member Functions
virtual OUString	ExpandImpl (SwRootFrame const *pLayout) const override

virtual std::unique_ptr< SwField >	Copy () const override

Private Attributes
OUString	m_sSetRefName

OUString	m_sSetReferenceLanguage

OUString	m_sText
	result More...

OUString	m_sTextRLHidden
	result for layout with redlines hidden More...

sal_uInt16	m_nSubType

sal_uInt16	m_nSeqNo
	reference to either a SwTextFootnote::m_nSeqNo or a SwSetExpField::mnSeqNo More...

Additional Inherited Members
Protected Member Functions inherited from SwField
void	SetFormat (sal_uInt32 const nSet)

	SwField (SwFieldType *pTyp, sal_uInt32 nFormat=0, LanguageType nLang=LANGUAGE_SYSTEM, bool m_bUseFieldValueCache=true)

Detailed Description

Definition at line 87 of file reffld.hxx.

Constructor & Destructor Documentation

◆ SwGetRefField()

SwGetRefField::SwGetRefField	(	SwGetRefFieldType *	pFieldType,
		OUString	aSetRef,
		OUString	aReferenceLanguage,
		sal_uInt16	nSubType,
		sal_uInt16	nSeqNo,
		sal_uLong	nFormat
	)

get references

Definition at line 349 of file reffld.cxx.

Referenced by Copy().

◆ ~SwGetRefField()

SwGetRefField::~SwGetRefField ( )

overridevirtual

Definition at line 360 of file reffld.cxx.

Member Function Documentation

◆ ConvertProgrammaticToUIName()

void SwGetRefField::ConvertProgrammaticToUIName ( )

Definition at line 1056 of file reffld.cxx.

References IDocumentFieldsAccess::GetFieldType(), SwDoc::getIDocumentFieldsAccess(), GetPar1(), SwStyleNameMapper::GetPoolIdFromProgName(), SwField::GetTyp(), m_nSubType, REF_SEQUENCEFLD, RES_POOLCOLL_LABEL_ABB, RES_POOLCOLL_LABEL_DRAWING, RES_POOLCOLL_LABEL_FIGURE, RES_POOLCOLL_LABEL_FRAME, RES_POOLCOLL_LABEL_TABLE, SetExp, SetPar1(), SwResId(), and TxtColl.

Referenced by PutValue().

◆ Copy()

std::unique_ptr< SwField > SwGetRefField::Copy ( ) const

overrideprivatevirtual

Implements SwField.

Definition at line 874 of file reffld.cxx.

References SwField::GetFormat(), SwField::GetTyp(), m_nSeqNo, m_nSubType, m_sSetReferenceLanguage, m_sSetRefName, m_sText, m_sTextRLHidden, and SwGetRefField().

◆ ExpandImpl()

OUString SwGetRefField::ExpandImpl ( SwRootFrame const * pLayout ) const

overrideprivatevirtual

Implements SwField.

Definition at line 439 of file reffld.cxx.

References SwRootFrame::IsHideRedlines(), m_sText, and m_sTextRLHidden.

Referenced by GetFieldName(), GetPar2(), and QueryValue().

◆ GetDescription()

OUString SwGetRefField::GetDescription ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 364 of file reffld.cxx.

References SwResId().

◆ GetExpandedTextOfReferencedTextNode()

OUString SwGetRefField::GetExpandedTextOfReferencedTextNode ( SwRootFrame const & rLayout ) const

Definition at line 413 of file reffld.cxx.

References sw::GetExpandTextMerged(), GetReferencedTextNode(), HideDeletions, lcl_formatStringByCombiningCharacter(), and u.

Referenced by SwContentType::FillMemberList(), and SwEditWin::RequestHelp().

◆ GetFieldName()

OUString SwGetRefField::GetFieldName ( ) const

overridevirtual

get name or content

Returns: name or content.

Reimplemented from SwField.

Definition at line 444 of file reffld.cxx.

References aName, ExpandImpl(), SwFieldType::GetName(), SwField::GetTyp(), and m_sSetRefName.

◆ GetPar1()

OUString SwGetRefField::GetPar1 ( ) const

overridevirtual

get reference name

Reimplemented from SwField.

Definition at line 885 of file reffld.cxx.

References m_sSetRefName.

Referenced by ConvertProgrammaticToUIName(), and QueryValue().

◆ GetPar2()

OUString SwGetRefField::GetPar2 ( ) const

overridevirtual

Reimplemented from SwField.

Definition at line 896 of file reffld.cxx.

References ExpandImpl().

◆ GetReferencedTextNode()

const SwTextNode * SwGetRefField::GetReferencedTextNode ( ) const

Definition at line 392 of file reffld.cxx.

References SwGetRefFieldType::FindAnchor(), SwGetRefFieldType::GetDoc(), SwField::GetTyp(), m_nSeqNo, m_nSubType, and m_sSetRefName.

Referenced by GetExpandedTextOfReferencedTextNode(), and SwFieldRefPage::UpdateSubType().

◆ GetSeqNo()

sal_uInt16 SwGetRefField::GetSeqNo ( ) const

inline

Get/set SequenceNo (of interest only for REF_SEQUENCEFLD).

Definition at line 134 of file reffld.hxx.

Referenced by SwEnhancedPDFExportHelper::EnhancedPDFExport(), SwFieldRefPage::FillItemSet(), AttributeOutputBase::GenerateBookmarksForSequenceField(), WW8Export::OutputField(), AttributeOutputBase::TextField(), and SwFieldRefPage::UpdateSubType().

◆ GetSetRefName()

const OUString & SwGetRefField::GetSetRefName ( ) const

inline

Definition at line 109 of file reffld.hxx.

Referenced by SwEnhancedPDFExportHelper::EnhancedPDFExport(), AttributeOutputBase::GenerateBookmarksForSequenceField(), IMPL_LINK_NOARG(), SwWW8FltRefStack::IsFootnoteEdnBkmField(), SwGetRefFieldType::MergeWithOtherDoc(), WW8Export::OutputField(), SwEditWin::RequestHelp(), AttributeOutputBase::TextField(), and SwFieldRefPage::UpdateSubType().

◆ GetSubType()

sal_uInt16 SwGetRefField::GetSubType ( ) const

overridevirtual

Get/set sub type.

Reimplemented from SwField.

Definition at line 369 of file reffld.cxx.

References m_nSubType.

Referenced by SwEnhancedPDFExportHelper::EnhancedPDFExport(), IsRefToHeadingCrossRefBookmark(), IsRefToNumItemCrossRefBookmark(), and SwGetRefFieldType::MergeWithOtherDoc().

◆ IsRefToHeadingCrossRefBookmark()

bool SwGetRefField::IsRefToHeadingCrossRefBookmark ( ) const

Definition at line 380 of file reffld.cxx.

References GetSubType(), sw::mark::CrossRefHeadingBookmark::IsLegalName(), m_sSetRefName, and REF_BOOKMARK.

Referenced by SwContentType::FillMemberList(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), IMPL_LINK_NOARG(), and SwEditWin::RequestHelp().

◆ IsRefToNumItemCrossRefBookmark()

bool SwGetRefField::IsRefToNumItemCrossRefBookmark ( ) const

Definition at line 386 of file reffld.cxx.

References GetSubType(), sw::mark::CrossRefNumItemBookmark::IsLegalName(), m_sSetRefName, and REF_BOOKMARK.

Referenced by SwContentType::FillMemberList(), SwAccessibleParagraph::GetFieldTypeNameAtIndex(), IMPL_LINK_NOARG(), and SwEditWin::RequestHelp().

◆ PutValue()

bool SwGetRefField::PutValue	(	const css::uno::Any &	rVal,
		sal_uInt16	nWhichId
	)

overridevirtual

Reimplemented from SwField.

Definition at line 976 of file reffld.cxx.

References ConvertProgrammaticToUIName(), ENDNOTE, FIELD_PROP_PAR1, FIELD_PROP_PAR3, FIELD_PROP_PAR4, FIELD_PROP_SHORT1, FIELD_PROP_USHORT1, FIELD_PROP_USHORT2, m_nSeqNo, m_nSubType, m_sSetReferenceLanguage, REF_BOOKMARK, REF_CHAPTER, REF_CONTENT, REF_ENDNOTE, REF_FOOTNOTE, REF_NUMBER, REF_NUMBER_FULL_CONTEXT, REF_NUMBER_NO_CONTEXT, REF_ONLYCAPTION, REF_ONLYNUMBER, REF_ONLYSEQNO, REF_PAGE, REF_PAGE_PGDESC, REF_SEQUENCEFLD, REF_SETREFATTR, REF_UPDOWN, SetExpand(), SwField::SetFormat(), and SetPar1().

◆ QueryValue()

bool SwGetRefField::QueryValue	(	css::uno::Any &	rVal,
		sal_uInt16	nWhichId
	)		const

overridevirtual

◆ SetExpand()

void SwGetRefField::SetExpand ( const OUString & rStr )

Definition at line 433 of file reffld.cxx.

References m_sText, and m_sTextRLHidden.

Referenced by PutValue().

◆ SetPar1()

void SwGetRefField::SetPar1 ( const OUString & rStr )

overridevirtual

set reference name

Reimplemented from SwField.

Definition at line 891 of file reffld.cxx.

References m_sSetRefName.

Referenced by ConvertProgrammaticToUIName(), and PutValue().

◆ SetSeqNo()

void SwGetRefField::SetSeqNo ( sal_uInt16 n )

inline

Definition at line 135 of file reffld.hxx.

References n.

◆ SetSubType()

void SwGetRefField::SetSubType ( sal_uInt16 n )

overridevirtual

Reimplemented from SwField.

Definition at line 374 of file reffld.cxx.

References m_nSubType, and n.

Referenced by SwWW8FltRefStack::SetAttrInDoc().

◆ UpdateField()

void SwGetRefField::UpdateField ( const SwTextField * pFieldTextAttr )

The <SwTextField> instance, which represents the text attribute for the <SwGetRefField> instance, has to be passed to the method.

This <SwTextField> instance is needed for the reference format type REF_UPDOWN and REF_NUMBER. Note: This instance may be NULL (field in Undo/Redo). This will cause no update for these reference format types.

Definition at line 484 of file reffld.cxx.

References ShellResource::aGetRefField_RefItemNotFound, SwChapterField::ChangeExpansion(), FilterText(), SwGetRefFieldType::FindAnchor(), SwFrame::FindPageFrame(), LocaleDataWrapper::getAboveWord(), SwDoc::GetAllLayouts(), LocaleDataWrapper::getBelowWord(), SwTextNode::GetExpandText(), sw::GetExpandTextMerged(), SwTextFrame::GetFollow(), SwTextAttr::GetFootnote(), SwDoc::GetFootnoteIdxs(), SwField::GetFormat(), SwField::GetLanguage(), SwContentNode::getLayoutFrame(), SwChapterField::GetNumber(), SvxNumberType::GetNumStr(), SwPageDesc::GetNumType(), SwPageFrame::GetPageDesc(), SwTextField::GetpTextNode(), SwGetExpField::GetReferenceTextPos(), SwTextFootnote::GetSeqRefNo(), SwViewShell::GetShellRes(), SwTextAttr::GetStart(), SwTextNode::GetText(), SwTextNode::GetTextAttrForCharAt(), SwTextField::GetTextNode(), SwField::GetTyp(), SwFormatFootnote::GetViewNumStr(), SwFrame::GetVirtPageNum(), HideDeletions, i, IsFrameBehind(), SwTextFrame::IsInside(), lcl_formatReferenceLanguage(), m_nSeqNo, m_nSubType, m_sSetReferenceLanguage, m_sSetRefName, m_sText, m_sTextRLHidden, MakeRefNumStr(), SwTextFrame::MapModelToView(), MAXLEVEL, min(), O3TL_UNREACHABLE, REF_BOOKMARK, REF_CHAPTER, REF_CONTENT, REF_ENDNOTE, REF_FOOTNOTE, REF_NUMBER, REF_NUMBER_FULL_CONTEXT, REF_NUMBER_NO_CONTEXT, REF_ONLYCAPTION, REF_ONLYNUMBER, REF_ONLYSEQNO, REF_OUTLINE, REF_PAGE, REF_PAGE_PGDESC, REF_SEQUENCEFLD, REF_SETREFATTR, REF_UPDOWN, RES_TXTATR_FIELD(), result, SwChapterField::SetLevel(), and size.

Referenced by SwGetRefFieldType::UpdateGetReferences().

Member Data Documentation

◆ m_nSeqNo

sal_uInt16 SwGetRefField::m_nSeqNo

private

reference to either a SwTextFootnote::m_nSeqNo or a SwSetExpField::mnSeqNo

Definition at line 96 of file reffld.hxx.

Referenced by Copy(), GetReferencedTextNode(), PutValue(), QueryValue(), and UpdateField().

◆ m_nSubType

sal_uInt16 SwGetRefField::m_nSubType

private

Definition at line 94 of file reffld.hxx.

Referenced by ConvertProgrammaticToUIName(), Copy(), GetReferencedTextNode(), GetSubType(), PutValue(), QueryValue(), SetSubType(), and UpdateField().

◆ m_sSetReferenceLanguage

OUString SwGetRefField::m_sSetReferenceLanguage

private

Definition at line 91 of file reffld.hxx.

Referenced by Copy(), PutValue(), QueryValue(), and UpdateField().

◆ m_sSetRefName

OUString SwGetRefField::m_sSetRefName

private

Definition at line 90 of file reffld.hxx.

Referenced by Copy(), GetFieldName(), GetPar1(), GetReferencedTextNode(), IsRefToHeadingCrossRefBookmark(), IsRefToNumItemCrossRefBookmark(), SetPar1(), and UpdateField().

◆ m_sText

OUString SwGetRefField::m_sText

private

result

Definition at line 92 of file reffld.hxx.

Referenced by Copy(), ExpandImpl(), SetExpand(), and UpdateField().

◆ m_sTextRLHidden

OUString SwGetRefField::m_sTextRLHidden

private

result for layout with redlines hidden

Definition at line 93 of file reffld.hxx.

Referenced by Copy(), ExpandImpl(), SetExpand(), and UpdateField().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SwGetRefField()

◆ ~SwGetRefField()

Member Function Documentation

◆ ConvertProgrammaticToUIName()

◆ Copy()

◆ ExpandImpl()

◆ GetDescription()

◆ GetExpandedTextOfReferencedTextNode()

◆ GetFieldName()

◆ GetPar1()

◆ GetPar2()

◆ GetReferencedTextNode()

◆ GetSeqNo()

◆ GetSetRefName()

◆ GetSubType()

◆ IsRefToHeadingCrossRefBookmark()

◆ IsRefToNumItemCrossRefBookmark()

◆ PutValue()

◆ QueryValue()

◆ SetExpand()

◆ SetPar1()

◆ SetSeqNo()

◆ SetSubType()

◆ UpdateField()

Member Data Documentation

◆ m_nSeqNo

◆ m_nSubType

◆ m_sSetReferenceLanguage

◆ m_sSetRefName

◆ m_sText

◆ m_sTextRLHidden