• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • ScheduleMessage
Public Types | Public Member Functions | Static Public Member Functions

KCalCore::ScheduleMessage Class Reference

A Scheduling message class. More...

#include <schedulemessage.h>

List of all members.

Public Types

typedef QSharedPointer
< ScheduleMessage > 
Ptr
enum  Status {
  PublishNew, PublishUpdate, Obsolete, RequestNew,
  RequestUpdate, Unknown
}

Public Member Functions

 ScheduleMessage (IncidenceBase::Ptr incidence, iTIPMethod method, Status status)
 ~ScheduleMessage ()
QString error () const
IncidenceBase::Ptr event () const
iTIPMethod method () const
Status status () const

Static Public Member Functions

static QString methodName (iTIPMethod method)

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 54 of file schedulemessage.h.


Member Typedef Documentation

typedef QSharedPointer<ScheduleMessage> KCalCore::ScheduleMessage::Ptr

A shared pointer to a ScheduleMessage.

Definition at line 72 of file schedulemessage.h.


Member Enumeration Documentation

enum KCalCore::ScheduleMessage::Status

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 60 of file schedulemessage.h.


Constructor & Destructor Documentation

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

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

Parameters:
incidencea pointer to a valid Incidence to be associated with this message.
methodan iTIPMethod.
statusa Status.

Definition at line 45 of file schedulemessage.cpp.

ScheduleMessage::~ScheduleMessage ( )

Destructor.

Definition at line 55 of file schedulemessage.cpp.


Member Function Documentation

QString ScheduleMessage::error ( ) const

Returns the error message if there is any.

Definition at line 99 of file schedulemessage.cpp.

IncidenceBase::Ptr ScheduleMessage::event ( ) const

Returns the event associated with this message.

Definition at line 60 of file schedulemessage.cpp.

iTIPMethod ScheduleMessage::method ( ) const

Returns the iTIP method associated with this message.

Definition at line 65 of file schedulemessage.cpp.

QString ScheduleMessage::methodName ( iTIPMethod  method) [static]

Returns a machine-readable (not translatable) name for a iTIP method.

Parameters:
methodan iTIPMethod.

Definition at line 70 of file schedulemessage.cpp.

ScheduleMessage::Status ScheduleMessage::status ( ) const

Returns the status of this message.

Definition at line 94 of file schedulemessage.cpp.


The documentation for this class was generated from the following files:
  • schedulemessage.h
  • schedulemessage.cpp

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal