LibreOffice Module comphelper (master)  1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
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< ConfigurationChangescreate (css::uno::Reference< css::uno::XComponentContext > const &context=comphelper::getProcessComponentContext())
 

Private Member Functions

 ConfigurationChanges (const ConfigurationChanges &)=delete
 
ConfigurationChangesoperator= (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 45 of file configuration.hxx.

Constructor & Destructor Documentation

comphelper::ConfigurationChanges::~ConfigurationChanges ( )

Definition at line 80 of file configuration.cxx.

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

Definition at line 86 of file configuration.cxx.

References access_, and create().

Member Function Documentation

void comphelper::ConfigurationChanges::commit ( ) const

Definition at line 82 of file configuration.cxx.

References access_.

std::shared_ptr< comphelper::ConfigurationChanges > comphelper::ConfigurationChanges::create ( css::uno::Reference< css::uno::XComponentContext > const &  context = comphelper::getProcessComponentContext())
static

Definition at line 74 of file configuration.cxx.

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

Definition at line 100 of file configuration.cxx.

References access_.

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

Definition at line 107 of file configuration.cxx.

References access_.

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

Definition at line 93 of file configuration.cxx.

References access_.

Friends And Related Function Documentation

friend class detail::ConfigurationWrapper
friend

Definition at line 78 of file configuration.hxx.

Member Data Documentation

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

Definition at line 76 of file configuration.hxx.


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