certmanager/lib Library API Documentation

Kleo::CryptoConfig Class Reference

Main interface to crypto configuration. More...

#include <cryptoconfig.h>

Inheritance diagram for Kleo::CryptoConfig:

Inheritance graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

Main interface to crypto configuration.

Definition at line 293 of file cryptoconfig.h.


Member Function Documentation

virtual QStringList 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.

virtual CryptoConfigComponent* Kleo::CryptoConfig::component const QString 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.

CryptoConfigEntry* Kleo::CryptoConfig::entry const QString componentName,
const QString groupName,
const QString 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 319 of file cryptoconfig.h.

References Kleo::CryptoConfigGroup::entry(), and Kleo::CryptoConfigComponent::group().

virtual void Kleo::CryptoConfig::sync bool  runtime  )  [pure virtual]
 

Write back changes.

Parameters:
runtime If 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.

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.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for certmanager/lib Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 4 04:46:19 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003