Classes | Public Types | Public Member Functions

mKCal::Notebook Class Reference

Placeholder for Notebook parameters. More...

#include <notebook.h>

List of all members.

Classes

class  Private
 Private class that helps to provide binary compatibility between releases.

Public Types

typedef QSharedPointer< NotebookPtr
 A shared pointer to a Notebook object.
typedef QSharedPointer< const
Notebook
ConstPtr
 A shared pointer to a non-mutable Notebook.
typedef QList< PtrList
 List of notebooks.

Public Member Functions

 Notebook ()
 Constructs a new Notebook object.
 Notebook (const QString &name, const QString &description)
 Notebook (const QString &uid, const QString &name, const QString &description, const QString &color, bool isShared, bool isMaster, bool oviSync, bool isReadOnly, bool isVisible)
 Notebook (const QString &uid, const QString &name, const QString &description, const QString &color, bool isShared, bool isMaster, bool isSynchronized, bool isReadOnly, bool isVisible, const QString &pluginName, const QString &account, int attachmentSize)
 Notebook (const Notebook &n)
 Constructs an Notebook as a copy of another Notebook object.
virtual ~Notebook ()
 Destructor.
QString uid () const
 Returns the uid of the notebook.
void setUid (const QString &uid)
 Set the uid of the notebook.
QString name () const
 Returns the name of the notebook.
void setName (const QString &name)
 Set the name of the notebook.
QString description () const
 Returns the notebook description.
void setDescription (const QString &description)
 Set the description of the notebook.
QString color () const
 Returns the notebook color in the form of RRGGBB.
void setColor (const QString &color)
 Set notebook color.
bool isShared () const
 Returns true if notebook is shared.
void setIsShared (bool isShared)
 Set notebook sharing.
bool isMaster () const
 Returns true if notebook is a master.
void setIsMaster (bool isMaster)
 Set notebook master status.
bool isSynchronized () const
 Returns true if notebook is synchronized to OVI.
void setIsSynchronized (bool oviSync)
 Set notebook OVI sync.
bool isReadOnly () const
 Returns true if notebook is read-only.
void setIsReadOnly (bool isReadOnly)
 Set notebook into read-only mode.
bool isVisible () const
 Returns true if notebook is visible.
void setIsVisible (bool isVisible)
 Set notebook visibility.
bool isRunTimeOnly () const
 Returns true if the notebook is never going to be saved; false otherwise.
void setRunTimeOnly (bool isRunTime)
 Determines if the notebook is only in memory and won't be saved into any storage.
KDateTime syncDate () const
 Returns sync date.
void setSyncDate (const KDateTime &syncDate)
 Sets sync date of notebook.
QString pluginName () const
 Gets the name of the plugin that created the notebook.
void setPluginName (const QString &pluginName)
 Sets the plugin name that created the notebook (if any).
QString account () const
 Gets the account associated with the notebook.
void setAccount (const QString &account)
 Sets the account associated with the notebook (if any).
int attachmentSize () const
 Gets the maximum size of attachments allowed in the notebook.
void setAttachmentSize (int size)
 Sets the size of attachments allowed in the notebook (if any).
KDateTime modifiedDate () const
 Returns modification date, in UTC.
void setModifiedDate (const KDateTime &modifiedDate)
 Sets modified date of notebook.
KDateTime creationDate () const
 Returns creation date, in UTC.
void setCreationDate (const KDateTime &date)
 Sets creation date of notebook.
bool isDefault () const
 Returns true if notebook is default notebook.
void setIsDefault (bool isDefault)
 Set notebook to default notebook.
bool isShareable () const
 Returns true if notebook is shareable.
void setIsShareable (bool isShareable)
 Set notebook to shareable.
QStringList sharedWith () const
 Gets the people shared with the notebook.
QString sharedWithStr () const
 Gets the people shared with the notebook.
void setSharedWith (const QStringList &sharedWith)
 Sets the people shared with the notebook.
void setSharedWithStr (const QString &sharedWith)
 Sets the people shared with the notebook.
QString syncProfile () const
 Gets the sync profile of the notebook.
void setSyncProfile (const QString &syncProfile)
 Sets the sync profile of the notebook.
void setEventsAllowed (bool eventsAllowed)
 Set whether the events are allowed to this notebook or not.
bool eventsAllowed () const
 Accessor querying whether events are allowed in this notebook.
void setJournalsAllowed (bool journalsAllowed)
 Set whether the journals are allowed to this notebook or not.
bool journalsAllowed () const
 Accessor querying whether journals are allowed in this notebook.
void setTodosAllowed (bool todosAllowed)
 Set whether the todos are allowed to this notebook or not.
bool todosAllowed () const
 Accessor querying whether todos are allowed in this notebook.
void setIsHidden (bool isHidden)
 Set notebook as hidden or to be shown.
bool isHidden () const
 Returns true if notebook is hidden.
bool incidenceAllowed (KCalCore::Incidence::Ptr incidence) const
 Utility function to find out whether the incidence is allowed within this notebook or not.
