#include <app/caltime.h>
| class TCalTime |
| Public Member Enumerations | |
|---|---|
| enum | TTimeMode { EFloating, EFixedUtc, EFixedTimeZone } |
| Public Member Functions | |
|---|---|
| TCalTime() | |
| IMPORT_C TTime | MaxTime() |
| IMPORT_C TTime | MinTime() |
| IMPORT_C void | SetTimeLocalFloatingL(const TTime &) |
| IMPORT_C void | SetTimeLocalL(const TTime &) |
| IMPORT_C void | SetTimeUtcL(const TTime &) |
| IMPORT_C TTime | TimeLocalL() |
| IMPORT_C TTimeMode | TimeMode() |
| IMPORT_C TTime | TimeUtcL() |
Represents a date/time, as used in the Calendar API.
This stores a single TTime, which may be set in UTC or local or floating local time, and can be retrieved in either UTC or system local time.
There are references to null time throughout the Interim API - this means Time::NullTTime().
| IMPORT_C | TCalTime | ( | ) |
Constructor for the TCalTime class. The time is initialised to Time::NullTTime().
| IMPORT_C TTime | MaxTime | ( | ) | [static] |
Get the maximum time allowed in the Interim API. Note that this time is the same for UTC and system local time - it can't be converted.
Returns: The maximum time.
| IMPORT_C TTime | MinTime | ( | ) | [static] |
Get the minimum time allowed in the Interim API. Note that this time is the same for UTC and system local time - it can't be converted.
Returns: The minimum time.
| IMPORT_C void | SetTimeLocalFloatingL | ( | const TTime & | aLocalTime | ) |
Sets the time to a local floating time value. Time values set using this API are said to be "floating" and are not bound to any time zone in particular. Floating time is used to represent the same time regardless of which time zone it is currently being observed from. This is described in RFC2445 as FORM #1: DATE WITH LOCAL TIME.
| Parameter | Description |
|---|---|
| aLocalTime | The time to be set in floating local time. |
| IMPORT_C void | SetTimeLocalL | ( | const TTime & | aLocalTime | ) |
Sets the time to a local time value bound to the current system time zone. Time values set using this API are said to be "fixed". The local time can be converted to an equivalent local time in any other time zone by calling TimeUtcL() and then converting the UTC time to the equivalent local time zone using RTz. This is described in RFC2445 as FORM #3: DATE WITH LOCAL TIME AND TIME ZONE REFERENCE.
| Parameter | Description |
|---|---|
| aLocalTime | The time to be set in system-local time. |
| IMPORT_C void | SetTimeUtcL | ( | const TTime & | aUtcTime | ) |
Sets the time to a UTC value. Time values set using this API are said to be "fixed". Fixed times in UTC format can be converted to the equivalent local time in any time zone using RTz, or converted to the local time of the current system time zone by calling TimeLocalL(). This is described in RFC2445 as FORM #2: DATE WITH UTC TIME.
| Parameter | Description |
|---|---|
| aUtcTime | The time to be set in UTC. |
| IMPORT_C TTime | TimeLocalL | ( | ) | const |
Returns the fixed or floating time as local time. If the time is fixed, the time is converted to the local time of the current system time zone before being returned.
Returns: The time in system-local time.
| IMPORT_C TTimeMode | TimeMode | ( | ) | const |
Returns the time mode that the time has been set to, whether it be floating local time, fixed UTC time, or fixed local time.
Returns: Time mode of the calendar time
| IMPORT_C TTime | TimeUtcL | ( | ) | const |
Returns the fixed or floating time as UTC.
Returns: The time in UTC.