Workspace 6.21.5
Public Member Functions | Static Public Member Functions | List of all members
AboutAppDialog Class Reference

Generic 'About $app' dialog box for use in Workspace applications. Caller should call adjustSize() once all customizations to the window are completed to ensure the dialog window looks good.

#include <Workspace/Widgets/aboutappdialog.h>

Inherits QDialog.

Public Member Functions

 AboutAppDialog (const QPixmap &icon, const QString &title, const QString &version, const QString &credits, QWidget *parent=nullptr)
 
 AboutAppDialog (QWidget *parent=nullptr)
 
 ~AboutAppDialog () override
 
void clearAllLicenses ()
 
void deleteAdditionalWidgets ()
 
QHBoxLayout * getBottomPlaceHolderLayout ()
 
QVBoxLayout * getRhsVerticalLayout ()
 
QHBoxLayout * getTopHorizontalLayout ()
 
void hideAppCredits ()
 
void hideAppIcon ()
 
void hideAppSubtitle ()
 
void hideAppTitle ()
 
void hideAppVersion ()
 
void hideCompilerInfo ()
 
void hideCopyright ()
 
void hideCopyrightLogo ()
 
void hideLicenseSelection ()
 
void hideLicenseTextEdit ()
 
void hideLicenseViewingToggle ()
 
void hidePluginLink ()
 
void hideWebsiteLink ()
 
void hideWorkspacePowered ()
 
void readLicenseFile (const QString &path, const QString &plugin=QString())
 
void readLicenseFiles (const QString &resourcePath, const QString &extension="txt")
 
void removeLicenses (const QStringList &licenses)
 
void setAdditionalWidget (QWidget *widget)
 
void setAppCredits (const QString &credits)
 
void setAppIcon (const QPixmap &icon)
 
void setAppIconInTitleLabel (const QPixmap &icon)
 
void setAppSubtitle (const QString &subtitle)
 
void setAppTitle (const QString &title)
 
void setAppVersion (const QString &version)
 
void setCompilerInfo (const QString &compilerText)
 
void setCopyright (const QString &copyright)
 
void setCopyrightLogo (const QPixmap &logo)
 
void setCustomerIconLabel1 (const QPixmap &icon)
 
void setCustomerIconLabel2 (const QPixmap &icon)
 
void setLicense (const QString &license)
 
void setLicenseSelection (const QString &library)
 
void setRhsLabelsAlignment (Qt::Alignment alignment)
 
void setWebsiteLink (const QString &htmlLink)
 
void showAppCredits ()
 
void showAppIcon ()
 
void showAppSubtitle ()
 
void showAppTitle ()
 
void showAppVersion ()
 
void showCompilerInfo ()
 
void showCopyright ()
 
void showCopyrightLogo ()
 
void showLicenseSelection ()
 
void showLicenseTextEdit ()
 
void showLicenseViewingToggle ()
 
void showPluginLink ()
 
void showWebsiteLink ()
 
void showWorkspacePowered ()
 

Static Public Member Functions

static void addAboutQtAction (QMenu *menu)
 
static void addAboutWorkspaceAction (QMenu *menu)
 
static void addCoreAboutActions (QMenu *menu)
 
static AboutAppDialogstandardAboutWorkspaceDialog ()
 

Constructor & Destructor Documentation

◆ AboutAppDialog() [1/2]

AboutAppDialog ( QWidget *  parent = nullptr)
explicit

◆ AboutAppDialog() [2/2]

AboutAppDialog ( const QPixmap &  icon,
const QString &  title,
const QString &  version,
const QString &  credits,
QWidget *  parent = nullptr 
)

◆ ~AboutAppDialog()

~AboutAppDialog ( )
override

Member Function Documentation

◆ addAboutQtAction()

void addAboutQtAction ( QMenu *  menu)
static

◆ addAboutWorkspaceAction()

void addAboutWorkspaceAction ( QMenu *  menu)
static

◆ addCoreAboutActions()

void addCoreAboutActions ( QMenu *  menu)
static

◆ clearAllLicenses()

void clearAllLicenses ( )

◆ deleteAdditionalWidgets()

void deleteAdditionalWidgets ( )

◆ getBottomPlaceHolderLayout()

QHBoxLayout * getBottomPlaceHolderLayout ( )

◆ getRhsVerticalLayout()

QVBoxLayout * getRhsVerticalLayout ( )

◆ getTopHorizontalLayout()

