CalendarSettings

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/CalendarSettings>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The CalendarSettings class contains system settings for calendars.

This class contains settings that are relevant to calendar applications, such as snooze time for calendar notifications, current system time zone, and whether the device time is in 24-hour format.

You can retrieve the current calendar settings by calling CalendarService::settings().

See also:

CalendarService


Overview

Public Functions Index

CalendarSettings ()
CalendarSettings (const CalendarSettings &other)
~CalendarSettings ()
intallDayMeetingReminder () const
QStringcurrentSystemTimezone () const
boolis24HourFormat () const
boolisValid () const
intmeetingReminder () const
CalendarSettings &operator= (const CalendarSettings &other)
voidset24HourFormat (bool value)
voidsetAllDayMeetingReminder (int allDayMeetingReminder)
voidsetCurrentSystemTimezone (const QString &currentSystemTimezone)
voidsetMeetingReminder (int meetingReminder)
voidsetSnoozeTime (int snoozeTime)
voidsetTimezoneDatabaseId (const QString &timezoneDatabaseId)
intsnoozeTime () const
QStringtimezoneDatabaseId () const

Public Functions

CalendarSettings ()

Constructs a new CalendarSettings.

Since:

BlackBerry 10.0.0

CalendarSettings (

Copy constructor.

This function constructs a CalendarSettings containing exactly the same values as the provided CalendarSettings.

Parameters
other

The CalendarSettings to be copied.

Since:

BlackBerry 10.0.0

~CalendarSettings ()

Destructor.

Since:

BlackBerry 10.0.0

int allDayMeetingReminder ()

Retrieves the default meeting reminder for all-day events.

Determines the moment when the device shows an alert to remind the user that an all-day event is about to start. The value is the number of minutes before the beginning of the event.

Return:

The all-day meeting reminder value.

Since:

BlackBerry 10.3.1

QString currentSystemTimezone ()

Retrieves the name of the current time zone.

This function returns the name of the device's current time zone.

Return:

The name of the current time zone.

Since:

BlackBerry 10.0.0

bool is24HourFormat ()

Indicates whether the device time is in 24-hour format.

Return:

true if the device time is in 24-hour format, false otherwise.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this CalendarSettings is valid.

This function determines whether the attributes of this CalendarSettings object have acceptable values.

Return:

true if this CalendarSettings is valid, false otherwise.

Since:

BlackBerry 10.0.0

int meetingReminder ()

Retrieves the default meeting reminder.

Determines the moment when the device shows an alert to remind the user that an event is about to start. The value is the number of minutes before the beginning of the event.

Return:

The meeting reminder value.

Since:

BlackBerry 10.3.1

CalendarSettings & operator= (

Assignment operator.

This operator copies all values from the provided CalendarSettings into this CalendarSettings.

Parameters
other

The CalendarSettings from which to copy all values.

Return:

A reference to this CalendarSettings.

Since:

BlackBerry 10.0.0

void set24HourFormat (
  • boolvalue)

Sets whether the device time is in 24-hour format.

Parameters
value

If true the time is in 24-hour format, if false the time is not in 24-hour format.

Since:

BlackBerry 10.0.0

void setAllDayMeetingReminder (
  • intallDayMeetingReminder)

Sets the all-day meeting reminder value.

Parameters
snoozeTime

The new all-day meeting reminder.

Since:

BlackBerry 10.3.1

void setCurrentSystemTimezone (
  • const QString &currentSystemTimezone)

Sets the name of the current time zone.

Parameters
currentSystemTimezone

The new time zone name.

Since:

BlackBerry 10.0.0

void setMeetingReminder (
  • intmeetingReminder)

Sets the meeting reminder value.

Parameters
snoozeTime

The new meeting reminder.

Since:

BlackBerry 10.3.1

void setSnoozeTime (
  • intsnoozeTime)

Sets the snooze time for calendar notifications.

Parameters
snoozeTime

The new snooze time.

Since:

BlackBerry 10.0.0

void setTimezoneDatabaseId (

Sets the ID of the current time zone.

Parameters
timezoneDatabaseId

The new time zone ID.

Since:

BlackBerry 10.0.0

int snoozeTime ()

Retrieves the current snooze time for calendar notifications.

The system notification manager shows alerts for upcoming events. The user can snooze an alert, which means that the manager will close it and then show it again after a period of time. This time interval is the snooze time.

Return:

The current snooze time.

Since:

BlackBerry 10.0.0

QString timezoneDatabaseId ()

Retrieves the ID of the current time zone.

This function returns the database ID for the device's current time zone.

Return:

The ID of the current time zone.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus