Akonadi::CalendarClipboard Class Reference

#include <calendarclipboard.h>

Inherits QObject.

Public Types
enum	Mode { SingleMode = 0, RecursiveMode, AskMode }

Signals
void	cutFinished (bool success, const QString &errorMessage)

Public Member Functions
	CalendarClipboard (const Akonadi::CalendarBase::Ptr &calendar, Akonadi::IncidenceChanger *changer=0, QObject *parent=0)
	~CalendarClipboard ()
bool	copyIncidence (const KCalCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
void	cutIncidence (const KCalCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
bool	pasteAvailable () const

Detailed Description

Class to copy or cut calendar incidences.

Author

Sérgio Martins iamse.nosp@m.rgio.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Since

4.11

Definition at line 39 of file calendarclipboard.h.

Member Enumeration Documentation

enum Akonadi::CalendarClipboard::Mode

Enumerator
SingleMode	Only the specified incidence is cut/copied.
RecursiveMode	The specified incidence's children are also cut/copied.
AskMode	The user is asked if he wants children to be cut/copied too.

Definition at line 43 of file calendarclipboard.h.

Constructor & Destructor Documentation

CalendarClipboard::CalendarClipboard ( const Akonadi::CalendarBase::Ptr &  calendar, Akonadi::IncidenceChanger *  changer = 0, QObject *  parent = 0  )

explicit

Constructs a new CalendarClipboard.

Parameters

calendar	calendar containing incidences
changer	incidence changer that will delete incidences while copying. If 0, an internal one will be created.
parent	QObject parent

Definition at line 182 of file calendarclipboard.cpp.

CalendarClipboard::~CalendarClipboard

(

)

Destroys the CalendarClipboard instance.

Definition at line 190 of file calendarclipboard.cpp.

Member Function Documentation

bool CalendarClipboard::copyIncidence	(	const KCalCore::Incidence::Ptr &	incidence,
		CalendarClipboard::Mode	mode = RecursiveMode
	)

Copies the specified incidence into the clipboard.

Parameters

incidence	the incidence to copy
mode	how to treat child incidences. Defaults to RecursiveMode

Returns

true on success

Definition at line 234 of file calendarclipboard.cpp.

void Akonadi::CalendarClipboard::cutFinished ( bool  success, const QString &  errorMessage  )

signal

Emitted after cutIncidences() finishes.

Parameters

success	true if the cut was successful
errorMessage	if success if false, contains the error message, empty otherwise.

void CalendarClipboard::cutIncidence	(	const KCalCore::Incidence::Ptr &	incidence,
		CalendarClipboard::Mode	mode = RecursiveMode
	)

Copies the specified incidence into the clipboard and then deletes it from akonadi.

The incidence must be present in the calendar. After it's deletion from akonadi, signal cutFinished() is emitted.

Parameters

incidence	to cut
mode	how to treat child incidences. Defaults to RecursiveMode

See also

cutFinished().

Definition at line 194 of file calendarclipboard.cpp.

bool CalendarClipboard::pasteAvailable

(

)

const

Returns if there's any ical mime data available for pasting.

Definition at line 272 of file calendarclipboard.cpp.

---

The documentation for this class was generated from the following files:

• calendarclipboard.h
• calendarclipboard.cpp