Kleo::CryptoConfigEntry Class Reference
Description of a single option.
More...
#include <cryptoconfig.h>
Inherited by QGpgMECryptoConfigEntry.
List of all members.
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
}
Public Member Functions
Detailed Description
Description of a single option.
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.
|
|
|
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_URL A URL
- ArgType_LDAPURL A LDAP URL Separated from URL so that a more specific widget can be shown, hiding the url syntax
|
Member Function Documentation
| 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::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] |
|
| virtual ArgType Kleo::CryptoConfigEntry::argType |
( |
|
) |
const [pure virtual] |
|
| 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: