LibreOffice Module xmloff (master) 1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
XMLTextFieldImportContext Class Referenceabstract

abstract class for text field import More...

#include <txtfldi.hxx>

Inheritance diagram for XMLTextFieldImportContext:
[legend]
Collaboration diagram for XMLTextFieldImportContext:
[legend]

Public Member Functions

 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
 

Static Public Member Functions

static XMLTextFieldImportContextCreateTextFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, sal_Int32 nElement)
 create the appropriate field context from (for use in paragraph import) More...
 

Protected Member Functions

XMLTextImportHelperGetImportHelper ()
 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
SvXMLImportGetImport ()
 
const SvXMLImportGetImport () const
 

Static Protected Member Functions

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

OUString sServicePrefix
 the import helper More...
 
bool bValid
 

Private Attributes

OUStringBuffer sContentBuffer
 
OUString sContent
 collect character data More...
 
OUString sServiceName
 character data after collection More...
 
XMLTextImportHelperrTextImportHelper
 service name for text field More...
 

Detailed Description

abstract class for text field import

Definition at line 49 of file txtfldi.hxx.

Constructor & Destructor Documentation

◆ XMLTextFieldImportContext()

XMLTextFieldImportContext::XMLTextFieldImportContext ( SvXMLImport rImport,
XMLTextImportHelper rHlp,
OUString  aService 
)

whether this field is valid ?

Parameters
rHlpXML Import
aServiceText import helper

Definition at line 125 of file txtfldi.cxx.

References sServiceName.

Member Function Documentation

◆ characters()

void XMLTextFieldImportContext::characters ( const OUString &  sContent)
overridevirtual

name of SO API service

process character data: will be collected in member sContentBuffer

Reimplemented from SvXMLImportContext.

Definition at line 187 of file txtfldi.cxx.

References sContentBuffer.

◆ CreateField()

bool XMLTextFieldImportContext::CreateField ( css::uno::Reference< css::beans::XPropertySet > &  xField,
const OUString &  sServiceName 
)
protected

◆ CreateTextFieldImportContext()

XMLTextFieldImportContext * XMLTextFieldImportContext::CreateTextFieldImportContext ( SvXMLImport rImport,
XMLTextImportHelper rHlp,
sal_Int32  nElement 
)
static

create the appropriate field context from (for use in paragraph import)

create the appropriate field context from

Definition at line 220 of file txtfldi.cxx.

