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

akonadi

  • Akonadi
  • IncidenceMimeTypeVisitor
Public Member Functions | Static Public Member Functions
Akonadi::IncidenceMimeTypeVisitor Class Reference

Helper for getting the Akonadi specific sub MIME type of a KCal::IncidenceBase item, e.g. More...

#include <incidencemimetypevisitor.h>

Inherits Visitor.

List of all members.

Public Member Functions

 IncidenceMimeTypeVisitor ()
virtual ~IncidenceMimeTypeVisitor ()
QStringList allMimeTypes () const
QString mimeType (KCal::IncidenceBase *incidence)
QString mimeType () const
virtual bool visit (KCal::Journal *journal)
virtual bool visit (KCal::Todo *todo)
virtual bool visit (KCal::FreeBusy *freebusy)
virtual bool visit (KCal::Event *event)

Static Public Member Functions

static QString eventMimeType ()
static QString freeBusyMimeType ()
static QString journalMimeType ()
static QString todoMimeType ()

Detailed Description

Helper for getting the Akonadi specific sub MIME type of a KCal::IncidenceBase item, e.g.

getting "application/x-vnd.akonadi.calendar.event" for a KCal::Event.

Usage example: creating Akonadi items for a list of incidences

  KCal::Incidence::List incidences; // assume it is filled somewhere else

  IncidenceMimeTypeVisitor visitor;
  Akonadi::Item::List items;
  foreach ( Incidence *incidence, incidences ) {
    incidence->accept( visitor );

    Akonadi::Item item( visitor.mimeType() );
    item.setPayload<IncidencePtr>( IncidencePtr( incidence->clone() ) );

    items << item;
  }
Since:
4.4

Definition at line 52 of file incidencemimetypevisitor.h.


Constructor & Destructor Documentation

Akonadi::IncidenceMimeTypeVisitor::IncidenceMimeTypeVisitor ( )

Creates a visitor instance.

Until its first visit mimeType() will return QString()

virtual Akonadi::IncidenceMimeTypeVisitor::~IncidenceMimeTypeVisitor ( ) [virtual]

Destroys the instance.


Member Function Documentation

QStringList Akonadi::IncidenceMimeTypeVisitor::allMimeTypes ( ) const

Returns a list of all calendar component sub MIME types.

static QString Akonadi::IncidenceMimeTypeVisitor::eventMimeType ( ) [static]

Returns the sub MIME type for Events.

static QString Akonadi::IncidenceMimeTypeVisitor::freeBusyMimeType ( ) [static]

Returns the sub MIME type for FreeBusys.

static QString Akonadi::IncidenceMimeTypeVisitor::journalMimeType ( ) [static]

Returns the sub MIME type for Journals.

QString Akonadi::IncidenceMimeTypeVisitor::mimeType ( ) const

Returns the Akonadi specific text/calendar sub MIME type of the last incidence visited by this instance.

Returns:
One of the Akonadi sub MIME types for calendar components or QString() if no incidence visited yet
QString Item::mimeType ( KCal::IncidenceBase *  incidence)

Returns the Akonadi specific text/calendar sub MIME type of the given incidence.

This is a convenience method, equivalent to

      incidence->accept( visitor );
      return visitor.mimeType();

Definition at line 175 of file collection.cpp.

static QString Akonadi::IncidenceMimeTypeVisitor::todoMimeType ( ) [static]

Returns the sub MIME type for Todos.

virtual bool Akonadi::IncidenceMimeTypeVisitor::visit ( KCal::Todo *  todo) [virtual]

Sets the MIME type to "application/x-vnd.akonadi.calendar.todo".

Parameters:
todoThe Todo to visit. Not used since the MIME type does not depend on instance specific properties.
Returns:
always returns true
virtual bool Akonadi::IncidenceMimeTypeVisitor::visit ( KCal::Event *  event) [virtual]

Sets the MIME type to "application/x-vnd.akonadi.calendar.event".

Parameters:
eventThe Event to visit. Not used since the MIME type does not depend on instance specific properties.
Returns:
always returns true
virtual bool Akonadi::IncidenceMimeTypeVisitor::visit ( KCal::FreeBusy *  freebusy) [virtual]

Sets the MIME type to "application/x-vnd.akonadi.calendar.freebusy".

Parameters:
freebusyThe FreeBusy to visit. Not used since the MIME type does not depend on instance specific properties.
Returns:
always returns true
virtual bool Akonadi::IncidenceMimeTypeVisitor::visit ( KCal::Journal *  journal) [virtual]

Sets the MIME type to "application/x-vnd.akonadi.calendar.journal".

Parameters:
journalThe Journal to visit. Not used since the MIME type does not depend on instance specific properties.
Returns:
always returns true

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

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • 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.4
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