KPIM::Signature

KPIM::Signature Class Reference

abstraction of a signature (aka "footer"). More...

#include <identity.h>

List of all members.

Public Types

enum Type { Disabled = 0, Inlined = 1, FromFile = 2, FromCommand = 3 }

Public Member Functions

bool operator== (const Signature &other) const
Signature ()
Signature (const QString &text)
Signature (const QString &url, bool isExecutable)
QString rawText (bool *ok=0) const
QString withSeparator (bool *ok=0) const
void setText (const QString &text)
QString text () const
void setUrl (const QString &url, bool isExecutable=false)
QString url () const
Type type () const

Protected Member Functions

void writeConfig (KConfigBase *config) const
void readConfig (const KConfigBase *config)

Friends

class Identity
QDataStream & KPIM::operator<< (QDataStream &stream, const Signature &sig)
QDataStream & KPIM::operator>> (QDataStream &stream, Signature &sig)

Detailed Description

abstraction of a signature (aka "footer").

Author:: Marc Mutz <mutz@kde.org>

Member Enumeration Documentation

enum KPIM::Signature::Type

Type of signature (ie.

way to obtain the signature text)

Constructor & Destructor Documentation

Signature::Signature

(

)

Constructor for disabled signature.

Signature::Signature

(

const QString &

text

)

Constructor for inline text.

Signature::Signature	(	const QString &	url,
		bool	isExecutable
	)

Constructor for text from a file or from output of a command.

Member Function Documentation

bool Signature::operator==

(

const Signature &

other

)

const

Used for comparison.

QString Signature::rawText ( bool * ok = 0 ) const

Returns:: the raw signature text as entered resp. read from file.

QString Signature::withSeparator ( bool * ok = 0 ) const

Returns:: the signature text with a "-- " separator added, if necessary.

void KPIM::Signature::setText ( const QString & text ) [inline]

Set the signature text and mark this signature as being of "inline text" type.

void Signature::setUrl	(	const QString &	url,
		bool	isExecutable = `false`
	)

Set the signature URL and mark this signature as being of "from file" resp.

"from output of command" type.

Type KPIM::Signature::type ( ) const [inline]

the type of signature (ie. way to obtain the signature text)

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

identity.h
identity.cpp

libkpimidentities

API Docs