KDE 5.0 PyKDE API Reference
  • KDE's Python API
  • Overview
  • PyKDE Home
  • Sitemap
  • Contact Us
 

KAboutPerson Class Reference

from PyKDE5.kcoreaddons import *

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"), "joe@host.com", 0);
 QList<KAboutPerson> people = about.authors();
 about.addCredit(people[0].name(), people[0].task());


Methods

 __init__ (self, QString name, QString task=QString(), QString emailAddress=QString(), QString webAddress=QString(), QString ocsUsername=QString())
 __init__ (self, KAboutPerson other)
 __init__ (self, QString name, QString email, bool disambiguation)
QString emailAddress (self)
QString name (self)
QString ocsUsername (self)
QString task (self)
QString webAddress (self)

Method Documentation

__init__ (  self,
QString  name,
QString  task=QString(),
QString  emailAddress=QString(),
QString  webAddress=QString(),
QString  ocsUsername=QString()
)

Convenience constructor

Parameters:
name  The name of the person.
task  The task of this person.
emailAddress  The email address of the person.
webAddress  Home page of the person.
ocsUsername  Open Collaboration Services username of the person.

__init__ (  self,
KAboutPerson  other
)

Copy constructor. Performs a deep copy.

Parameters:
other  object to copy

__init__ (  self,
QString  name,
QString  email,
bool  disambiguation
)

Internal:
Used by KAboutData to construct translator data.

QString emailAddress (   self )

The person's email address

Returns:
the person's email address (can be QString(), if it has been constructed with an empty email)

QString name (   self )

The person's name

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

QString ocsUsername (   self )

The person's Open Collaboration Services username

Returns:
the persons OCS username (can be QString(), if it has been constructed with an empty username)

QString task (   self )

The person's task

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

QString webAddress (   self )

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)

  • Full Index

Modules

  • karchive
  • kcoreaddons
  • kguiaddons
  • kitemmodels
  • kitemviews
  • kplotting
  • kwidgetsaddons
  • solid
  • sonnet
This documentation is maintained by Simon Edwards.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal