tbq::DialogAbout Class Reference

Allow to easily create an "about" dialog window. More...

Inheritance diagram for tbq::DialogAbout:

Collaboration diagram for tbq::DialogAbout:

Classes
struct	Ressource
struct	RessourceGroup

Public Types
using	ListDeps = QVector<DepInfos>
using	ListResGroups = QVector<RessourceGroup>

Public Member Functions
	DialogAbout (QWidget *parent=nullptr)
	Create a dialog about.
void	setAppInfos (const QString &name, const QVersionNumber &version)
	Use to set application main informations.
void	setLogo (const QPixmap &logo)
	Use to set application logo.
void	addSectionAbout (const QString &aboutApp, const RichLink &linkHome=RichLink(), const RichLink &linkBug=RichLink())
	Add an "about" section.
void	addSectionDeps (const ListDeps &listDeps, const QString &invalidSemver="/")
	Add section used to list all dependencies.
void	addSectionRessources (const ListResGroups &listGroups)
	Add section used to list all used ressources (images, fonts, audios, etc...).
void	addSectionChangelog (const QUrl &sourceUrl, QTextDocument::ResourceType type=QTextDocument::MarkdownResource)
	Add a changelog section.
void	addSectionLicense (const QUrl &sourceUrl, QTextDocument::ResourceType type=QTextDocument::MarkdownResource)
	Add a license section.
void	addSectionFromDoc (const QString &name, const QUrl &sourceUrl, QTextDocument::ResourceType type)
	Add a custom section using ressource.

Detailed Description

Allow to easily create an "about" dialog window.

For example:

#include "toolboxqt/widgets/dialogabout.h"
 
void MenuBar::showHelpAbout()
{
    /* Create dialog about */
    tbq::DialogAbout *dialogAbout = new tbq::DialogAbout(this);
    dialogAbout->setAttribute(Qt::WA_DeleteOnClose);
 
    /* Set informations */
    // Set app main informations
    dialogAbout->addSectionAbout(
            "My great application which do many things:\n"
            "- The first great things\n"
            "- The second great things\n",
        tbq::RichLink(QUrl("https://github.com/myuser/myproject")),
        tbq::RichLink(QUrl("https://github.com/myuser/myproject/issues"))
    );
 
    // Set dependency section
    const QString teaseVer = QString::fromStdString(tease::Semver::getLibraryVersion().toString('.', 1));
    const tbq::DialogAbout::ListDeps listDeps = {
        tbq::DepInfos(tbq::RichLink(QUrl("https://www.qt.io/"), "Qt Framework"), QVersionNumber::fromString(QT_VERSION_STR)),
 
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/google/googletest"), "Google Tests"), QVersionNumber()),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/nlohmann/json"), "JSON for Modern C++"), QVersionNumber()),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/legerch/QLogger"), "QLogger"), QLogger::QLoggerFactory::getLibraryVersion()),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/legerch/qtavplayer"), "QtAvPlayer"), QVersionNumber::fromString(QTAVPLAYER_VERSION_STR)),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/stachenov/quazip"), "Quazip"), QVersionNumber()),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/legerch/ToolBoxQt"), "Toolbox Qt"), QVersionNumber::fromString(TOOLBOXQT_VERSION_STR)),
        tbq::DepInfos(tbq::RichLink(QUrl("https://github.com/legerch/TransferEase"), "TransferEase"), QVersionNumber::fromString(teaseVer)),
        tbq::DepInfos(tbq::RichLink(QUrl("https://zlib.net/"), "ZLib"), QVersionNumber()),
    };
    dialogAbout->addSectionDeps(listDeps);
 
    // Set credit section
    const tbq::DialogAbout::ListResGroups listRes = {
        {
            .name = "Icons",
            .listRes = {
                {.source = tbq::RichLink(QUrl("https://www.flaticon.com/free-icon/local-area_2082759?term=computer&related_id=2082759"), "Main logo"), .author = "Eucalyp", .license = "Flaticon License"},
                {.source = tbq::RichLink(QUrl("https://www.bankoficons/greaticon1"), "Action1 icon"), .author = "David Awesome", .license = "Creative Commons"},
                {.source = tbq::RichLink(QUrl("https://www.bankoficons/greaticon2"), "Sub menu icon"), .author = "Paul Allesome", .license = "Creative Commons"},
            }
        },
        {
            .name = "Fonts",
            .listRes = {
                {.source = tbq::RichLink(QUrl("https://www.bankoffonts/greatfont1"), "App font"), .author = "Dave Calligraph", .license = "Creative Commons"},
                {.source = tbq::RichLink(QUrl("https://www.bankoffonts/greatfont2"), "Emoji font"), .author = "Sascha Isaac", .license = "GPL"},
            }
        }
    };
    dialogAbout->addSectionRessources(listRes);
 
    // Add useful documents
    dialogAbout->addSectionChangelog(QUrl("qrc:/docs/changelog"));
    dialogAbout->addSectionLicense(QUrl("qrc:/docs/license"));
 
    /* Display dialog about */
    dialogAbout->show();
}