void setFlags (int flags)
 Set the notebook flags.
int flags () const
 Get the flags associated with the notebook.
Notebookoperator= (const Notebook &other)
 Assignment operator.
bool operator== (const Notebook &notebook) const
 Compare this with notebook for equality.

Detailed Description

Placeholder for Notebook parameters.


Member Typedef Documentation

typedef QSharedPointer<const Notebook> mKCal::Notebook::ConstPtr

A shared pointer to a non-mutable Notebook.

typedef QList<Ptr> mKCal::Notebook::List

List of notebooks.

typedef QSharedPointer<Notebook> mKCal::Notebook::Ptr

A shared pointer to a Notebook object.


Constructor & Destructor Documentation

Notebook::Notebook (  )  [explicit]

Constructs a new Notebook object.

Notebook::Notebook ( const QString &  name,
const QString &  description 
) [explicit]
Notebook::Notebook ( const QString &  uid,
const QString &  name,
const QString &  description,
const QString &  color,
bool  isShared,
bool  isMaster,
bool  oviSync,
bool  isReadOnly,
bool  isVisible 
) [explicit]
Notebook::Notebook ( const QString &  uid,
const QString &  name,
const QString &  description,
const QString &  color,
bool  isShared,
bool  isMaster,
bool  isSynchronized,
bool  isReadOnly,
bool  isVisible,
const QString &  pluginName,
const QString &  account,
int  attachmentSize 
) [explicit]
Notebook::Notebook ( const Notebook n  )  [explicit]

Constructs an Notebook as a copy of another Notebook object.

Parameters:
n is the Notebook to copy.
Notebook::~Notebook (  )  [virtual]

Destructor.


Member Function Documentation

QString Notebook::account (  )  const

Gets the account associated with the notebook.

Returns:
The account.
See also:
setAccount().
int Notebook::attachmentSize (  )  const

Gets the maximum size of attachments allowed in the notebook.

Returns:
The size in bytes.
See also:
setAttachmentSize().
QString Notebook::color (  )  const

Returns the notebook color in the form of RRGGBB.

See also:
setColor().
KDateTime Notebook::creationDate (  )  const

Returns creation date, in UTC.

QString Notebook::description (  )  const

Returns the notebook description.

See also:
setDescription().
bool Notebook::eventsAllowed (  )  const

Accessor querying whether events are allowed in this notebook.

int Notebook::flags (  )  const

Get the flags associated with the notebook.

This utility function mostly facilitates easy database loading and saving, as storing the 'flags' is equivalent to getting all the booleans in this API. The content of flags is not public as such.

bool mKCal::Notebook::incidenceAllowed ( KCalCore::Incidence::Ptr  incidence  )  const

Utility function to find out whether the incidence is allowed within this notebook or not.

bool Notebook::isDefault (  )  const

Returns true if notebook is default notebook.

See also:
setIsDefault().
bool Notebook::isHidden (  )  const

Returns true if notebook is hidden.

See also:
setIsHidden().
bool Notebook::isMaster (  )  const

Returns true if notebook is a master.

See also:
setIsMaster().
bool Notebook::isReadOnly (  )  const

Returns true if notebook is read-only.

See also:
setIsReadOnly().
bool Notebook::isRunTimeOnly (  )  const

Returns true if the notebook is never going to be saved; false otherwise.

See also:
setRunTimeOnly().
bool Notebook::isShareable (  )  const

Returns true if notebook is shareable.

See also:
setIsShareable().
bool Notebook::isShared (  )  const

Returns true if notebook is shared.

See also:
setIsShared().
bool Notebook::isSynchronized (  )  const

Returns true if notebook is synchronized to OVI.

See also:
setIsOviSync().
bool Notebook::isVisible (  )  const

Returns true if notebook is visible.

See also:
setIsVisible().
bool Notebook::journalsAllowed (  )  const

Accessor querying whether journals are allowed in this notebook.

KDateTime Notebook::modifiedDate (  )  const

Returns modification date, in UTC.

Every time a property is set, the time is updated.

QString Notebook::name (  )  const

Returns the name of the notebook.

See also:
setName()
Notebook & Notebook::operator= ( const Notebook other  ) 

Assignment operator.

bool Notebook::operator== ( const Notebook notebook  )  const

Compare this with notebook for equality.

QString Notebook::pluginName (  )  const

Gets the name of the plugin that created the notebook.

Returns:
The name of the plugin that owns the notebook.
See also:
setPluginName().
void Notebook::setAccount ( const QString &  account  ) 

Sets the account associated with the notebook (if any).

Parameters:
account The account
See also:
account().
void Notebook::setAttachmentSize ( int  size  ) 

Sets the size of attachments allowed in the notebook (if any).

Parameters:
size The size in bytes. 0 means no attachments allowed; -1 means unlimited size.
See also:
attachmentSize().
void Notebook::setColor ( const QString &  color  ) 

