|
Home · All Classes · Annotated · Functions | |
The QAppointment class holds the data of a calendar appointment. More...
#include <QAppointment>
Inherits QPimRecord.
The QAppointment class holds the data of a calendar appointment.
This data includes descriptive data of the appointment and schedualing information.
This enum type defines the sound that is made when an appointment alarm occurs The currently defined types are:
| Constant | Value | Description |
|---|---|---|
| QAppointment::NoAlarm | 0x00 | The appointment has no alarm set |
| QAppointment::Visible | 0x01 | The appointment has dialog popup alarm set |
| QAppointment::Audible | 0x02 | Visible | The appontment has an audible alarm set. |
The AlarmFlags type is a typedef for QFlags<AlarmFlag>. It stores an OR combination of AlarmFlag values.
See also setAlarm() and alarm().
This enum type defines how an appointment repeats.
| Constant | Value | Description |
|---|---|---|
| QAppointment::NoRepeat | 0 | appointment occurs only once |
| QAppointment::Daily | 1 | appointment occurs every N days |
| QAppointment::Weekly | 2 | appointment occurs every N weeks |
| QAppointment::MonthlyDate | 3 | appointment occurs on the Xth day of the month every N months |
| QAppointment::MonthlyDay | 4 | appointment occurs on the Xth week of the month every N months |
| QAppointment::MonthlyEndDay | 6 | appointment occurs on the Xth last week of the month every N months |
| QAppointment::Yearly | 5 | appointment occurs every N years |
See also frequency(), weekOffset(), showOnNearest(), and repeatOnWeekDay().
The WeekFlags only apply to appointments that have a RepeatRule of Weekly.
| Constant | Value | Description |
|---|---|---|
| QAppointment::OccurMonday | 0x01 | The appointment occurs on each Monday |
| QAppointment::OccurTuesday | 0x02 | The appointment occurs on each Tuesday |
| QAppointment::OccurWednesday | 0x04 | The appointment occurs on each Wednesday |
| QAppointment::OccurThursday | 0x08 | The appointment occurs on each Thursday |
| QAppointment::OccurFriday | 0x10 | The appointment occurs on each Friday |
| QAppointment::OccurSaturday | 0x20 | The appointment occurs on each Saturday |
| QAppointment::OccurSunday | 0x40 | The appointment occurs on each Sunday |
The WeekFlags type is a typedef for QFlags<WeekFlag>. It stores an OR combination of WeekFlag values.
Constructs a new QAppointment.
Constructs a new QAppointment as a copy of appointment.
Constructs a new QAppointment starting at start and running until end.
Destroys a QAppointment.
Returns the type of alarm to sound.
See also setAlarm() and AlarmFlags.
Returns the number of minutes before the appointment to activate the alarm for the appointment.
See also setAlarm().
Reimplemented from QPimRecord.
This is an overloaded member function, provided for convenience.
Reimplemented from QPimRecord.
Clears any alarms set for the appointment.
See also setAlarm().
Removes all exceptions from the appointment.
Note: clearing exceptions and updating appointment in the QAppointmentModel will NOT store the exception changes. Use the functions QAppointmentModel::removeOccurrence(), QAppointmentModel::replaceOccurrence() and QAppointmentModel::replaceRemaining() instead.
Reimplemented from QPimRecord.
This is an overloaded member function, provided for convenience.
Reimplemented from QPimRecord.
Returns the description of the appointment.
See also setDescription().
Returns when the first occurrence of the appointment starts.
See also endInCurrentTZ() and setEnd().
Returns the end time of the appointment in the current system timezone.
See also end().
Returns the uid of the repeating appointment that this an exception to
See also setExceptionParent().
Returns the list of exceptions to the appointments repeat rule.
See also setExceptions().
Returns the first occurrence for the appointment.
If there are no valid occurrence for the appointment will return a null occurrence.
Returns how often the appointment repeats.
See also setFrequency().
Returns the WeekFlag associated with day as a Qt::DayOfWeek.
Returns true if there is an alarm set for the appointment. Otherwise returns false.
See also setAlarm().
Returns false if the appointment has repeat type NoRepeat. Otherwise returns true.
See also setRepeatRule() and RepeatRule.
Returns true if the appointment is an all day appointment. Otherwise returns false.
See also setAllDay().
Returns true if the appointment is an exception of another repeating appointment.
Returns true if the appointment can occur. Otherwise returns false.
Returns the location of the appointment.
See also setLocation().
Returns the first date on or after from that the appointment will next occur. If the appointment only occurs once (no repeat) will return the date of the start of the appointment if the start of the appointment is on or after from.
If the appointment does not occur on or after from then a null date is returned.
Returns the notes of the appointment.
Reimplemented from QPimRecord.
See also setNotes().
Reads the file specified by filename as a list of vCalendar objects and returns the list of near equivalent appointments.
See also writeVCalendar().
Returns true if the appointment will repeat forever. Otherwise returns false.
See also repeatUntil() and setRepeatForever().
If the repeat type of the appointment is Weekly and the appointment is set to repeat on day of the week, then returns true. Otherwise returns false.
See also setRepeatOnWeekDay().
Returns the RepeatRule of the appointment.
See also setRepeatRule() and RepeatRule.
Returns the date the appointment will repeat until
See also repeatForever() and setRepeatUntil().
Returns the date the appointment will repeat till in the current system timezone.
See also repeatUntil().
Sets an alarm for the appointment, minutes before the start of the appointment, with an alarm type of s.
See also clearAlarm(), hasAlarm(), alarm(), and alarmDelay().
Sets whether the appointment is an an all day appointment to enable. All day appointments have a no set time-zone (empty string).
See also isAllDay() and setTimeZone().
Sets the description of the appointment to text.
See also description().
Sets the end time of the appointment to time. This will also change the duration of the appointment. time must be at least 5 minutes after the start time of the appointment.
See also end() and endInCurrentTZ().
Sets the uid of the repeating appointment that this an exception to id.
See also exceptionParent().
Sets the exceptions for the appointment to those in list.
Note: setting exceptions and updating appointment in the QAppointmentModel will NOT store the exception. Use the functions QAppointmentModel::removeOccurrence(), QAppointmentModel::replaceOccurrence() and QAppointmentModel::replaceRemaining() instead.
See also exceptions().
Sets the frequency of the appointment to freq. If freq is less than 1 will set the frequency of the appointment to 1.
See also frequency().
Set the location of the appointment to text.
See also location().
Sets the notes of the appointment to text.
Reimplemented from QPimRecord.
See also notes().
Sets the appointment to repeat forever.
See also repeatForever().
Sets the appointment to repeat on the day of the wekif enable is true. Otherwise sets the appointment not to repeat on the day of the week.
Event will always repeat on the day of the week that it started on.
See also repeatOnWeekDay().
Sets the repeat type of the appointment to t.
See also repeatRule(), hasRepeat(), and RepeatRule.
Sets the date the appointment will repeat until to date. If date is before the end of the first appointment will set the appointment to occur once.
See also repeatUntil() and repeatForever().
Sets whether to show a repeating appointment on the nearest previous date if the day it would repeat on does not exist to b.
An example would be a repeating appointment that occures on the 31st of each month. Setting showOnNearest to true will have the appointment show up on the 30th on months that do not have 31 days, (or 28/29 in the case of Febuary).
See also showOnNearest().
Sets the start time of the appointment to time. This will change the end time fo the appointment to maintain the same duration.
See also start() and startInCurrentTZ().
Sets the time zone of the appointment to zone. This will affect when the appointment occurs in UTC. All day appointments cannot have a time zone set.
Setting the time zone to an invalid QTimeZone will cause the appointment to have no associated time zone.
See also timeZone() and isAllDay().
Sets the days of the weeek the appointment occurs on to be those specified by the flags f.
See also weekFlags().
Returns if the exact date the appointment would occur is not a valid date. and the appointment should be shown on the nearest match of an occurrence
See also setShowOnNearest().
Returns when the first occurrence of the appointment starts.
See also startInCurrentTZ() and setStart().
Returns the start time of the appointment in the current system timezone.
See also start().
Returns the time zone of the appointment or an invalid QTimeZone if the appointment has no time zone. All day appointments allways have no time zone.
See also setTimeZone() and isAllDay().
Returns the Qt::DayOfWeek associated with day.
Reimplemented from QPimRecord.
This is an overloaded member function, provided for convenience.
Reimplemented from QPimRecord.
Returns the flags representing the days of the week the appointment occurs on when set as a Weekly recuring event.
See also setWeekFlags().
Returns the instance of the week the appointment will occur for the repeat types MonthlyDay and MonthlyEndDay. The week offset is determined by the starting date of the appointment.
if (weekOffset() == 1) appointment occurs in first week of the month. if (weekOffset() == 3) appointment occurs in third week of the month. if (weekOffset() == -1) appointment occurs in last week of the month.
Returns 0 if there is no week offset for the appointment.
Write the list of appointments as vCalendar objects to the file specified by filename.
See also readVCalendar().
This is an overloaded member function, provided for convenience.
Write the appointment as a vCalendar to the file specified by filename.
See also readVCalendar().
Returns true if the appoinment is not equal to other. Otherwise returns false.
Sets the appointment to be a copy of other.
Returns true if the appointment is equal to other. Otherwise returns false.
| Copyright © 2006 Trolltech | Trademarks | Qtopia 4.1.7 |