KDE PIM / Developers / API Docs / libkpimidentities

KPIM::Signature Class Reference

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

#include <identity.h>

List of all members.

Public Types

Public Member Functions

Protected Member Functions

Friends


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: