KiCad PCB EDA Suite
AboutAppInfo Class Reference

An object of this class is meant to be used to store application specific information like who has contributed in which area of the application, the license, copyright and other descriptive information. More...

#include <aboutinfo.h>

Public Member Functions

 AboutAppInfo ()
 
virtual ~AboutAppInfo ()
 
void AddDeveloper (const Contributor *developer)
 
void AddDocWriter (const Contributor *docwriter)
 
void AddArtist (const Contributor *artist)
 
void AddTranslator (const Contributor *translator)
 
void AddPackager (const Contributor *packager)
 
Contributors GetDevelopers ()
 
Contributors GetDocWriters ()
 
Contributors GetArtists ()
 
Contributors GetTranslators ()
 
Contributors GetPackagers ()
 
void SetDescription (const wxString &text)
 
wxString & GetDescription ()
 
void SetLicense (const wxString &text)
 
wxString & GetLicense ()
 
void SetCopyright (const wxString &text)
 
wxString GetCopyright ()
 
void SetAppName (const wxString &name)
 
wxString & GetAppName ()
 
void SetBuildVersion (const wxString &version)
 
wxString & GetBuildVersion ()
 
void SetLibVersion (const wxString &version)
 
wxString & GetLibVersion ()
 
void SetIcon (const wxIcon &icon)
 
wxIcon & GetIcon ()
 

Private Attributes

Contributors developers
 
Contributors docwriters
 
Contributors artists
 
Contributors translators
 
Contributors packagers
 
wxString description
 
wxString license
 
wxString copyright
 
wxString appName
 
wxString buildVersion
 
wxString libVersion
 
wxIcon appIcon
 

Detailed Description

An object of this class is meant to be used to store application specific information like who has contributed in which area of the application, the license, copyright and other descriptive information.

Definition at line 42 of file aboutinfo.h.

Constructor & Destructor Documentation

AboutAppInfo::AboutAppInfo ( )
inline

Definition at line 45 of file aboutinfo.h.

45 {};
virtual AboutAppInfo::~AboutAppInfo ( )
inlinevirtual

Definition at line 46 of file aboutinfo.h.

46 {};

Member Function Documentation

void AboutAppInfo::AddArtist ( const Contributor artist)
inline

Definition at line 60 of file aboutinfo.h.

References artists.

61  {
62  if( artist != NULL )
63  artists.Add( artist );
64  }
Contributors artists
Definition: aboutinfo.h:119
void AboutAppInfo::AddDeveloper ( const Contributor developer)
inline

Definition at line 48 of file aboutinfo.h.

References developers.

49  {
50  if( developer != NULL )
51  developers.Add( developer );
52  }
Contributors developers
Definition: aboutinfo.h:117
void AboutAppInfo::AddDocWriter ( const Contributor docwriter)
inline

Definition at line 54 of file aboutinfo.h.

References docwriters.

55  {
56  if( docwriter != NULL )
57  docwriters.Add( docwriter );
58  }
Contributors docwriters
Definition: aboutinfo.h:118
void AboutAppInfo::AddPackager ( const Contributor packager)
inline

Definition at line 72 of file aboutinfo.h.

References packagers.

73  {
74  if( packager != NULL )
75  packagers.Add( packager );
76  }
Contributors packagers
Definition: aboutinfo.h:121
void AboutAppInfo::AddTranslator ( const Contributor translator)
inline

Definition at line 66 of file aboutinfo.h.

References translators.

67  {
68  if( translator != NULL )
69  translators.Add( translator );
70  }
Contributors translators
Definition: aboutinfo.h:120
wxString& AboutAppInfo::GetAppName ( )
inline

Definition at line 105 of file aboutinfo.h.

References appName.

Referenced by dialog_about::dialog_about(), and dialog_about::OnCopyVersionInfo().

105 { return appName; }
wxString appName
Definition: aboutinfo.h:127
Contributors AboutAppInfo::GetArtists ( )
inline

Definition at line 80 of file aboutinfo.h.

References artists.

Referenced by dialog_about::CreateNotebooks().

80 { return artists; }
Contributors artists
Definition: aboutinfo.h:119
wxString& AboutAppInfo::GetBuildVersion ( )
inline

Definition at line 108 of file aboutinfo.h.

References buildVersion.

Referenced by dialog_about::CreateHyperlink(), dialog_about::dialog_about(), and dialog_about::OnCopyVersionInfo().

108 { return buildVersion; }
wxString buildVersion
Definition: aboutinfo.h:128
wxString AboutAppInfo::GetCopyright ( )
inline

Definition at line 91 of file aboutinfo.h.

References copyright.

Referenced by dialog_about::dialog_about().

92  {
93  wxString copyrightText = copyright;
94 
95 #if wxUSE_UNICODE
96  const wxString utf8_copyrightSign = wxString::FromUTF8( "\xc2\xa9" );
97  copyrightText.Replace( "(c)", utf8_copyrightSign );
98  copyrightText.Replace( "(C)", utf8_copyrightSign );
99 #endif // wxUSE_UNICODE
100 
101  return copyrightText;
102  }
wxString copyright
Definition: aboutinfo.h:126
wxString& AboutAppInfo::GetDescription ( )
inline

Definition at line 85 of file aboutinfo.h.

References description.

Referenced by dialog_about::CreateNotebooks().

