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

#include <SettingsExportHelper.hxx>

Collaboration diagram for XMLSettingsExportHelper:
[legend]

Public Member Functions

 XMLSettingsExportHelper (::xmloff::XMLSettingsExportContext &i_rContext)
 
 ~XMLSettingsExportHelper ()
 
void exportAllSettings (const css::uno::Sequence< css::beans::PropertyValue > &aProps, const OUString &rName) const
 

Private Member Functions

void ManipulateSetting (css::uno::Any &rAny, std::u16string_view rName) const
 For some settings we may want to change their API representation from their XML settings representation. More...
 
void CallTypeFunction (const css::uno::Any &rAny, const OUString &rName) const
 
void exportBool (const bool bValue, const OUString &rName) const
 
void exportShort (const sal_Int16 nValue, const OUString &rName) const
 
void exportInt (const sal_Int32 nValue, const OUString &rName) const
 
void exportLong (const sal_Int64 nValue, const OUString &rName) const
 
void exportDouble (const double fValue, const OUString &rName) const
 
void exportString (const OUString &sValue, const OUString &rName) const
 
void exportDateTime (const css::util::DateTime &aValue, const OUString &rName) const
 
void exportSequencePropertyValue (const css::uno::Sequence< css::beans::PropertyValue > &aProps, const OUString &rName) const
 
void exportbase64Binary (const css::uno::Sequence< sal_Int8 > &aProps, const OUString &rName) const
 
void exportMapEntry (const css::uno::Any &rAny, const OUString &rName, const bool bNameAccess) const
 
void exportNameAccess (const css::uno::Reference< css::container::XNameAccess > &rNamed, const OUString &rName) const
 
void exportIndexAccess (const css::uno::Reference< css::container::XIndexAccess > &rIndexed, const OUString &rName) const
 
void exportSymbolDescriptors (const css::uno::Sequence< css::formula::SymbolDescriptor > &rProps, const OUString &rName) const
 
void exportForbiddenCharacters (const css::uno::Any &rAny, const OUString &rName) const
 

Static Private Member Functions

static void exportByte ()
 

Private Attributes

::xmloff::XMLSettingsExportContext & m_rContext
 
css::uno::Reference< css::util::XStringSubstitution > mxStringSubstitution
 

Detailed Description

Definition at line 48 of file SettingsExportHelper.hxx.

Constructor & Destructor Documentation

◆ XMLSettingsExportHelper()

XMLSettingsExportHelper::XMLSettingsExportHelper ( ::xmloff::XMLSettingsExportContext &  i_rContext)

Definition at line 57 of file SettingsExportHelper.cxx.

References m_rContext.

◆ ~XMLSettingsExportHelper()

XMLSettingsExportHelper::~XMLSettingsExportHelper ( )

Definition at line 62 of file SettingsExportHelper.cxx.

Member Function Documentation

◆ CallTypeFunction()

void XMLSettingsExportHelper::CallTypeFunction ( const css::uno::Any &  rAny,
const OUString &  rName 
) const
private

Definition at line 66 of file SettingsExportHelper.cxx.

References exportbase64Binary(), exportBool(), exportByte(), exportDateTime(), exportDouble(), exportForbiddenCharacters(), exportIndexAccess(), exportInt(), exportLong(), exportNameAccess(), exportSequencePropertyValue(), exportShort(), exportString(), exportSymbolDescriptors(), and ManipulateSetting().

Referenced by exportMapEntry(), and exportSequencePropertyValue().

◆ exportAllSettings()

void XMLSettingsExportHelper::exportAllSettings ( const css::uno::Sequence< css::beans::PropertyValue > &  aProps,
const OUString &  rName 
) const

Definition at line 464 of file SettingsExportHelper.cxx.

References DBG_ASSERT, and exportSequencePropertyValue().

Referenced by SvXMLExport::ImplExportSettings().

◆ exportbase64Binary()

void XMLSettingsExportHelper::exportbase64Binary ( const css::uno::Sequence< sal_Int8 > &  aProps,
const OUString &  rName 
) const
private

Definition at line 335 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, comphelper::Base64::encode(), xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_BASE64BINARY, xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_NAME, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportBool()

void XMLSettingsExportHelper::exportBool ( const bool  bValue,
const OUString &  rName 
) const
private

Definition at line 183 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), xmloff::token::GetXMLToken(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_BOOLEAN, xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_FALSE, xmloff::token::XML_NAME, xmloff::token::XML_TRUE, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportByte()

void XMLSettingsExportHelper::exportByte ( )
staticprivate

Definition at line 198 of file SettingsExportHelper.cxx.

Referenced by CallTypeFunction().

◆ exportDateTime()

void XMLSettingsExportHelper::exportDateTime ( const css::util::DateTime &  aValue,
const OUString &  rName 
) const
private

Definition at line 258 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), sax::Converter::convertDateTime(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_DATETIME, xmloff::token::XML_NAME, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportDouble()

void XMLSettingsExportHelper::exportDouble ( const double  fValue,
const OUString &  rName 
) const
private

Definition at line 235 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), sax::Converter::convertDouble(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_DOUBLE, xmloff::token::XML_NAME, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportForbiddenCharacters()

void XMLSettingsExportHelper::exportForbiddenCharacters ( const css::uno::Any &  rAny,
const OUString &  rName 
) const
private

Definition at line 408 of file SettingsExportHelper.cxx.

References exportIndexAccess(), nPos, SAL_WARN_IF, u, XML_FORBIDDEN_CHARACTER_BEGIN_LINE, XML_FORBIDDEN_CHARACTER_COUNTRY, XML_FORBIDDEN_CHARACTER_END_LINE, XML_FORBIDDEN_CHARACTER_LANGUAGE, XML_FORBIDDEN_CHARACTER_MAX, and XML_FORBIDDEN_CHARACTER_VARIANT.

Referenced by CallTypeFunction().

◆ exportIndexAccess()

void XMLSettingsExportHelper::exportIndexAccess ( const css::uno::Reference< css::container::XIndexAccess > &  rIndexed,
const OUString &  rName 
) const
private

Definition at line 388 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), exportMapEntry(), i, m_rContext, nCount, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM_MAP_INDEXED, and xmloff::token::XML_NAME.

