<?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::Field 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_1Field.html">Field</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-static-methods">Static Protected Member Functions</a> | <a href="classKABC_1_1Field-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">KABC::Field Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="field_8h_source.html">field.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:ac5b1866d86de7117cafbd07ca9cf6436"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436">FieldCategory</a> { <br/>   <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436a1a0eecc82040a2e6616ef3711e9411ea">All</a> = 0x0, <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436a3ee179ee423887541e59a388819896e4">Frequent</a> = 0x01, <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436addd0af3c0424d86cde282adf3c13e4bf">Address</a> = 0x02, <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436a42ddf6a2f43d50318158a140b479694f">Email</a> = 0x04, <br/>   <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436ace69d30d7bcde8ab313d2006f97308c2">Personal</a> = 0x08, <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436abd2b317cdedc6c12ceba5c035914c16c">Organization</a> = 0x10, <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436abaac0d1c8aeed345d2d7281fd5d2bb67">CustomCategory</a> = 0x20 <br/> }</td></tr> <tr class="separator:ac5b1866d86de7117cafbd07ca9cf6436"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a94165a536bad304ffd4f203deab2a465"><td class="memItemLeft" align="right" valign="top">typedef QList< <a class="el" href="classKABC_1_1Field.html">Field</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">List</a></td></tr> <tr class="separator:a94165a536bad304ffd4f203deab2a465"><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:a1d2be75bac199d1db813e4eb5df22dba"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba">category</a> ()</td></tr> <tr class="separator:a1d2be75bac199d1db813e4eb5df22dba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a29f5ed1ae2392796a80e84564b7c301b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a29f5ed1ae2392796a80e84564b7c301b">equals</a> (<a class="el" href="classKABC_1_1Field.html">Field</a> *field)</td></tr> <tr class="separator:a29f5ed1ae2392796a80e84564b7c301b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:accb2905a614773bcb2154ddc852e6c86"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#accb2905a614773bcb2154ddc852e6c86">isCustom</a> ()</td></tr> <tr class="separator:accb2905a614773bcb2154ddc852e6c86"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a89a18dcf1e903cebf8edbd9608dc8366"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a89a18dcf1e903cebf8edbd9608dc8366">label</a> ()</td></tr> <tr class="separator:a89a18dcf1e903cebf8edbd9608dc8366"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3219049a6cf0a1ef91aa73171050e605"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a3219049a6cf0a1ef91aa73171050e605">setValue</a> (KABC::Addressee &, const QString &)</td></tr> <tr class="separator:a3219049a6cf0a1ef91aa73171050e605"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a33a19283d7f5ab0696657bf13975e54d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a33a19283d7f5ab0696657bf13975e54d">sortKey</a> (const KABC::Addressee &)</td></tr> <tr class="separator:a33a19283d7f5ab0696657bf13975e54d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a085495eafe7e2a3cd5332b6c3fab3160"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a085495eafe7e2a3cd5332b6c3fab3160">value</a> (const KABC::Addressee &)</td></tr> <tr class="separator:a085495eafe7e2a3cd5332b6c3fab3160"><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:a6d2fe46d66d7858d6b5c5257af9f1bb0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a6d2fe46d66d7858d6b5c5257af9f1bb0">allFields</a> ()</td></tr> <tr class="separator:a6d2fe46d66d7858d6b5c5257af9f1bb0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8ca8c0ef2704ae9490804a15a4d28d11"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a8ca8c0ef2704ae9490804a15a4d28d11">categoryLabel</a> (int <a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba">category</a>)</td></tr> <tr class="separator:a8ca8c0ef2704ae9490804a15a4d28d11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adf6fca38ab0e16bc7dc0d234e1065e69"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1Field.html">Field</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#adf6fca38ab0e16bc7dc0d234e1065e69">createCustomField</a> (const QString &<a class="el" href="classKABC_1_1Field.html#a89a18dcf1e903cebf8edbd9608dc8366">label</a>, int <a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba">category</a>, const QString &key, const QString &app)</td></tr> <tr class="separator:adf6fca38ab0e16bc7dc0d234e1065e69"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a00ed11750eeb013d0f986ed4796be963"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a00ed11750eeb013d0f986ed4796be963">defaultFields</a> ()</td></tr> <tr class="separator:a00ed11750eeb013d0f986ed4796be963"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88a65aede9ef62e100efd980292270e2"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a88a65aede9ef62e100efd980292270e2">deleteFields</a> ()</td></tr> <tr class="separator:a88a65aede9ef62e100efd980292270e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83bbc1cabef364291ddfad3e2751747d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a83bbc1cabef364291ddfad3e2751747d">restoreFields</a> (const KConfigGroup &cfg, const QString &identifier)</td></tr> <tr class="separator:a83bbc1cabef364291ddfad3e2751747d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc6624b9072f2278c7c69a03dbcf1c84"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#afc6624b9072f2278c7c69a03dbcf1c84">restoreFields</a> (const QString &identifier)</td></tr> <tr class="separator:afc6624b9072f2278c7c69a03dbcf1c84"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1be7c56cb9665e25cfcdcff5f65777ad"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a1be7c56cb9665e25cfcdcff5f65777ad">saveFields</a> (KConfigGroup &cfg, const QString &identifier, const <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> &fields)</td></tr> <tr class="separator:a1be7c56cb9665e25cfcdcff5f65777ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4d57dc4ba725450a731a1c823dc3901"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#af4d57dc4ba725450a731a1c823dc3901">saveFields</a> (const QString &identifier, const <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> &fields)</td></tr> <tr class="separator:af4d57dc4ba725450a731a1c823dc3901"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a> Static Protected Member Functions</h2></td></tr> <tr class="memitem:a9bd9b198d390cea755ca10f98e522d56"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a9bd9b198d390cea755ca10f98e522d56">createDefaultField</a> (int id, int <a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba">category</a>=0)</td></tr> <tr class="separator:a9bd9b198d390cea755ca10f98e522d56"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a62e381a646e808afd26269f1a5bfe2da"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Field.html#a62e381a646e808afd26269f1a5bfe2da">createField</a> (int id, int <a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba">category</a>=0)</td></tr> <tr class="separator:a62e381a646e808afd26269f1a5bfe2da"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Represents a field in the Addressbook. </p> <p>This class represents a field in the Addressbook database. It provides methods for accessing meta-information about the field (such as <a class="el" href="classKABC_1_1Field.html#a89a18dcf1e903cebf8edbd9608dc8366" title="Returns the translated label for this field.">label()</a> or <a class="el" href="classKABC_1_1Field.html#a1d2be75bac199d1db813e4eb5df22dba" title="Returns the ored categories the field belongs to.">category()</a>) as well as getting or setting the field's value in an instance of Addressee (<a class="el" href="classKABC_1_1Field.html#a085495eafe7e2a3cd5332b6c3fab3160" title="Returns a string representation of the value the field has in the given Addressee.">value()</a>, <a class="el" href="classKABC_1_1Field.html#a3219049a6cf0a1ef91aa73171050e605" title="Sets the value of the field in the given Addressee.">setValue()</a>).</p> <p>Furthermore, some static methods are provided for getting a list of all fields (<a class="el" href="classKABC_1_1Field.html#a6d2fe46d66d7858d6b5c5257af9f1bb0" title="Returns a list of all fields.">allFields()</a>, <a class="el" href="classKABC_1_1Field.html#a00ed11750eeb013d0f986ed4796be963" title="Returns a list of the default fields.">defaultFields()</a>), for creating new fields (<a class="el" href="classKABC_1_1Field.html#adf6fca38ab0e16bc7dc0d234e1065e69" title="Creates a custom field.">createCustomField()</a>) and for saving or loading fields to/from a config file (<a class="el" href="classKABC_1_1Field.html#a1be7c56cb9665e25cfcdcff5f65777ad" title="Save the field settings to a config file.">saveFields()</a>, <a class="el" href="classKABC_1_1Field.html#a83bbc1cabef364291ddfad3e2751747d" title="Load the field settings from a config file.">restoreFields()</a>). </p> <p>Definition at line <a class="el" href="field_8h_source.html#l00046">46</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a94165a536bad304ffd4f203deab2a465"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef QList<<a class="el" href="classKABC_1_1Field.html">Field</a> *> <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">KABC::Field::List</a></td> </tr> </table> </div><div class="memdoc"> <p>This type is used for a list of fields. </p> <p>Definition at line <a class="el" href="field_8h_source.html#l00052">52</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p> </div> </div> <h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classKABC_1_1Field.html#ac5b1866d86de7117cafbd07ca9cf6436">KABC::Field::FieldCategory</a></td> </tr> </table> </div><div class="memdoc"> <p>Represents the category a field belongs to. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436a1a0eecc82040a2e6616ef3711e9411ea"></a>All</em> </td><td class="fielddoc"> <p>All fields. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436a3ee179ee423887541e59a388819896e4"></a>Frequent</em> </td><td class="fielddoc"> <p>Frequently used fields. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436addd0af3c0424d86cde282adf3c13e4bf"></a>Address</em> </td><td class="fielddoc"> <p>Fields which belong to the address, such as Street, City, Zip, etc. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436a42ddf6a2f43d50318158a140b479694f"></a>Email</em> </td><td class="fielddoc"> <p>Fields which store information about the e-mail contact, such as e-mail address or mail client. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436ace69d30d7bcde8ab313d2006f97308c2"></a>Personal</em> </td><td class="fielddoc"> <p>Personal fields, such as Birthday, Home <a class="el" href="classKABC_1_1Address.html" title="Postal address information.">Address</a> fields, IM <a class="el" href="classKABC_1_1Address.html" title="Postal address information.">Address</a>, etc. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436abd2b317cdedc6c12ceba5c035914c16c"></a>Organization</em> </td><td class="fielddoc"> <p>Fields about the organization, such as Business <a class="el" href="classKABC_1_1Address.html" title="Postal address information.">Address</a> fields, Department, Profession, etc. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="ac5b1866d86de7117cafbd07ca9cf6436abaac0d1c8aeed345d2d7281fd5d2bb67"></a>CustomCategory</em> </td><td class="fielddoc"> <p>Custom (user-defined) fields. </p> </td></tr> </table> <p>Definition at line <a class="el" href="field_8h_source.html#l00057">57</a> of file <a class="el" href="field_8h_source.html">field.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a6d2fe46d66d7858d6b5c5257af9f1bb0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> KABC::Field::allFields </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>Returns a list of all fields. </p> </div> </div> <a class="anchor" id="a1d2be75bac199d1db813e4eb5df22dba"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual int KABC::Field::category </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the ored categories the field belongs to. </p> </div> </div> <a class="anchor" id="a8ca8c0ef2704ae9490804a15a4d28d11"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static QString KABC::Field::categoryLabel </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>category</em></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>Returns the translated label for <code>category</code>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">category</td><td>the category of type FieldCategory </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the translated label </dd></dl> </div> </div> <a class="anchor" id="adf6fca38ab0e16bc7dc0d234e1065e69"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKABC_1_1Field.html">Field</a>* KABC::Field::createCustomField </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>label</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>category</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>app</em> </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>Creates a custom field. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">label</td><td>The label for this field </td></tr> <tr><td class="paramname">category</td><td>The category of this field </td></tr> <tr><td class="paramname">key</td><td>Unique key for this field </td></tr> <tr><td class="paramname">app</td><td>Unique app name for this field </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a9bd9b198d390cea755ca10f98e522d56"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static void KABC::Field::createDefaultField </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>category</em> = <code>0</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 class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a field and appends it to the list of default fields.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">id</td><td>The identifier for the field </td></tr> <tr><td class="paramname">category</td><td>The optional category for the field </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a62e381a646e808afd26269f1a5bfe2da"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static void KABC::Field::createField </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>category</em> = <code>0</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 class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a field and appends it to the general list of fields.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">id</td><td>The identifier for the field </td></tr> <tr><td class="paramname">category</td><td>The optional category for the field </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a00ed11750eeb013d0f986ed4796be963"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> KABC::Field::defaultFields </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>Returns a list of the default fields. </p> </div> </div> <a class="anchor" id="a88a65aede9ef62e100efd980292270e2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static void KABC::Field::deleteFields </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>Delete all fields from list. </p> </div> </div> <a class="anchor" id="a29f5ed1ae2392796a80e84564b7c301b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KABC::Field::equals </td> <td>(</td> <td class="paramtype"><a class="el" href="classKABC_1_1Field.html">Field</a> * </td> <td class="paramname"><em>field</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns, if the field is equal with <code>field</code>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">field</td><td>the field to compare this field to </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the fields are equal, <code>false</code> otherwise </dd></dl> </div> </div> <a class="anchor" id="accb2905a614773bcb2154ddc852e6c86"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KABC::Field::isCustom </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns, if the field is a user-defined field. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if this is a custom field, <code>false</code> otherwise </dd></dl> </div> </div> <a class="anchor" id="a89a18dcf1e903cebf8edbd9608dc8366"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual QString KABC::Field::label </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the translated label for this field. </p> </div> </div> <a class="anchor" id="a83bbc1cabef364291ddfad3e2751747d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> KABC::Field::restoreFields </td> <td>(</td> <td class="paramtype">const KConfigGroup & </td> <td class="paramname"><em>cfg</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>identifier</em> </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>Load the field settings from a config file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cfg</td><td>The config file object </td></tr> <tr><td class="paramname">identifier</td><td>The unique identifier </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="afc6624b9072f2278c7c69a03dbcf1c84"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> KABC::Field::restoreFields </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>identifier</em></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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Here, the list is loaded from KGlobal::config() from group "KABCFields". </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">identifier</td><td>The unique identifier </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a1be7c56cb9665e25cfcdcff5f65777ad"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static void KABC::Field::saveFields </td> <td>(</td> <td class="paramtype">KConfigGroup & </td> <td class="paramname"><em>cfg</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"><em>identifier</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> & </td> <td class="paramname"><em>fields</em> </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>Save the field settings to a config file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cfg</td><td>The config file object </td></tr> <tr><td class="paramname">identifier</td><td>The unique identifier </td></tr> <tr><td class="paramname">fields</td><td>The list of the fields </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af4d57dc4ba725450a731a1c823dc3901"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static void KABC::Field::saveFields </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>identifier</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classKABC_1_1Field.html#a94165a536bad304ffd4f203deab2a465">Field::List</a> & </td> <td class="paramname"><em>fields</em> </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>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Here, the list is stored in KGlobal::config() in group "KABCFields". </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">identifier</td><td>The unique identifier </td></tr> <tr><td class="paramname">fields</td><td>The list of the fields </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a3219049a6cf0a1ef91aa73171050e605"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool KABC::Field::setValue </td> <td>(</td> <td class="paramtype">KABC::Addressee & </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the value of the field in the given Addressee. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success or <code>false</code>, if the given string couldn't be converted to a valid value. </dd></dl> </div> </div> <a class="anchor" id="a33a19283d7f5ab0696657bf13975e54d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString KABC::Field::sortKey </td> <td>(</td> <td class="paramtype">const KABC::Addressee & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns a string, that can be used for sorting. </p> </div> </div> <a class="anchor" id="a085495eafe7e2a3cd5332b6c3fab3160"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual QString KABC::Field::value </td> <td>(</td> <td class="paramtype">const KABC::Addressee & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a string representation of the value the field has in the given Addressee. </p> <dl class="section return"><dt>Returns</dt><dd>the string representation of the value or QString(), if it is not possible to convert the value to a string. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="field_8h_source.html">field.h</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>