KDAV2::DavCollection

KDAV2::DavCollection Class Reference

#include <davcollection.h>

Public Types

enum  ContentType {
  Events = 1, Todos = 2, Contacts = 4, FreeBusy = 8,
  Journal = 16, Calendar = 32
}
 
typedef QFlags< ContentTypeContentTypes
 
typedef QVector< DavCollectionList
 

Public Member Functions

 DavCollection ()
 
 DavCollection (const DavUrl &url, const QString &displayName, ContentTypes contentTypes)
 
 DavCollection (const DavCollection &other)
 
QColor color () const
 
ContentTypes contentTypes () const
 
QString CTag () const
 
QString displayName () const
 
DavCollectionoperator= (const DavCollection &other)
 
Privileges privileges () const
 
void setColor (const QColor &color)
 
void setContentTypes (ContentTypes types)
 
void setCTag (const QString &ctag)
 
void setDisplayName (const QString &name)
 
void setPrivileges (Privileges privs)
 
void setUrl (const DavUrl &url)
 
DavUrl url () const
 

Detailed Description

A helper class to store information about DAV collection.

This class is used as container to transfer information about DAV collections between the Akonadi resource and the DAV jobs.

Definition at line 49 of file davcollection.h.

Member Typedef Documentation

Defines a list of DAV collection objects.

Definition at line 55 of file davcollection.h.

Member Enumeration Documentation

Describes the possible content type of the DAV collection.

Enumerator
Events 

The collection can contain event DAV resources.

Todos 

The collection can contain todo DAV resources.

Contacts 

The collection can contain contact DAV resources.

FreeBusy 

The collection can contain free/busy information.

Journal 

The collection can contain journal DAV resources.

Calendar 

The collection can contain anything calendar-related.

Definition at line 60 of file davcollection.h.

Constructor & Destructor Documentation

DavCollection::DavCollection ( )

Creates an empty DAV collection.

Definition at line 54 of file davcollection.cpp.

DavCollection::DavCollection ( const DavUrl url,
const QString displayName,
ContentTypes  contentTypes 
)

Creates a new DAV collection.

Parameters
urlThe url that identifies the collection.
displayNameThe display name of the collection.
contentTypesThe possible content types of the collection.

Definition at line 59 of file davcollection.cpp.

Member Function Documentation

QColor DavCollection::color ( ) const

Return the color of the collection, or an empty string if none was provided by the backend.

Definition at line 119 of file davcollection.cpp.

DavCollection::ContentTypes DavCollection::contentTypes ( ) const

Returns the possible content types of the collection.

Definition at line 129 of file davcollection.cpp.

QString DavCollection::CTag ( ) const

Returns this collection CTag.

The returned value will be empty if no CTag was found.

Definition at line 89 of file davcollection.cpp.

QString DavCollection::displayName ( ) const

Returns the display name of the collection.

Definition at line 109 of file davcollection.cpp.

Privileges DavCollection::privileges ( ) const

Returns the privileges on this collection.

Definition at line 139 of file davcollection.cpp.

void DavCollection::setColor ( const QColor color)

Sets the color for this collection.

Definition at line 114 of file davcollection.cpp.

void DavCollection::setContentTypes ( ContentTypes  types)

Sets the possible content types of the collection.

Definition at line 124 of file davcollection.cpp.

void DavCollection::setCTag ( const QString ctag)

Sets this collection CTag.

Definition at line 84 of file davcollection.cpp.

void DavCollection::setDisplayName ( const QString name)

Sets the display name of the collection.

Definition at line 104 of file davcollection.cpp.

void DavCollection::setPrivileges ( Privileges  privs)

Sets the privileges on this collection.

Definition at line 134 of file davcollection.cpp.

void DavCollection::setUrl ( const DavUrl url)

Sets the url that identifies the collection.

Definition at line 94 of file davcollection.cpp.

DavUrl DavCollection::url ( ) const

Returns the url that identifies the collection.

Definition at line 99 of file davcollection.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 Thu Nov 26 2020 23:17:36 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.