Set notebook color.

Parameters:
color notebook color.
void Notebook::setCreationDate ( const KDateTime &  date  ) 

Sets creation date of notebook.

Used internally.

Parameters:
date creation date.
See also:
creationDate().
void Notebook::setDescription ( const QString &  description  ) 

Set the description of the notebook.

Parameters:
description notebook description.
void Notebook::setEventsAllowed ( bool  eventsAllowed  ) 

Set whether the events are allowed to this notebook or not.

By default, this is true.

void Notebook::setFlags ( int  flags  ) 

Set the notebook flags.

This utility function mostly facilitates easy database loading and saving, as setting the 'flags' is equivalent to setting all the booleans in this API. The content of flags is not public as such.

Parameters:
flags The flags to be set for the notebook.
void Notebook::setIsDefault ( bool  isDefault  ) 

Set notebook to default notebook.

Parameters:
isDefault true to set default.
void Notebook::setIsHidden ( bool  isHidden  ) 

Set notebook as hidden or to be shown.

Parameters:
isHidden true to set as hidden mode.
void Notebook::setIsMaster ( bool  isMaster  ) 

Set notebook master status.

The actual meaning is storage specific.

Parameters:
isMaster true to set master status
void Notebook::setIsReadOnly ( bool  isReadOnly  ) 

Set notebook into read-only mode.

This means that storages will not save any notes for the notebook. Typically used for showing shared notebooks without write permission.

Parameters:
isReadOnly true to set read-only mode
void Notebook::setIsShareable ( bool  isShareable  ) 

Set notebook to shareable.

Parameters:
isShareable true to set shareable.
void Notebook::setIsShared ( bool  isShared  ) 

Set notebook sharing.

The actual meaning is storage specific.

Parameters:
isShared true to allow sharing.
void Notebook::setIsSynchronized ( bool  oviSync  ) 

Set notebook OVI sync.

The actual meaning is storage specific.

Parameters:
oviSync true to set OVI sync.
void Notebook::setIsVisible ( bool  isVisible  ) 

Set notebook visibility.

Calendar will check this value for including/excluding incidences into search lists.

Parameters:
isVisible true to set visible mode.
void Notebook::setJournalsAllowed ( bool  journalsAllowed  ) 

Set whether the journals are allowed to this notebook or not.

By default, this is true.

void Notebook::setModifiedDate ( const KDateTime &  modifiedDate  ) 

Sets modified date of notebook.

Used internally by storages and synchronization services.

Parameters:
modifiedDate last modification date.
See also:
modifiedDate().
void Notebook::setName ( const QString &  name  ) 

Set the name of the notebook.

Parameters:
name notebook name
void Notebook::setPluginName ( const QString &  pluginName  ) 

Sets the plugin name that created the notebook (if any).

Parameters:
pluginName The name of the plugin.
See also:
pluginName();
void Notebook::setRunTimeOnly ( bool  isRunTime  ) 

Determines if the notebook is only in memory and won't be saved into any storage.

Parameters:
isRunTime true if the incidence is never going to be saved.
void Notebook::setSharedWith ( const QStringList &  sharedWith  ) 

Sets the people shared with the notebook.

Parameters:
sharedWith The list of people shared with
See also:
sharedWith().
void Notebook::setSharedWithStr ( const QString &  sharedWith  ) 

Sets the people shared with the notebook.

Parameters:
sharedWith The string of people shared with.
See also:
sharedWithStr().
void Notebook::setSyncDate ( const KDateTime &  syncDate  ) 

Sets sync date of notebook.

Used internally by storages and synchronization services.

Parameters:
syncDate last sync date.
See also:
syncDate().
void Notebook::setSyncProfile ( const QString &  syncProfile  ) 

Sets the sync profile of the notebook.

Parameters:
syncProfile string of sync profile
See also:
syncProfile();
void Notebook::setTodosAllowed ( bool  todosAllowed  ) 

Set whether the todos are allowed to this notebook or not.

By default, this is true.

void Notebook::setUid ( const QString &  uid  ) 

Set the uid of the notebook.

Typically called internally by the storage.

Parameters:
uid unique identifier.
QStringList Notebook::sharedWith (  )  const

Gets the people shared with the notebook.

Returns:
list of people shared with.
See also:
setSharedWith().
QString Notebook::sharedWithStr (  )  const

Gets the people shared with the notebook.

Returns:
string of people shared with.
See also:
setSharedWithStr().
KDateTime Notebook::syncDate (  )  const

Returns sync date.

See also:
setSyncDate().
QString Notebook::syncProfile (  )  const

Gets the sync profile of the notebook.

Returns:
string sync profile.
See also:
setSyncProfile()
bool Notebook::todosAllowed (  )  const

Accessor querying whether todos are allowed in this notebook.

QString Notebook::uid (  )  const

Returns the uid of the notebook.

See also:
setUid().

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

Generated on Tue Jul 5 2011 16:40:27 for libmkcal by doxygen 1.7.1