QHBoxLayout * getTopHorizontalLayout ( )

◆ hideAppCredits()

void hideAppCredits ( )

◆ hideAppIcon()

void hideAppIcon ( )

◆ hideAppSubtitle()

void hideAppSubtitle ( )

◆ hideAppTitle()

void hideAppTitle ( )

◆ hideAppVersion()

void hideAppVersion ( )

◆ hideCompilerInfo()

void hideCompilerInfo ( )

◆ hideCopyright()

void hideCopyright ( )

◆ hideCopyrightLogo()

void hideCopyrightLogo ( )

◆ hideLicenseSelection()

void hideLicenseSelection ( )

◆ hideLicenseTextEdit()

void hideLicenseTextEdit ( )

◆ hideLicenseViewingToggle()

void hideLicenseViewingToggle ( )

◆ hidePluginLink()

void hidePluginLink ( )

◆ hideWebsiteLink()

void hideWebsiteLink ( )

◆ hideWorkspacePowered()

void hideWorkspacePowered ( )

◆ readLicenseFile()

void readLicenseFile ( const QString &  path,
const QString &  plugin = QString() 
)

◆ readLicenseFiles()

void readLicenseFiles ( const QString &  resourcePath,
const QString &  extension = "txt" 
)
Parameters
resourcePathResource path where license files can be found.
extensionFile extension of license file. Do not include the dot seperator.

Read in core Workspace licenses. Licenses files are required to be in on a single resource path and have the same file extension, which by default is '.txt'.

The license file name (without the extension) is displayed to the user in the GUI so it should be named by the library/app that licenses.

◆ removeLicenses()

void removeLicenses ( const QStringList licenses)

◆ setAdditionalWidget()

void setAdditionalWidget ( QWidget *  widget)

Set a custom widget south of the application text area.

◆ setAppCredits()

void setAppCredits ( const QString &  credits)

◆ setAppIcon()

void setAppIcon ( const QPixmap &  icon)

◆ setAppIconInTitleLabel()

void setAppIconInTitleLabel ( const QPixmap &  icon)

◆ setAppSubtitle()

void setAppSubtitle ( const QString &  subtitle)

◆ setAppTitle()

void setAppTitle ( const QString &  title)

◆ setAppVersion()

void setAppVersion ( const QString &  version)

◆ setCompilerInfo()

void setCompilerInfo ( const QString &  compilerText)

◆ setCopyright()

void setCopyright ( const QString &  copyright)

◆ setCopyrightLogo()

void setCopyrightLogo ( const QPixmap &  logo)

◆ setCustomerIconLabel1()

void setCustomerIconLabel1 ( const QPixmap &  icon)

Optional - set another icon in the position below and left of the main app icon

◆ setCustomerIconLabel2()

void setCustomerIconLabel2 ( const QPixmap &  icon)

Optional - set another icon in the position below and right of the main app icon

◆ setLicense()

void setLicense ( const QString &  license)

◆ setLicenseSelection()

void setLicenseSelection ( const QString &  library)

◆ setRhsLabelsAlignment()

void setRhsLabelsAlignment ( Qt::Alignment  alignment)

Affects labels on the right hand side of the app icon.

◆ setWebsiteLink()

void setWebsiteLink ( const QString &  htmlLink)
Parameters
htmlLinkThe string needs to be formatted with a .... This allows caller to hyperlink a sub-string of the user visible text.

◆ showAppCredits()

void showAppCredits ( )

◆ showAppIcon()

void showAppIcon ( )

◆ showAppSubtitle()

void showAppSubtitle ( )

◆ showAppTitle()

void showAppTitle ( )

◆ showAppVersion()

void showAppVersion ( )

◆ showCompilerInfo()

void showCompilerInfo ( )

◆ showCopyright()

void showCopyright ( )

◆ showCopyrightLogo()

void showCopyrightLogo ( )

◆ showLicenseSelection()

void showLicenseSelection ( )

◆ showLicenseTextEdit()

void showLicenseTextEdit ( )

◆ showLicenseViewingToggle()

void showLicenseViewingToggle ( )

◆ showPluginLink()

void showPluginLink ( )

◆ showWebsiteLink()

void showWebsiteLink ( )

◆ showWorkspacePowered()

void showWorkspacePowered ( )

◆ standardAboutWorkspaceDialog()

AboutAppDialog * standardAboutWorkspaceDialog ( )
static