• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal::ICalFormat

KCal::ICalFormat Class Reference

iCalendar format implementation. More...

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:

Inheritance graph
[legend]

List of all members.


Public Member Functions

QString createScheduleMessage (IncidenceBase *incidence, iTIPMethod method)
bool fromRawString (Calendar *calendar, const QByteArray &string)
bool fromString (RecurrenceRule *rule, const QString &string)
Incidence * fromString (const QString &string)
bool fromString (Calendar *calendar, const QString &string)
 ICalFormat ()
bool load (Calendar *calendar, const QString &fileName)
FreeBusy * parseFreeBusy (const QString &string)
ScheduleMessage * parseScheduleMessage (Calendar *calendar, const QString &string)
bool save (Calendar *calendar, const QString &fileName)
void setTimeSpec (const KDateTime::Spec &timeSpec)
KDateTime::Spec timeSpec () const
QString timeZoneId () const
QString toICalString (Incidence *incidence)
QString toString (RecurrenceRule *rule)
QString toString (Incidence *incidence)
QString toString (Calendar *calendar)
virtual ~ICalFormat ()

Detailed Description

iCalendar format implementation.

This class implements the iCalendar format. It provides methods for loading/saving/converting iCalendar format data into the internal representation as Calendar and Incidences.

Definition at line 52 of file icalformat.h.


Constructor & Destructor Documentation

ICalFormat::ICalFormat (  ) 

Constructor a new iCalendar Format object.

Definition at line 75 of file icalformat.cpp.

ICalFormat::~ICalFormat (  )  [virtual]

Destructor.

Definition at line 80 of file icalformat.cpp.


Member Function Documentation

QString ICalFormat::createScheduleMessage ( IncidenceBase *  incidence,
iTIPMethod  method 
)

Creates a scheduling message string for an Incidence.

Parameters:
incidence is a pointer to an IncidenceBase object to be scheduled.
method is a Scheduler::Method
Returns:
a QString containing the message if successful; 0 otherwise.

Definition at line 339 of file icalformat.cpp.

bool ICalFormat::fromRawString ( Calendar *  calendar,
const QByteArray &  string 
) [virtual]

Parses a utf8 encoded string, returning the first iCal component encountered in that string.

This is an overload used for efficient reading to avoid utf8 conversions, which are expensive when reading from disk.

Parameters:
calendar is the Calendar to be loaded.
string is the QByteArray containing the Calendar data.
Returns:
true if successful; false otherwise.
See also:
fromString(), toString().

Implements KCal::CalFormat.

Definition at line 151 of file icalformat.cpp.

bool ICalFormat::fromString ( RecurrenceRule *  rule,
const QString &  string 
)

Parses a string and fills a RecurrenceRule object with the information.

Parameters:
rule is a pointer to a RecurrenceRule object.
string is a QString containing the data to be parsed.
Returns:
true if successful; false otherwise.

Definition at line 319 of file icalformat.cpp.

Incidence * ICalFormat::fromString ( const QString &  string  ) 

Parses a string, returning the first iCal component as an Incidence.

Parameters:
string is a QString containing the data to be parsed.
Returns:
non-zero pointer if the parsing was successful; 0 otherwise.
See also:
fromString(Calendar *, const QString &), fromRawString()

Definition at line 205 of file icalformat.cpp.

bool ICalFormat::fromString ( Calendar *  calendar,
const QString &  string 
) [virtual]

Loads a calendar from a string.

Parameters:
calendar is the Calendar to be loaded.
string is the QString containing the Calendar data.
Returns:
true if successful; false otherwise.
See also:
fromRawString(), toString().

Implements KCal::CalFormat.

Definition at line 146 of file icalformat.cpp.

bool ICalFormat::load ( Calendar *  calendar,
const QString &  fileName 
) [virtual]

Loads a calendar on disk into the calendar associated with this format.

Parameters:
calendar is the Calendar to be loaded.
fileName is the name of the disk file containing the Calendar data.
Returns:
true if successful; false otherwise.

Implements KCal::CalFormat.

Definition at line 85 of file icalformat.cpp.

FreeBusy * ICalFormat::parseFreeBusy ( const QString &  string  ) 

Converts a QString into a FreeBusy object.

Parameters:
string is a QString containing the data to be parsed.
Returns:
a pointer to a FreeBusy object if successful; 0 otherwise.
Note:
Do not attempt to free the FreeBusy memory from the calling routine.

Definition at line 371 of file icalformat.cpp.

ScheduleMessage * ICalFormat::parseScheduleMessage ( Calendar *  calendar,
const QString &  string 
)

Parses a Calendar scheduling message string into ScheduleMessage object.

Parameters:
calendar is a pointer to a Calendar object associated with the scheduling message.
string is a QString containing the data to be parsed.
Returns:
a pointer to a ScheduleMessage object if successful; 0 otherwise. The calling routine may later free the return memory.

Definition at line 403 of file icalformat.cpp.

bool ICalFormat::save ( Calendar *  calendar,
const QString &  fileName 
) [virtual]

Writes the calendar to disk.

Parameters:
calendar is the Calendar containing the data to be saved.
fileName is the name of the file to write the calendar data.
Returns:
true if successful; false otherwise.

Implements KCal::CalFormat.

Definition at line 110 of file icalformat.cpp.

void ICalFormat::setTimeSpec ( const KDateTime::Spec &  timeSpec  ) 

Sets the iCalendar time specification (time zone, etc.

).

Parameters:
timeSpec is the time specification to set.
See also:
timeSpec().

Definition at line 578 of file icalformat.cpp.

KDateTime::Spec ICalFormat::timeSpec (  )  const

Returns the iCalendar time specification.

See also:
setTimeSpec().

Definition at line 583 of file icalformat.cpp.

QString ICalFormat::timeZoneId (  )  const

Returns the timezone id string used by the iCalendar; an empty string if the iCalendar does not have a timezone.

Definition at line 588 of file icalformat.cpp.

QString ICalFormat::toICalString ( Incidence *  incidence  ) 

Converts an Incidence to iCalendar formatted text.

Parameters:
incidence is a pointer to an Incidence object to be converted into iCal formatted text.
Returns:
the QString will be Null if the conversion was unsuccessful.

Definition at line 290 of file icalformat.cpp.

QString ICalFormat::toString ( RecurrenceRule *  rule  ) 

Converts a RecurrenceRule to a QString.

Parameters:
rule is a pointer to a RecurrenceRule object to be converted into a QString.
Returns:
the QString will be Null if the conversion was unsuccessful.

Definition at line 310 of file icalformat.cpp.

QString ICalFormat::toString ( Incidence *  incidence  ) 

Converts an Incidence to a QString.

Parameters:
incidence is a pointer to an Incidence object to be converted into a QString.
Returns:
the QString will be Null if the conversion was unsuccessful.

Definition at line 297 of file icalformat.cpp.

QString ICalFormat::toString ( Calendar *  calendar  )  [virtual]

Returns the calendar as a string.

Parameters:
calendar is the Calendar containing the data to be saved.
Returns:
a QString containing the Calendar data if successful; an empty string otherwise.
See also:
fromString(), fromRawString().

Implements KCal::CalFormat.

Definition at line 229 of file icalformat.cpp.


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

KCal Library

Skip menu "KCal 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
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
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