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 &name, const wxString &email, const wxString &category=wxEmptyString, wxBitmap *icon=NULL)
 
virtual ~Contributor ()
 
wxString & GetName ()
 
wxString & GetEMail ()
 
wxString & GetCategory ()
 
wxBitmap * GetIcon ()
 
void SetChecked (bool status)
 
bool IsChecked ()
 

Private Attributes

wxString m_name
 
wxString m_email
 
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
  • EMail address

Each contributor can have optional information assigned like:

  • A category
  • A category specific icon

Definition at line 147 of file aboutinfo.h.

Constructor & Destructor Documentation

Contributor::Contributor ( const wxString &  name,
const wxString &  email,
const wxString &  category = wxEmptyString,
wxBitmap *  icon = NULL 
)
inline

Definition at line 150 of file aboutinfo.h.

References m_category, m_email, m_icon, and m_name.

153  :
154  m_checked( false )
155  { m_name = name; m_email = email; m_category = category; m_icon = icon; }
wxBitmap * m_icon
Definition: aboutinfo.h:170
wxString m_email
Definition: aboutinfo.h:168
wxString m_name
Definition: aboutinfo.h:167
wxString m_category
Definition: aboutinfo.h:169
bool m_checked
Definition: aboutinfo.h:171
virtual Contributor::~Contributor ( )
inlinevirtual

Definition at line 157 of file aboutinfo.h.

157 {}

Member Function Documentation

wxString& Contributor::GetCategory ( )
inline

Definition at line 161 of file aboutinfo.h.

References m_category.

Referenced by dialog_about::CreateNotebookPageByCategory().

161 { return m_category; }
wxString m_category
Definition: aboutinfo.h:169
wxString& Contributor::GetEMail ( )
inline

Definition at line 160 of file aboutinfo.h.

References m_email.

Referenced by dialog_about::CreateNotebookPage(), and dialog_about::CreateNotebookPageByCategory().

160 { return m_email; }
wxString m_email
Definition: aboutinfo.h:168
wxBitmap* Contributor::GetIcon ( )
inline

Definition at line 162 of file aboutinfo.h.

References m_icon.

Referenced by dialog_about::CreateNotebookPage(), and dialog_about::CreateNotebookPageByCategory().

162 { return m_icon; }
wxBitmap * m_icon
Definition: aboutinfo.h:170
wxString& Contributor::GetName ( void  )
inline

Definition at line 159 of file aboutinfo.h.

References m_name.

Referenced by dialog_about::CreateNotebookPage(), and dialog_about::CreateNotebookPageByCategory().

159 { return m_name; }
wxString m_name
Definition: aboutinfo.h:167
bool Contributor::IsChecked ( )
inline

Definition at line 164 of file aboutinfo.h.

References m_checked.

Referenced by dialog_about::CreateNotebookPageByCategory().

164 { return m_checked; }
bool m_checked
Definition: aboutinfo.h:171
void Contributor::SetChecked ( bool  status)
inline

Definition at line 163 of file aboutinfo.h.

References m_checked.

Referenced by dialog_about::CreateNotebookPageByCategory().

163 { m_checked = status; }
bool m_checked
Definition: aboutinfo.h:171

Member Data Documentation

wxString Contributor::m_category
private

Definition at line 169 of file aboutinfo.h.

Referenced by Contributor(), and GetCategory().

bool Contributor::m_checked
private

Definition at line 171 of file aboutinfo.h.

Referenced by IsChecked(), and SetChecked().

wxString Contributor::m_email
private

Definition at line 168 of file aboutinfo.h.

Referenced by Contributor(), and GetEMail().

wxBitmap* Contributor::m_icon
private

Definition at line 170 of file aboutinfo.h.

Referenced by Contributor(), and GetIcon().

wxString Contributor::m_name
private

Definition at line 167 of file aboutinfo.h.

Referenced by Contributor(), and GetName().


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