Audacity  2.2.0
AboutDialog Class Referencefinal

The AboutDialog shows the program version and developer credits. More...

#include <AboutDialog.h>

Inheritance diagram for AboutDialog:
wxTabTraversalWrapper< Base >

Public Member Functions

 AboutDialog (wxWindow *parent)
 
virtual ~AboutDialog ()
 
void OnOK (wxCommandEvent &event)
 
- Public Member Functions inherited from wxTabTraversalWrapper< Base >
template<typename... Args>
 wxTabTraversalWrapper (Args &&...args)
 
 ~wxTabTraversalWrapper ()
 

Static Public Member Functions

static AboutDialogActiveIntance ()
 

Public Attributes

wxStaticBitmap * icon
 

Private Types

enum  Role {
  roleTeamMember, roleEmeritusTeam, roleDeceased, roleContributor,
  roleTranslators, roleLibrary, roleThanks
}
 

Private Member Functions

void PopulateAudacityPage (ShuttleGui &S)
 
void PopulateLicensePage (ShuttleGui &S)
 
void PopulateInformationPage (ShuttleGui &S)
 : Fills out the "Information" tab of the preferences dialogue More...
 
void CreateCreditsList ()
 
void AddCredit (wxString &&description, Role role)
 
wxString GetCreditsByRole (AboutDialog::Role role)
 
void AddBuildinfoRow (wxString *htmlstring, const wxChar *libname, const wxChar *libdesc, const wxString &status)
 Add a table row saying if a library is used or not. More...
 
void AddBuildinfoRow (wxString *htmlstring, const wxChar *libname, const wxChar *libdesc)
 Add a table row saying if a library is used or not. More...
 

Private Attributes

AboutDialogCreditItemsList creditItems
 

Detailed Description

The AboutDialog shows the program version and developer credits.

It is a simple scrolling window with an 'OK... Audacious!' button to close it.

Member Enumeration Documentation

enum AboutDialog::Role
private
Enumerator
roleTeamMember 
roleEmeritusTeam 
roleDeceased 
roleContributor 
roleTranslators 
roleLibrary 
roleThanks 

Constructor & Destructor Documentation

AboutDialog::~AboutDialog ( )
virtual

Member Function Documentation

AboutDialog * AboutDialog::ActiveIntance ( )
static
void AboutDialog::AddBuildinfoRow ( wxString *  htmlstring,
const wxChar *  libname,
const wxChar *  libdesc,
const wxString &  status 
)
private

Add a table row saying if a library is used or not.

Used when creating the build information tab to show if each optional library is enabled or not, and what it does

Referenced by PopulateInformationPage().

void AboutDialog::AddBuildinfoRow ( wxString *  htmlstring,
const wxChar *  libname,
const wxChar *  libdesc 
)
private

Add a table row saying if a library is used or not.

Used when creating the build information tab to show build dates and file paths

void AboutDialog::AddCredit ( wxString &&  description,
Role  role 
)
private

References creditItems.

Referenced by CreateCreditsList().

void AboutDialog::CreateCreditsList ( )
private
wxString AboutDialog::GetCreditsByRole ( AboutDialog::Role  role)
private

References creditItems.

Referenced by PopulateAudacityPage().

void AboutDialog::OnOK ( wxCommandEvent &  event)
void AboutDialog::PopulateInformationPage ( ShuttleGui S)
private

: Fills out the "Information" tab of the preferences dialogue

Provides as much information as possible about build-time options and the libraries used, to try and make Linux support easier. Basically anything about the build we might wish to know should be visible here

References _(), ABOUT_DIALOG_WIDTH, AddBuildinfoRow(), ShuttleGuiBase::AddWindow(), FileNames::DataDir(), ShuttleGuiBase::EndNotebookPage(), ShuttleGuiBase::EndVerticalLay(), FormatHtmlText(), ShuttleGuiBase::GetParent(), ShuttleGui::Prop(), REV_IDENT, safenew, ShuttleGuiBase::StartNotebookPage(), ShuttleGuiBase::StartVerticalLay(), and VerCheckHtml().

Referenced by AboutDialog().

Member Data Documentation

AboutDialogCreditItemsList AboutDialog::creditItems
private

Referenced by AddCredit(), and GetCreditsByRole().

wxStaticBitmap* AboutDialog::icon

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