libkcal Library API Documentation

KCal::ScheduleMessage Class Reference

This class provides an encapsulation of a scheduling message. A Scheduling message. More...

#include <scheduler.h>

List of all members.

Public Types

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

Public Methods

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

Static Public Methods

QString statusName (Status status)


Detailed Description

This class provides an encapsulation of a scheduling message. A Scheduling message.

It associates an incidence with a method and status information. This class is used by the Scheduler class.

Definition at line 41 of file scheduler.h.


Member Enumeration Documentation

enum KCal::ScheduleMessage::Status
 

Message status.

Definition at line 47 of file scheduler.h.

Referenced by status().


Constructor & Destructor Documentation

ScheduleMessage::ScheduleMessage IncidenceBase  ,
int    method,
Status    status
 

Create a scheduling message with method as defined in Scheduler::Method and a status.

Definition at line 39 of file scheduler.cpp.

References method(), and status().


Member Function Documentation

IncidenceBase* KCal::ScheduleMessage::event   [inline]
 

Return event associated with this message.

Definition at line 60 of file scheduler.h.

int KCal::ScheduleMessage::method   [inline]
 

Return iTIP method associated with this message.

Definition at line 64 of file scheduler.h.

Referenced by ScheduleMessage().

Status KCal::ScheduleMessage::status   [inline]
 

Return status of this message.

Definition at line 68 of file scheduler.h.

References Status.

Referenced by ScheduleMessage(), and statusName().

QString KCal::ScheduleMessage::error   [inline]
 

Return error message if there is any.

Definition at line 72 of file scheduler.h.

QString ScheduleMessage::statusName Status    status [static]
 

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

Definition at line 46 of file scheduler.cpp.

References QString::number(), and status().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:25 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003