Akonadi::AgentType Class Reference

A representation of an agent type. More...

#include <agenttype.h>

List of all members.

Classes

class  Private

Public Types

typedef QList< AgentTypeList

Public Member Functions

 AgentType (const AgentType &other)
 AgentType ()
 ~AgentType ()
QStringList capabilities () 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.

 Akonadi::AgentType::List types = Akonadi::AgentManager::self()->types();
 foreach ( const Akonadi::AgentType &type, types ) {
   qDebug() << "Name:" << type.name() << "(" << type.identifier() << ")";
 }
Author:
Tobias Koenig <tokoe@kde.org>

Definition at line 56 of file agenttype.h.


Member Typedef Documentation

Describes a list of agent types.

Definition at line 65 of file agenttype.h.


Constructor & Destructor Documentation

AgentType::AgentType (  ) 

Creates a new agent type.

Definition at line 27 of file agenttype.cpp.

AgentType::AgentType ( const AgentType other  ) 

Creates an agent type from an other agent type.

Definition at line 32 of file agenttype.cpp.

AgentType::~AgentType (  ) 

Destroys the agent type.

Definition at line 37 of file agenttype.cpp.


Member Function Documentation

QStringList AgentType::capabilities (  )  const

Returns the list of supported capabilities of the agent type.

Definition at line 76 of file agenttype.cpp.

QString AgentType::description (  )  const

Returns the description of the agent type.

Definition at line 56 of file agenttype.cpp.

QIcon AgentType::icon (  )  const

Returns the icon of the agent type.

Definition at line 66 of file agenttype.cpp.

QString AgentType::iconName (  )  const

Returns the name of the icon of the agent type.

Definition at line 61 of file agenttype.cpp.

QString AgentType::identifier (  )  const

Returns the unique identifier of the agent type.

Definition at line 46 of file agenttype.cpp.

bool AgentType::isValid (  )  const

Returns whether the agent type is valid.

Definition at line 41 of file agenttype.cpp.

QStringList AgentType::mimeTypes (  )  const

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

Definition at line 71 of file agenttype.cpp.

QString AgentType::name (  )  const

Returns the i18n'ed name of the agent type.

Definition at line 51 of file agenttype.cpp.

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

For internal use only.

Definition at line 81 of file agenttype.cpp.

bool AgentType::operator== ( const AgentType other  )  const

For internal use only.

Definition at line 89 of file agenttype.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys