<?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_US" xml:lang="en_US"> <head> <title>libkpimidentities: KPIM::Signature Class Reference (libkpimidentities)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <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" /> <link rel="shortcut icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> <style type="text/css"> <!-- hr { display: none; } #content h2 { margin-left: 0px; } table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; } td.mdRow { padding: 8px 20px; } td.md { font-weight: bold; } td.mdname1 { font-weight: bold; color: #602020; } td.mdname { font-weight: bold; color: #602020; } --> </style> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" /> <div id="nav_header_title" align="left">KDE PIM API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_left" style="text-align: left;"> / <a href="../../">API Reference</a> / <a href=".">libkpimidentities</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <h2><a name="content"></a>libkpimidentities</h2> <!-- Generated by Doxygen 1.5.5 --> <div class="navpath"><b>KPIM</b>::<a class="el" href="classKPIM_1_1Signature.html">Signature</a> </div> <div class="contents"> <h1>KPIM::Signature Class Reference</h1><!-- doxytag: class="KPIM::Signature" --><code>#include <<a class="el" href="identity_8h-source.html">identity.h</a>></code> <p> <p> <a href="classKPIM_1_1Signature-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> abstraction of a signature (aka "footer"). <p> <dl class="author" compact><dt><b>Author:</b></dt><dd>Marc Mutz <<a href="mailto:mutz@kde.org">mutz@kde.org</a>> </dd></dl> <p>Definition at line <a class="el" href="identity_8h-source.html#l00033">33</a> of file <a class="el" href="identity_8h-source.html">identity.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#1984c73ba38afeafc66da77001acd9c1">Type</a> { <b>Disabled</b> = 0, <b>Inlined</b> = 1, <b>FromFile</b> = 2, <b>FromCommand</b> = 3 }</td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#b2a41304854386275068721be1ad28a1">operator==</a> (const <a class="el" href="classKPIM_1_1Signature.html">Signature</a> &other) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#acfc092d01d1efd7008c027caaa9203c">Signature</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#ec6729193bcddf35888cc518e3d558c7">Signature</a> (const QString &text)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#b1fb7a4e20ec5803ed06c58c073296da">Signature</a> (const QString &url, bool isExecutable)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#b7873c0ac0b390786b1848b321809f60">rawText</a> (bool *ok=0) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#e585a4897b67ae6d7cfe0699a23320b7">withSeparator</a> (bool *ok=0) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#f38123e33540635e3e5a68121ab0161b">setText</a> (const QString &text)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef5c1aa63edf9d028eb68cf621a422c7"></a><!-- doxytag: member="KPIM::Signature::text" ref="ef5c1aa63edf9d028eb68cf621a422c7" args="() const " --> QString </td><td class="memItemRight" valign="bottom"><b>text</b> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#8d0af8f13cfba09fdef3c45c3c68a186">setUrl</a> (const QString &url, bool isExecutable=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39e7e734cee09b595d5e81aebe6e16b0"></a><!-- doxytag: member="KPIM::Signature::url" ref="39e7e734cee09b595d5e81aebe6e16b0" args="() const " --> QString </td><td class="memItemRight" valign="bottom"><b>url</b> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKPIM_1_1Signature.html#1984c73ba38afeafc66da77001acd9c1">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1Signature.html#8fc2ec4643840052c0bff99bd162e75c">type</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a7f92e77de0f2564602dead8e8e59b4"></a><!-- doxytag: member="KPIM::Signature::setType" ref="3a7f92e77de0f2564602dead8e8e59b4" args="(Type type)" --> void </td><td class="memItemRight" valign="bottom"><b>setType</b> (<a class="el" href="classKPIM_1_1Signature.html#1984c73ba38afeafc66da77001acd9c1">Type</a> type)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bceeb3ab0eded0d6de412d16305c6f35"></a><!-- doxytag: member="KPIM::Signature::writeConfig" ref="bceeb3ab0eded0d6de412d16305c6f35" args="(KConfigBase *config) const " --> void </td><td class="memItemRight" valign="bottom"><b>writeConfig</b> (KConfigBase *config) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e663b4330038a106486b3ffe67cfe7e"></a><!-- doxytag: member="KPIM::Signature::readConfig" ref="2e663b4330038a106486b3ffe67cfe7e" args="(const KConfigBase *config)" --> void </td><td class="memItemRight" valign="bottom"><b>readConfig</b> (const KConfigBase *config)</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0356b07ec7295ba08eb3f7364cce24c3"></a><!-- doxytag: member="KPIM::Signature::Identity" ref="0356b07ec7295ba08eb3f7364cce24c3" args="" --> class </td><td class="memItemRight" valign="bottom"><b>Identity</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12f00b9f84862c9c34d006a3ff791ecc"></a><!-- doxytag: member="KPIM::Signature::operator<<" ref="12f00b9f84862c9c34d006a3ff791ecc" args="(QDataStream &stream, const Signature &sig)" --> QDataStream & </td><td class="memItemRight" valign="bottom"><b>operator<<</b> (QDataStream &stream, const <a class="el" href="classKPIM_1_1Signature.html">Signature</a> &sig)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12d2934f172516a4f44b53a7d82f5ea3"></a><!-- doxytag: member="KPIM::Signature::operator>>" ref="12d2934f172516a4f44b53a7d82f5ea3" args="(QDataStream &stream, Signature &sig)" --> QDataStream & </td><td class="memItemRight" valign="bottom"><b>operator>></b> (QDataStream &stream, <a class="el" href="classKPIM_1_1Signature.html">Signature</a> &sig)</td></tr> </table> <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="1984c73ba38afeafc66da77001acd9c1"></a><!-- doxytag: member="KPIM::Signature::Type" ref="1984c73ba38afeafc66da77001acd9c1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classKPIM_1_1Signature.html#1984c73ba38afeafc66da77001acd9c1">KPIM::Signature::Type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Type of signature (ie. <p> way to obtain the signature text) <p>Definition at line <a class="el" href="identity_8h-source.html#l00041">41</a> of file <a class="el" href="identity_8h-source.html">identity.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="acfc092d01d1efd7008c027caaa9203c"></a><!-- doxytag: member="KPIM::Signature::Signature" ref="acfc092d01d1efd7008c027caaa9203c" args="()" --> <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 width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor for disabled signature. <p> <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00031">31</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="ec6729193bcddf35888cc518e3d558c7"></a><!-- doxytag: member="KPIM::Signature::Signature" ref="ec6729193bcddf35888cc518e3d558c7" args="(const QString &text)" --> <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 width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor for inline text. <p> <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00037">37</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="b1fb7a4e20ec5803ed06c58c073296da"></a><!-- doxytag: member="KPIM::Signature::Signature" ref="b1fb7a4e20ec5803ed06c58c073296da" args="(const QString &url, bool isExecutable)" --> <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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></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="identity_8cpp-source.html#l00044">44</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="b2a41304854386275068721be1ad28a1"></a><!-- doxytag: member="KPIM::Signature::operator==" ref="b2a41304854386275068721be1ad28a1" args="(const Signature &other) const " --> <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="classKPIM_1_1Signature.html">Signature</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Used for comparison. <p> <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00050">50</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="b7873c0ac0b390786b1848b321809f60"></a><!-- doxytag: member="KPIM::Signature::rawText" ref="b7873c0ac0b390786b1848b321809f60" args="(bool *ok=0) const " --> <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 width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the raw signature text as entered resp. read from file. </dd></dl> <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00061">61</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="e585a4897b67ae6d7cfe0699a23320b7"></a><!-- doxytag: member="KPIM::Signature::withSeparator" ref="e585a4897b67ae6d7cfe0699a23320b7" args="(bool *ok=0) const " --> <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 width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the signature text with a "-- " separator added, if necessary. </dd></dl> <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00136">136</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="f38123e33540635e3e5a68121ab0161b"></a><!-- doxytag: member="KPIM::Signature::setText" ref="f38123e33540635e3e5a68121ab0161b" args="(const QString &text)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPIM::Signature::setText </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>text</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></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="identity_8h-source.html#l00062">62</a> of file <a class="el" href="identity_8h-source.html">identity.h</a>.</p> </div> </div><p> <a class="anchor" name="8d0af8f13cfba09fdef3c45c3c68a186"></a><!-- doxytag: member="KPIM::Signature::setUrl" ref="8d0af8f13cfba09fdef3c45c3c68a186" args="(const QString &url, bool isExecutable=false)" --> <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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Set the signature URL and mark this signature as being of "from file" resp. <p> "from output of command" type. <p>Definition at line <a class="el" href="identity_8cpp-source.html#l00159">159</a> of file <a class="el" href="identity_8cpp-source.html">identity.cpp</a>.</p> </div> </div><p> <a class="anchor" name="8fc2ec4643840052c0bff99bd162e75c"></a><!-- doxytag: member="KPIM::Signature::type" ref="8fc2ec4643840052c0bff99bd162e75c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKPIM_1_1Signature.html#1984c73ba38afeafc66da77001acd9c1">Type</a> KPIM::Signature::type </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the type of signature (ie. way to obtain the signature text) </dd></dl> <p>Definition at line <a class="el" href="identity_8h-source.html#l00071">71</a> of file <a class="el" href="identity_8h-source.html">identity.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="identity_8h-source.html">identity.h</a><li><a class="el" href="identity_8cpp-source.html">identity.cpp</a></ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>libkpimidentities</h2> <div class="nav_list"> <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="files.html">File List</a></li><li><a href="functions.html">Class Members</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="classKPIM_1_1Identity.html">kpim::identity</option>, <option value="classKPIM_1_1IdentityCombo.html">kpim::identitycombo</option>, <option value="classKPIM_1_1Signature.html">kpim::signature</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>