• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.4 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • KCal
  • ICalFormat
Public Member Functions
KCal::ICalFormat Class Reference

#include <icalformat.h>

Inheritance diagram for KCal::ICalFormat:
KCal::CalFormat

List of all members.

Public Member Functions

 ICalFormat ()
virtual ~ICalFormat ()
QString createScheduleMessage (IncidenceBase *incidence, iTIPMethod method)
bool fromRawString (Calendar *calendar, const QByteArray &string)
bool fromString (Calendar *calendar, const QString &string)
Incidence * fromString (const QString &string)
bool fromString (RecurrenceRule *rule, const QString &string)
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 (Calendar *calendar)
QString toString (Incidence *incidence)
QString toString (RecurrenceRule *rule)
- Public Member Functions inherited from KCal::CalFormat
 CalFormat ()
virtual ~CalFormat ()
void clearException ()
ErrorFormat * exception ()
const QString & loadedProductId ()
void setException (ErrorFormat *error)

Additional Inherited Members

- Static Public Member Functions inherited from KCal::CalFormat
static const QString & application ()
static QString createUniqueId ()
static const QString & productId ()
static void setApplication (const QString &application, const QString &productID)
- Protected Member Functions inherited from KCal::CalFormat
void setLoadedProductId (const QString &id)

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:
incidenceis a pointer to an IncidenceBase object to be scheduled.
methodis 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

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

Parameters:
calendaris the Calendar to be loaded.
stringis 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 ( Calendar *  calendar,
const QString &  string 
)
virtual

Parameters:
calendaris the Calendar to be loaded.
stringis 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.

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

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

Parameters:
stringis 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 ( RecurrenceRule *  rule,
const QString &  string 
)

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

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

Definition at line 319 of file icalformat.cpp.

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

Parameters:
calendaris the Calendar to be loaded.
fileNameis 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:
stringis 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:
calendaris a pointer to a Calendar object associated with the scheduling message.
stringis 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

Parameters:
calendaris the Calendar containing the data to be saved.
fileNameis 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:
timeSpecis 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:
incidenceis 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 ( Calendar *  calendar)
virtual

Parameters:
calendaris 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.

QString ICalFormat::toString ( Incidence *  incidence)

Converts an Incidence to a QString.

Parameters:
incidenceis 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 ( RecurrenceRule *  rule)

Converts a RecurrenceRule to a QString.

Parameters:
ruleis 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.


The documentation for this class was generated from the following files:
  • icalformat.h
  • icalformat.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Mon Jun 24 2013 13:01:23 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

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

kdepimlibs-4.10.4 API Reference

Skip menu "kdepimlibs-4.10.4 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal