KiCad PCB EDA Suite
CONTRIBUTOR Class Reference

A contributor, a person which was involved in the development of the application or which has contributed in any kind somehow to the project. More...

#include <aboutinfo.h>

Public Member Functions

 CONTRIBUTOR (const wxString &aName, const wxString &aEmail=wxEmptyString, const wxString &aUrl=wxEmptyString, const wxString &aCategory=wxEmptyString, wxBitmap *aIcon=NULL)
 
virtual ~CONTRIBUTOR ()
 
wxString & GetName ()
 
wxString & GetEMail ()
 
wxString & GetUrl ()
 
wxString & GetCategory ()
 
wxBitmap * GetIcon ()
 
void SetChecked (bool status)
 
bool IsChecked ()
 

Private Attributes

wxString m_name
 
wxString m_email
 
wxString m_url
 
wxString m_category
 
wxBitmap * m_icon
 
bool m_checked
 

Detailed Description

A contributor, a person which was involved in the development of the application or which has contributed in any kind somehow to the project.

A contributor consists of the following mandatory information:

  • Name

Each contributor can have optional information assigned like:

  • EMail address
  • A category
  • A category specific icon

Definition at line 152 of file aboutinfo.h.

Constructor & Destructor Documentation

◆ CONTRIBUTOR()

CONTRIBUTOR::CONTRIBUTOR ( const wxString &  aName,
const wxString &  aEmail = wxEmptyString,
const wxString &  aUrl = wxEmptyString,
const wxString &  aCategory = wxEmptyString,
wxBitmap *  aIcon = NULL 
)
inline

Definition at line 155 of file aboutinfo.h.

160  {
161  m_checked = false;
162  m_name = aName;
163  m_url = aUrl,
164  m_email = aEmail;
165  m_category = aCategory;
166  m_icon = aIcon;
167  }
wxString m_category
Definition: aboutinfo.h:183
wxString m_email
Definition: aboutinfo.h:181
bool m_checked
Definition: aboutinfo.h:185
wxBitmap * m_icon
Definition: aboutinfo.h:184
wxString m_name
Definition: aboutinfo.h:180
wxString m_url
Definition: aboutinfo.h:182

References m_category, m_checked, m_email, m_icon, m_name, and m_url.

◆ ~CONTRIBUTOR()

virtual CONTRIBUTOR::~CONTRIBUTOR ( )
inlinevirtual

Definition at line 169 of file aboutinfo.h.

169 {}

Member Function Documentation

◆ GetCategory()

wxString& CONTRIBUTOR::GetCategory ( )
inline

Definition at line 174 of file aboutinfo.h.

174 { return m_category; }
wxString m_category
Definition: aboutinfo.h:183

References m_category.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ GetEMail()

wxString& CONTRIBUTOR::GetEMail ( )
inline

Definition at line 172 of file aboutinfo.h.

172 { return m_email; }
wxString m_email
Definition: aboutinfo.h:181

References m_email.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

◆ GetIcon()

wxBitmap* CONTRIBUTOR::GetIcon ( )
inline

Definition at line 175 of file aboutinfo.h.

175 { return m_icon; }
wxBitmap * m_icon
Definition: aboutinfo.h:184

References m_icon.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

◆ GetName()

wxString& CONTRIBUTOR::GetName ( void  )
inline

Definition at line 171 of file aboutinfo.h.

171 { return m_name; }
wxString m_name
Definition: aboutinfo.h:180

References m_name.

Referenced by DIALOG_ABOUT::createNotebookPage(), and DIALOG_ABOUT::createNotebookPageByCategory().

◆ GetUrl()

wxString& CONTRIBUTOR::GetUrl ( )
inline

Definition at line 173 of file aboutinfo.h.

173 { return m_url; }
wxString m_url
Definition: aboutinfo.h:182

References m_url.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ IsChecked()

bool CONTRIBUTOR::IsChecked ( )
inline

Definition at line 177 of file aboutinfo.h.

177 { return m_checked; }
bool m_checked
Definition: aboutinfo.h:185

References m_checked.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

◆ SetChecked()

void CONTRIBUTOR::SetChecked ( bool  status)
inline

Definition at line 176 of file aboutinfo.h.

176 { m_checked = status; }
bool m_checked
Definition: aboutinfo.h:185

References m_checked.

Referenced by DIALOG_ABOUT::createNotebookPageByCategory().

Member Data Documentation

◆ m_category

wxString CONTRIBUTOR::m_category
private

Definition at line 183 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetCategory().

◆ m_checked

bool CONTRIBUTOR::m_checked
private

Definition at line 185 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), IsChecked(), and SetChecked().

◆ m_email

wxString CONTRIBUTOR::m_email
private

Definition at line 181 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetEMail().

◆ m_icon

wxBitmap* CONTRIBUTOR::m_icon
private

Definition at line 184 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetIcon().

◆ m_name

wxString CONTRIBUTOR::m_name
private

Definition at line 180 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetName().

◆ m_url

wxString CONTRIBUTOR::m_url
private

Definition at line 182 of file aboutinfo.h.

Referenced by CONTRIBUTOR(), and GetUrl().


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