• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

kpimidentities

KPIMIdentities::Signature

KPIMIdentities::Signature Class Reference

#include <signature.h>

List of all members.


Detailed Description

abstraction of a signature (aka "footer").

Author:
Marc Mutz <mutz@kde.org>

Definition at line 53 of file signature.h.


Public Types

enum  Type { Disabled = 0, Inlined = 1, FromFile = 2, FromCommand = 3 }

Public Member Functions

bool isInlinedHtml () const
bool operator== (const Signature &other) const
QString rawText (bool *ok=0) const
void setInlinedHtml (bool isHtml)
void setText (const QString &text)
void setType (Type type)
void setUrl (const QString &url, bool isExecutable=false)
 Signature (const QString &url, bool isExecutable)
 Signature (const QString &text)
 Signature ()
QString text () const
Type type () const
QString url () const
QString withSeparator (bool *ok=0) const

Protected Member Functions

void readConfig (const KConfigGroup &config)
void writeConfig (KConfigGroup &config) const

Friends

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

Member Enumeration Documentation

enum KPIMIdentities::Signature::Type

Type of signature (ie.

way to obtain the signature text)

Definition at line 62 of file signature.h.


Constructor & Destructor Documentation

Signature::Signature (  ) 

Constructor for disabled signature.

Definition at line 36 of file signature.cpp.

Signature::Signature ( const QString &  text  ) 

Constructor for inline text.

Definition at line 41 of file signature.cpp.

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

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

Definition at line 47 of file signature.cpp.


Member Function Documentation

bool Signature::isInlinedHtml (  )  const

Returns:
boolean whether the inlined signature is html

Since:
4.1

Definition at line 174 of file signature.cpp.

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

Used for comparison.

Definition at line 248 of file signature.cpp.

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

Returns:
the raw signature text as entered resp.

read from file.

Definition at line 53 of file signature.cpp.

void Signature::setInlinedHtml ( bool  isHtml  ) 

Sets the inlined signature to text or html.

Parameters:
isHtml sets the inlined signature to html
Since:
4.1

Definition at line 169 of file signature.cpp.

void Signature::setText ( const QString &  text  ) 

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

Definition at line 285 of file signature.cpp.

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 163 of file signature.cpp.

Signature::Type Signature::type (  )  const

Returns:
the type of signature (ie. way to obtain the signature text)

Definition at line 278 of file signature.cpp.

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

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

A newline will not be appended or prepended.

Definition at line 141 of file signature.cpp.


The documentation for this class was generated from the following files:
  • signature.h
  • signature.cpp

kpimidentities

Skip menu "kpimidentities"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal