KCalendarCore::CalFormat

Search for usage in LXR

#include <calformat.h>

Inheritance diagram for KCalendarCore::CalFormat:

Public Member Functions

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

Static Public Member Functions

static const QStringapplication ()
 
static QString createUniqueId ()
 
static const QStringproductId ()
 
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 38 of file calformat.h.

Constructor & Destructor Documentation

◆ ~CalFormat()

CalFormat::~CalFormat ( )
virtual

Destructor.

Definition at line 37 of file calformat.cpp.

Member Function Documentation

◆ application()

const QString & CalFormat::application ( )
static

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

Definition at line 68 of file calformat.cpp.

◆ clearException()

void CalFormat::clearException ( )

Clears the exception status.

Definition at line 47 of file calformat.cpp.

◆ createUniqueId()

QString CalFormat::createUniqueId ( )
static

Creates a unique id string.

Definition at line 88 of file calformat.cpp.

◆ exception()

Exception * CalFormat::exception ( ) const

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

Definition at line 57 of file calformat.cpp.

◆ fromRawString()

virtual bool KCalendarCore::CalFormat::fromRawString ( const Calendar::Ptr & 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 KCalendarCore::ICalFormat, and KCalendarCore::VCalFormat.

◆ fromString()

bool CalFormat::fromString ( const Calendar::Ptr & calendar,
const QString & string )

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

Definition at line 42 of file calformat.cpp.

◆ load()

virtual bool KCalendarCore::CalFormat::load ( const Calendar::Ptr & 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 KCalendarCore::ICalFormat, and KCalendarCore::VCalFormat.

◆ loadedProductId()

QString CalFormat::loadedProductId ( )

Returns the PRODID string loaded from calendar file.

See also
setLoadedProductId()

Definition at line 78 of file calformat.cpp.

◆ productId()

const QString & CalFormat::productId ( )
static

Returns the our library's PRODID string to write into calendar files.

Definition at line 73 of file calformat.cpp.

◆ save()

virtual bool KCalendarCore::CalFormat::save ( const Calendar::Ptr & 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 KCalendarCore::ICalFormat, and KCalendarCore::VCalFormat.

◆ setApplication()

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 62 of file calformat.cpp.

◆ setException()

void CalFormat::setException ( Exception * error)

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

Parameters
erroris a pointer to an Exception which contains the exception.

Definition at line 52 of file calformat.cpp.

◆ setLoadedProductId()

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

Sets the PRODID string loaded from calendar file.

Parameters
idis a pruduct Id string to set for the calendar file.
See also
loadedProductId()

Definition at line 83 of file calformat.cpp.

◆ toString()

virtual QString KCalendarCore::CalFormat::toString ( const Calendar::Ptr & 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 KCalendarCore::ICalFormat, and KCalendarCore::VCalFormat.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 14 2024 11:55:37 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.