30#ifndef MKCAL_NOTEBOOK_H
31#define MKCAL_NOTEBOOK_H
35#include <KCalendarCore/Incidence>
37#include <QtCore/QList>
51 typedef QSharedPointer<Notebook>
Ptr;
56 typedef QSharedPointer<const Notebook>
ConstPtr;
110 QString
name()
const;
135 QString
color()
const;
419 QString
customProperty(
const QByteArray &key,
const QString &defaultValue = QString())
const;
QSharedPointer< const Notebook > ConstPtr
A shared pointer to a non-mutable Notebook.
Definition notebook.h:56
void setPluginName(const QString &pluginName)
Sets the plugin name that created the notebook (if any).
Definition notebook.cpp:337
Notebook()
Constructs a new Notebook object.
Definition notebook.cpp:129
QDateTime modifiedDate() const
Returns modification date, in UTC.
Definition notebook.cpp:365
void setSyncProfile(const QString &syncProfile)
Sets the sync profile of the notebook.
Definition notebook.cpp:434
void setSharedWithStr(const QString &sharedWith)
Sets the people shared with the notebook.
Definition notebook.cpp:412
QList< QByteArray > customPropertyKeys() const
List the keys of all stored custom properties.
Definition notebook.cpp:519
void setAccount(const QString &account)
Sets the account associated with the notebook (if any).
Definition notebook.cpp:348
QString description() const
Returns the notebook description.
Definition notebook.cpp:234
void setIsSynchronized(bool oviSync)
Set notebook OVI sync.
Definition notebook.cpp:282
void setSharedWith(const QStringList &sharedWith)
Sets the people shared with the notebook.
Definition notebook.cpp:406
QString customProperty(const QByteArray &key, const QString &defaultValue=QString()) const
A getter function for a custom property, see setCustomProperty().
Definition notebook.cpp:514
QString account() const
Gets the account associated with the notebook.
Definition notebook.cpp:343
void setUid(const QString &uid)
Set the uid of the notebook.
Definition notebook.cpp:219
QSharedPointer< Notebook > Ptr
A shared pointer to a Notebook object.
Definition notebook.h:51
QString uid() const
Returns the uid of the notebook.
Definition notebook.cpp:214
void setIsShared(bool isShared)
Set notebook sharing.
Definition notebook.cpp:260
bool isRunTimeOnly() const
Returns true if the notebook is never going to be saved; false otherwise.
Definition notebook.cpp:310
QStringList sharedWith() const
Gets the people shared with the notebook.
Definition notebook.cpp:396
void setJournalsAllowed(bool journalsAllowed)
Set whether the journals are allowed to this notebook or not.
Definition notebook.cpp:451
void setCustomProperty(const QByteArray &key, const QString &value)
Set a key/value property.
Definition notebook.cpp:504
QString color() const
Returns the notebook color in the form of #RRGGBB.
Definition notebook.cpp:244
bool isVisible() const
Returns true if notebook is visible.
Definition notebook.cpp:299
void setEventsAllowed(bool eventsAllowed)
Set whether the events are allowed to this notebook or not.
Definition notebook.cpp:440
bool isShareable() const
Returns true if notebook is shareable.
Definition notebook.cpp:385
bool isShared() const
Returns true if notebook is shared.
Definition notebook.cpp:255
QDateTime creationDate() const
Returns creation date, in UTC.
Definition notebook.cpp:375
void setTodosAllowed(bool todosAllowed)
Set whether the todos are allowed to this notebook or not.
Definition notebook.cpp:462
QString name() const
Returns the name of the notebook.
Definition notebook.cpp:224
QString pluginName() const
Gets the name of the plugin that created the notebook.
Definition notebook.cpp:332
void setDescription(const QString &description)
Set the description of the notebook.
Definition notebook.cpp:239
void setIsReadOnly(bool isReadOnly)
Set notebook into read-only mode.
Definition notebook.cpp:293
void setCreationDate(const QDateTime &date)
Sets creation date of notebook.
Definition notebook.cpp:380
bool isSynchronized() const
Returns true if notebook is synchronized to OVI.
Definition notebook.cpp:277
QString sharedWithStr() const
Gets the people shared with the notebook.
Definition notebook.cpp:401
void setIsVisible(bool isVisible)
Set notebook visibility.
Definition notebook.cpp:304
bool isMaster() const
Returns true if notebook is a master.
Definition notebook.cpp:266
QList< Ptr > List
List of notebooks.
Definition notebook.h:61
void setModifiedDate(const QDateTime &modifiedDate)
Sets modified date of notebook.
Definition notebook.cpp:370
bool operator==(const Notebook ¬ebook) const
Compare this with notebook for equality.
Definition notebook.cpp:199
void setIsMaster(bool isMaster)
Set notebook master status.
Definition notebook.cpp:271
QString syncProfile() const
Gets the sync profile of the notebook.
Definition notebook.cpp:429
bool isReadOnly() const
Returns true if notebook is read-only.
Definition notebook.cpp:288
void setColor(const QString &color)
Set notebook color.
Definition notebook.cpp:249
void setSyncDate(const QDateTime &syncDate)
Sets sync date of notebook.
Definition notebook.cpp:326
void setRunTimeOnly(bool isRunTime)
Determines if the notebook is only in memory and won't be saved into any storage.
Definition notebook.cpp:315
void setIsShareable(bool isShareable)
Set notebook to shareable.
Definition notebook.cpp:390
bool todosAllowed() const
Accessor querying whether todos are allowed in this notebook.
Definition notebook.cpp:468
void setName(const QString &name)
Set the name of the notebook.
Definition notebook.cpp:229
bool incidenceAllowed(KCalendarCore::Incidence::Ptr incidence) const
Utility function to find out whether the incidence is allowed within this notebook or not.
Definition notebook.cpp:473
Notebook & operator=(const Notebook &other)
Assignment operator.
Definition notebook.cpp:189
QDateTime syncDate() const
Returns sync date.
Definition notebook.cpp:321
bool journalsAllowed() const
Accessor querying whether journals are allowed in this notebook.
Definition notebook.cpp:457
bool eventsAllowed() const
Accessor querying whether events are allowed in this notebook.
Definition notebook.cpp:446
int attachmentSize() const
Gets the maximum size of attachments allowed in the notebook.
Definition notebook.cpp:354
void setAttachmentSize(int size)
Sets the size of attachments allowed in the notebook (if any).
Definition notebook.cpp:359
#define MKCAL_EXPORT
Definition mkcal_export.h:27
Definition extendedstorage.h:49