kmail Library API Documentation

Signature Class Reference

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

#include <kmidentity.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)
void setUrl (const QString &url, bool isExecutable=false)

Protected Member Functions

void writeConfig (KConfigBase *config) const
void readConfig (const KConfigBase *config)
Type type () const
QString url () const
QString text () const

Protected Attributes

QString mUrl
QString mText
Type mType

Friends

QDataStream & operator<< (QDataStream &stream, const Signature &sig)
QDataStream & operator>> (QDataStream &stream, Signature &sig)


Detailed Description

abstraction of a signature (aka "footer").

Author:
Marc Mutz <mutz@kde.org>

Definition at line 26 of file kmidentity.h.


Member Enumeration Documentation

enum Signature::Type
 

Type of signature (ie.

way to obtain the signature text)

Definition at line 35 of file kmidentity.h.


Constructor & Destructor Documentation

Signature::Signature  ) 
 

Constructor for disabled signature.

Definition at line 26 of file kmidentity.cpp.

Signature::Signature const QString &  text  ) 
 

Constructor for inline text.

Definition at line 32 of file kmidentity.cpp.

Signature::Signature const QString &  url,
bool  isExecutable
 

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

Definition at line 39 of file kmidentity.cpp.


Member Function Documentation

bool Signature::operator== const Signature other  )  const
 

Used for comparison.

Definition at line 45 of file kmidentity.cpp.

References mText, mType, mUrl, and operator==().

Referenced by operator==().

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

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

Definition at line 56 of file kmidentity.cpp.

References rawText().

Referenced by rawText(), and withSeparator().

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

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

Definition at line 134 of file kmidentity.cpp.

References rawText(), and withSeparator().

Referenced by KMIdentity::signatureText(), and withSeparator().

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

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

Definition at line 56 of file kmidentity.h.

References setText().

Referenced by setText().

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.

Definition at line 157 of file kmidentity.cpp.

References setUrl().

Referenced by setUrl().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 28 23:58:05 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003