MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QContactAnniversary Class Reference

The QContactAnniversary class contains an anniversary of a contact. More...

 #include <QContactAnniversary>

Inherits: QContactDetail.

This class was introduced in Qt Mobility 1.0.

Public Functions

QString calendarId () const
QString event () const
QDate originalDate () const
QDateTime originalDateTime () const
void setCalendarId ( const QString & calendarId )
void setEvent ( const QString & event )
void setOriginalDate ( const QDate & date )
void setOriginalDateTime ( const QDateTime & dateTime )
void setSubType ( const QString & subType )
QString subType () const

Static Public Members

const QLatin1Constant DefinitionName
const QLatin1Constant FieldCalendarId
const QLatin1Constant FieldEvent
const QLatin1Constant FieldOriginalDate
const QLatin1Constant FieldSubType
const QLatin1Constant SubTypeEmployment
const QLatin1Constant SubTypeEngagement
const QLatin1Constant SubTypeMemorial
const QLatin1Constant SubTypeWedding

Detailed Description

The QContactAnniversary class contains an anniversary of a contact.

This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project.

Member Function Documentation

QString QContactAnniversary::calendarId () const

* Returns the identifier of the calendar entry associated with this anniversary. *

This function was introduced in Qt Mobility 1.0.

See also setCalendarId().

QString QContactAnniversary::event () const

Returns the name of the event for which this detail contains information.

This function was introduced in Qt Mobility 1.0.

See also setEvent().

QDate QContactAnniversary::originalDate () const

Returns the original date of the event stored in this detail. If the original event occurrence stored is a QDateTime, this returns the date portion.

See also setOriginalDate().

QDateTime QContactAnniversary::originalDateTime () const

Returns the original date and time of the event stored in this detail. If the original event occurrence stored is a QDate, this returns a QDateTime with the time set to midnight.

This function was introduced in Qt Mobility 1.0.

See also setOriginalDateTime().

void QContactAnniversary::setCalendarId ( const QString & calendarId )

Sets the identifier of the calendar entry associated with this anniversary to calendarId.

This function was introduced in Qt Mobility 1.0.

See also calendarId().

void QContactAnniversary::setEvent ( const QString & event )

Sets the name of the event for which this detail contains information to event.

This function was introduced in Qt Mobility 1.0.

See also event().

void QContactAnniversary::setOriginalDate ( const QDate & date )

Sets the original date of the event stored in this detail to date.

This function was introduced in Qt Mobility 1.0.

See also originalDate().

void QContactAnniversary::setOriginalDateTime ( const QDateTime & dateTime )

Sets the original date and time of the event stored in this detail to dateTime.

See also originalDateTime().

void QContactAnniversary::setSubType ( const QString & subType )

Sets the subtype which this detail implements to be the given subType.

This function was introduced in Qt Mobility 1.0.

See also subType().

QString QContactAnniversary::subType () const

Returns the subtype that this detail implements, if defined.

This function was introduced in Qt Mobility 1.0.

See also setSubType().

Member Variable Documentation

const QLatin1Constant QContactAnniversary::DefinitionName

The string constant for the definition name of QContactAnniversary details.

const QLatin1Constant QContactAnniversary::FieldCalendarId

The field key constant for the value containing the id of the calendar event.

See also calendarId() and setCalendarId().

const QLatin1Constant QContactAnniversary::FieldEvent

The field key constant for the name of the event value.

See also event() and setEvent().

const QLatin1Constant QContactAnniversary::FieldOriginalDate

The field key constant for the original anniversary date value.

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).

See also originalDate(), setOriginalDate(), originalDateTime(), and setOriginalDateTime().

const QLatin1Constant QContactAnniversary::FieldSubType

The field key constant for the field that stores the sub type of a QContactAnniversary.

See also subType() and setSubType().

const QLatin1Constant QContactAnniversary::SubTypeEmployment

The predefined string constant for a sub type value, indicating this anniversary is the anniversary of a start of employment.

See also subType() and setSubType().

const QLatin1Constant QContactAnniversary::SubTypeEngagement

The predefined string constant for a sub type value, indicating this anniversary is the anniversary of an engagement.

See also subType() and setSubType().

const QLatin1Constant QContactAnniversary::SubTypeMemorial

The predefined string constant for a sub type value, indicating this anniversary is an anniversary of an event of sentimental significance.

See also subType() and setSubType().

const QLatin1Constant QContactAnniversary::SubTypeWedding

The predefined string constant for a sub type value, indicating this anniversary is a wedding anniversary.

See also subType() and setSubType().

© 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.

All other trademarks are property of their respective owners. Privacy Policy


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.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.