References nToken, OFFICE, TEXT, xmloff::token::XML_ANNOTATION, xmloff::token::XML_ANNOTATION_END, xmloff::token::XML_AUTHOR_INITIALS, xmloff::token::XML_AUTHOR_NAME, xmloff::token::XML_BIBLIOGRAPHY_MARK, xmloff::token::XML_BOOKMARK_REF, xmloff::token::XML_CHAPTER, xmloff::token::XML_CHARACTER_COUNT, xmloff::token::XML_CONDITIONAL_TEXT, xmloff::token::XML_CREATION_DATE, xmloff::token::XML_CREATION_TIME, xmloff::token::XML_CREATOR, xmloff::token::XML_DATABASE_DISPLAY, xmloff::token::XML_DATABASE_NAME, xmloff::token::XML_DATABASE_NEXT, xmloff::token::XML_DATABASE_ROW_NUMBER, xmloff::token::XML_DATABASE_ROW_SELECT, xmloff::token::XML_DATE, xmloff::token::XML_DATE_TIME, xmloff::token::XML_DDE_CONNECTION, xmloff::token::XML_DESCRIPTION, xmloff::token::XML_DROP_DOWN, xmloff::token::XML_EDITING_CYCLES, xmloff::token::XML_EDITING_DURATION, XML_ELEMENT, xmloff::token::XML_EXECUTE_MACRO, xmloff::token::XML_EXPRESSION, xmloff::token::XML_FILE_NAME, xmloff::token::XML_FOOTER, xmloff::token::XML_HEADER, xmloff::token::XML_HIDDEN_PARAGRAPH, xmloff::token::XML_HIDDEN_TEXT, xmloff::token::XML_IMAGE_COUNT, xmloff::token::XML_INITIAL_CREATOR, xmloff::token::XML_KEYWORDS, xmloff::token::XML_MEASURE, xmloff::token::XML_MODIFICATION_DATE, xmloff::token::XML_MODIFICATION_TIME, xmloff::token::XML_NOTE_REF, xmloff::token::XML_OBJECT_COUNT, xmloff::token::XML_PAGE_CONTINUATION, xmloff::token::XML_PAGE_CONTINUATION_STRING, xmloff::token::XML_PAGE_COUNT, xmloff::token::XML_PAGE_NAME, xmloff::token::XML_PAGE_NUMBER, xmloff::token::XML_PAGE_VARIABLE_GET, xmloff::token::XML_PAGE_VARIABLE_SET, xmloff::token::XML_PARAGRAPH_COUNT, xmloff::token::XML_PLACEHOLDER, xmloff::token::XML_PRINT_DATE, xmloff::token::XML_PRINT_TIME, xmloff::token::XML_PRINTED_BY, xmloff::token::XML_REFERENCE_REF, xmloff::token::XML_SCRIPT, xmloff::token::XML_SENDER_CITY, xmloff::token::XML_SENDER_COMPANY, xmloff::token::XML_SENDER_COUNTRY, xmloff::token::XML_SENDER_EMAIL, xmloff::token::XML_SENDER_FAX, xmloff::token::XML_SENDER_FIRSTNAME, xmloff::token::XML_SENDER_INITIALS, xmloff::token::XML_SENDER_LASTNAME, xmloff::token::XML_SENDER_PHONE_PRIVATE, xmloff::token::XML_SENDER_PHONE_WORK, xmloff::token::XML_SENDER_POSITION, xmloff::token::XML_SENDER_POSTAL_CODE, xmloff::token::XML_SENDER_STATE_OR_PROVINCE, xmloff::token::XML_SENDER_STREET, xmloff::token::XML_SENDER_TITLE, xmloff::token::XML_SEQUENCE, xmloff::token::XML_SEQUENCE_REF, xmloff::token::XML_SHEET_NAME, xmloff::token::XML_SUBJECT, xmloff::token::XML_TABLE_COUNT, xmloff::token::XML_TABLE_FORMULA, xmloff::token::XML_TEMPLATE_NAME, xmloff::token::XML_TEXT_INPUT, xmloff::token::XML_TIME, xmloff::token::XML_TITLE, xmloff::token::XML_USER_DEFINED, xmloff::token::XML_USER_FIELD_GET, xmloff::token::XML_USER_FIELD_INPUT, xmloff::token::XML_VARIABLE_GET, xmloff::token::XML_VARIABLE_INPUT, xmloff::token::XML_VARIABLE_SET, and xmloff::token::XML_WORD_COUNT.

Referenced by XMLImpSpanContext_Impl::CreateSpanContext().

◆ endFastElement()

void XMLTextFieldImportContext::endFastElement ( sal_Int32  nElement)
overridevirtual

◆ ForceUpdate()

void XMLTextFieldImportContext::ForceUpdate ( const css::uno::Reference< css::beans::XPropertySet > &  rPropertySet)
staticprotected

force an update of the field's value call update on optional XUpdatable interface; (disable Fixed property)

Definition at line 465 of file txtfldi.cxx.

Referenced by XMLSenderFieldImportContext::PrepareField(), XMLAuthorFieldImportContext::PrepareField(), XMLTimeFieldImportContext::PrepareField(), XMLSimpleDocInfoImportContext::PrepareField(), and XMLRevisionDocInfoImportContext::PrepareField().

◆ GetContent()

OUString const & XMLTextFieldImportContext::GetContent ( )
protected

◆ GetImportHelper()

XMLTextImportHelper & XMLTextFieldImportContext::GetImportHelper ( )
inlineprotected

◆ GetServiceName()

const OUString & XMLTextFieldImportContext::GetServiceName ( ) const
inlineprotected

◆ PrepareField()

virtual void XMLTextFieldImportContext::PrepareField ( const css::uno::Reference< css::beans::XPropertySet > &  xPropertySet)
protectedpure virtual

◆ ProcessAttribute()

virtual void XMLTextFieldImportContext::ProcessAttribute ( sal_Int32  nAttrToken,
std::string_view  sAttrValue 
)
protectedpure virtual

◆ SetServiceName()

void XMLTextFieldImportContext::SetServiceName ( const OUString &  sStr)
inlineprotected

◆ startFastElement()

void XMLTextFieldImportContext::startFastElement ( sal_Int32  nElement,
const css::uno::Reference< css::xml::sax::XFastAttributeList > &  xAttrList 
)
overridevirtual

