PimCommon::CollectionTypeUtil Class

class PimCommon::CollectionTypeUtil

The CollectionTypeUtil class provides utilities for collection type handling Author: Laurent Montel <montel@kde.org>. More...

Header: #include <PimCommonAkonadi/CollectionTypeUtil>
CMake: find_package(KPim6PimCommonAkonadi REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommonAkonadi)

Public Functions

CollectionTypeUtil()
~CollectionTypeUtil()
PimCommon::CollectionTypeUtil::FolderContentsType contentsTypeFromString(const QString &type)
QString folderContentDescription(PimCommon::CollectionTypeUtil::FolderContentsType type)
QString iconNameFromContentsType(PimCommon::CollectionTypeUtil::FolderContentsType type)
PimCommon::CollectionTypeUtil::IncidencesFor incidencesForFromString(const QString &string)
QString incidencesForToString(PimCommon::CollectionTypeUtil::IncidencesFor type)
QByteArray kolabNameFromType(PimCommon::CollectionTypeUtil::FolderContentsType type)
PimCommon::CollectionTypeUtil::FolderContentsType typeFromKolabName(const QByteArray &name)
QString typeNameFromKolabType(const QByteArray &type)

Static Public Members

QByteArray kolabFolderType()
QByteArray kolabIncidencesFor()
QByteArray kolabSharedSeen()

Detailed Description

Member Function Documentation

CollectionTypeUtil::CollectionTypeUtil()

Constructs a CollectionTypeUtil.

[noexcept] CollectionTypeUtil::~CollectionTypeUtil()

Destructs the CollectionTypeUtil.

PimCommon::CollectionTypeUtil::FolderContentsType CollectionTypeUtil::contentsTypeFromString(const QString &type)

Converts a string to a FolderContentsType. @param type The type string @return The corresponding FolderContentsType

QString CollectionTypeUtil::folderContentDescription(PimCommon::CollectionTypeUtil::FolderContentsType type)

Returns a human-readable description for a folder contents type. @param type The folder contents type @return The description string

QString CollectionTypeUtil::iconNameFromContentsType(PimCommon::CollectionTypeUtil::FolderContentsType type)

Returns an icon name for a folder contents type. @param type The folder contents type @return The icon name

PimCommon::CollectionTypeUtil::IncidencesFor CollectionTypeUtil::incidencesForFromString(const QString &string)

Converts a string to an IncidencesFor value. @param string The string to convert @return The corresponding IncidencesFor value

QString CollectionTypeUtil::incidencesForToString(PimCommon::CollectionTypeUtil::IncidencesFor type)

Converts an IncidencesFor value to a string. @param type The IncidencesFor value @return The string representation

[static] QByteArray CollectionTypeUtil::kolabFolderType()

Returns the Kolab folder type attribute name. @return The Kolab folder type as a byte array

[static] QByteArray CollectionTypeUtil::kolabIncidencesFor()

Returns the Kolab incidences-for attribute name. @return The Kolab incidences-for as a byte array

QByteArray CollectionTypeUtil::kolabNameFromType(PimCommon::CollectionTypeUtil::FolderContentsType type)

Converts a FolderContentsType to a Kolab type name. @param type The folder contents type @return The Kolab type name

[static] QByteArray CollectionTypeUtil::kolabSharedSeen()

Returns the Kolab shared-seen attribute name. @return The Kolab shared-seen as a byte array

PimCommon::CollectionTypeUtil::FolderContentsType CollectionTypeUtil::typeFromKolabName(const QByteArray &name)

Converts a Kolab type name to a FolderContentsType. @param name The Kolab type name @return The corresponding FolderContentsType

QString CollectionTypeUtil::typeNameFromKolabType(const QByteArray &type)

Returns a type name from a Kolab type. @param type The Kolab type @return The type name