Referenced by CallTypeFunction(), exportForbiddenCharacters(), and exportSymbolDescriptors().

◆ exportInt()

void XMLSettingsExportHelper::exportInt ( const sal_Int32  nValue,
const OUString &  rName 
) const
private

Definition at line 215 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, nValue, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_INT, xmloff::token::XML_NAME, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportLong()

void XMLSettingsExportHelper::exportLong ( const sal_Int64  nValue,
const OUString &  rName 
) const
private

Definition at line 225 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, nValue, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_LONG, xmloff::token::XML_NAME, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportMapEntry()

void XMLSettingsExportHelper::exportMapEntry ( const css::uno::Any &  rAny,
const OUString &  rName,
const bool  bNameAccess 
) const
private

Definition at line 352 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), CallTypeFunction(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM_MAP_ENTRY, and xmloff::token::XML_NAME.

Referenced by exportIndexAccess(), and exportNameAccess().

◆ exportNameAccess()

void XMLSettingsExportHelper::exportNameAccess ( const css::uno::Reference< css::container::XNameAccess > &  rNamed,
const OUString &  rName 
) const
private

Definition at line 370 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), exportMapEntry(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM_MAP_NAMED, and xmloff::token::XML_NAME.

Referenced by CallTypeFunction().

◆ exportSequencePropertyValue()

void XMLSettingsExportHelper::exportSequencePropertyValue ( const css::uno::Sequence< css::beans::PropertyValue > &  aProps,
const OUString &  rName 
) const
private

Definition at line 270 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), CallTypeFunction(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM_SET, and xmloff::token::XML_NAME.

Referenced by CallTypeFunction(), and exportAllSettings().

◆ exportShort()

void XMLSettingsExportHelper::exportShort ( const sal_Int16  nValue,
const OUString &  rName 
) const
private

Definition at line 205 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, nValue, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_NAME, xmloff::token::XML_SHORT, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportString()

void XMLSettingsExportHelper::exportString ( const OUString &  sValue,
const OUString &  rName 
) const
private

Definition at line 247 of file SettingsExportHelper.cxx.

References xmloff::XMLSettingsExportContext::AddAttribute(), xmloff::XMLSettingsExportContext::Characters(), DBG_ASSERT, xmloff::XMLSettingsExportContext::EndElement(), m_rContext, xmloff::XMLSettingsExportContext::StartElement(), xmloff::token::XML_CONFIG_ITEM, xmloff::token::XML_NAME, xmloff::token::XML_STRING, and xmloff::token::XML_TYPE.

Referenced by CallTypeFunction().

◆ exportSymbolDescriptors()

void XMLSettingsExportHelper::exportSymbolDescriptors ( const css::uno::Sequence< css::formula::SymbolDescriptor > &  rProps,
const OUString &  rName 
) const
private

Definition at line 284 of file SettingsExportHelper.cxx.

References exportIndexAccess(), nCount, nIndex, sName, u, XML_SYMBOL_DESCRIPTOR_CHAR_SET, XML_SYMBOL_DESCRIPTOR_CHARACTER, XML_SYMBOL_DESCRIPTOR_EXPORT_NAME, XML_SYMBOL_DESCRIPTOR_FAMILY, XML_SYMBOL_DESCRIPTOR_FONT_NAME, XML_SYMBOL_DESCRIPTOR_ITALIC, XML_SYMBOL_DESCRIPTOR_MAX, XML_SYMBOL_DESCRIPTOR_NAME, XML_SYMBOL_DESCRIPTOR_PITCH, XML_SYMBOL_DESCRIPTOR_SYMBOL_SET, and XML_SYMBOL_DESCRIPTOR_WEIGHT.

Referenced by CallTypeFunction().

◆ ManipulateSetting()

void XMLSettingsExportHelper::ManipulateSetting ( css::uno::Any &  rAny,
std::u16string_view  rName 
) const
private

For some settings we may want to change their API representation from their XML settings representation.

This is your chance to do so!

Definition at line 477 of file SettingsExportHelper.cxx.

References aURL, DBG_UNHANDLED_EXCEPTION, xmloff::XMLSettingsExportContext::GetComponentContext(), gsBitmapTableURL(), gsColorTableURL(), gsDashTableURL(), gsGradientTableURL(), gsHatchTableURL(), gsLineEndTableURL(), gsPrinterIndependentLayout(), m_rContext, and mxStringSubstitution.

Referenced by CallTypeFunction().

Member Data Documentation

◆ m_rContext

::xmloff::XMLSettingsExportContext& XMLSettingsExportHelper::m_rContext
private

Definition at line 50 of file SettingsExportHelper.hxx.

Referenced by exportbase64Binary(), exportBool(), exportDateTime(), exportDouble(), exportIndexAccess(), exportInt(), exportLong(), exportMapEntry(), exportNameAccess(), exportSequencePropertyValue(), exportShort(), exportString(), and ManipulateSetting().

◆ mxStringSubstitution

css::uno::Reference< css::util::XStringSubstitution > XMLSettingsExportHelper::mxStringSubstitution
private

Definition at line 52 of file SettingsExportHelper.hxx.

Referenced by ManipulateSetting().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:41:16 for LibreOffice Module xmloff (master) by doxygen 1.9.3