libkcal Library API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files
KCal::ScheduleMessage

KCal::ScheduleMessage Class Reference

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

#include <scheduler.h>

Collaboration diagram for KCal::ScheduleMessage:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Member Functions

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

Static Public Member Functions

static 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 42 of file scheduler.h.

Member Enumeration Documentation

enum KCal::ScheduleMessage::Status
 

Message status.

Definition at line 48 of file scheduler.h.

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 41 of file scheduler.cpp.

Member Function Documentation

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

Return event associated with this message.

Definition at line 61 of file scheduler.h.

int KCal::ScheduleMessage::method (   )  [inline]
 

Return iTIP method associated with this message.

Definition at line 65 of file scheduler.h.

Status KCal::ScheduleMessage::status (   )  [inline]
 

Return status of this message.

Definition at line 69 of file scheduler.h.

QString KCal::ScheduleMessage::error (   )  [inline]
 

Return error message if there is any.

Definition at line 73 of file scheduler.h.

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

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

Definition at line 48 of file scheduler.cpp.

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.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 4 06:41:32 2005 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003