Akonadi::CalendarClipboard

Search for usage in LXR

Akonadi::CalendarClipboard Class Reference

#include <calendarclipboard.h>

Inheritance diagram for Akonadi::CalendarClipboard:

Public Types

enum  Mode { SingleMode = 0 , RecursiveMode , AskMode }
 
- Public Types inherited from QObject
typedef  QObjectList
 

Signals

void cutFinished (bool success, const QString &errorMessage)
 

Public Member Functions

 CalendarClipboard (const Akonadi::CalendarBase::Ptr &calendar, Akonadi::IncidenceChanger *changer=nullptr, QObject *parent=nullptr)
 
 ~CalendarClipboard () override
 
bool copyIncidence (const KCalendarCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
 
void cutIncidence (const KCalendarCore::Incidence::Ptr &incidence, CalendarClipboard::Mode mode=RecursiveMode)
 
bool pasteAvailable () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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 28 of file calendarclipboard.h.

Member Enumeration Documentation

◆ 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 32 of file calendarclipboard.h.

Constructor & Destructor Documentation

◆ CalendarClipboard()

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

Constructs a new CalendarClipboard.

Parameters
calendarcalendar containing incidences
changerincidence changer that will delete incidences while copying. If 0, an internal one will be created.
parentQObject parent

Definition at line 162 of file calendarclipboard.cpp.

◆ ~CalendarClipboard()

CalendarClipboard::~CalendarClipboard ( )
overridedefault

Destroys the CalendarClipboard instance.

Member Function Documentation

◆ copyIncidence()

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

Copies the specified incidence into the clipboard.

Parameters
incidencethe incidence to copy
modehow to treat child incidences. Defaults to RecursiveMode
Returns
true on success

Definition at line 210 of file calendarclipboard.cpp.

◆ cutFinished

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

Emitted after cutIncidences() finishes.

Parameters
successtrue if the cut was successful
errorMessageif success if false, contains the error message, empty otherwise.

◆ cutIncidence()

void CalendarClipboard::cutIncidence ( const KCalendarCore::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
incidenceto cut
modehow to treat child incidences. Defaults to RecursiveMode
See also
cutFinished().

Definition at line 170 of file calendarclipboard.cpp.

◆ pasteAvailable()

bool CalendarClipboard::pasteAvailable ( ) const
nodiscard

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

Definition at line 248 of file calendarclipboard.cpp.


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 Dec 6 2024 12:07:18 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.