Akonadi::AgentType

Akonadi::AgentType Class Reference

#include <agenttype.h>

Public Types

typedef QVector< AgentTypeList
 

Public Member Functions

 AgentType ()
 
 AgentType (const AgentType &other)
 
 ~AgentType ()
 
QStringList capabilities () const
 
QVariantMap customProperties () const
 
QString description () const
 
QIcon icon () const
 
QString iconName () const
 
QString identifier () const
 
bool isValid () const
 
QStringList mimeTypes () const
 
QString name () const
 
AgentTypeoperator= (const AgentType &other)
 
bool operator== (const AgentType &other) const
 

Detailed Description

A representation of an agent type.

The agent type is a representation of an available agent, that can be started as an agent instance. It provides all information about the type.

All available agent types can be retrieved from the AgentManager.

for ( const Akonadi::AgentType &type : types ) {
qDebug() << "Name:" << type.name() << "(" << type.identifier() << ")";
}
Author
Tobias Koenig tokoe[email protected]@kde[email protected].org

Definition at line 44 of file core/agenttype.h.

Member Typedef Documentation

Describes a list of agent types.

Definition at line 53 of file core/agenttype.h.

Constructor & Destructor Documentation

AgentType::AgentType ( )

Creates a new agent type.

Definition at line 25 of file akonadicontrol/agenttype.cpp.

AgentType::AgentType ( const AgentType other)

Creates an agent type from an other agent type.

Definition at line 19 of file core/agenttype.cpp.

AgentType::~AgentType ( )

Destroys the agent type.

Definition at line 24 of file core/agenttype.cpp.

Member Function Documentation

QStringList AgentType::capabilities ( ) const

Returns the list of supported capabilities of the agent type.

Definition at line 63 of file core/agenttype.cpp.

QVariantMap AgentType::customProperties ( ) const

Returns a Map of custom properties of the agent type.

Since
4.12

Definition at line 68 of file core/agenttype.cpp.

QString AgentType::description ( ) const

Returns the description of the agent type.

Definition at line 43 of file core/agenttype.cpp.

QIcon AgentType::icon ( ) const

Returns the icon of the agent type.

Definition at line 53 of file core/agenttype.cpp.

QString AgentType::iconName ( ) const

Returns the name of the icon of the agent type.

Definition at line 48 of file core/agenttype.cpp.

QString AgentType::identifier ( ) const

Returns the unique identifier of the agent type.

Definition at line 33 of file core/agenttype.cpp.

bool AgentType::isValid ( ) const

Returns whether the agent type is valid.

Definition at line 28 of file core/agenttype.cpp.

QStringList AgentType::mimeTypes ( ) const

Returns the list of supported mime types of the agent type.

Definition at line 58 of file core/agenttype.cpp.

QString AgentType::name ( ) const

Returns the i18n'ed name of the agent type.

Definition at line 38 of file core/agenttype.cpp.

AgentType & AgentType::operator= ( const AgentType other)
Parameters
otherother agent type

Definition at line 73 of file core/agenttype.cpp.

bool AgentType::operator== ( const AgentType other) const
Parameters
otherother agent type

Definition at line 82 of file core/agenttype.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 Fri Nov 27 2020 23:19:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.