libkpgp

Kpgp::UserID

Kpgp::UserID Class Reference

#include <kpgpkey.h>

Detailed Description

This class is used to store information about a user id of a PGP key.

Definition at line 73 of file kpgpkey.h.


Public Member Functions
bool	invalid () const
bool	revoked () const
void	setInvalid (const bool invalid)
void	setRevoked (const bool revoked)
void	setText (const QString &str)
void	setValidity (const Validity validity)
QString	text () const
	UserID (const QString &str, const Validity validity=KPGP_VALIDITY_UNKNOWN, const bool revoked=false, const bool invalid=false)
Validity	validity () const
	~UserID ()
Protected Attributes
bool	mInvalid: 1
bool	mRevoked: 1
QString	mText
Validity	mValidity

Constructor & Destructor Documentation

Kpgp::UserID::UserID	(	const QString &	str,
		const Validity	validity = `KPGP_VALIDITY_UNKNOWN`,
		const bool	revoked = `false`,
		const bool	invalid = `false`
	)			`[explicit]`

Constructs a new user id with the given values.

Parameters:

	str	User Id (descriptive text)
	validity	Validity of key, relevant mostly if `invalid` is `false`
	revoked	Is the key revoked?
	invalid	Is the key invalid?

Todo:: How exactly do invalid and validity affect each other?

Definition at line 52 of file kpgpkey.cpp.

Kpgp::UserID::~UserID ( ) [inline]

Definition at line 88 of file kpgpkey.h.

Member Function Documentation

bool Kpgp::UserID::invalid ( ) const [inline]

Returns true if the user id is invalid.

Definition at line 152 of file kpgpkey.h.

bool Kpgp::UserID::revoked ( ) const [inline]

Returns true if the user id has been revoked.

Definition at line 147 of file kpgpkey.h.

void Kpgp::UserID::setInvalid ( const bool invalid ) [inline]

Sets the flag if the user id is invalid to invalid.

Parameters:

invalid

Whether the user id is invalid or not.

Todo:: Is it the user id that is invalid or the key itself? This should then also be documented in setText().

Definition at line 172 of file kpgpkey.h.

void Kpgp::UserID::setRevoked ( const bool revoked ) [inline]

Sets the flag if the user id has been revoked to revoked.

Parameters:

revoked

Whether the user id has been revoked or not.

Todo:: Does one revoke a user id or a key? See also comments for setInvalid() and setText().

Definition at line 167 of file kpgpkey.h.

void Kpgp::UserID::setText ( const QString & str ) [inline]

Sets the text of the user id to str.

Parameters:

str

The new user id text.

Definition at line 162 of file kpgpkey.h.

void Kpgp::UserID::setValidity ( const Validity validity ) [inline]

Sets the validity of resp.

the trust in the user id to validity .

Parameters:

validity

New validity value.

Todo:: Are there any restrictions on how you can change validities?

Definition at line 177 of file kpgpkey.h.

QString Kpgp::UserID::text ( ) const [inline]

Returns the text of the user id.

Definition at line 142 of file kpgpkey.h.

Validity Kpgp::UserID::validity ( ) const [inline]

Returns the validity of resp.

the trust in the user id.

Definition at line 157 of file kpgpkey.h.

Member Data Documentation

bool Kpgp::UserID::mInvalid [protected]

Invalid flag.

See also:: setInvalid()
invalid()

Definition at line 132 of file kpgpkey.h.

bool Kpgp::UserID::mRevoked [protected]

Revoked flag.

See also:: setRevoked()
revoked()

Definition at line 130 of file kpgpkey.h.

QString Kpgp::UserID::mText [protected]

User id (descriptive text).

See also:: setText()
text()

Definition at line 136 of file kpgpkey.h.

Validity Kpgp::UserID::mValidity [protected]

Validity (assuming invalid flag is false).

See also:: setValidity()
validity()

Definition at line 134 of file kpgpkey.h.

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

libkpgp

Kpgp::UserID Class Reference

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

libkpgp

kdepim