libkcal
KCal::Incidence Class Reference
This class provides the base class common to all calendar components. More...
#include <incidence.h>

Public Types | |
enum | Status { StatusNone, StatusTentative, StatusConfirmed, StatusCompleted, StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft, StatusFinal, StatusX } |
enum | { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 } |
typedef ListBase< Incidence > | List |
Public Member Functions | |
Incidence (const Incidence &) | |
Incidence & | operator= (const Incidence &i) |
bool | operator== (const Incidence &) const |
virtual Incidence * | clone ()=0 |
void | setReadOnly (bool readonly) |
void | setFloats (bool f) |
void | recreate () |
void | setCreated (const TQDateTime &) |
TQDateTime | created () const |
void | setRevision (int rev) |
int | revision () const |
virtual void | setDtStart (const TQDateTime &dtStart) |
virtual TQDateTime | dtEnd () const |
void | setDescription (const TQString &description) |
TQString | description () const |
void | setSummary (const TQString &summary) |
TQString | summary () const |
void | setCategories (const TQStringList &categories) |
void | setCategories (const TQString &catStr) |
TQStringList | categories () const |
TQString | categoriesStr () const |
void | setRelatedToUid (const TQString &) |
TQString | relatedToUid () const |
void | setRelatedTo (Incidence *relatedTo) |
Incidence * | relatedTo () const |
Incidence::List | relations () const |
void | addRelation (Incidence *) |
void | removeRelation (Incidence *) |
Recurrence * | recurrence () const |
void | clearRecurrence () |
bool | doesRecur () const |
uint | recurrenceType () const |
virtual bool | recursOn (const TQDate &qd) const |
bool | recursAt (const TQDateTime &qdt) const |
virtual bool | recursOn (const TQDate &qd, Calendar *cal) const |
bool | recursAt (const TQDateTime &qdt, Calendar *cal) const |
virtual TQValueList< TQDateTime > | startDateTimesForDate (const TQDate &date) const |
virtual TQValueList< TQDateTime > | startDateTimesForDateTime (const TQDateTime &datetime) const |
virtual TQDateTime | endDateForStart (const TQDateTime &startDt) const |
void | addAttachment (Attachment *attachment) |
void | deleteAttachment (Attachment *attachment) |
void | deleteAttachments (const TQString &mime) |
Attachment::List | attachments () const |
Attachment::List | attachments (const TQString &mime) const |
void | clearAttachments () |
void | setSecrecy (int) |
int | secrecy () const |
TQString | secrecyStr () const |
void | setStatus (Status status) |
void | setCustomStatus (const TQString &status) |
Status | status () const |
TQString | statusStr () const |
void | setResources (const TQStringList &resources) |
TQStringList | resources () const |
void | setPriority (int priority) |
int | priority () const |
bool | hasRecurrenceID () const |
void | setHasRecurrenceID (bool hasRecurrenceID) |
void | setRecurrenceID (const TQDateTime &recurrenceID) |
TQDateTime | recurrenceID () const |
void | addChildIncidence (TQString childIncidence) |
void | deleteChildIncidence (TQString childIncidence) |
IncidenceList | childIncidences () const |
const Alarm::List & | alarms () const |
Alarm * | newAlarm () |
void | addAlarm (Alarm *) |
void | removeAlarm (Alarm *) |
void | clearAlarms () |
bool | isAlarmEnabled () const |
void | setLocation (const TQString &location) |
TQString | location () const |
void | setSchedulingID (const TQString &sid) |
TQString | schedulingID () const |
virtual void | recurrenceUpdated (Recurrence *) |
Static Public Member Functions | |
static TQStringList | secrecyList () |
static TQString | secrecyName (int) |
static TQString | statusName (Status) |
Protected Member Functions | |
virtual TQDateTime | endDateRecurrenceBase () const |
Classes | |
class | AddSubResourceVisitor |
This class implements a visitor for adding an Incidence to a resource plus subresource supporting addEvent(), addTodo() and addJournal() calls. More... | |
class | AddVisitor |
This class implements a visitor for adding an Incidence to a resource supporting addEvent(), addTodo() and addJournal() calls. More... | |
class | DeleteVisitor |
This class implements a visitor for deleting an Incidence from a resource supporting deleteEvent(), deleteTodo() and deleteJournal() calls. More... |
Detailed Description
This class provides the base class common to all calendar components.Definition at line 47 of file incidence.h.
Member Enumeration Documentation
anonymous enum |
Member Function Documentation
virtual Incidence* KCal::Incidence::clone | ( | ) | [pure virtual] |
Return copy of this object.
The returned object is owned by the caller.
Implemented in KCal::Event, KCal::Journal, and KCal::Todo.
void Incidence::setReadOnly | ( | bool | readonly | ) | [virtual] |
Set readonly state of incidence.
- Parameters:
-
readonly If true, the incidence is set to readonly, if false the incidence is set to readwrite.
Reimplemented from KCal::IncidenceBase.
Definition at line 222 of file incidence.cpp.
void Incidence::setFloats | ( | bool | f | ) |
Set whether the incidence floats, i.e.
has a date but no time attached to it.
Reimplemented from KCal::IncidenceBase.
Definition at line 229 of file incidence.cpp.
void Incidence::recreate | ( | ) |
Recreate event.
The event is made a new unique event, but already stored event information is preserved. Sets uniquie id, creation date, last modification date and revision number.
Definition at line 208 of file incidence.cpp.
void Incidence::setCreated | ( | const TQDateTime & | created | ) |
TQDateTime Incidence::created | ( | ) | const |
void Incidence::setRevision | ( | int | rev | ) |
int Incidence::revision | ( | ) | const |
void Incidence::setDtStart | ( | const TQDateTime & | dtStart | ) | [virtual] |
Set starting date/time.
Reimplemented from KCal::IncidenceBase.
Reimplemented in KCal::Todo.
Definition at line 264 of file incidence.cpp.
virtual TQDateTime KCal::Incidence::dtEnd | ( | ) | const [inline, virtual] |
Return the incidence's ending date/time as a TQDateTime.
Reimplemented in KCal::Event.
Definition at line 184 of file incidence.h.
void Incidence::setDescription | ( | const TQString & | description | ) |
TQString Incidence::description | ( | ) | const |
void Incidence::setSummary | ( | const TQString & | summary | ) |
TQString Incidence::summary | ( | ) | const |
void Incidence::setCategories | ( | const TQStringList & | categories | ) |
void Incidence::setCategories | ( | const TQString & | catStr | ) |
TQStringList Incidence::categories | ( | ) | const |
TQString Incidence::categoriesStr | ( | ) | const |
void Incidence::setRelatedToUid | ( | const TQString & | relatedToUid | ) |
Point at some other event to which the event relates.
This function should only be used when constructing a calendar before the related Incidence exists.
Definition at line 333 of file incidence.cpp.
TQString Incidence::relatedToUid | ( | ) | const |
What event does this one relate to? This function should only be used when constructing a calendar before the related Incidence exists.
Definition at line 340 of file incidence.cpp.
void Incidence::setRelatedTo | ( | Incidence * | relatedTo | ) |
Incidence * Incidence::relatedTo | ( | ) | const |
Incidence::List Incidence::relations | ( | ) | const |
void Incidence::addRelation | ( | Incidence * | event | ) |
void Incidence::removeRelation | ( | Incidence * | event | ) |
Recurrence * Incidence::recurrence | ( | ) | const |
Return the recurrence rule associated with this incidence.
If there is none, returns an appropriate (non-0) object.
Definition at line 390 of file incidence.cpp.
void Incidence::clearRecurrence | ( | ) |
bool Incidence::doesRecur | ( | ) | const |
bool Incidence::recursOn | ( | const TQDate & | qd | ) | const [virtual] |
Returns true if the date specified is one on which the incidence will recur.
Reimplemented in KCal::Todo.
Definition at line 422 of file incidence.cpp.
bool Incidence::recursAt | ( | const TQDateTime & | qdt | ) | const |
Returns true if the date/time specified is one on which the incidence will recur.
Definition at line 430 of file incidence.cpp.
bool Incidence::recursOn | ( | const TQDate & | qd, | |
Calendar * | cal | |||
) | const [virtual] |
Returns true if the date specified is one on which the incidence will recur.
This function takes RECURRENCE-ID parameters into account
- Parameters:
-
cal the calendar owning the incidence
Definition at line 438 of file incidence.cpp.
bool Incidence::recursAt | ( | const TQDateTime & | qdt, | |
Calendar * | cal | |||
) | const |
Returns true if the date/time specified is one on which the incidence will recur.
This function takes RECURRENCE-ID parameters into account
- Parameters:
-
cal the calendar owning the incidence
Definition at line 459 of file incidence.cpp.
TQValueList< TQDateTime > Incidence::startDateTimesForDate | ( | const TQDate & | date | ) | const [virtual] |
Calculates the start date/time for all recurrences that happen at some time on the given date (might start before that date, but end on or after the given date).
Calculates the start date/time for all recurrences that happen at some time on the given date (might start before that date, but end on or after the given date).
- Parameters:
-
date the date where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date. Empty list if the incidence does not overlap with the date at all
- Parameters:
-
date the date where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date. Empty list if the incidence does not overlap with the date at all
Definition at line 486 of file incidence.cpp.
TQValueList< TQDateTime > Incidence::startDateTimesForDateTime | ( | const TQDateTime & | datetime | ) | const [virtual] |
Calculates the start date/time for all recurrences that happen at the given time.
Calculates the start date/time for all recurrences that happen at the given time.
- Parameters:
-
datetime the date/time where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date/time. Empty list if the incidence does not happen at the given time at all.
- Parameters:
-
datetime the date/time where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date/time. Empty list if the incidence does not happen at the given time at all.
Definition at line 533 of file incidence.cpp.
TQDateTime Incidence::endDateForStart | ( | const TQDateTime & | startDt | ) | const [virtual] |
Return the end time of the occurrence if it starts at the given date/time.
Definition at line 573 of file incidence.cpp.
void Incidence::addAttachment | ( | Attachment * | attachment | ) |
void Incidence::deleteAttachment | ( | Attachment * | attachment | ) |
void Incidence::deleteAttachments | ( | const TQString & | mime | ) |
Remove and delete all attachments with this mime type.
Definition at line 686 of file incidence.cpp.
Attachment::List Incidence::attachments | ( | ) | const |
Attachment::List Incidence::attachments | ( | const TQString & | mime | ) | const |
void Incidence::clearAttachments | ( | ) |
void Incidence::setSecrecy | ( | int | sec | ) |
Sets secrecy status.
This can be Public, Private or Confidential. See separate enum.
Definition at line 786 of file incidence.cpp.
int Incidence::secrecy | ( | ) | const |
TQString Incidence::secrecyStr | ( | ) | const |
TQStringList Incidence::secrecyList | ( | ) | [static] |
Return list of all available secrecy states as list of translated strings.
Definition at line 817 of file incidence.cpp.
TQString Incidence::secrecyName | ( | int | secrecy | ) | [static] |
Return human-readable translated name of secrecy class.
Definition at line 803 of file incidence.cpp.
void Incidence::setStatus | ( | Incidence::Status | status | ) |
Sets the incidence status to a standard status value.
See separate enum. Note that StatusX cannot be specified.
Definition at line 741 of file incidence.cpp.
void Incidence::setCustomStatus | ( | const TQString & | status | ) |
Sets the incidence status to a non-standard status value.
- Parameters:
-
status non-standard status string. If empty, the incidence status will be set to StatusNone.
Definition at line 749 of file incidence.cpp.
Incidence::Status Incidence::status | ( | ) | const |
TQString Incidence::statusStr | ( | ) | const |
TQString Incidence::statusName | ( | Incidence::Status | status | ) | [static] |
Return human-readable translated name of status value.
Definition at line 769 of file incidence.cpp.
void Incidence::setResources | ( | const TQStringList & | resources | ) |
TQStringList Incidence::resources | ( | ) | const |
void Incidence::setPriority | ( | int | priority | ) |
Set the incidences priority.
The priority has to be a value between 0 and 9, 0 is undefined, 1 the highest, 9 the lowest priority (decreasing order).
Definition at line 729 of file incidence.cpp.
int Incidence::priority | ( | ) | const |
Return priority.
The priority is a number between 1 and 9. 1 is highest priority. If the priority is undefined 0 is returned.
Definition at line 736 of file incidence.cpp.
bool Incidence::hasRecurrenceID | ( | ) | const |
Returns true if the incidence has recurrenceID, otherwise return false.
- See also:
- setHasRecurrenceID(), setRecurrenceID(TQDateTime)
- Since:
- 3.5.12
Definition at line 893 of file incidence.cpp.
void Incidence::setHasRecurrenceID | ( | bool | hasRecurrenceID | ) |
Sets if the incidence has recurrenceID.
- Parameters:
-
hasRecurrenceID true if incidence has recurrenceID, otherwise false
- See also:
- hasRecurrenceID(), recurrenceID()
- Since:
- 3.5.12
Definition at line 898 of file incidence.cpp.
void Incidence::setRecurrenceID | ( | const TQDateTime & | recurrenceID | ) |
Set the incidences recurrenceID.
- Parameters:
-
recurrenceID is the incidence recurrenceID to set
- See also:
- recurrenceID().
- Since:
- 3.5.12
Definition at line 913 of file incidence.cpp.
TQDateTime Incidence::recurrenceID | ( | ) | const |
Returns the incidence recurrenceID.
- Returns:
- incidences recurrenceID value
- See also:
- setRecurrenceID().
- Since:
- 3.5.12
Definition at line 908 of file incidence.cpp.
void Incidence::addChildIncidence | ( | TQString | childIncidence | ) |
Attach a child incidence to a parent incidence.
- Parameters:
-
childIncidence is the child incidence to add
- Since:
- 3.5.12
Definition at line 924 of file incidence.cpp.
void Incidence::deleteChildIncidence | ( | TQString | childIncidence | ) |
Detach a child incidence from its parent incidence.
- Parameters:
-
childIncidence is the child incidence to remove
- Since:
- 3.5.12
Definition at line 929 of file incidence.cpp.
IncidenceList Incidence::childIncidences | ( | ) | const |
Returns an EventList of all child incidences.
- Returns:
- EventList of all child incidences.
- Since:
- 3.5.12
Definition at line 934 of file incidence.cpp.
const Alarm::List & Incidence::alarms | ( | ) | const |
Alarm * Incidence::newAlarm | ( | ) |
Create a new alarm which is associated with this incidence.
Definition at line 833 of file incidence.cpp.
void Incidence::addAlarm | ( | Alarm * | alarm | ) |
void Incidence::removeAlarm | ( | Alarm * | alarm | ) |
Remove an alarm that is associated with this incidence.
Definition at line 847 of file incidence.cpp.
void Incidence::clearAlarms | ( | ) |
Remove all alarms that are associated with this incidence.
Definition at line 853 of file incidence.cpp.
bool Incidence::isAlarmEnabled | ( | ) | const |
Return whether any alarm associated with this incidence is enabled.
Definition at line 859 of file incidence.cpp.
void Incidence::setLocation | ( | const TQString & | location | ) |
Set the event's/todo's location.
Do _not_ use it with journal.
Definition at line 868 of file incidence.cpp.
TQString Incidence::location | ( | ) | const |
Return the event's/todo's location.
Do _not_ use it with journal.
Definition at line 875 of file incidence.cpp.
void Incidence::setSchedulingID | ( | const TQString & | sid | ) |
Set the event's/todo's scheduling ID.
Does not make sense for journals. This is used for accepted invitations as the place to store the UID of the invitation. It is later used again if updates to the invitation comes in. If we did not set a new UID on incidences from invitations, we can end up with more than one resource having events with the same UID, if you have access to other peoples resources.
Definition at line 880 of file incidence.cpp.
TQString Incidence::schedulingID | ( | ) | const |
Return the event's/todo's scheduling ID.
Does not make sense for journals If this is not set, it will return uid().
Definition at line 885 of file incidence.cpp.
void Incidence::recurrenceUpdated | ( | Recurrence * | recurrence | ) | [virtual] |
Observer interface for the recurrence class.
If the recurrence is changed, this method will be called for the incidence the recurrence object belongs to.
If the recurrence is changed, this method will be called for the incidence the recurrence object belongs to.
Definition at line 942 of file incidence.cpp.
virtual TQDateTime KCal::Incidence::endDateRecurrenceBase | ( | ) | const [inline, protected, virtual] |
Return the end date/time of the base incidence (e.g.
due date/time for to-dos, end date/time for events). This method needs to be reimplemented by derived classes.
Reimplemented in KCal::Event, and KCal::Todo.
Definition at line 552 of file incidence.h.
The documentation for this class was generated from the following files: