LibreOffice Module oox (master) 1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
oox::dump::Config Class Reference

#include <dumperbase.hxx>

Inheritance diagram for oox::dump::Config:
[legend]
Collaboration diagram for oox::dump::Config:
[legend]

Public Member Functions

 Config (const char *pcEnvVar, const ::oox::core::FilterBase &rFilter)
 
 Config (const char *pcEnvVar, const css::uno::Reference< css::uno::XComponentContext > &rxContext, const StorageRef &rxRootStrg, const OUString &rSysFileName)
 
virtual ~Config () override
 
 Config (Config const &)=default
 
 Config (Config &&)=default
 
Configoperator= (Config const &)=default
 
Configoperator= (Config &&)=default
 
const css::uno::Reference< css::uno::XComponentContext > & getContext () const
 
const StorageRefgetRootStorage () const
 
const OUString & getSysFileName () const
 
const OUString & getStringOption (const String &rKey, const OUString &rDefault) const
 
bool getBoolOption (const String &rKey, bool bDefault) const
 
template<typename Type >
Type getIntOption (const String &rKey, Type nDefault) const
 
bool isDumperEnabled () const
 
bool isImportEnabled () const
 
template<typename ListType >
std::shared_ptr< ListType > createNameList (const String &rListName)
 
void eraseNameList (const String &rListName)
 
NameListRef getNameList (const String &rListName) const
 
template<typename Type >
OUString getName (const NameListWrapper &rListWrp, Type nKey) const
 Returns the name for the passed key from the passed name list. More...
 
template<typename Type >
bool hasName (const NameListWrapper &rListWrp, Type nKey) const
 Returns true, if the passed name list contains an entry for the passed key. More...
 
- Public Member Functions inherited from oox::dump::Base
virtual ~Base ()
 
 Base (Base const &)=default
 
 Base (Base &&)=default
 
Baseoperator= (Base const &)=default
 
Baseoperator= (Base &&)=default
 
bool isValid () const
 

Protected Member Functions

 Config ()
 
void construct (const char *pcEnvVar, const ::oox::core::FilterBase &rFilter)
 
void construct (const char *pcEnvVar, const css::uno::Reference< css::uno::XComponentContext > &rxContext, const StorageRef &rxRootStrg, const OUString &rSysFileName)
 
virtual bool implIsValid () const override
 
const OUString * implGetOption (const OUString &rKey) const
 
- Protected Member Functions inherited from oox::dump::Base
 Base ()
 
virtual bool implIsValid () const =0
 

Private Attributes

std::shared_ptr< SharedConfigDatamxCfgData
 

Additional Inherited Members

- Static Public Member Functions inherited from oox::dump::Base
static bool isValid (const std::shared_ptr< Base > &rxBase)
 

Detailed Description

Definition at line 832 of file dumperbase.hxx.

Constructor & Destructor Documentation

◆ Config() [1/5]

oox::dump::Config::Config ( const char *  pcEnvVar,
const ::oox::core::FilterBase rFilter 
)
explicit

◆ Config() [2/5]

oox::dump::Config::Config ( const char *  pcEnvVar,
const css::uno::Reference< css::uno::XComponentContext > &  rxContext,
const StorageRef rxRootStrg,
const OUString &  rSysFileName 
)
explicit

◆ ~Config()

Config::~Config ( )
overridevirtual

Definition at line 1408 of file dumperbase.cxx.

◆ Config() [3/5]

oox::dump::Config::Config ( Config const &  )
default

◆ Config() [4/5]

oox::dump::Config::Config ( Config &&  )
default

◆ Config() [5/5]

oox::dump::Config::Config ( )
inlineprotected

Definition at line 876 of file dumperbase.hxx.

Member Function Documentation

◆ construct() [1/2]

void oox::dump::Config::construct ( const char *  pcEnvVar,
const ::oox::core::FilterBase rFilter 
)
protected

◆ construct() [2/2]

void oox::dump::Config::construct ( const char *  pcEnvVar,
const css::uno::Reference< css::uno::XComponentContext > &  rxContext,
const StorageRef rxRootStrg,
const OUString &  rSysFileName 
)
protected

◆ createNameList()

template<typename ListType >
std::shared_ptr< ListType > Config::createNameList ( const String rListName)

Definition at line 906 of file dumperbase.hxx.

References mxCfgData.

Referenced by oox::dump::OlePropertyStreamObject::dumpSection().

◆ eraseNameList()

void Config::eraseNameList ( const String rListName)

Definition at line 1447 of file dumperbase.cxx.

References mxCfgData.

Referenced by oox::dump::OlePropertyStreamObject::dumpSection().

◆ getBoolOption()

bool Config::getBoolOption ( const String rKey,
bool  bDefault 
) const

◆ getContext()

const css::uno::Reference< css::uno::XComponentContext > & oox::dump::Config::getContext ( ) const
inline

Definition at line 851 of file dumperbase.hxx.

References mxCfgData.

◆ getIntOption()

template<typename Type >
Type Config::getIntOption ( const String rKey,
Type  nDefault 
) const

◆ getName()

template<typename Type >
OUString Config::getName ( const NameListWrapper rListWrp,
Type  nKey 
) const

◆ getNameList()

NameListRef Config::getNameList ( const String rListName) const

◆ getRootStorage()

const StorageRef & oox::dump::Config::getRootStorage ( ) const
inline

Definition at line 852 of file dumperbase.hxx.

References mxCfgData.

Referenced by oox::dump::StorageObjectBase::construct().

◆ getStringOption()

const OUString & Config::getStringOption ( const String rKey,
const OUString &  rDefault 
) const

◆ getSysFileName()

const OUString & oox::dump::Config::getSysFileName ( ) const
inline

Definition at line 853 of file dumperbase.hxx.

References mxCfgData.

Referenced by oox::dump::StorageObjectBase::construct().

◆ hasName()

template<typename Type >
bool Config::hasName ( const NameListWrapper rListWrp,
Type  nKey 
) const

Returns true, if the passed name list contains an entry for the passed key.

Definition at line 919 of file dumperbase.hxx.

References oox::dump::NameListWrapper::getNameList().

◆ implGetOption()

const OUString * Config::implGetOption ( const OUString &  rKey) const
protected

Definition at line 1462 of file dumperbase.cxx.

References mxCfgData.

Referenced by getBoolOption(), getIntOption(), and getStringOption().

◆ implIsValid()

bool Config::implIsValid ( ) const
overrideprotectedvirtual

Implements oox::dump::Base.

Definition at line 1457 of file dumperbase.cxx.

References oox::dump::Base::isValid(), and mxCfgData.

◆ isDumperEnabled()

bool Config::isDumperEnabled ( ) const

Definition at line 1437 of file dumperbase.cxx.

References getBoolOption().

◆ isImportEnabled()

bool Config::isImportEnabled ( ) const

Definition at line 1442 of file dumperbase.cxx.

References getBoolOption().

Referenced by oox::dump::DumperBase::isImportEnabled().

◆ operator=() [1/2]

Config & oox::dump::Config::operator= ( Config &&  )
default

◆ operator=() [2/2]

Config & oox::dump::Config::operator= ( Config const &  )
default

Member Data Documentation

◆ mxCfgData

std::shared_ptr< SharedConfigData > oox::dump::Config::mxCfgData
private

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