libkpimidentities

Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
KPIM::Signature Class Reference

#include <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 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 (TDEConfigBase *config) const
 
void readConfig (const TDEConfigBase *config)
 

Friends

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

Detailed Description

abstraction of a signature (aka "footer").

Author
Marc Mutz mutz@.nosp@m.kde..nosp@m.org

Definition at line 39 of file identity.h.

Member Enumeration Documentation

◆ Type

enum KPIM::Signature::Type

Type of signature (ie.

way to obtain the signature text)

Definition at line 47 of file identity.h.

Constructor & Destructor Documentation

◆ Signature() [1/3]

Signature::Signature ( )

Constructor for disabled signature.

Definition at line 30 of file identity.cpp.

◆ Signature() [2/3]

Signature::Signature ( const TQString &  text)

Constructor for inline text.

Definition at line 36 of file identity.cpp.

◆ Signature() [3/3]

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

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

Definition at line 43 of file identity.cpp.

Member Function Documentation

◆ operator==()

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

Used for comparison.

Definition at line 49 of file identity.cpp.

◆ rawText()

TQString Signature::rawText ( bool *  ok = 0) const
Returns
the raw signature text as entered resp. read from file.

Definition at line 60 of file identity.cpp.

◆ readConfig()

void Signature::readConfig ( const TDEConfigBase *  config)
protected

Definition at line 174 of file identity.cpp.

◆ setText()

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 68 of file identity.h.

◆ setType()

void KPIM::Signature::setType ( Type  type)
inline

Definition at line 78 of file identity.h.

◆ setUrl()

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 158 of file identity.cpp.

◆ text()

TQString KPIM::Signature::text ( ) const
inline

Definition at line 69 of file identity.h.

◆ type()

Type KPIM::Signature::type ( ) const
inline
Returns
the type of signature (ie. way to obtain the signature text)

Definition at line 77 of file identity.h.

◆ url()

TQString KPIM::Signature::url ( ) const
inline

Definition at line 74 of file identity.h.

◆ withSeparator()

TQString Signature::withSeparator ( bool *  ok = 0) const
Returns
the signature text with a "-- " separator added, if necessary.

Definition at line 135 of file identity.cpp.

◆ writeConfig()

void Signature::writeConfig ( TDEConfigBase *  config) const
protected

Definition at line 191 of file identity.cpp.

Friends And Related Function Documentation

◆ Identity

friend class Identity
friend

Definition at line 40 of file identity.h.

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