KCalendarCore::FileStorage

KCalendarCore::FileStorage Class Reference

#include <filestorage.h>

Inheritance diagram for KCalendarCore::FileStorage:

Public Types

typedef QSharedPointer< FileStoragePtr
 

Public Member Functions

 FileStorage (const Calendar::Ptr &calendar, const QString &fileName=QString(), KCalendarCore::CalFormat *format=nullptr)
 
 ~FileStorage () override
 
bool close () override
 
QString fileName () const
 
bool load () override
 
bool open () override
 
bool save () override
 
CalFormatsaveFormat () const
 
void setFileName (const QString &fileName)
 
void setSaveFormat (KCalendarCore::CalFormat *format)
 
- Public Member Functions inherited from KCalendarCore::CalStorage
 CalStorage (const Calendar::Ptr &calendar)
 
 ~CalStorage () override
 
Calendar::Ptr calendar () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
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 QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
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_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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

This class provides a calendar storage as a local file.

Definition at line 32 of file filestorage.h.

Member Typedef Documentation

A shared pointer to a FileStorage.

Definition at line 40 of file filestorage.h.

Constructor & Destructor Documentation

FileStorage::FileStorage ( const Calendar::Ptr calendar,
const QString fileName = QString(),
KCalendarCore::CalFormat format = nullptr 
)
explicit

Constructs a new FileStorage object for Calendar calendar with format format, and storage to file fileName.

Parameters
calendaris a pointer to a valid Calendar object.
fileNameis the name of the disk file containing the calendar data.
formatis a pointer to a valid CalFormat object that specifies the calendar format to be used. FileStorage takes ownership; i.e., the memory for format is deleted by this destructor. If no format is specified, then iCalendar format is assumed.

Definition at line 49 of file filestorage.cpp.

FileStorage::~FileStorage ( )
override

Destructor.

Definition at line 56 of file filestorage.cpp.

Member Function Documentation

bool FileStorage::close ( )
overridevirtual

Closes the calendar storage.

Returns
true if the close was successful; false otherwise.

Implements KCalendarCore::CalStorage.

Definition at line 172 of file filestorage.cpp.

QString FileStorage::fileName ( ) const

Returns the calendar file name.

Returns
A QString with the name of the calendar file for this storge.
See also
setFileName().

Definition at line 66 of file filestorage.cpp.

bool FileStorage::load ( )
overridevirtual

Loads the calendar into memory.

Returns
true if the load was successful; false otherwise.

Implements KCalendarCore::CalStorage.

Definition at line 87 of file filestorage.cpp.

bool FileStorage::open ( )
overridevirtual

Opens the calendar for storage.

Returns
true if the open was successful; false otherwise.

Implements KCalendarCore::CalStorage.

Definition at line 82 of file filestorage.cpp.

bool FileStorage::save ( )
overridevirtual

Saves the calendar.

Returns
true if the save was successful; false otherwise.

Implements KCalendarCore::CalStorage.

Definition at line 145 of file filestorage.cpp.

CalFormat * FileStorage::saveFormat ( ) const

Returns the CalFormat object used by this storage.

Returns
A pointer to the CalFormat object used by this storage.
See also
setSaveFormat().

Definition at line 77 of file filestorage.cpp.

void FileStorage::setFileName ( const QString fileName)

Sets the name of the file that contains the calendar data.

Parameters
fileNameis the name of the disk file containing the calendar data.
See also
fileName().

Definition at line 61 of file filestorage.cpp.

void FileStorage::setSaveFormat ( KCalendarCore::CalFormat format)

Sets the CalFormat object to use for this storage.

Parameters
formatis a pointer to a valid CalFormat object that specifies the calendar format to be used. FileStorage takes ownership.
See also
saveFormat().

Definition at line 71 of file filestorage.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jul 1 2020 22:49:15 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.