certmanager/lib
Kleo::CryptoConfigEntry Class Reference
#include <cryptoconfig.h>
Inherited by QGpgMECryptoConfigEntry.
Detailed Description
Description of a single option.Definition at line 49 of file cryptoconfig.h.
Public Types | |
enum | Level { Level_Basic = 0, Level_Advanced = 1, Level_Expert = 2 } |
enum | ArgType { ArgType_None = 0, ArgType_String = 1, ArgType_Int = 2, ArgType_UInt = 3, ArgType_Path = 4, ArgType_URL = 5, ArgType_LDAPURL = 6, ArgType_DirPath = 7 } |
Public Member Functions | |
virtual QString | name () const =0 |
virtual QString | description () const =0 |
virtual bool | isOptional () const =0 |
virtual bool | isReadOnly () const =0 |
virtual bool | isList () const =0 |
virtual bool | isRuntime () const =0 |
virtual Level | level () const =0 |
virtual ArgType | argType () const =0 |
virtual bool | isSet () const =0 |
virtual bool | boolValue () const =0 |
virtual QString | stringValue () const =0 |
virtual int | intValue () const =0 |
virtual unsigned int | uintValue () const =0 |
virtual KURL | urlValue () const =0 |
virtual unsigned int | numberOfTimesSet () const =0 |
virtual QStringList | stringValueList () const =0 |
virtual QValueList< int > | intValueList () const =0 |
virtual QValueList< unsigned int > | uintValueList () const =0 |
virtual KURL::List | urlValueList () const =0 |
virtual void | resetToDefault ()=0 |
virtual void | setBoolValue (bool)=0 |
virtual void | setStringValue (const QString &)=0 |
virtual void | setIntValue (int)=0 |
virtual void | setUIntValue (unsigned int)=0 |
virtual void | setURLValue (const KURL &)=0 |
virtual void | setNumberOfTimesSet (unsigned int)=0 |
virtual void | setStringValueList (const QStringList &)=0 |
virtual void | setIntValueList (const QValueList< int > &)=0 |
virtual void | setUIntValueList (const QValueList< unsigned int > &)=0 |
virtual void | setURLValueList (const KURL::List &)=0 |
virtual bool | isDirty () const =0 |
Member Enumeration Documentation
- basic This option should always be offered to the user.
- advanced This option may be offered to advanced users.
- expert This option should only be offered to expert users.
Definition at line 58 of file cryptoconfig.h.
Type of the argument.
- ArgType_None The option is set or not set, but no argument.
- ArgType_String An unformatted string.
- ArgType_Int A signed integer number.
- ArgType_UInt An unsigned integer number.
- ArgType_Path A string that describes the pathname of a file. The file does not necessarily need to exist. Separated from string so that e.g. a KURLRequester can be used.
- ArgType_DirPath A string that describes the pathname of a directory. The directory does not necessarily need to exist. Separated from path so that e.g. a KURLRequester can be used which only allows directories to be selected.
- ArgType_URL A URL
- ArgType_LDAPURL A LDAP URL Separated from URL so that a more specific widget can be shown, hiding the url syntax
Definition at line 79 of file cryptoconfig.h.
Member Function Documentation
virtual QString Kleo::CryptoConfigEntry::name | ( | ) | const [pure virtual] |
Return the internal name of this entry.
virtual QString Kleo::CryptoConfigEntry::description | ( | ) | const [pure virtual] |
- Returns:
- user-visible description of this entry
virtual bool Kleo::CryptoConfigEntry::isOptional | ( | ) | const [pure virtual] |
- Returns:
- true if the argument is optional
virtual bool Kleo::CryptoConfigEntry::isReadOnly | ( | ) | const [pure virtual] |
- Returns:
- true if the entry is readonly
virtual bool Kleo::CryptoConfigEntry::isList | ( | ) | const [pure virtual] |
- Returns:
- true if the argument can be given multiple times
virtual bool Kleo::CryptoConfigEntry::isRuntime | ( | ) | const [pure virtual] |
- Returns:
- true if the argument can be changed at runtime
virtual Level Kleo::CryptoConfigEntry::level | ( | ) | const [pure virtual] |
User level.
virtual ArgType Kleo::CryptoConfigEntry::argType | ( | ) | const [pure virtual] |
Argument type.
virtual bool Kleo::CryptoConfigEntry::isSet | ( | ) | const [pure virtual] |
Return true if the option is set, i.e.
different from default
virtual bool Kleo::CryptoConfigEntry::boolValue | ( | ) | const [pure virtual] |
Return value as a bool (only allowed for ArgType_None).
virtual QString Kleo::CryptoConfigEntry::stringValue | ( | ) | const [pure virtual] |
Return value as a string (available for all argtypes) The returned string can be empty (explicitely set to empty) or null (not set).
virtual int Kleo::CryptoConfigEntry::intValue | ( | ) | const [pure virtual] |
Return value as a signed int.
virtual unsigned int Kleo::CryptoConfigEntry::uintValue | ( | ) | const [pure virtual] |
Return value as an unsigned int.
virtual KURL Kleo::CryptoConfigEntry::urlValue | ( | ) | const [pure virtual] |
Return value as a URL (only meaningful for Path and URL argtypes).
virtual unsigned int Kleo::CryptoConfigEntry::numberOfTimesSet | ( | ) | const [pure virtual] |
Return number of times the option is set (only valid for ArgType_None, if isList()).
virtual QStringList Kleo::CryptoConfigEntry::stringValueList | ( | ) | const [pure virtual] |
Return value as a list of strings (mostly meaningful for String, Path and URL argtypes, if isList()).
virtual QValueList<int> Kleo::CryptoConfigEntry::intValueList | ( | ) | const [pure virtual] |
Return value as a list of signed ints.
virtual QValueList<unsigned int> Kleo::CryptoConfigEntry::uintValueList | ( | ) | const [pure virtual] |
Return value as a list of unsigned ints.
virtual KURL::List Kleo::CryptoConfigEntry::urlValueList | ( | ) | const [pure virtual] |
Return value as a list of URLs (only meaningful for Path and URL argtypes, if isList()).
virtual void Kleo::CryptoConfigEntry::resetToDefault | ( | ) | [pure virtual] |
Reset an option to its default value.
virtual void Kleo::CryptoConfigEntry::setBoolValue | ( | bool | ) | [pure virtual] |
Define whether the option is set or not (only allowed for ArgType_None) #### TODO: and for options with optional args.
virtual void Kleo::CryptoConfigEntry::setStringValue | ( | const QString & | ) | [pure virtual] |
Set string value (allowed for all argtypes).
virtual void Kleo::CryptoConfigEntry::setIntValue | ( | int | ) | [pure virtual] |
Set a new signed int value.
virtual void Kleo::CryptoConfigEntry::setUIntValue | ( | unsigned | int | ) | [pure virtual] |
Set a new unsigned int value.
virtual void Kleo::CryptoConfigEntry::setURLValue | ( | const KURL & | ) | [pure virtual] |
Set value as a URL (only meaningful for Path (if local) and URL argtypes).
virtual void Kleo::CryptoConfigEntry::setNumberOfTimesSet | ( | unsigned | int | ) | [pure virtual] |
Set the number of times the option is set (only valid for ArgType_None, if isList()).
virtual void Kleo::CryptoConfigEntry::setStringValueList | ( | const QStringList & | ) | [pure virtual] |
Set a new string-list value (only allowed for String, Path and URL argtypes, if isList()).
virtual void Kleo::CryptoConfigEntry::setIntValueList | ( | const QValueList< int > & | ) | [pure virtual] |
Set a new list of signed int values.
virtual void Kleo::CryptoConfigEntry::setUIntValueList | ( | const QValueList< unsigned int > & | ) | [pure virtual] |
Set a new list of unsigned int values.
virtual void Kleo::CryptoConfigEntry::setURLValueList | ( | const KURL::List & | ) | [pure virtual] |
Set value as a URL list (only meaningful for Path (if all URLs are local) and URL argtypes, if isList()).
virtual bool Kleo::CryptoConfigEntry::isDirty | ( | ) | const [pure virtual] |
- Returns:
- true if the value was changed
The documentation for this class was generated from the following file: