Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 686

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactdetails.cpp -->
  <title>Qt Mobility 1.2: QContactAnniversary Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcontacts.html">QtContacts</a></li>
<li>QContactAnniversary</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactAnniversary Class Reference</h1>
<!-- $$$QContactAnniversary-brief -->
<p>The QContactAnniversary class contains an anniversary of a contact. <a href="#details">More...</a></p>
<!-- @@@QContactAnniversary -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContactAnniversary&gt;</span></pre><p><b>Inherits: </b><a href="qcontactdetail.html">QContactDetail</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactanniversary-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#calendarId">calendarId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#event">event</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDate </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#originalDate">originalDate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#originalDateTime">originalDateTime</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#setCalendarId">setCalendarId</a></b> ( const QString &amp; <i>calendarId</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#setEvent">setEvent</a></b> ( const QString &amp; <i>event</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#setOriginalDate">setOriginalDate</a></b> ( const QDate &amp; <i>date</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#setOriginalDateTime">setOriginalDateTime</a></b> ( const QDateTime &amp; <i>dateTime</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#setSubType">setSubType</a></b> ( const QString &amp; <i>subType</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#subType">subType</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qcontactdetail.html#public-functions">QContactDetail</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#DefinitionName-var">DefinitionName</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#FieldCalendarId-var">FieldCalendarId</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#FieldEvent-var">FieldEvent</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#FieldOriginalDate-var">FieldOriginalDate</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#FieldSubType-var">FieldSubType</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#SubTypeEmployment-var">SubTypeEmployment</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#SubTypeEngagement-var">SubTypeEngagement</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#SubTypeMemorial-var">SubTypeMemorial</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactanniversary.html#SubTypeWedding-var">SubTypeWedding</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QContactAnniversary-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactAnniversary class contains an anniversary of a contact.</p>
<p>This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project.</p>
</div>
<!-- @@@QContactAnniversary -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$calendarId[overload1]$$$calendarId -->
<h3 class="fn"><a name="calendarId"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactAnniversary::<span class="name">calendarId</span> () const</h3>
<p>* Returns the identifier of the calendar entry associated with this anniversary. *</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#setCalendarId">setCalendarId</a>().</p>
<!-- @@@calendarId -->
<!-- $$$event[overload1]$$$event -->
<h3 class="fn"><a name="event"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactAnniversary::<span class="name">event</span> () const</h3>
<p>Returns the name of the event for which this detail contains information.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#setEvent">setEvent</a>().</p>
<!-- @@@event -->
<!-- $$$originalDate[overload1]$$$originalDate -->
<h3 class="fn"><a name="originalDate"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdate.html">QDate</a></span> QContactAnniversary::<span class="name">originalDate</span> () const</h3>
<p>Returns the original date of the event stored in this detail. If the original event occurrence stored is a <a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a>, this returns the date portion.</p>
<p><b>See also </b><a href="qcontactanniversary.html#setOriginalDate">setOriginalDate</a>().</p>
<!-- @@@originalDate -->
<!-- $$$originalDateTime[overload1]$$$originalDateTime -->
<h3 class="fn"><a name="originalDateTime"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> QContactAnniversary::<span class="name">originalDateTime</span> () const</h3>
<p>Returns the original date and time of the event stored in this detail. If the original event occurrence stored is a <a href="http://qt.nokia.com/doc/4.7/qdate.html">QDate</a>, this returns a <a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a> with the time set to midnight.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#setOriginalDateTime">setOriginalDateTime</a>().</p>
<!-- @@@originalDateTime -->
<!-- $$$setCalendarId[overload1]$$$setCalendarIdconstQString& -->
<h3 class="fn"><a name="setCalendarId"></a><span class="type">void</span> QContactAnniversary::<span class="name">setCalendarId</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>calendarId</i> )</h3>
<p>Sets the identifier of the calendar entry associated with this anniversary to <i>calendarId</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#calendarId">calendarId</a>().</p>
<!-- @@@setCalendarId -->
<!-- $$$setEvent[overload1]$$$setEventconstQString& -->
<h3 class="fn"><a name="setEvent"></a><span class="type">void</span> QContactAnniversary::<span class="name">setEvent</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>event</i> )</h3>
<p>Sets the name of the event for which this detail contains information to <i>event</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#event">event</a>().</p>
<!-- @@@setEvent -->
<!-- $$$setOriginalDate[overload1]$$$setOriginalDateconstQDate& -->
<h3 class="fn"><a name="setOriginalDate"></a><span class="type">void</span> QContactAnniversary::<span class="name">setOriginalDate</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdate.html">QDate</a></span> &amp; <i>date</i> )</h3>
<p>Sets the original date of the event stored in this detail to <i>date</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#originalDate">originalDate</a>().</p>
<!-- @@@setOriginalDate -->
<!-- $$$setOriginalDateTime[overload1]$$$setOriginalDateTimeconstQDateTime& -->
<h3 class="fn"><a name="setOriginalDateTime"></a><span class="type">void</span> QContactAnniversary::<span class="name">setOriginalDateTime</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> &amp; <i>dateTime</i> )</h3>
<p>Sets the original date and time of the event stored in this detail to <i>dateTime</i>.</p>
<p><b>See also </b><a href="qcontactanniversary.html#originalDateTime">originalDateTime</a>().</p>
<!-- @@@setOriginalDateTime -->
<!-- $$$setSubType[overload1]$$$setSubTypeconstQString& -->
<h3 class="fn"><a name="setSubType"></a><span class="type">void</span> QContactAnniversary::<span class="name">setSubType</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>subType</i> )</h3>
<p>Sets the subtype which this detail implements to be the given <i>subType</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>().</p>
<!-- @@@setSubType -->
<!-- $$$subType[overload1]$$$subType -->
<h3 class="fn"><a name="subType"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactAnniversary::<span class="name">subType</span> () const</h3>
<p>Returns the subtype that this detail implements, if defined.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@subType -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$DefinitionName -->
<h3 class="fn"><a name="DefinitionName-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">DefinitionName</span></h3>
<p>The string constant for the definition name of <a href="qcontactanniversary.html">QContactAnniversary</a> details.</p>
<!-- @@@DefinitionName -->
<!-- $$$FieldCalendarId -->
<h3 class="fn"><a name="FieldCalendarId-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">FieldCalendarId</span></h3>
<p>The field key constant for the value containing the id of the calendar event.</p>
<p><b>See also </b><a href="qcontactanniversary.html#calendarId">calendarId</a>() and <a href="qcontactanniversary.html#setCalendarId">setCalendarId</a>().</p>
<!-- @@@FieldCalendarId -->
<!-- $$$FieldEvent -->
<h3 class="fn"><a name="FieldEvent-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">FieldEvent</span></h3>
<p>The field key constant for the name of the event value.</p>
<p><b>See also </b><a href="qcontactanniversary.html#event">event</a>() and <a href="qcontactanniversary.html#setEvent">setEvent</a>().</p>
<!-- @@@FieldEvent -->
<!-- $$$FieldOriginalDate -->
<h3 class="fn"><a name="FieldOriginalDate-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">FieldOriginalDate</span></h3>
<p>The field key constant for the original anniversary date value.</p>
<p>This field is either a date, or a date and time. Some managers may support either type, while others may convert the value here to a specific type (either discarding the time if only a date is supported, or by using midnight if a time is not supplied).</p>
<p><b>See also </b><a href="qcontactanniversary.html#originalDate">originalDate</a>(), <a href="qcontactanniversary.html#setOriginalDate">setOriginalDate</a>(), <a href="qcontactanniversary.html#originalDateTime">originalDateTime</a>(), and <a href="qcontactanniversary.html#setOriginalDateTime">setOriginalDateTime</a>().</p>
<!-- @@@FieldOriginalDate -->
<!-- $$$FieldSubType -->
<h3 class="fn"><a name="FieldSubType-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">FieldSubType</span></h3>
<p>The field key constant for the field that stores the sub type of a <a href="qcontactanniversary.html">QContactAnniversary</a>.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>() and <a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@FieldSubType -->
<!-- $$$SubTypeEmployment -->
<h3 class="fn"><a name="SubTypeEmployment-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">SubTypeEmployment</span></h3>
<p>The predefined string constant for a sub type value, indicating this anniversary is the anniversary of a start of employment.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>() and <a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@SubTypeEmployment -->
<!-- $$$SubTypeEngagement -->
<h3 class="fn"><a name="SubTypeEngagement-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">SubTypeEngagement</span></h3>
<p>The predefined string constant for a sub type value, indicating this anniversary is the anniversary of an engagement.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>() and <a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@SubTypeEngagement -->
<!-- $$$SubTypeMemorial -->
<h3 class="fn"><a name="SubTypeMemorial-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">SubTypeMemorial</span></h3>
<p>The predefined string constant for a sub type value, indicating this anniversary is an anniversary of an event of sentimental significance.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>() and <a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@SubTypeMemorial -->
<!-- $$$SubTypeWedding -->
<h3 class="fn"><a name="SubTypeWedding-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactAnniversary::<span class="name">SubTypeWedding</span></h3>
<p>The predefined string constant for a sub type value, indicating this anniversary is a wedding anniversary.</p>
<p><b>See also </b><a href="qcontactanniversary.html#subType">subType</a>() and <a href="qcontactanniversary.html#setSubType">setSubType</a>().</p>
<!-- @@@SubTypeWedding -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>