• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • Tag
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Akonadi::Tag Class Reference

#include <tag.h>

Inheritance diagram for Akonadi::Tag:
Akonadi::AttributeEntity

Public Types

typedef qint64 Id
 
typedef QList< Tag > List
 
- Public Types inherited from Akonadi::AttributeEntity
enum  CreateOption { AddIfMissing }
 

Public Member Functions

 Tag (const QString &name)
 
 Tag (const Tag &other)
 
 Tag (Id id)
 
QByteArray gid () const
 
Id id () const
 
bool isImmutable () const
 
bool isValid () const
 
QString name () const
 
AttributeEntity & operator= (const AttributeEntity &)
 
Tag & operator= (const Tag &)
 
bool operator== (const Tag &) const
 
Tag parent () const
 
QByteArray remoteId () const
 
void setGid (const QByteArray &gid) const
 
void setId (Id identifier)
 
void setName (const QString &name)
 
void setParent (const Tag &parent)
 
void setRemoteId (const QByteArray &remoteId) const
 
void setType (const QByteArray &type) const
 
QByteArray type () const
 
KUrl url () const
 
- Public Member Functions inherited from Akonadi::AttributeEntity
 AttributeEntity (const AttributeEntity &other)
 
void addAttribute (Attribute *attribute)
 
template<typename T >
T * attribute () const
 
Attribute * attribute (const QByteArray &name) const
 
template<typename T >
T * attribute (CreateOption option)
 
Attribute::List attributes () const
 
void clearAttributes ()
 
template<typename T >
bool hasAttribute () const
 
bool hasAttribute (const QByteArray &name) const
 
template<typename T >
void removeAttribute ()
 
void removeAttribute (const QByteArray &name)
 

Static Public Member Functions

static Tag fromUrl (const KUrl &url)
 

Static Public Attributes

static const char * PLAIN = "PLAIN"
 

Detailed Description

An Akonadi Tag.

Definition at line 43 of file tag.h.

Member Typedef Documentation

◆ Id

typedef qint64 Akonadi::Tag::Id

Definition at line 47 of file tag.h.

◆ List

typedef QList<Tag> Akonadi::Tag::List

Definition at line 46 of file tag.h.

Constructor & Destructor Documentation

◆ Tag() [1/4]

Tag::Tag ( )

Definition at line 42 of file tag.cpp.

◆ Tag() [2/4]

Tag::Tag ( Tag::Id id)
explicit

Definition at line 49 of file tag.cpp.

◆ Tag() [3/4]

Tag::Tag ( const QString & name)
explicit

Creates a PLAIN tag.

Definition at line 56 of file tag.cpp.

◆ Tag() [4/4]

Tag::Tag ( const Tag & other)

Definition at line 65 of file tag.cpp.

◆ ~Tag()

Tag::~Tag ( )

Definition at line 72 of file tag.cpp.

Member Function Documentation

◆ fromUrl()

Tag Tag::fromUrl ( const KUrl & url)
static

Definition at line 102 of file tag.cpp.

◆ gid()

QByteArray Tag::gid ( ) const

Definition at line 141 of file tag.cpp.

◆ id()

Tag::Id Tag::id ( ) const

Returns the unique identifier of the tag.

Definition at line 131 of file tag.cpp.

◆ isImmutable()

bool Tag::isImmutable ( ) const

Returns true if the tag is immutable (cannot be modified after creation).

Note that the immutability does not affect the attributes.

Definition at line 201 of file tag.cpp.

◆ isValid()

bool Tag::isValid ( ) const

Definition at line 196 of file tag.cpp.

◆ name()

QString Tag::name ( ) const

Definition at line 164 of file tag.cpp.

◆ operator=() [1/2]

AttributeEntity & Tag::operator= ( const AttributeEntity & other)
virtual

Reimplemented from Akonadi::AttributeEntity.

Definition at line 89 of file tag.cpp.

◆ operator=() [2/2]

Tag & Tag::operator= ( const Tag & other)

Definition at line 76 of file tag.cpp.

◆ operator==()

bool Tag::operator== ( const Tag & other) const

Definition at line 94 of file tag.cpp.

◆ parent()

Tag Tag::parent ( ) const

Definition at line 178 of file tag.cpp.

◆ remoteId()

QByteArray Tag::remoteId ( ) const

Definition at line 151 of file tag.cpp.

◆ setGid()

void Tag::setGid ( const QByteArray & gid) const

Definition at line 136 of file tag.cpp.

◆ setId()

void Tag::setId ( Tag::Id identifier)

Sets the unique identifier of the tag.

Definition at line 126 of file tag.cpp.

◆ setName()

void Tag::setName ( const QString & name)

Definition at line 156 of file tag.cpp.

◆ setParent()

void Tag::setParent ( const Tag & parent)

Definition at line 171 of file tag.cpp.

◆ setRemoteId()

void Tag::setRemoteId ( const QByteArray & remoteId) const

Definition at line 146 of file tag.cpp.

◆ setType()

void Tag::setType ( const QByteArray & type) const

Definition at line 186 of file tag.cpp.

◆ type()

QByteArray Tag::type ( ) const

Definition at line 191 of file tag.cpp.

◆ url()

KUrl Tag::url ( ) const

Returns the url of the tag.

Definition at line 118 of file tag.cpp.

Member Data Documentation

◆ PLAIN

const char * Akonadi::Tag::PLAIN = "PLAIN"
static

The PLAIN type has the following properties:

  • gid == displayName
  • immutable
  • no hierarchy (no parent)

PLAIN tags are general purpose tags that are easy to map by backends.

Definition at line 57 of file tag.h.


The documentation for this class was generated from the following files:
  • tag.h
  • tag.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal