certmanager/lib

Kleo::CryptoConfig Class Referenceabstract

#include <cryptoconfig.h>

Inheritance diagram for Kleo::CryptoConfig:
QGpgMECryptoConfig

Public Member Functions

virtual TQStringList componentList () const =0
 
virtual CryptoConfigComponentcomponent (const TQString &name) const =0
 
CryptoConfigEntryentry (const TQString &componentName, const TQString &groupName, const TQString &entryName) const
 
virtual void sync (bool runtime)=0
 
virtual void clear ()=0
 

Detailed Description

Main interface to crypto configuration.

Definition at line 334 of file cryptoconfig.h.

Member Function Documentation

◆ clear()

virtual void Kleo::CryptoConfig::clear ( )
pure virtual

Tells the CryptoConfig to discard any cached information, including all components, groups and entries.

Call this to free some memory when you won't be using the object for some time. DON'T call this if you're holding pointers to components, groups or entries.

Implemented in QGpgMECryptoConfig.

◆ component()

virtual CryptoConfigComponent* Kleo::CryptoConfig::component ( const TQString &  name) const
pure virtual
Returns
the configuration object for a given component The object is owned by CryptoConfig, don't delete it.

Implemented in QGpgMECryptoConfig.

◆ componentList()

virtual TQStringList Kleo::CryptoConfig::componentList ( ) const
pure virtual

Returns the list of known components (e.g.

"gpg-agent", "dirmngr" etc.). Use component() to retrieve more information about each one.

Returns
list of component names.

Implemented in QGpgMECryptoConfig.

◆ entry()

CryptoConfigEntry* Kleo::CryptoConfig::entry ( const TQString &  componentName,
const TQString &  groupName,
const TQString &  entryName 
) const
inline

Convenience method to get hold of a single configuration entry when its component, group and name are known.

This can be used to read the value and/or to set a value to it.

Returns
the configuration object for a single configuration entry, 0 if not found. The object is owned by CryptoConfig, don't delete it.

Definition at line 360 of file cryptoconfig.h.

◆ sync()

virtual void Kleo::CryptoConfig::sync ( bool  runtime)
pure virtual

Write back changes.

Parameters
runtimeIf this option is set, the changes will take effect at run-time, as far as this is possible. Otherwise, they will take effect at the next start of the respective backend programs.

Implemented in QGpgMECryptoConfig.


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