85 { return description; }
wxString description
Definition: aboutinfo.h:123
Contributors AboutAppInfo::GetDevelopers ( )
inline

Definition at line 78 of file aboutinfo.h.

References developers.

Referenced by dialog_about::CreateNotebooks().

78 { return developers; }
Contributors developers
Definition: aboutinfo.h:117
Contributors AboutAppInfo::GetDocWriters ( )
inline

Definition at line 79 of file aboutinfo.h.

References docwriters.

Referenced by dialog_about::CreateNotebooks().

79 { return docwriters; }
Contributors docwriters
Definition: aboutinfo.h:118
wxIcon& AboutAppInfo::GetIcon ( )
inline

Definition at line 114 of file aboutinfo.h.

References appIcon.

Referenced by dialog_about::dialog_about(), and ShowAboutDialog().

114 { return appIcon; }
wxIcon appIcon
Definition: aboutinfo.h:131
wxString& AboutAppInfo::GetLibVersion ( )
inline

Definition at line 111 of file aboutinfo.h.

References libVersion.

Referenced by dialog_about::CreateHyperlink(), and dialog_about::dialog_about().

111 { return libVersion; }
wxString libVersion
Definition: aboutinfo.h:129
wxString& AboutAppInfo::GetLicense ( )
inline

Definition at line 88 of file aboutinfo.h.

References license.

Referenced by dialog_about::CreateNotebooks().

88 { return license; }
wxString license
Definition: aboutinfo.h:124
Contributors AboutAppInfo::GetPackagers ( )
inline

Definition at line 82 of file aboutinfo.h.

References packagers.

Referenced by dialog_about::CreateNotebooks().

82 { return packagers; }
Contributors packagers
Definition: aboutinfo.h:121
Contributors AboutAppInfo::GetTranslators ( )
inline

Definition at line 81 of file aboutinfo.h.

References translators.

Referenced by dialog_about::CreateNotebooks().

81 { return translators; }
Contributors translators
Definition: aboutinfo.h:120
void AboutAppInfo::SetAppName ( const wxString &  name)
inline

Definition at line 104 of file aboutinfo.h.

References appName.

104 { appName = name; }
wxString appName
Definition: aboutinfo.h:127
void AboutAppInfo::SetBuildVersion ( const wxString &  version)
inline

Definition at line 107 of file aboutinfo.h.

References buildVersion.

107 { buildVersion = version; }
wxString buildVersion
Definition: aboutinfo.h:128
void AboutAppInfo::SetCopyright ( const wxString &  text)
inline

Definition at line 90 of file aboutinfo.h.

References copyright.

90 { copyright = text; }
wxString copyright
Definition: aboutinfo.h:126
void AboutAppInfo::SetDescription ( const wxString &  text)
inline

Definition at line 84 of file aboutinfo.h.

References description.

84 { description = text; }
wxString description
Definition: aboutinfo.h:123
void AboutAppInfo::SetIcon ( const wxIcon &  icon)
inline

Definition at line 113 of file aboutinfo.h.

References appIcon.

113 { appIcon = icon; }
wxIcon appIcon
Definition: aboutinfo.h:131
void AboutAppInfo::SetLibVersion ( const wxString &  version)
inline

Definition at line 110 of file aboutinfo.h.

References libVersion.

110 { libVersion = version; }
wxString libVersion
Definition: aboutinfo.h:129
void AboutAppInfo::SetLicense ( const wxString &  text)
inline

Definition at line 87 of file aboutinfo.h.

References license.

87 { license = text; }
wxString license
Definition: aboutinfo.h:124

Member Data Documentation

wxIcon AboutAppInfo::appIcon
private

Definition at line 131 of file aboutinfo.h.

Referenced by GetIcon(), and SetIcon().

wxString AboutAppInfo::appName
private

Definition at line 127 of file aboutinfo.h.

Referenced by GetAppName(), and SetAppName().

Contributors AboutAppInfo::artists
private

Definition at line 119 of file aboutinfo.h.

Referenced by AddArtist(), and GetArtists().

wxString AboutAppInfo::buildVersion
private

Definition at line 128 of file aboutinfo.h.

Referenced by GetBuildVersion(), and SetBuildVersion().

wxString AboutAppInfo::copyright
private

Definition at line 126 of file aboutinfo.h.

Referenced by GetCopyright(), and SetCopyright().

wxString AboutAppInfo::description
private

Definition at line 123 of file aboutinfo.h.

Referenced by GetDescription(), and SetDescription().

Contributors AboutAppInfo::developers
private

Definition at line 117 of file aboutinfo.h.

Referenced by AddDeveloper(), and GetDevelopers().

Contributors AboutAppInfo::docwriters
private

Definition at line 118 of file aboutinfo.h.

Referenced by AddDocWriter(), and GetDocWriters().

wxString AboutAppInfo::libVersion
private

Definition at line 129 of file aboutinfo.h.

Referenced by GetLibVersion(), and SetLibVersion().

wxString AboutAppInfo::license
private

Definition at line 124 of file aboutinfo.h.

Referenced by GetLicense(), and SetLicense().

Contributors AboutAppInfo::packagers
private

Definition at line 121 of file aboutinfo.h.

Referenced by AddPackager(), and GetPackagers().

Contributors AboutAppInfo::translators
private

Definition at line 120 of file aboutinfo.h.

Referenced by AddTranslator(), and GetTranslators().


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