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

KCal Library

  • KCal
  • CalFormat
Public Member Functions | Static Public Member Functions | Protected Member Functions
KCal::CalFormat Class Reference

#include <calformat.h>

Inheritance diagram for KCal::CalFormat:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CalFormat ()
virtual ~CalFormat ()
void clearException ()
ErrorFormat * exception ()
virtual bool fromRawString (Calendar *calendar, const QByteArray &string)=0
virtual bool fromString (Calendar *calendar, const QString &string)=0
virtual bool load (Calendar *calendar, const QString &fileName)=0
const QString & loadedProductId ()
virtual bool save (Calendar *calendar, const QString &fileName)=0
void setException (ErrorFormat *error)
virtual QString toString (Calendar *calendar)=0

Static Public Member Functions

static const QString & application ()
static QString createUniqueId ()
static const QString & productId ()
static void setApplication (const QString &application, const QString &productID)

Protected Member Functions

void setLoadedProductId (const QString &id)

Detailed Description

An abstract base class that provides an interface to various calendar formats.

This is the base class for calendar formats. It provides an interface for the generation/interpretation of a textual representation of a calendar.

Definition at line 51 of file calformat.h.


Constructor & Destructor Documentation

CalFormat::CalFormat ( )

Constructs a new Calendar Format object.

Private class that helps to provide binary compatibility between releases.

Definition at line 61 of file calformat.cpp.

CalFormat::~CalFormat ( ) [virtual]

Destructor.

Definition at line 66 of file calformat.cpp.


Member Function Documentation

const QString & CalFormat::application ( ) [static]

Returns the application name used in unique IDs and error messages.

Definition at line 95 of file calformat.cpp.

void CalFormat::clearException ( )

Clears the exception status.

Definition at line 71 of file calformat.cpp.

QString CalFormat::createUniqueId ( ) [static]

Creates a unique id string.

Definition at line 115 of file calformat.cpp.

ErrorFormat * CalFormat::exception ( )

Returns an exception, if there is any, containing information about the last error that occurred.

Definition at line 83 of file calformat.cpp.

virtual bool KCal::CalFormat::fromRawString ( Calendar *  calendar,
const QByteArray &  string 
) [pure 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:
calendaris the Calendar to be loaded.
stringis the QByteArray containing the Calendar data.
Returns:
true if successful; false otherwise.
See also:
fromString(), toString().

Implemented in KCal::ICalFormat, and KCal::QtopiaFormat.

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

Loads a calendar from a string.

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

Implemented in KCal::ICalFormat, and KCal::QtopiaFormat.

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

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

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

Implemented in KCal::ICalFormat, and KCal::QtopiaFormat.

const QString & CalFormat::loadedProductId ( )

Returns the PRODID string loaded from calendar file.

Definition at line 105 of file calformat.cpp.

const QString & CalFormat::productId ( ) [static]

Returns the PRODID string to write into calendar files.

Definition at line 100 of file calformat.cpp.

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

Writes the calendar to disk.

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.

Implemented in KCal::ICalFormat, and KCal::QtopiaFormat.

void CalFormat::setApplication ( const QString &  application,
const QString &  productID 
) [static]

Sets the application name for use in unique IDs and error messages, and product ID for incidence PRODID property.

Parameters:
applicationis a string containing the application name.
productIDis a string containing the product identifier.

Definition at line 88 of file calformat.cpp.

void CalFormat::setException ( ErrorFormat *  error)

Sets an exception that is to be used by the functions of this class to report errors.

Parameters:
erroris a pointer to an ErrorFormat which contains the exception.

Definition at line 77 of file calformat.cpp.

void CalFormat::setLoadedProductId ( const QString &  id) [protected]

PRODID string loaded from calendar file.

Definition at line 110 of file calformat.cpp.

virtual QString KCal::CalFormat::toString ( Calendar *  calendar) [pure virtual]

Returns the calendar as a string.

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().

Implemented in KCal::ICalFormat, and KCal::QtopiaFormat.


The documentation for this class was generated from the following files:
  • calformat.h
  • calformat.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Tue May 8 2012 00:03:22 by doxygen 1.8.0 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.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • 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
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