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

akonadi

  • Akonadi
  • IncidenceMimeTypeVisitor
Public Member Functions | Static Public Member Functions | List of all members
Akonadi::IncidenceMimeTypeVisitor Class Reference

#include <incidencemimetypevisitor.h>

Inherits KCal::IncidenceBase::Visitor.

Public Member Functions

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

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;
}
Akonadi::IncidenceMimeTypeVisitor
Helper for getting the Akonadi specific sub MIME type of a KCal::IncidenceBase item,...
Definition: incidencemimetypevisitor.h:53
Akonadi::IncidenceMimeTypeVisitor::mimeType
QString mimeType() const
Returns the Akonadi specific text/calendar sub MIME type of the last incidence visited by this instan...
Definition: incidencemimetypevisitor.cpp:77
Since
4.4

Definition at line 52 of file incidencemimetypevisitor.h.

Constructor & Destructor Documentation

◆ IncidenceMimeTypeVisitor()

IncidenceMimeTypeVisitor::IncidenceMimeTypeVisitor ( )

Creates a visitor instance.

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

Definition at line 39 of file incidencemimetypevisitor.cpp.

◆ ~IncidenceMimeTypeVisitor()

IncidenceMimeTypeVisitor::~IncidenceMimeTypeVisitor ( )
virtual

Destroys the instance.

Definition at line 44 of file incidencemimetypevisitor.cpp.

Member Function Documentation

◆ allMimeTypes()

QStringList IncidenceMimeTypeVisitor::allMimeTypes ( ) const

Returns a list of all calendar component sub MIME types.

Definition at line 82 of file incidencemimetypevisitor.cpp.

◆ eventMimeType()

QString IncidenceMimeTypeVisitor::eventMimeType ( )
static

Returns the sub MIME type for Events.

Definition at line 95 of file incidencemimetypevisitor.cpp.

◆ freeBusyMimeType()

QString IncidenceMimeTypeVisitor::freeBusyMimeType ( )
static

Returns the sub MIME type for FreeBusys.

Definition at line 110 of file incidencemimetypevisitor.cpp.

◆ journalMimeType()

QString IncidenceMimeTypeVisitor::journalMimeType ( )
static

Returns the sub MIME type for Journals.

Definition at line 105 of file incidencemimetypevisitor.cpp.

◆ mimeType() [1/2]

QString 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

Definition at line 77 of file incidencemimetypevisitor.cpp.

◆ mimeType() [2/2]

QString IncidenceMimeTypeVisitor::mimeType ( KCal::IncidenceBase *  incidence)

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

Parameters
incidencethe incidence to retrieve MIME type from This is a convenience method, equivalent to
incidence->accept( visitor );
return visitor.mimeType();

Definition at line 87 of file incidencemimetypevisitor.cpp.

◆ todoMimeType()

QString IncidenceMimeTypeVisitor::todoMimeType ( )
static

Returns the sub MIME type for Todos.

Definition at line 100 of file incidencemimetypevisitor.cpp.

◆ visit() [1/4]

bool 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

Definition at line 49 of file incidencemimetypevisitor.cpp.

◆ visit() [2/4]

bool 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

Definition at line 70 of file incidencemimetypevisitor.cpp.

◆ visit() [3/4]

bool 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

Definition at line 63 of file incidencemimetypevisitor.cpp.

◆ visit() [4/4]

bool 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

Definition at line 56 of file incidencemimetypevisitor.cpp.


The documentation for this class was generated from the following files:
  • incidencemimetypevisitor.h
  • incidencemimetypevisitor.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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