Member Data Documentation

◆ bValid

bool XMLTextFieldImportContext::bValid
protected

Definition at line 61 of file txtfldi.hxx.

Referenced by XMLMacroFieldImportContext::createFastChildContext(), endFastElement(), XMLDdeFieldImportContext::endFastElement(), XMLAnnotationImportContext::endFastElement(), XMLSetVarFieldImportContext::endFastElement(), XMLDatabaseDisplayImportContext::endFastElement(), XMLPlaceholderFieldImportContext::ProcessAttribute(), XMLDatabaseNameImportContext::ProcessAttribute(), XMLDatabaseNextImportContext::ProcessAttribute(), XMLDatabaseSelectImportContext::ProcessAttribute(), XMLDatabaseNumberImportContext::ProcessAttribute(), XMLUserDocInfoImportContext::ProcessAttribute(), XMLHiddenParagraphImportContext::ProcessAttribute(), XMLConditionalTextImportContext::ProcessAttribute(), XMLHiddenTextImportContext::ProcessAttribute(), XMLMacroFieldImportContext::ProcessAttribute(), XMLReferenceFieldImportContext::ProcessAttribute(), XMLDdeFieldImportContext::ProcessAttribute(), XMLUrlFieldImportContext::ProcessAttribute(), XMLScriptImportContext::ProcessAttribute(), XMLMeasureFieldImportContext::ProcessAttribute(), XMLVarFieldImportContext::ProcessAttribute(), XMLTableFormulaImportContext::ProcessAttribute(), XMLDatabaseDisplayImportContext::ProcessAttribute(), XMLSenderFieldImportContext::startFastElement(), XMLAuthorFieldImportContext::startFastElement(), XMLAnnotationImportContext::XMLAnnotationImportContext(), XMLBibliographyFieldImportContext::XMLBibliographyFieldImportContext(), XMLChapterImportContext::XMLChapterImportContext(), XMLCountFieldImportContext::XMLCountFieldImportContext(), XMLDateTimeDocInfoImportContext::XMLDateTimeDocInfoImportContext(), XMLDateTimeFieldImportContext::XMLDateTimeFieldImportContext(), XMLDropDownFieldImportContext::XMLDropDownFieldImportContext(), XMLExpressionFieldImportContext::XMLExpressionFieldImportContext(), XMLFileNameImportContext::XMLFileNameImportContext(), XMLFooterFieldImportContext::XMLFooterFieldImportContext(), XMLHeaderFieldImportContext::XMLHeaderFieldImportContext(), XMLPageContinuationImportContext::XMLPageContinuationImportContext(), XMLPageNameFieldImportContext::XMLPageNameFieldImportContext(), XMLPageNumberImportContext::XMLPageNumberImportContext(), XMLPageVarGetFieldImportContext::XMLPageVarGetFieldImportContext(), XMLPageVarSetFieldImportContext::XMLPageVarSetFieldImportContext(), XMLRevisionDocInfoImportContext::XMLRevisionDocInfoImportContext(), XMLSheetNameImportContext::XMLSheetNameImportContext(), XMLSimpleDocInfoImportContext::XMLSimpleDocInfoImportContext(), XMLTemplateNameImportContext::XMLTemplateNameImportContext(), XMLTextInputFieldImportContext::XMLTextInputFieldImportContext(), XMLTimeFieldImportContext::XMLTimeFieldImportContext(), and XMLUserDocInfoImportContext::XMLUserDocInfoImportContext().

◆ rTextImportHelper

XMLTextImportHelper& XMLTextFieldImportContext::rTextImportHelper
private

service name for text field

Definition at line 55 of file txtfldi.hxx.

Referenced by endFastElement(), and GetImportHelper().

◆ sContent

OUString XMLTextFieldImportContext::sContent
private

collect character data

Definition at line 53 of file txtfldi.hxx.

Referenced by GetContent().

◆ sContentBuffer

OUStringBuffer XMLTextFieldImportContext::sContentBuffer
private

Definition at line 52 of file txtfldi.hxx.

Referenced by characters(), and GetContent().

◆ sServiceName

OUString XMLTextFieldImportContext::sServiceName
private

character data after collection

Definition at line 54 of file txtfldi.hxx.

Referenced by GetServiceName(), and SetServiceName().

◆ sServicePrefix

OUString XMLTextFieldImportContext::sServicePrefix
protected

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