abstract parent class for all variable related fields More...

#include <txtvfldi.hxx>

Inheritance diagram for XMLVarFieldImportContext:

Collaboration diagram for XMLVarFieldImportContext:

Public Member Functions
	XMLVarFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, const OUString &pServiceName, bool bFormula, bool bFormulaDefault, bool bDescription, bool bHelp, bool bHint, bool bVisible, bool bDisplayFormula, bool bType, bool bStyle, bool bValue, bool bPresentation)
	set presentation frm elem. content? More...

Public Member Functions inherited from XMLTextFieldImportContext
	XMLTextFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, OUString aService)
	whether this field is valid ? More...

virtual void SAL_CALL	characters (const OUString &sContent) override
	name of SO API service More...

virtual void SAL_CALL	startFastElement (sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &xAttrList) override
	parses attributes and calls ProcessAttribute More...

virtual void SAL_CALL	endFastElement (sal_Int32 nElement) override
	create XTextField and insert into document; calls PrepareTextField More...

Public Member Functions inherited from SvXMLImportContext
	SvXMLImportContext (SvXMLImport &rImport)
	A contexts constructor does anything that is required if an element starts. More...

virtual	~SvXMLImportContext ()
	A contexts destructor does anything that is required if an element ends. More...

virtual void SAL_CALL	startFastElement (sal_Int32 Element, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override

virtual void SAL_CALL	startUnknownElement (const OUString &Namespace, const OUString &Name, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override

virtual void SAL_CALL	endFastElement (sal_Int32 Element) override
	endFastElement is called before a context will be destructed, but after an elements context has been parsed. More...

virtual void SAL_CALL	endUnknownElement (const OUString &Namespace, const OUString &Name) override

virtual css::uno::Reference< XFastContextHandler > SAL_CALL	createFastChildContext (sal_Int32 Element, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override

virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL	createUnknownChildContext (const OUString &Namespace, const OUString &Name, const css::uno::Reference< css::xml::sax::XFastAttributeList > &Attribs) override

virtual void SAL_CALL	characters (const OUString &aChars) override
	This method is called for all characters that are contained in the current element. More...

virtual css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &aType) final override

virtual void SAL_CALL	acquire () noexcept final override

virtual void SAL_CALL	release () noexcept final override

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () final override

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () final override

Protected Member Functions
virtual void	ProcessAttribute (sal_Int32 nAttrToken, std::string_view sAttrValue) override
	set presentation from elem. content More...

virtual void	PrepareField (const css::uno::Reference< css::beans::XPropertySet > &xPropertySet) override
	prepare XTextField for insertion into document More...

const OUString &	GetName () const

bool	IsStringValue () const

Protected Member Functions inherited from XMLTextFieldImportContext
XMLTextImportHelper &	GetImportHelper ()
	get helper More...

const OUString &	GetServiceName () const

void	SetServiceName (const OUString &sStr)

OUString const &	GetContent ()

virtual void	ProcessAttribute (sal_Int32 nAttrToken, std::string_view sAttrValue)=0
	process attribute values More...

virtual void	PrepareField (const css::uno::Reference< css::beans::XPropertySet > &xPropertySet)=0
	prepare XTextField for insertion into document More...

bool	CreateField (css::uno::Reference< css::beans::XPropertySet > &xField, const OUString &sServiceName)
	create field from ServiceName More...

Protected Member Functions inherited from SvXMLImportContext
SvXMLImport &	GetImport ()

const SvXMLImport &	GetImport () const

Private Attributes
OUString	sName

OUString	sFormula
	name attribute More...

OUString	sDescription
	formula attribute More...

OUString	sHelp
	description More...

OUString	sHint
	help text More...

XMLValueImportHelper	aValueHelper
	hint More...

bool	bDisplayFormula
	value, value-type, and style More...

bool	bDisplayNone
	display formula?(rather than value) More...

bool	bFormulaOK
	hide field? More...

bool	bDescriptionOK
	sFormula was set More...

bool	bHelpOK
	sDescription was set More...

bool	bHintOK
	sHelp was set More...

bool	bDisplayOK
	sHint was set More...

bool	bSetFormula
	sDisplayFormula/-None were set More...

bool	bSetFormulaDefault
	set Formula property More...

bool	bSetDescription
	use content as default for formula More...

bool	bSetHelp
	set sDescription with Hint-property More...

bool	bSetHint

bool	bSetVisible

bool	bSetDisplayFormula
	set IsVisible More...

bool	bSetPresentation
	set DisplayFormula (sub type???) More...

Additional Inherited Members
Static Public Member Functions inherited from XMLTextFieldImportContext
static XMLTextFieldImportContext *	CreateTextFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, sal_Int32 nElement)
	create the appropriate field context from (for use in paragraph import) More...

Static Protected Member Functions inherited from XMLTextFieldImportContext
static void	ForceUpdate (const css::uno::Reference< css::beans::XPropertySet > &rPropertySet)
	force an update of the field's value call update on optional XUpdatable interface; (disable Fixed property) More...

Protected Attributes inherited from XMLTextFieldImportContext
OUString	sServicePrefix
	the import helper More...

bool	bValid

Detailed Description

abstract parent class for all variable related fields

variable-set/get/decl (not -decls),
user-field-get/decl (not -decls),
sequence/-decl (not -decls),
expression,
text-input

Processes the following attributes:

name
formula
display
value, value-type, data-style-name (via XMLValueImportHelper)
description.

Each attribute has a corresponding member, a bool variable to indicate whether it was set or not, and a bool variable whether it should be set using the standard property name.

bValid is set true, when name is found! (Most variable related fields are valid, if a name is found. However, some are always valid. In this case, setting bValid does not matter.)

Definition at line 105 of file txtvfldi.hxx.

Constructor & Destructor Documentation

◆ XMLVarFieldImportContext()

XMLVarFieldImportContext::XMLVarFieldImportContext	(	SvXMLImport &	rImport,
		XMLTextImportHelper &	rHlp,
		const OUString &	pServiceName,
		bool	bFormula,
		bool	bFormulaDefault,
		bool	bDescription,
		bool	bHelp,
		bool	bHint,
		bool	bVisible,
		bool	bDisplayFormula,
		bool	bType,
		bool	bStyle,
		bool	bValue,
		bool	bPresentation
	)

set presentation frm elem. content?

Parameters

rHlp	XML Import
pServiceName	text import helper
bFormula	name of SO API service
bFormulaDefault	set Formula property
bDescription	use content as default for formula
bHelp	set sDescription with Hint-property
bDisplayFormula	set IsVisible (display attr)
bType	set ??? (display attr.)
bStyle	set value type with ???-property
bValue	set data style (NumberFormat-Prop.)
bPresentation	set value with Content/Value-Prop.

Definition at line 81 of file txtvfldi.cxx.

References bVisible.

Member Function Documentation

◆ GetName()

const OUString & XMLVarFieldImportContext::GetName ( ) const

inlineprotected

Definition at line 164 of file txtvfldi.hxx.

References sName.

Referenced by XMLSetVarFieldImportContext::endFastElement(), XMLSetVarFieldImportContext::FindFieldMaster(), XMLVariableGetFieldImportContext::PrepareField(), XMLUserFieldInputImportContext::PrepareField(), and XMLSequenceFieldImportContext::PrepareField().

◆ IsStringValue()

bool XMLVarFieldImportContext::IsStringValue ( ) const

inlineprotected

Definition at line 165 of file txtvfldi.hxx.

References aValueHelper, and XMLValueImportHelper::IsStringValue().

Referenced by XMLVariableSetFieldImportContext::PrepareField(), and XMLVariableInputFieldImportContext::PrepareField().

◆ PrepareField()

void XMLVarFieldImportContext::PrepareField ( const css::uno::Reference< css::beans::XPropertySet > & xPropertySet )

overrideprotectedvirtual

prepare XTextField for insertion into document

Implements XMLTextFieldImportContext.

Reimplemented in XMLVariableGetFieldImportContext, XMLExpressionFieldImportContext, XMLTextInputFieldImportContext, XMLVariableSetFieldImportContext, XMLVariableInputFieldImportContext, XMLUserFieldInputImportContext, and XMLSequenceFieldImportContext.

Definition at line 174 of file txtvfldi.cxx.

References Any, aValueHelper, bDescriptionOK, bDisplayFormula, bDisplayNone, bDisplayOK, bFormulaOK, bHelpOK, bHintOK, bSetDescription, bSetDisplayFormula, bSetFormula, bSetFormulaDefault, bSetHelp, bSetHint, bSetPresentation, bSetVisible, XMLTextFieldImportContext::GetContent(), XMLValueImportHelper::PrepareField(), sAPI_content, sAPI_current_presentation, sAPI_is_visible, sDescription, XMLValueImportHelper::SetDefault(), sFormula, sHelp, and sHint.

Referenced by XMLSetVarFieldImportContext::endFastElement(), XMLVariableGetFieldImportContext::PrepareField(), XMLExpressionFieldImportContext::PrepareField(), XMLTextInputFieldImportContext::PrepareField(), XMLVariableSetFieldImportContext::PrepareField(), XMLVariableInputFieldImportContext::PrepareField(), XMLUserFieldInputImportContext::PrepareField(), and XMLSequenceFieldImportContext::PrepareField().

◆ ProcessAttribute()

void XMLVarFieldImportContext::ProcessAttribute	(	sal_Int32	nAttrToken,
		std::string_view	sAttrValue
	)

overrideprotectedvirtual

set presentation from elem. content

process attribute values

Implements XMLTextFieldImportContext.

Reimplemented in XMLSequenceFieldImportContext.

Definition at line 109 of file txtvfldi.cxx.

References aValueHelper, bDescriptionOK, bDisplayFormula, bDisplayNone, bDisplayOK, bFormulaOK, bHelpOK, bHintOK, XMLTextFieldImportContext::bValid, DBG_ASSERT, SvXMLImportContext::GetImport(), xmloff::token::IsXMLToken(), XMLValueImportHelper::ProcessAttribute(), sDescription, sFormula, sHelp, sHint, sName, TEXT, xmloff::token::XML_DESCRIPTION, xmloff::token::XML_DISPLAY, XML_ELEMENT, xmloff::token::XML_FORMULA, xmloff::token::XML_HELP, xmloff::token::XML_HINT, xmloff::token::XML_NAME, XML_NAMESPACE_OOOW, xmloff::token::XML_NONE, and xmloff::token::XML_VALUE.

Referenced by XMLSequenceFieldImportContext::ProcessAttribute().

Member Data Documentation

◆ aValueHelper

XMLValueImportHelper XMLVarFieldImportContext::aValueHelper

private

hint

Definition at line 113 of file txtvfldi.hxx.

Referenced by IsStringValue(), PrepareField(), and ProcessAttribute().

◆ bDescriptionOK

bool XMLVarFieldImportContext::bDescriptionOK

private

sFormula was set

Definition at line 118 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bDisplayFormula

bool XMLVarFieldImportContext::bDisplayFormula

private

value, value-type, and style

Definition at line 114 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bDisplayNone

bool XMLVarFieldImportContext::bDisplayNone

private

display formula?(rather than value)

Definition at line 115 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bDisplayOK

bool XMLVarFieldImportContext::bDisplayOK

private

sHint was set

Definition at line 121 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bFormulaOK

bool XMLVarFieldImportContext::bFormulaOK

private

hide field?

Definition at line 117 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bHelpOK

bool XMLVarFieldImportContext::bHelpOK

private

sDescription was set

Definition at line 119 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bHintOK

bool XMLVarFieldImportContext::bHintOK

private

sHelp was set

Definition at line 120 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ bSetDescription

bool XMLVarFieldImportContext::bSetDescription

private

use content as default for formula

Definition at line 125 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetDisplayFormula

bool XMLVarFieldImportContext::bSetDisplayFormula

private

set IsVisible

Definition at line 129 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetFormula

bool XMLVarFieldImportContext::bSetFormula

private

sDisplayFormula/-None were set

Definition at line 123 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetFormulaDefault

bool XMLVarFieldImportContext::bSetFormulaDefault

private

set Formula property

Definition at line 124 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetHelp

bool XMLVarFieldImportContext::bSetHelp

private

set sDescription with Hint-property

Definition at line 126 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetHint

bool XMLVarFieldImportContext::bSetHint

private

Definition at line 127 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetPresentation

bool XMLVarFieldImportContext::bSetPresentation

private

set DisplayFormula (sub type???)

Definition at line 130 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ bSetVisible

bool XMLVarFieldImportContext::bSetVisible

private

Definition at line 128 of file txtvfldi.hxx.

Referenced by PrepareField().

◆ sDescription

OUString XMLVarFieldImportContext::sDescription

private

formula attribute

Definition at line 110 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ sFormula

OUString XMLVarFieldImportContext::sFormula

private

name attribute

Definition at line 109 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ sHelp

OUString XMLVarFieldImportContext::sHelp

private

description

Definition at line 111 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ sHint

OUString XMLVarFieldImportContext::sHint

private

help text

Definition at line 112 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

◆ sName

OUString XMLVarFieldImportContext::sName

private

Definition at line 108 of file txtvfldi.hxx.

Referenced by GetName(), and ProcessAttribute().

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLVarFieldImportContext()

Member Function Documentation

◆ GetName()

◆ IsStringValue()

◆ PrepareField()

◆ ProcessAttribute()

Member Data Documentation

◆ aValueHelper

◆ bDescriptionOK

◆ bDisplayFormula

◆ bDisplayNone

◆ bDisplayOK

◆ bFormulaOK

◆ bHelpOK

◆ bHintOK

◆ bSetDescription

◆ bSetDisplayFormula

◆ bSetFormula

◆ bSetFormulaDefault

◆ bSetHelp

◆ bSetHint

◆ bSetPresentation

◆ bSetVisible

◆ sDescription

◆ sFormula

◆ sHelp

◆ sHint

◆ sName