comphelper::ConfigurationChanges Class Reference

A batch of configuration changes that is committed as a whole. More...

#include <configuration.hxx>

Public Member Functions
	~ConfigurationChanges ()
void	commit () const

Static Public Member Functions
static std::shared_ptr< ConfigurationChanges >	create ()

Private Member Functions
	ConfigurationChanges (const ConfigurationChanges &)=delete
ConfigurationChanges &	operator= (const ConfigurationChanges &)=delete
SAL_DLLPRIVATE	ConfigurationChanges (css::uno::Reference< css::uno::XComponentContext > const &context)
SAL_DLLPRIVATE void	setPropertyValue (OUString const &path, css::uno::Any const &value) const
SAL_DLLPRIVATE css::uno::Reference< css::container::XHierarchicalNameReplace >	getGroup (OUString const &path) const
SAL_DLLPRIVATE css::uno::Reference< css::container::XNameContainer >	getSet (OUString const &path) const

Private Attributes
css::uno::Reference< css::configuration::XReadWriteAccess >	access_

Friends
class	detail::ConfigurationWrapper

Detailed Description

A batch of configuration changes that is committed as a whole.

Client code needs to call commit explicitly; otherwise the changes are lost when the instance is destroyed.

This is the only class from this header file that client code should use directly.

Definition at line 52 of file configuration.hxx.

Constructor & Destructor Documentation

~ConfigurationChanges()

comphelper::ConfigurationChanges::~ConfigurationChanges

(

)

Definition at line 70 of file configuration.cxx.

ConfigurationChanges() [1/2]

comphelper::ConfigurationChanges::ConfigurationChanges ( const ConfigurationChanges &  )

privatedelete

ConfigurationChanges() [2/2]

comphelper::ConfigurationChanges::ConfigurationChanges ( css::uno::Reference< css::uno::XComponentContext > const &  context )

private

Definition at line 76 of file configuration.cxx.

References access_, and create().

Member Function Documentation

commit()

void comphelper::ConfigurationChanges::commit

(

)

const

Definition at line 72 of file configuration.cxx.

References access_.

create()

std::shared_ptr< comphelper::ConfigurationChanges > comphelper::ConfigurationChanges::create ( )

static

Definition at line 65 of file configuration.cxx.

References comphelper::detail::ConfigurationWrapper::createChanges(), and comphelper::detail::ConfigurationWrapper::get().

getGroup()

css::uno::Reference< css::container::XHierarchicalNameReplace > comphelper::ConfigurationChanges::getGroup ( OUString const &  path ) const

private

Definition at line 90 of file configuration.cxx.

References access_.

getSet()

css::uno::Reference< css::container::XNameContainer > comphelper::ConfigurationChanges::getSet ( OUString const &  path ) const

private

Definition at line 97 of file configuration.cxx.

References access_.

operator=()

ConfigurationChanges & comphelper::ConfigurationChanges::operator= ( const ConfigurationChanges &  )

privatedelete

References setPropertyValue().

setPropertyValue()

void comphelper::ConfigurationChanges::setPropertyValue ( OUString const &  path, css::uno::Any const &  value  ) const

private

Definition at line 83 of file configuration.cxx.

References access_, and value.

Friends And Related Function Documentation

detail::ConfigurationWrapper

friend class detail::ConfigurationWrapper

friend

Definition at line 83 of file configuration.hxx.

Member Data Documentation

access_

css::uno::Reference< css::configuration::XReadWriteAccess > comphelper::ConfigurationChanges::access_

private

Definition at line 81 of file configuration.hxx.

---

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

• configuration.hxx
• configuration.cxx