kabc Library API Documentation

KABC::Agent Class Reference

Important!!! More...

#include <agent.h>

List of all members.

Public Methods

 Agent ()
 Consturctor.

 Agent (const QString &url)
 Consturctor.

 Agent (Addressee *addressee)
 Consturctor.

 ~Agent ()
 Destructor.

void setUrl (const QString &url)
 Sets a URL for the location of the agent file.

void setAddressee (Addressee *addressee)
 Sets the addressee of the agent.

bool isIntern () const
 Returns whether the agent is described by a URL (extern) or by a addressee (intern).

QString url () const
 Returns the location URL of this agent.

Addresseeaddressee () const
 Returns the addressee object of this agent.

QString asString () const
 Returns string representation of the agent.


Detailed Description

Important!!!

At the moment the vcard format does not support saving and loading this entity.

Definition at line 34 of file agent.h.


Constructor & Destructor Documentation

Agent::Agent  
 

Consturctor.

Creates an empty object.

Definition at line 27 of file agent.cpp.

Agent::Agent const QString   url
 

Consturctor.

Parameters:
url  A URL that describes the position of the agent file.

Definition at line 32 of file agent.cpp.

Agent::Agent Addressee   addressee
 

Consturctor.

Parameters:
addressee  The addressee object of the agent.

Definition at line 37 of file agent.cpp.

Agent::~Agent  
 

Destructor.

Definition at line 42 of file agent.cpp.


Member Function Documentation

void Agent::setUrl const QString   url
 

Sets a URL for the location of the agent file.

When using this function, isIntern() will return 'false' until you use setAddressee().

Parameters:
url  The location URL of the agent file.

Definition at line 69 of file agent.cpp.

void Agent::setAddressee Addressee   addressee
 

Sets the addressee of the agent.

When using this function, isIntern() will return 'true' until you use setUrl().

Parameters:
addressee  The addressee object of the agent.

Definition at line 75 of file agent.cpp.

bool Agent::isIntern  
 

Returns whether the agent is described by a URL (extern) or by a addressee (intern).

When this method returns 'true' you can use addressee() to get a Addressee object. Otherwise you can request the URL of this agent by url() and load the data from that location.

Definition at line 81 of file agent.cpp.

QString Agent::url  
 

Returns the location URL of this agent.

Definition at line 86 of file agent.cpp.

Addressee * Agent::addressee  
 

Returns the addressee object of this agent.

Definition at line 91 of file agent.cpp.

QString Agent::asString  
 

Returns string representation of the agent.

Definition at line 96 of file agent.cpp.

Referenced by KABC::Addressee::dump().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:22:09 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001