libkpimidentities

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 TQString &text)
 Signature (const TQString &url, bool isExecutable)
TQString rawText (bool *ok=0) const
TQString withSeparator (bool *ok=0) const
void setText (const TQString &text)
TQString text () const
void setUrl (const TQString &url, bool isExecutable=false)
TQString 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
TQDataStream & operator<< (TQDataStream &stream, const Signature &sig)
TQDataStream & operator>> (TQDataStream &stream, Signature &sig)

Detailed Description

abstraction of a signature (aka "footer").

Author:
Marc Mutz <mutz@kde.org>

Definition at line 33 of file identity.h.


Member Enumeration Documentation

Type of signature (ie.

way to obtain the signature text)

Definition at line 41 of file identity.h.


Constructor & Destructor Documentation

Signature::Signature (  ) 

Constructor for disabled signature.

Definition at line 31 of file identity.cpp.

Signature::Signature ( const TQString &  text  ) 

Constructor for inline text.

Definition at line 37 of file identity.cpp.

Signature::Signature ( const TQString &  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

Used for comparison.

Definition at line 50 of file identity.cpp.

TQString 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.

TQString 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 TQString &  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 TQString &  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: