libkpimidentities
KPIM::Signature Class Reference
#include <identity.h>
Detailed Description
abstraction of a signature (aka "footer").
Definition at line 33 of file identity.h.
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 |
| void | setType (Type type) |
Protected Member Functions | |
| void | writeConfig (KConfigBase *config) const |
| void | readConfig (const KConfigBase *config) |
Friends | |
| class | Identity |
| QDataStream & | operator<< (QDataStream &stream, const Signature &sig) |
| QDataStream & | operator>> (QDataStream &stream, Signature &sig) |
Member Enumeration Documentation
Constructor & Destructor Documentation
| Signature::Signature | ( | ) |
| Signature::Signature | ( | const QString & | text | ) |
| Signature::Signature | ( | const QString & | url, | |
| bool | isExecutable | |||
| ) |
Constructor for text from a file or from output of a command.
Definition at line 44 of file identity.cpp.
Member Function Documentation
| bool Signature::operator== | ( | const Signature & | other | ) | const |
| QString Signature::rawText | ( | bool * | ok = 0 |
) | const |
- Returns:
- the raw signature text as entered resp.
read from file.
Definition at line 61 of file identity.cpp.
| QString Signature::withSeparator | ( | bool * | ok = 0 |
) | const |
- Returns:
- the signature text with a "-- " separator added, if necessary.
Definition at line 136 of file identity.cpp.
| void KPIM::Signature::setText | ( | const QString & | text | ) | [inline] |
Set the signature text and mark this signature as being of "inline text" type.
Definition at line 62 of file identity.h.
| 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 159 of file identity.cpp.
| Type KPIM::Signature::type | ( | ) | const [inline] |
- Returns:
- the type of signature (ie. way to obtain the signature text)
Definition at line 71 of file identity.h.
The documentation for this class was generated from the following files:
