KCal::ScheduleMessage Class Reference

A Scheduling message class. More...

#include <scheduler.h>

List of all members.

Public Types

enum  Status {
  PublishNew, PublishUpdate, Obsolete, RequestNew,
  RequestUpdate, Unknown
}

Public Member Functions

 ScheduleMessage (IncidenceBase *incidence, iTIPMethod method, Status status)
 ~ScheduleMessage ()
QString error ()
IncidenceBaseevent ()
iTIPMethod method ()
Status status ()

Static Public Member Functions

static QString statusName (Status status)

Detailed Description

A Scheduling message class.

This class provides an encapsulation of a scheduling message. It associates an incidence with an iTIPMethod and status information.

Definition at line 58 of file scheduler.h.


Member Enumeration Documentation

Message status.

Enumerator:
PublishNew 

New message posting.

PublishUpdate 

Updated message.

Obsolete 

obsolete

RequestNew 

Request new message posting.

RequestUpdate 

Request updated message.

Unknown 

No status.

Definition at line 64 of file scheduler.h.


Constructor & Destructor Documentation

ScheduleMessage::ScheduleMessage ( IncidenceBase incidence,
iTIPMethod  method,
ScheduleMessage::Status  status 
)

Creates a scheduling message with method as defined in iTIPMethod and a status.

Definition at line 52 of file scheduler.cpp.

ScheduleMessage::~ScheduleMessage (  ) 

Destructor.

Definition at line 62 of file scheduler.cpp.


Member Function Documentation

QString ScheduleMessage::error (  ) 

Returns the error message if there is any.

Definition at line 100 of file scheduler.cpp.

IncidenceBase * ScheduleMessage::event (  ) 

Returns the event associated with this message.

Definition at line 67 of file scheduler.cpp.

iTIPMethod ScheduleMessage::method (  ) 

Returns the iTIP method associated with this message.

Definition at line 72 of file scheduler.cpp.

ScheduleMessage::Status ScheduleMessage::status (  ) 

Returns the status of this message.

Definition at line 77 of file scheduler.cpp.

QString ScheduleMessage::statusName ( ScheduleMessage::Status  status  )  [static]

Returns a human-readable name for an iTIP message status.

Definition at line 82 of file scheduler.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys