LibreOffice Module xmloff (master)  1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
XMLVarFieldImportContext Class Reference

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

#include <txtvfldi.hxx>

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

Public Member Functions

 XMLVarFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, const char *pServiceName, sal_uInt16 nPrfx, const OUString &rLocalName, 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, const char *pService, sal_uInt16 nPrfx, const OUString &rLocalName)
 whether this field is valid ? More...
 
virtual void Characters (const OUString &sContent) override
 element name w/o prefix More...
 
virtual void StartElement (const css::uno::Reference< css::xml::sax::XAttributeList > &xAttrList) override
 parses attributes and calls ProcessAttribute More...
 
virtual void EndElement () override
 create XTextField and insert into document; calls PrepareTextField More...
 
- Public Member Functions inherited from SvXMLImportContext
bool IsPrefixFilledIn () const
 
sal_uInt16 GetPrefix () const
 
const OUString & GetLocalName () const
 
 SvXMLImportContext (SvXMLImport &rImport, sal_uInt16 nPrfx, const OUString &rLName)
 A contexts constructor does anything that is required if an element starts. More...
 
 SvXMLImportContext (SvXMLImport &rImport)
 
virtual ~SvXMLImportContext ()
 A contexts destructor does anything that is required if an element ends. More...
 
virtual SvXMLImportContextRef CreateChildContext (sal_uInt16 nPrefix, const OUString &rLocalName, const css::uno::Reference< css::xml::sax::XAttributeList > &xAttrList)
 Create a children element context. 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
 
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
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &aType) final override
 
virtual void SAL_CALL acquire () final override throw ()
 
virtual void SAL_CALL release () final override throw ()
 
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_uInt16 nAttrToken, const OUString &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
XMLTextImportHelperGetImportHelper ()
 get helper More...
 
const OUString & GetServiceName () const
 
void SetServiceName (const OUString &sStr)
 
OUString const & GetContent ()
 
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
 

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 XMLTextFieldImportContextCreateTextFieldImportContext (SvXMLImport &rImport, XMLTextImportHelper &rHlp, sal_uInt16 nPrefix, const OUString &rName, sal_uInt16 nToken)
 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

Processes the following attributes:

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 106 of file txtvfldi.hxx.

Constructor & Destructor Documentation

XMLVarFieldImportContext::XMLVarFieldImportContext ( SvXMLImport rImport,
XMLTextImportHelper rHlp,
const char *  pServiceName,
sal_uInt16  nPrfx,
const OUString &  rLocalName,
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
rHlpXML Import
pServiceNametext import helper
nPrfxname of SO API service
rLocalNamenamespace prefix
bFormulaelement name w/o prefix
bFormulaDefaultset Formula property
bDescriptionuse content as default for formula
bHelpset sDescription with Hint-property
bDisplayFormulaset IsVisible (display attr)
bTypeset ??? (display attr.)
bStyleset value type with ???-property
bValueset data style (NumberFormat-Prop.)
bPresentationset value with Content/Value-Prop.

Definition at line 81 of file txtvfldi.cxx.

Member Function Documentation

const OUString& XMLVarFieldImportContext::GetName ( ) const
inlineprotected
bool XMLVarFieldImportContext::IsStringValue ( ) const
inlineprotected
void XMLVarFieldImportContext::PrepareField ( const css::uno::Reference< css::beans::XPropertySet > &  xPropertySet)
overrideprotectedvirtual
void XMLVarFieldImportContext::ProcessAttribute ( sal_uInt16  nAttrToken,
const OUString &  sAttrValue 
)
overrideprotectedvirtual

Member Data Documentation

XMLValueImportHelper XMLVarFieldImportContext::aValueHelper
private

hint

Definition at line 114 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bDescriptionOK
private

sFormula was set

Definition at line 119 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bDisplayFormula
private

value, value-type, and style

Definition at line 115 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bDisplayNone
private

display formula?(rather than value)

Definition at line 116 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bDisplayOK
private

sHint was set

Definition at line 122 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bFormulaOK
private

hide field?

Definition at line 118 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bHelpOK
private

sDescription was set

Definition at line 120 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bHintOK
private

sHelp was set

Definition at line 121 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

bool XMLVarFieldImportContext::bSetDescription
private

use content as default for formula

Definition at line 126 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetDisplayFormula
private

set IsVisible

Definition at line 130 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetFormula
private

sDisplayFormula/-None were set

Definition at line 124 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetFormulaDefault
private

set Formula property

Definition at line 125 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetHelp
private

set sDescription with Hint-property

Definition at line 127 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetHint
private

Definition at line 128 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetPresentation
private

set DisplayFormula (sub type???)

Definition at line 131 of file txtvfldi.hxx.

Referenced by PrepareField().

bool XMLVarFieldImportContext::bSetVisible
private

Definition at line 129 of file txtvfldi.hxx.

Referenced by PrepareField().

OUString XMLVarFieldImportContext::sDescription
private

formula attribute

Definition at line 111 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

OUString XMLVarFieldImportContext::sFormula
private

name attribute

Definition at line 110 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

OUString XMLVarFieldImportContext::sHelp
private

description

Definition at line 112 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

OUString XMLVarFieldImportContext::sHint
private

help text

Definition at line 113 of file txtvfldi.hxx.

Referenced by PrepareField(), and ProcessAttribute().

OUString XMLVarFieldImportContext::sName
private

Definition at line 109 of file txtvfldi.hxx.

Referenced by GetName(), and ProcessAttribute().


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