<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KPIMIdentities::Signature Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>kpimidentities</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KPIMIdentities</b></li><li class="navelem"><a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classKPIMIdentities_1_1Signature-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KPIMIdentities::Signature Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="signature_8h_source.html">signature.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a1a9735e6c2389722487e1125de4a864b"><td class="memItemLeft" align="right" valign="top">typedef QFlags< <a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dc">AddedTextFlag</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">AddedText</a></td></tr>
<tr class="separator:a1a9735e6c2389722487e1125de4a864b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6af6534fed2d2f9e0093ce2450a583dc"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dc">AddedTextFlag</a> { <a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dca783e0007250bb1d97a3a729cab149c18">AddNothing</a> = 0,
<a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dca774248dee027be773192269ac20ef4d6">AddSeparator</a> = 1 << 0,
<a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dca4dcbcb3909e66c475f3cf85bcd43df8c">AddNewLines</a> = 1 << 1
}</td></tr>
<tr class="separator:a6af6534fed2d2f9e0093ce2450a583dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c14d029727922cb9e04fda762df2a92"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> { <a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92aade1e668fc10250149ef8883d66e27d9">Start</a>,
<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f">End</a>,
<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92aa50324bd43ef307452efc25b5684ecaf">AtCursor</a>
}</td></tr>
<tr class="separator:a4c14d029727922cb9e04fda762df2a92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af44755883e6bf7a2e83a8781837a5e3d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#af44755883e6bf7a2e83a8781837a5e3d">Type</a> { <b>Disabled</b> = 0,
<b>Inlined</b> = 1,
<b>FromFile</b> = 2,
<b>FromCommand</b> = 3
}</td></tr>
<tr class="separator:af44755883e6bf7a2e83a8781837a5e3d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aacfc092d01d1efd7008c027caaa9203c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#aacfc092d01d1efd7008c027caaa9203c">Signature</a> ()</td></tr>
<tr class="separator:aacfc092d01d1efd7008c027caaa9203c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec6729193bcddf35888cc518e3d558c7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#aec6729193bcddf35888cc518e3d558c7">Signature</a> (const QString &text)</td></tr>
<tr class="separator:aec6729193bcddf35888cc518e3d558c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1fb7a4e20ec5803ed06c58c073296da"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ab1fb7a4e20ec5803ed06c58c073296da">Signature</a> (const QString &url, bool isExecutable)</td></tr>
<tr class="separator:ab1fb7a4e20ec5803ed06c58c073296da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a883dfc84dd3bc0273922a5efb5914b86"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a883dfc84dd3bc0273922a5efb5914b86">Signature</a> (const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> &that)</td></tr>
<tr class="separator:a883dfc84dd3bc0273922a5efb5914b86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0bb12039b385e4600dddc7d703f52fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ad0bb12039b385e4600dddc7d703f52fb">~Signature</a> ()</td></tr>
<tr class="separator:ad0bb12039b385e4600dddc7d703f52fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adda197641ba5edcf8ced10cfed16bddd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#adda197641ba5edcf8ced10cfed16bddd">addImage</a> (const QImage &image, const QString &imageName)</td></tr>
<tr class="separator:adda197641ba5edcf8ced10cfed16bddd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4562099cff4c874c3810d7ffbb347a1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4562099cff4c874c3810d7ffbb347a1c">insertIntoTextEdit</a> (KRichTextEdit *textEdit, <a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> placement=<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f">End</a>, bool addSeparator=true)</td></tr>
<tr class="separator:a4562099cff4c874c3810d7ffbb347a1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeff8cb59ccf13e179161f4ef697c2625"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#aeff8cb59ccf13e179161f4ef697c2625">insertIntoTextEdit</a> (<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> placement, <a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">AddedText</a> addedText, KPIMTextEdit::TextEdit *textEdit) const </td></tr>
<tr class="separator:aeff8cb59ccf13e179161f4ef697c2625"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba67e8e05f5564e8d37205c17e184d39"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#aba67e8e05f5564e8d37205c17e184d39">insertIntoTextEdit</a> (<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> placement, <a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">AddedText</a> addedText, KPIMTextEdit::TextEdit *textEdit, bool forceDisplay) const </td></tr>
<tr class="separator:aba67e8e05f5564e8d37205c17e184d39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0464c22bb8168da3de2b67e260edfeb4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0464c22bb8168da3de2b67e260edfeb4"></a>
bool </td><td class="memItemRight" valign="bottom"><b>isEnabledSignature</b> () const </td></tr>
<tr class="separator:a0464c22bb8168da3de2b67e260edfeb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa006ce4d12874f5f636e8088ebe8fdce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#aa006ce4d12874f5f636e8088ebe8fdce">isInlinedHtml</a> () const </td></tr>
<tr class="separator:aa006ce4d12874f5f636e8088ebe8fdce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af57888b275d5c0f2243fa8480cb44766"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#af57888b275d5c0f2243fa8480cb44766">operator=</a> (const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> &that)</td></tr>
<tr class="separator:af57888b275d5c0f2243fa8480cb44766"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2a41304854386275068721be1ad28a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ab2a41304854386275068721be1ad28a1">operator==</a> (const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> &other) const </td></tr>
<tr class="separator:ab2a41304854386275068721be1ad28a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7873c0ac0b390786b1848b321809f60"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ab7873c0ac0b390786b1848b321809f60">rawText</a> (bool *ok=0) const </td></tr>
<tr class="separator:ab7873c0ac0b390786b1848b321809f60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6f6752e3fc48a5605097dc16bb2a577"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ac6f6752e3fc48a5605097dc16bb2a577">setEnabledSignature</a> (bool enabled)</td></tr>
<tr class="separator:ac6f6752e3fc48a5605097dc16bb2a577"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d6931f0ca1c7971ce98fd24b7c43566"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a5d6931f0ca1c7971ce98fd24b7c43566">setImageLocation</a> (const QString &path)</td></tr>
<tr class="separator:a5d6931f0ca1c7971ce98fd24b7c43566"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a877d783cd163896967d719e9ec032a63"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a877d783cd163896967d719e9ec032a63">setInlinedHtml</a> (bool isHtml)</td></tr>
<tr class="separator:a877d783cd163896967d719e9ec032a63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a458e10da55aa44b89a1feb8249761d7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a458e10da55aa44b89a1feb8249761d7b">setText</a> (const QString &text)</td></tr>
<tr class="separator:a458e10da55aa44b89a1feb8249761d7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7aa7a977b9e0a9652b9325bd4674f811"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7aa7a977b9e0a9652b9325bd4674f811"></a>
void </td><td class="memItemRight" valign="bottom"><b>setType</b> (<a class="el" href="classKPIMIdentities_1_1Signature.html#af44755883e6bf7a2e83a8781837a5e3d">Type</a> <a class="el" href="classKPIMIdentities_1_1Signature.html#afbaa0879bfe2b9cdabfc3f5f6e54700b">type</a>)</td></tr>
<tr class="separator:a7aa7a977b9e0a9652b9325bd4674f811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d0af8f13cfba09fdef3c45c3c68a186"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a8d0af8f13cfba09fdef3c45c3c68a186">setUrl</a> (const QString &url, bool isExecutable=false)</td></tr>
<tr class="separator:a8d0af8f13cfba09fdef3c45c3c68a186"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae019a933f4c2a614c659440465cc4e0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae019a933f4c2a614c659440465cc4e0a"></a>
QString </td><td class="memItemRight" valign="bottom"><b>text</b> () const </td></tr>
<tr class="separator:ae019a933f4c2a614c659440465cc4e0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a122d809ce8a176476ab0ca47a4b7ed38"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a122d809ce8a176476ab0ca47a4b7ed38">toPlainText</a> () const </td></tr>
<tr class="separator:a122d809ce8a176476ab0ca47a4b7ed38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbaa0879bfe2b9cdabfc3f5f6e54700b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKPIMIdentities_1_1Signature.html#af44755883e6bf7a2e83a8781837a5e3d">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#afbaa0879bfe2b9cdabfc3f5f6e54700b">type</a> () const </td></tr>
<tr class="separator:afbaa0879bfe2b9cdabfc3f5f6e54700b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace42c58bf1e611b0d5a56eff7f7fe7d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace42c58bf1e611b0d5a56eff7f7fe7d6"></a>
QString </td><td class="memItemRight" valign="bottom"><b>url</b> () const </td></tr>
<tr class="separator:ace42c58bf1e611b0d5a56eff7f7fe7d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae585a4897b67ae6d7cfe0699a23320b7"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#ae585a4897b67ae6d7cfe0699a23320b7">withSeparator</a> (bool *ok=0) const </td></tr>
<tr class="separator:ae585a4897b67ae6d7cfe0699a23320b7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5da722385b56a7a9d67568585eebd998"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIMIdentities_1_1Signature.html#a5da722385b56a7a9d67568585eebd998">insertPlainSignatureIntoTextEdit</a> (const QString &signature, KRichTextEdit *textEdit, <a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> placement=<a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f">End</a>, bool isHtml=false)</td></tr>
<tr class="separator:a5da722385b56a7a9d67568585eebd998"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aebb6aa0b1b0175fd62345105cf9fe9e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebb6aa0b1b0175fd62345105cf9fe9e4"></a>
void </td><td class="memItemRight" valign="bottom"><b>readConfig</b> (const KConfigGroup &config)</td></tr>
<tr class="separator:aebb6aa0b1b0175fd62345105cf9fe9e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad004c9e95a0215d6c01cc873385738b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad004c9e95a0215d6c01cc873385738b"></a>
void </td><td class="memItemRight" valign="bottom"><b>writeConfig</b> (KConfigGroup &config) const </td></tr>
<tr class="separator:aad004c9e95a0215d6c01cc873385738b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a5f30347f22ea7f06aedcf5bad769f884"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f30347f22ea7f06aedcf5bad769f884"></a>
KPIMIDENTITIES_EXPORT QDataStream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (QDataStream &stream, const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> &sig)</td></tr>
<tr class="separator:a5f30347f22ea7f06aedcf5bad769f884"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54a5e08e5e137ed302ec73742b403029"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54a5e08e5e137ed302ec73742b403029"></a>
KPIMIDENTITIES_EXPORT QDataStream & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (QDataStream &stream, <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> &sig)</td></tr>
<tr class="separator:a54a5e08e5e137ed302ec73742b403029"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstraction of a signature (aka "footer"). </p>
<p>The signature can either be plain text, HTML text, text returned from a command or text stored in a file.</p>
<p>In case of HTML text, the signature can contain images. Since you set the HTML source with <a class="el" href="classKPIMIdentities_1_1Signature.html#a458e10da55aa44b89a1feb8249761d7b" title="Set the signature text and mark this signature as being of "inline text" type.">setText()</a>, there also needs to be a way to add the images to the signature, as the HTML source contains only the img tags that reference those images. To add the image to the signature, call <a class="el" href="classKPIMIdentities_1_1Signature.html#adda197641ba5edcf8ced10cfed16bddd" title="Adds the given image to the signature.">addImage()</a>. The name given there must match the name of the img tag in the HTML source.</p>
<p>The images need to be stored somewhere. The <a class="el" href="classKPIMIdentities_1_1Signature.html" title="Abstraction of a signature (aka "footer").">Signature</a> class handles that by storing all images in a directory. You must set that directory with <a class="el" href="classKPIMIdentities_1_1Signature.html#a5d6931f0ca1c7971ce98fd24b7c43566" title="Sets the location where the copies of the signature images will be stored.">setImageLocation()</a>, before calling <a class="el" href="classKPIMIdentities_1_1Signature.html#adda197641ba5edcf8ced10cfed16bddd" title="Adds the given image to the signature.">addImage()</a>. The images added with <a class="el" href="classKPIMIdentities_1_1Signature.html#adda197641ba5edcf8ced10cfed16bddd" title="Adds the given image to the signature.">addImage()</a> are then saved to that directory when calling writeConfig(). When loading a signature, readConfig() automatically loads the images as well. To actually add the images to a text edit, call <a class="el" href="classKPIMIdentities_1_1Signature.html#a4562099cff4c874c3810d7ffbb347a1c">insertIntoTextEdit()</a>.</p>
<p>Example of creating a HTML signature and then inserting it into a text edit: </p>
<div class="fragment"><div class="line"><a class="code" href="classKPIMIdentities_1_1Signature.html#aacfc092d01d1efd7008c027caaa9203c" title="Constructor for disabled signature.">Signature</a> htmlSig;</div>
<div class="line">htmlSig.setText( <span class="stringliteral">"<img src=\"hello.png\"> World"</span> );</div>
<div class="line">htmlSig.setInlinedHtml( <span class="keyword">true</span> );</div>
<div class="line">htmlSig.setImageLocation( KStandardDirs::locateLocal( <span class="stringliteral">"data"</span>, <span class="stringliteral">"emailidentities/example/"</span> );</div>
<div class="line">QImage image = ...;</div>
<div class="line">htmlSig.addImage( image, <span class="stringliteral">"hello.png"</span> );</div>
<div class="line">...</div>
<div class="line">KTextEdit edit;</div>
<div class="line">htmlSig.insertIntoTextEdit( <a class="code" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f" title="The signature is placed at the end of the textedit.">KPIMIdentities::Signature::End</a>,</div>
<div class="line"> <a class="code" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dca774248dee027be773192269ac20ef4d6" title="The separator '– ' will be added in front of the signature.">KPIMIdentities::Signature::AddSeparator</a>, &edit );</div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="signature_8h_source.html#l00089">89</a> of file <a class="el" href="signature_8h_source.html">signature.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a1a9735e6c2389722487e1125de4a864b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef QFlags<<a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dc">AddedTextFlag</a>> <a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">KPIMIdentities::Signature::AddedText</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes which additional parts should be added to the signature. </p>
<p>Definition at line <a class="el" href="signature_8h_source.html#l00228">228</a> of file <a class="el" href="signature_8h_source.html">signature.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a6af6534fed2d2f9e0093ce2450a583dc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKPIMIdentities_1_1Signature.html#a6af6534fed2d2f9e0093ce2450a583dc">KPIMIdentities::Signature::AddedTextFlag</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a6af6534fed2d2f9e0093ce2450a583dca783e0007250bb1d97a3a729cab149c18"></a>AddNothing</em> </td><td class="fielddoc">
<p>Don't add any text to the signature. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a6af6534fed2d2f9e0093ce2450a583dca774248dee027be773192269ac20ef4d6"></a>AddSeparator</em> </td><td class="fielddoc">
<p>The separator '– <br/>
' will be added in front of the signature. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a6af6534fed2d2f9e0093ce2450a583dca4dcbcb3909e66c475f3cf85bcd43df8c"></a>AddNewLines</em> </td><td class="fielddoc">
<p>Add a newline character in front or after the signature, depending on the placement. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="signature_8h_source.html#l00219">219</a> of file <a class="el" href="signature_8h_source.html">signature.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4c14d029727922cb9e04fda762df2a92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">KPIMIdentities::Signature::Placement</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes the placement of the signature text when it is to be inserted into a text edit. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a4c14d029727922cb9e04fda762df2a92aade1e668fc10250149ef8883d66e27d9"></a>Start</em> </td><td class="fielddoc">
<p>The signature is placed at the start of the textedit. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f"></a>End</em> </td><td class="fielddoc">
<p>The signature is placed at the end of the textedit. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a4c14d029727922cb9e04fda762df2a92aa50324bd43ef307452efc25b5684ecaf"></a>AtCursor</em> </td><td class="fielddoc">
<p>The signature is placed at the current cursor position. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="signature_8h_source.html#l00109">109</a> of file <a class="el" href="signature_8h_source.html">signature.h</a>.</p>
</div>
</div>
<a class="anchor" id="af44755883e6bf7a2e83a8781837a5e3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKPIMIdentities_1_1Signature.html#af44755883e6bf7a2e83a8781837a5e3d">KPIMIdentities::Signature::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of signature (ie. </p>
<p>way to obtain the signature text) </p>
<p>Definition at line <a class="el" href="signature_8h_source.html#l00098">98</a> of file <a class="el" href="signature_8h_source.html">signature.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aacfc092d01d1efd7008c027caaa9203c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Signature::Signature </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for disabled signature. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00099">99</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aec6729193bcddf35888cc518e3d558c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Signature::Signature </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for inline text. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00104">104</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab1fb7a4e20ec5803ed06c58c073296da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Signature::Signature </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isExecutable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for text from a file or from output of a command. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00110">110</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a883dfc84dd3bc0273922a5efb5914b86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Signature::Signature </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> & </td>
<td class="paramname"><em>that</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00127">127</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad0bb12039b385e4600dddc7d703f52fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Signature::~Signature </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00142">142</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adda197641ba5edcf8ced10cfed16bddd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::addImage </td>
<td>(</td>
<td class="paramtype">const QImage & </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>imageName</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the given image to the signature. </p>
<p>This is needed if you use <a class="el" href="classKPIMIdentities_1_1Signature.html#a458e10da55aa44b89a1feb8249761d7b" title="Set the signature text and mark this signature as being of "inline text" type.">setText()</a> to set some HTML source that references images. Those referenced images needed to be added by calling this function. The has to match the src attribute of the img tag.</p>
<p>If you use <a class="el" href="classKPIMIdentities_1_1SignatureConfigurator.html" title="This widget gives an interface so users can edit their signature.">SignatureConfigurator</a>, you don't need to call this function, as the configurator will handle this for you. <a class="el" href="classKPIMIdentities_1_1Signature.html#a5d6931f0ca1c7971ce98fd24b7c43566" title="Sets the location where the copies of the signature images will be stored.">setImageLocation()</a> needs to be called once before. </p>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00632">632</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4562099cff4c874c3810d7ffbb347a1c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::insertIntoTextEdit </td>
<td>(</td>
<td class="paramtype">KRichTextEdit * </td>
<td class="paramname"><em>textEdit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> </td>
<td class="paramname"><em>placement</em> = <code><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f">End</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>addSeparator</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section since"><dt>Since</dt><dd>4.3 </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Use the other overload of <a class="el" href="classKPIMIdentities_1_1Signature.html#a4562099cff4c874c3810d7ffbb347a1c">insertIntoTextEdit()</a> instead. This one doesn't support inline images and always adds newline characters. </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00506">506</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeff8cb59ccf13e179161f4ef697c2625"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::insertIntoTextEdit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> </td>
<td class="paramname"><em>placement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">AddedText</a> </td>
<td class="paramname"><em>addedText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KPIMTextEdit::TextEdit * </td>
<td class="paramname"><em>textEdit</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts this signature into the given text edit. </p>
<p>The cursor position is preserved. For undo/redo, this is treated as one operation.</p>
<p>Rich text mode of the text edit will be enabled if the signature is in inlined HTML format.</p>
<p>If this signature uses images, they will be added automatically.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">placement</td><td>defines where in the text edit the signature should be inserted. </td></tr>
<tr><td class="paramname">addedText</td><td>defines which other texts should be added to the signature </td></tr>
<tr><td class="paramname">textEdit</td><td>the signature will be inserted into this text edit.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00524">524</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aba67e8e05f5564e8d37205c17e184d39"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::insertIntoTextEdit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Placement</a> </td>
<td class="paramname"><em>placement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a1a9735e6c2389722487e1125de4a864b">AddedText</a> </td>
<td class="paramname"><em>addedText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KPIMTextEdit::TextEdit * </td>
<td class="paramname"><em>textEdit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forceDisplay</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section since"><dt>Since</dt><dd>4.9 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00530">530</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5da722385b56a7a9d67568585eebd998"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Signature::insertPlainSignatureIntoTextEdit </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KRichTextEdit * </td>
<td class="paramname"><em>textEdit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92">Signature::Placement</a> </td>
<td class="paramname"><em>placement</em> = <code><a class="el" href="classKPIMIdentities_1_1Signature.html#a4c14d029727922cb9e04fda762df2a92a0ffd414dd986f244c5ff9aa259db864f">End</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isHtml</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts this given signature into the given text edit. </p>
<p>The cursor position is preserved. A leading or trailing newline is also added automatically, depending on the placement. For undo/redo, this is treated as one operation. A separator is not added.</p>
<p>Use the <a class="el" href="classKPIMIdentities_1_1Signature.html#a4562099cff4c874c3810d7ffbb347a1c">insertIntoTextEdit()</a> function if possible, as it has support for separators and does HTML detection automatically.</p>
<p>Rich text mode of the text edit will be enabled if <code>isHtml</code> is true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signature</td><td>the signature, either as plain text or as HTML </td></tr>
<tr><td class="paramname">textEdit</td><td>the text edit to insert the signature into </td></tr>
<tr><td class="paramname">placement</td><td>defines where in the textedit the signature should be inserted. </td></tr>
<tr><td class="paramname">isHtml</td><td>defines whether the signature should be inserted as text or html</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.3 </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Use the non-static <a class="el" href="classKPIMIdentities_1_1Signature.html#a4562099cff4c874c3810d7ffbb347a1c">insertIntoTextEdit()</a> instead </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00563">563</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa006ce4d12874f5f636e8088ebe8fdce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Signature::isInlinedHtml </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>boolean whether the inlined signature is html </dd></dl>
<dl class="section since"><dt>Since</dt><dd>4.1 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00273">273</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af57888b275d5c0f2243fa8480cb44766"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> & Signature::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> & </td>
<td class="paramname"><em>that</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00132">132</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab2a41304854386275068721be1ad28a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Signature::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKPIMIdentities_1_1Signature.html">Signature</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Used for comparison. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00587">587</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab7873c0ac0b390786b1848b321809f60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Signature::rawText </td>
<td>(</td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>ok</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the raw signature text as entered resp. read from file. </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00147">147</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac6f6752e3fc48a5605097dc16bb2a577"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::setEnabledSignature </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>setEnabledSignature </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enabled</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.9 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00677">677</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5d6931f0ca1c7971ce98fd24b7c43566"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::setImageLocation </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the location where the copies of the signature images will be stored. </p>
<p>The images will be stored there when calling writeConfig(). The image location is stored in the config, so the next readConfig() call knows where to look for images. It is recommended to use KStandardDirs::locateLocal( "data", "emailidentities/%1" ) for the location, where %1 is the unique identifier of the identity.</p>
<dl class="section warning"><dt>Warning</dt><dd>readConfig will delete all other PNG files in this directory, as they could be stale inline image files</dd></dl>
<p>Like with <a class="el" href="classKPIMIdentities_1_1Signature.html#adda197641ba5edcf8ced10cfed16bddd" title="Adds the given image to the signature.">addImage()</a>, the <a class="el" href="classKPIMIdentities_1_1SignatureConfigurator.html" title="This widget gives an interface so users can edit their signature.">SignatureConfigurator</a> will handle this for you.</p>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00641">641</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a877d783cd163896967d719e9ec032a63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::setInlinedHtml </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isHtml</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the inlined signature to text or html. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">isHtml</td><td>sets the inlined signature to html </td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>4.1 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00268">268</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a458e10da55aa44b89a1feb8249761d7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::setText </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the signature text and mark this signature as being of "inline text" type. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00665">665</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8d0af8f13cfba09fdef3c45c3c68a186"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Signature::setUrl </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isExecutable</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the signature URL and mark this signature as being of "from file" resp. </p>
<p>"from output of command" type. </p>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00262">262</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a122d809ce8a176476ab0ca47a4b7ed38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Signature::toPlainText </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the text of the signature. </p>
<p>If the signature is HTML, the HTML tags will be stripped. </p>
<dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00618">618</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afbaa0879bfe2b9cdabfc3f5f6e54700b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPIMIdentities_1_1Signature.html#af44755883e6bf7a2e83a8781837a5e3d">Signature::Type</a> Signature::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the type of signature (ie. way to obtain the signature text) </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00658">658</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae585a4897b67ae6d7cfe0699a23320b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Signature::withSeparator </td>
<td>(</td>
<td class="paramtype">bool * </td>
<td class="paramname"><em>ok</em> = <code>0</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the signature text with a "&ndash; \n" separator added, if necessary. A newline will not be appended or prepended. </dd></dl>
<p>Definition at line <a class="el" href="signature_8cpp_source.html#l00235">235</a> of file <a class="el" href="signature_8cpp_source.html">signature.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="signature_8h_source.html">signature.h</a></li>
<li><a class="el" href="signature_8cpp_source.html">signature.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:49:49 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kpimidentities</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kpimidentities"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKPIMIdentities_1_1Identity.html">kpimidentities::identity</option>, <option value="classKPIMIdentities_1_1IdentityManager.html">kpimidentities::identitymanager</option>, <option value="classKPIMIdentities_1_1Signature.html">kpimidentities::signature</option>, <option value="classKPIMIdentities_1_1SignatureConfigurator.html">kpimidentities::signatureconfigurator</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
