<?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>KABC::AddresseeHelper 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>kabc</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>KABC</b></li><li class="navelem"><a class="el" href="classKABC_1_1AddresseeHelper.html">AddresseeHelper</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-slots">Public Slots</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classKABC_1_1AddresseeHelper-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">KABC::AddresseeHelper Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="addresseehelper_8h_source.html">addresseehelper.h</a>></code></p> <p>Inherits QObject.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a> Public Slots</h2></td></tr> <tr class="memitem:af6d32b66b7724ddcbc221b7de721d571"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#af6d32b66b7724ddcbc221b7de721d571">initSettings</a> ()</td></tr> <tr class="separator:af6d32b66b7724ddcbc221b7de721d571"><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:aa3a9a8745b9a9cd21c7f19447e2722da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#aa3a9a8745b9a9cd21c7f19447e2722da">containsPrefix</a> (const QString &prefix) const </td></tr> <tr class="separator:aa3a9a8745b9a9cd21c7f19447e2722da"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a983079016e01a4cd6bc9b527a9beef4e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#a983079016e01a4cd6bc9b527a9beef4e">containsSuffix</a> (const QString &suffix) const </td></tr> <tr class="separator:a983079016e01a4cd6bc9b527a9beef4e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa8eb3bcd1018acf96914c280a9600d68"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#aa8eb3bcd1018acf96914c280a9600d68">containsTitle</a> (const QString &title) const </td></tr> <tr class="separator:aa8eb3bcd1018acf96914c280a9600d68"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a9fe7a12b5fdc2b4a1cd3b0547d16b9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#a7a9fe7a12b5fdc2b4a1cd3b0547d16b9">tradeAsFamilyName</a> () const </td></tr> <tr class="separator:a7a9fe7a12b5fdc2b4a1cd3b0547d16b9"><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:a1022ba147ce81acd1b7affe0facf7994"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1AddresseeHelper.html">AddresseeHelper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1AddresseeHelper.html#a1022ba147ce81acd1b7affe0facf7994">self</a> ()</td></tr> <tr class="separator:a1022ba147ce81acd1b7affe0facf7994"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This singleton class stores static data, which is shared by all Addressee objects. </p> <p>It maintains three lists of strings, which can be queried using this class:</p> <ul> <li>a list of honoric prefixes, like "Mrs.", "Prof." etc, see <a class="el" href="classKABC_1_1AddresseeHelper.html#aa8eb3bcd1018acf96914c280a9600d68" title="Queries the list of honoric prefixes.">containsTitle()</a></li> <li>a list of inclusions, such as "van" or "de", see <a class="el" href="classKABC_1_1AddresseeHelper.html#aa3a9a8745b9a9cd21c7f19447e2722da" title="Queries the list of inclusions.">containsPrefix()</a></li> <li>a list of honoric suffixes, such as "I" or "Jr.", see <a class="el" href="classKABC_1_1AddresseeHelper.html#a983079016e01a4cd6bc9b527a9beef4e" title="Queries the list of honoric suffixes.">containsSuffix()</a></li> </ul> <p>All of these lists have a hardcoded and a configurable part. The configurable part is found in <code>kabcrc</code>, group <code>General</code>, fields <code>Prefixes</code>, <code>Inclusions</code>, and <code>Suffixes</code>.</p> <p>In addition to the above, this class stores one conveniece setting: it stores whether or not a single name component should be interpreted as a family name (see <a class="el" href="classKABC_1_1AddresseeHelper.html#a7a9fe7a12b5fdc2b4a1cd3b0547d16b9" title="Returns whether or not a single name component should be interpreted as a family name.">tradeAsFamilyName()</a>). The corresponding configuration field is <code>TradeAsFamilyName</code>. </p> <p>Definition at line <a class="el" href="addresseehelper_8h_source.html#l00054">54</a> of file <a class="el" href="addresseehelper_8h_source.html">addresseehelper.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aa3a9a8745b9a9cd21c7f19447e2722da"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool AddresseeHelper::containsPrefix </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>prefix</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Queries the list of inclusions. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">prefix</td><td>the inclusion to search for </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code>, if <code>prefix</code> was found in the list, <code>false</code> otherwise </dd></dl> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00103">103</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <a class="anchor" id="a983079016e01a4cd6bc9b527a9beef4e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool AddresseeHelper::containsSuffix </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>suffix</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Queries the list of honoric suffixes. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">suffix</td><td>the honoric suffix to search for </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code>, if <code>suffix</code> was found in the list, <code>false</code> otherwise </dd></dl> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00108">108</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <a class="anchor" id="aa8eb3bcd1018acf96914c280a9600d68"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool AddresseeHelper::containsTitle </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>title</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Queries the list of honoric prefixes. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">title</td><td>the honoric prefix to search for </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code>, if <code>title</code> was found in the list, <code>false</code> otherwise </dd></dl> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00098">98</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <a class="anchor" id="af6d32b66b7724ddcbc221b7de721d571"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void AddresseeHelper::initSettings </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">slot</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Recreates the static data and reparses the configuration. </p> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00066">66</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <a class="anchor" id="a1022ba147ce81acd1b7affe0facf7994"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKABC_1_1AddresseeHelper.html">AddresseeHelper</a> * AddresseeHelper::self </td> <td>(</td> <td class="paramname"></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>Singleton interface to this class. </p> <dl class="section return"><dt>Returns</dt><dd>a pointer to the unique instance of this class. </dd></dl> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00034">34</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <a class="anchor" id="a7a9fe7a12b5fdc2b4a1cd3b0547d16b9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool AddresseeHelper::tradeAsFamilyName </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns whether or not a single name component should be interpreted as a family name. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if single name component is a family name, <code>false</code> otherwise. </dd></dl> <p>Definition at line <a class="el" href="addresseehelper_8cpp_source.html#l00113">113</a> of file <a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="addresseehelper_8h_source.html">addresseehelper.h</a></li> <li><a class="el" href="addresseehelper_8cpp_source.html">addresseehelper.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:41 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">kabc</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kabc"</a> </div></div> <ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</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="classKABC_1_1Address.html">kabc::address</option>, <option value="classKABC_1_1AddressBook.html">kabc::addressbook</option>, <option value="classKABC_1_1AddressBook_1_1ConstIterator.html">kabc::addressbook::constiterator</option>, <option value="classKABC_1_1AddressBook_1_1Iterator.html">kabc::addressbook::iterator</option>, <option value="classKABC_1_1AddresseeDialog.html">kabc::addresseedialog</option>, <option value="classKABC_1_1AddresseeHelper.html">kabc::addresseehelper</option>, <option value="classKABC_1_1AddresseeItem.html">kabc::addresseeitem</option>, <option value="classKABC_1_1AddresseeList.html">kabc::addresseelist</option>, <option value="classKABC_1_1AddressLineEdit.html">kabc::addresslineedit</option>, <option value="classKABC_1_1BinaryFormat.html">kabc::binaryformat</option>, <option value="classKABC_1_1ConsoleErrorHandler.html">kabc::consoleerrorhandler</option>, <option value="classKABC_1_1ContactGroup.html">kabc::contactgroup</option>, <option value="classKABC_1_1ContactGroup_1_1ContactGroupReference.html">kabc::contactgroup::contactgroupreference</option>, <option value="classKABC_1_1ContactGroup_1_1ContactReference.html">kabc::contactgroup::contactreference</option>, <option value="classKABC_1_1ContactGroup_1_1Data.html">kabc::contactgroup::data</option>, <option value="classKABC_1_1DistributionList.html">kabc::distributionlist</option>, <option value="classKABC_1_1DistributionList_1_1Entry.html">kabc::distributionlist::entry</option>, <option value="classKABC_1_1DistributionListDialog.html">kabc::distributionlistdialog</option>, <option value="classKABC_1_1DistributionListEditorWidget.html">kabc::distributionlisteditorwidget</option>, <option value="classKABC_1_1EmailSelector.html">kabc::emailselector</option>, <option value="classKABC_1_1ErrorHandler.html">kabc::errorhandler</option>, <option value="classKABC_1_1Field.html">kabc::field</option>, <option value="classKABC_1_1FieldSortMode.html">kabc::fieldsortmode</option>, <option value="classKABC_1_1Format.html">kabc::format</option>, <option value="classKABC_1_1FormatFactory.html">kabc::formatfactory</option>, <option value="classKABC_1_1Geo.html">kabc::geo</option>, <option value="classKABC_1_1GuiErrorHandler.html">kabc::guierrorhandler</option>, <option value="classKABC_1_1Key.html">kabc::key</option>, <option value="classKABC_1_1Lock.html">kabc::lock</option>, <option value="classKABC_1_1LockNull.html">kabc::locknull</option>, <option value="classKABC_1_1NameSortMode.html">kabc::namesortmode</option>, <option value="classKABC_1_1PhoneNumber.html">kabc::phonenumber</option>, <option value="classKABC_1_1Picture.html">kabc::picture</option>, <option value="classKABC_1_1Plugin.html">kabc::plugin</option>, <option value="classKABC_1_1Resource.html">kabc::resource</option>, <option value="classKABC_1_1Resource_1_1ConstIterator.html">kabc::resource::constiterator</option>, <option value="classKABC_1_1ResourceABC.html">kabc::resourceabc</option>, <option value="classKABC_1_1ResourceDir.html">kabc::resourcedir</option>, <option value="classKABC_1_1ResourceFile.html">kabc::resourcefile</option>, <option value="classKABC_1_1ResourceNet.html">kabc::resourcenet</option>, <option value="classKABC_1_1SortMode.html">kabc::sortmode</option>, <option value="classKABC_1_1Sound.html">kabc::sound</option>, <option value="classKABC_1_1StdAddressBook.html">kabc::stdaddressbook</option>, <option value="classKABC_1_1Ticket.html">kabc::ticket</option>, <option value="classKABC_1_1TimeZone.html">kabc::timezone</option>, <option value="classKABC_1_1VCardConverter.html">kabc::vcardconverter</option>, <option value="classKABC_1_1VCardFormat.html">kabc::vcardformat</option>, <option value="classLdif.html">ldif</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>