Constructor & Destructor Documentation

DialogAbout()

tbq::DialogAbout::DialogAbout ( QWidget * parent = nullptr )

explicit

Create a dialog about.

Methods setAppInfos() and setLogo() are called by this constructor. Informations used are the one provided QApplication global instance

Parameters

[in,out]

parent

Parent of the dialog.

See also

addSectionAbout(), addSectionDeps(), addSectionRessources()

addSectionChangelog(), addSectionLicense()

addSectionFromDoc()

Member Function Documentation

addSectionAbout()

void tbq::DialogAbout::addSectionAbout	(	const QString &	aboutApp,
		const RichLink &	linkHome = RichLink(),
		const RichLink &	linkBug = RichLink() )

Add an "about" section.

Parameters

[in]	aboutApp	Description of the application goals. This field is a rich text.
[in]	linkHome	Link to the project homepage.
[in]	linkBug	Link to the project bug tracker.

addSectionChangelog()

void tbq::DialogAbout::addSectionChangelog	(	const QUrl &	sourceUrl,
		QTextDocument::ResourceType	type = QTextDocument::MarkdownResource )

Add a changelog section.

Parameters

[in]	sourceUrl	Path to changelog ressource to use
[in]	type	Type of ressource.

See also

addSectionLicense()

addSectionFromDoc()

addSectionDeps()

void tbq::DialogAbout::addSectionDeps	(	const ListDeps &	listDeps,
		const QString &	invalidSemver = "/" )

Add section used to list all dependencies.

Parameters

[in]	listDeps	List of dependencies to display
[in]	invalidSemver	Text to display when version is invalid or unknown.

See also

addSectionRessources()

addSectionFromDoc()

void tbq::DialogAbout::addSectionFromDoc	(	const QString &	name,
		const QUrl &	sourceUrl,
		QTextDocument::ResourceType	type )

Add a custom section using ressource.

Parameters

[in]	name	Section name
[in]	sourceUrl	Path to ressource to use
[in]	type	Type of ressource.

See also

addSectionChangelog(), addSectionLicense()

addSectionLicense()

void tbq::DialogAbout::addSectionLicense	(	const QUrl &	sourceUrl,
		QTextDocument::ResourceType	type = QTextDocument::MarkdownResource )

Add a license section.

Parameters

[in]	sourceUrl	Path to license ressource to use
[in]	type	Type of ressource.

See also

addSectionChangelog()

addSectionFromDoc()

addSectionRessources()

void tbq::DialogAbout::addSectionRessources

(

const ListResGroups &

listGroups

)

Add section used to list all used ressources (images, fonts, audios, etc...).

Parameters

[in]

listGroups

List of group ressources to display.

See also

addSectionDeps()

setAppInfos()

void tbq::DialogAbout::setAppInfos	(	const QString &	name,
		const QVersionNumber &	version )

Use to set application main informations.

Parameters

[in]	name	Application name
[in]	version	Application version

See also

setLogo()

setLogo()

void tbq::DialogAbout::setLogo

(

const QPixmap &

logo

)

Use to set application logo.

Parameters

[in]

logo

Application logo to use

See also

setAppInfos()

---

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

• toolboxqt/widgets/dialogabout.h
• toolboxqt/widgets/dialogabout.cpp