KAboutPerson

#include <kaboutdata.h>

Properties

QString emailAddress
 
QString name
 
QString ocsUsername
 
QString task
 
QString webAddress
 

Public Member Functions

 KAboutPerson (const QString &name=QString(), const QString &task=QString(), const QString &emailAddress=QString(), const QString &webAddress=QString(), const QString &ocsUsername=QString())
 
 KAboutPerson (const KAboutPerson &other)
 
QString emailAddress () const
 
QString name () const
 
QString ocsUsername () const
 
KAboutPersonoperator= (const KAboutPerson &other)
 
QString task () const
 
QString webAddress () const
 

Static Public Member Functions

static KAboutPerson fromJSON (const QJsonObject &obj)
 

Detailed Description

This class is used to store information about a person or developer.

It can store the person's name, a task, an email address and a link to a home page. This class is intended for use in the KAboutData class, but it can be used elsewhere as well. Normally you should at least define the person's name. Creating a KAboutPerson object by yourself is relatively useless, but the KAboutData methods KAboutData::authors() and KAboutData::credits() return lists of KAboutPerson data objects which you can examine.

Example usage within a main(), retrieving the list of people involved with a program and re-using data from one of them:

KAboutData about("khello", i18n("KHello"), "0.1",
i18n("A KDE version of Hello, world!"),
KAboutLicense::LGPL,
i18n("Copyright (C) 2014 Developer"));
about.addAuthor(i18n("Joe Developer"), i18n("developer"), "[email protected]", 0);
QList<KAboutPerson> people = about.authors();
about.addCredit(people[0].name(), people[0].task());

Definition at line 55 of file kaboutdata.h.

Constructor & Destructor Documentation

KAboutPerson::KAboutPerson ( const QString name = QString(),
const QString task = QString(),
const QString emailAddress = QString(),
const QString webAddress = QString(),
const QString ocsUsername = QString() 
)
explicit

Convenience constructor.

Parameters
nameThe name of the person.
taskThe task of this person.
emailAddressThe email address of the person.
webAddressHome page of the person.
ocsUsernameOpen Collaboration Services username of the person.

name default argument

Since
5.53

Definition at line 47 of file kaboutdata.cpp.

KAboutPerson::KAboutPerson ( const KAboutPerson other)

Copy constructor.

Performs a deep copy.

Parameters
otherobject to copy

Definition at line 68 of file kaboutdata.cpp.

Member Function Documentation

QString KAboutPerson::emailAddress ( ) const

The person's email address.

Returns
the person's email address (can be QString(), if it has been constructed with an empty email)
KAboutPerson KAboutPerson::fromJSON ( const QJsonObject obj)
static

Creates a KAboutPerson from a JSON object with the following structure:

Key Accessor
Name name()
Email emailAddress()
Task task()
Website webAddress()
UserName ocsUsername()

The Name and Task key are translatable (by using e.g. a "Task[de_DE]" key)

Since
5.18

Definition at line 109 of file kaboutdata.cpp.

QString KAboutPerson::name ( ) const

The person's name.

Returns
the person's name (can be QString(), if it has been constructed with an empty name)
QString KAboutPerson::ocsUsername ( ) const

The person's Open Collaboration Services username.

Returns
the persons OCS username (can be QString(), if it has been constructed with an empty username)
KAboutPerson & KAboutPerson::operator= ( const KAboutPerson other)

Assignment operator.

Performs a deep copy.

Parameters
otherobject to copy

Definition at line 103 of file kaboutdata.cpp.

QString KAboutPerson::task ( ) const

The person's task.

Returns
the person's task (can be QString(), if it has been constructed with an empty task)
QString KAboutPerson::webAddress ( ) const

The home page or a relevant link.

Returns
the persons home page (can be QString(), if it has been constructed with an empty home page)

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 Sat Oct 24 2020 23:07:21 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.