Quassel IRC  Pre-Release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
AboutData Class Reference

#include </tmp/quassel/src/uisupport/aboutdata.h>

Public Member Functions

 AboutData (QObject *parent=nullptr)
AboutDataaddAuthor (const AboutPerson &author)
AboutDataaddAuthors (std::initializer_list< AboutPerson > authors)
AboutDataaddCredit (const AboutPerson &credit)
AboutDataaddCredits (std::initializer_list< AboutPerson > credits)
QList< AboutPersonauthors () const
QList< AboutPersoncredits () const

Static Public Member Functions

static void setQuasselPersons (AboutData *aboutData)

Private Attributes

QList< AboutPerson_authors
 The list of authors.
QList< AboutPerson_credits
 The list of other contributors.

Detailed Description

Holds a list of authors, contributors and translators.

This class is meant to hold the list of people who contributed to Quassel, used for displaying the About Quassel dialog. Additionally, this class can provide a KAboutData object to be shown if KDE integration is enabled.

Definition at line 107 of file aboutdata.h.

Constructor & Destructor Documentation

AboutData ( QObject *  parent = nullptr)

Default constructor.

Parameters
[in]parentThe parent object, if applicable

Definition at line 84 of file aboutdata.cpp.

Member Function Documentation

AboutData & addAuthor ( const AboutPerson author)

Adds an author to the list of contributors.

Authors are people who contributed a significant amount of code to Quassel.

Parameters
[in]authorThe author to add
Returns
A reference to this AboutData instance

Definition at line 103 of file aboutdata.cpp.

References _authors.

AboutData & addAuthors ( std::initializer_list< AboutPerson authors)

Adds a list of authors to the list of contributors.

This method allows the use of a brace initializer in order to easily add a long list of people.

Parameters
[in]authorsA list of authors to add
Returns
A reference to this AboutData instance

Definition at line 110 of file aboutdata.cpp.

References _authors.

Referenced by setQuasselPersons().

AboutData & addCredit ( const AboutPerson credit)

Adds a contributor.

Parameters
[in]authorThe contributor to add
Returns
A reference to this AboutData instance

Definition at line 117 of file aboutdata.cpp.

References _credits.

AboutData & addCredits ( std::initializer_list< AboutPerson credits)

Adds a list of contributors.

This method allows the use of brace initializers in order to easily add a long list of people.

Parameters
[in]authorsA list of contributors to add
Returns
A reference to this AboutData instance

Definition at line 124 of file aboutdata.cpp.

References _credits.

Referenced by setQuasselPersons().

QList< AboutPerson > authors ( ) const

Gets the list of authors stored in this AboutData instance.

Returns
A list of authors

Definition at line 91 of file aboutdata.cpp.

References _authors.

Referenced by AboutDlg::authors().

QList< AboutPerson > credits ( ) const

Gets the list of non-author contributors stored in this AboutData instance.

Returns
A list of contributors

Definition at line 97 of file aboutdata.cpp.

References _credits.

Referenced by AboutDlg::contributors().

void setQuasselPersons ( AboutData aboutData)
static

Fills the given AboutData instance with data relevant for Quassel itself.

This method adds a (hardcoded) list of contributors to the given AboutData instance.

Parameters
[in,out]aboutDataAn existing AboutData instance to add Quassel's contributors to

Definition at line 171 of file aboutdata.cpp.

References addAuthors(), and addCredits().

Referenced by AboutDlg::AboutDlg(), and main().

Member Data Documentation

QList<AboutPerson> _authors
private

The list of authors.

Definition at line 192 of file aboutdata.h.

Referenced by addAuthor(), addAuthors(), and authors().

QList<AboutPerson> _credits
private

The list of other contributors.

Definition at line 193 of file aboutdata.h.

Referenced by addCredit(), addCredits(), and credits().


The documentation for this class was generated from the following files: