certmanager/lib

Public Types | Public Member Functions | List of all members
Kleo::CryptoConfigEntry Class Referenceabstract

#include <cryptoconfig.h>

Inherited by QGpgMECryptoConfigEntry.

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 TQString name () const =0
 
virtual TQString 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 TQString 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 TQStringList stringValueList () const =0
 
virtual TQValueList< int > intValueList () const =0
 
virtual TQValueList< unsigned int > uintValueList () const =0
 
virtual KURL::List urlValueList () const =0
 
virtual void resetToDefault ()=0
 
virtual void setBoolValue (bool)=0
 
virtual void setStringValue (const TQString &)=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 TQStringList &)=0
 
virtual void setIntValueList (const TQValueList< int > &)=0
 
virtual void setUIntValueList (const TQValueList< unsigned int > &)=0
 
virtual void setURLValueList (const KURL::List &)=0
 
virtual bool isDirty () const =0
 

Detailed Description

Description of a single option.

Definition at line 49 of file cryptoconfig.h.

Member Enumeration Documentation

◆ ArgType

enum Kleo::CryptoConfigEntry::ArgType

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.

◆ Level

enum Kleo::CryptoConfigEntry::Level
  • 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.

Member Function Documentation

◆ argType()

virtual ArgType Kleo::CryptoConfigEntry::argType ( ) const
pure virtual

Argument type.

◆ boolValue()

virtual bool Kleo::CryptoConfigEntry::boolValue ( ) const
pure virtual

Return value as a bool (only allowed for ArgType_None)

◆ description()

virtual TQString Kleo::CryptoConfigEntry::description ( ) const
pure virtual
Returns
user-visible description of this entry

◆ intValue()

virtual int Kleo::CryptoConfigEntry::intValue ( ) const
pure virtual

Return value as a signed int.

◆ intValueList()

virtual TQValueList<int> Kleo::CryptoConfigEntry::intValueList ( ) const
pure virtual

Return value as a list of signed ints.

◆ isDirty()

virtual bool Kleo::CryptoConfigEntry::isDirty ( ) const
pure virtual
Returns
true if the value was changed

◆ isList()

virtual bool Kleo::CryptoConfigEntry::isList ( ) const
pure virtual
Returns
true if the argument can be given multiple times

◆ isOptional()

virtual bool Kleo::CryptoConfigEntry::isOptional ( ) const
pure virtual
Returns
true if the argument is optional

◆ isReadOnly()

virtual bool Kleo::CryptoConfigEntry::isReadOnly ( ) const
pure virtual
Returns
true if the entry is readonly

◆ isRuntime()

virtual bool Kleo::CryptoConfigEntry::isRuntime ( ) const
pure virtual
Returns
true if the argument can be changed at runtime

◆ isSet()

virtual bool Kleo::CryptoConfigEntry::isSet ( ) const
pure virtual

Return true if the option is set, i.e.

different from default

◆ level()

virtual Level Kleo::CryptoConfigEntry::level ( ) const
pure virtual

User level.

◆ name()

virtual TQString Kleo::CryptoConfigEntry::name ( ) const
pure virtual

Return the internal name of this entry.

◆ numberOfTimesSet()

virtual unsigned int Kleo::CryptoConfigEntry::numberOfTimesSet ( ) const
pure virtual

Return number of times the option is set (only valid for ArgType_None, if isList())

◆ resetToDefault()

virtual void Kleo::CryptoConfigEntry::resetToDefault ( )
pure virtual

Reset an option to its default value.

◆ setBoolValue()

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

◆ setIntValue()

virtual void Kleo::CryptoConfigEntry::setIntValue ( int  )
pure virtual

Set a new signed int value.

◆ setIntValueList()

virtual void Kleo::CryptoConfigEntry::setIntValueList ( const TQValueList< int > &  )
pure virtual

Set a new list of signed int values.

◆ setNumberOfTimesSet()

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())

◆ setStringValue()

virtual void Kleo::CryptoConfigEntry::setStringValue ( const TQString &  )
pure virtual

Set string value (allowed for all argtypes)

◆ setStringValueList()

virtual void Kleo::CryptoConfigEntry::setStringValueList ( const TQStringList &  )
pure virtual

Set a new string-list value (only allowed for String, Path and URL argtypes, if isList())

◆ setUIntValue()

virtual void Kleo::CryptoConfigEntry::setUIntValue ( unsigned int  )
pure virtual

Set a new unsigned int value.

◆ setUIntValueList()

virtual void Kleo::CryptoConfigEntry::setUIntValueList ( const TQValueList< unsigned int > &  )
pure virtual

Set a new list of unsigned int values.

◆ setURLValue()

virtual void Kleo::CryptoConfigEntry::setURLValue ( const KURL &  )
pure virtual

Set value as a URL (only meaningful for Path (if local) and URL argtypes)

◆ setURLValueList()

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())

◆ stringValue()

virtual TQString 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).

◆ stringValueList()

virtual TQStringList Kleo::CryptoConfigEntry::stringValueList ( ) const
pure virtual

Return value as a list of strings (mostly meaningful for String, Path and URL argtypes, if isList())

◆ uintValue()

virtual unsigned int Kleo::CryptoConfigEntry::uintValue ( ) const
pure virtual

Return value as an unsigned int.

◆ uintValueList()

virtual TQValueList<unsigned int> Kleo::CryptoConfigEntry::uintValueList ( ) const
pure virtual

Return value as a list of unsigned ints.

◆ urlValue()

virtual KURL Kleo::CryptoConfigEntry::urlValue ( ) const
pure virtual

Return value as a URL (only meaningful for Path and URL argtypes)

◆ urlValueList()

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())

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