KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TEMPLATE_WIDGET Class Reference

#include <dialog_template_selector.h>

Inheritance diagram for TEMPLATE_WIDGET:
TEMPLATE_WIDGET_BASE

Public Member Functions

 TEMPLATE_WIDGET (wxWindow *aParent, DIALOG_TEMPLATE_SELECTOR *aDialog)
 
void SetTemplate (PROJECT_TEMPLATE *aTemplate)
 Set the project template for this widget, which will determine the icon and title associated with this project template widget.
 
PROJECT_TEMPLATE * GetTemplate ()
 
void Select ()
 
void SelectWithoutStateChange ()
 
void Unselect ()
 
void SetDescription (const wxString &aDescription)
 
wxString GetDescription () const
 
void SetIsUserTemplate (bool aIsUser)
 Set whether this template widget represents a user template.
 
bool IsUserTemplate () const
 
bool IsSelected () const
 

Protected Member Functions

void OnKillFocus (wxFocusEvent &event)
 
void OnMouse (wxMouseEvent &event)
 
void OnDoubleClick (wxMouseEvent &event)
 
void OnSize (wxSizeEvent &event)
 
void onRightClick (wxMouseEvent &event)
 
void onEditTemplate (wxCommandEvent &event)
 
void onDuplicateTemplate (wxCommandEvent &event)
 

Protected Attributes

DIALOG_TEMPLATE_SELECTOR * m_dialog
 
wxWindow * m_parent
 
wxPanel * m_panel
 
bool m_selected
 
bool m_isUserTemplate
 
wxString m_description
 
PROJECT_TEMPLATE * m_currTemplate
 
wxStaticBitmap * m_bitmapIcon
 
wxStaticText * m_staticTitle
 
wxStaticText * m_staticDescription
 

Detailed Description

Definition at line 68 of file dialog_template_selector.h.

Constructor & Destructor Documentation

◆ TEMPLATE_WIDGET()

TEMPLATE_WIDGET::TEMPLATE_WIDGET ( wxWindow * aParent,
DIALOG_TEMPLATE_SELECTOR * aDialog )

Definition at line 119 of file dialog_template_selector.cpp.

References KIUI::GetInfoFont(), TEMPLATE_WIDGET_BASE::m_bitmapIcon, m_currTemplate, m_dialog, m_isUserTemplate, m_parent, TEMPLATE_WIDGET_BASE::m_staticDescription, TEMPLATE_WIDGET_BASE::m_staticTitle, OnDoubleClick(), OnMouse(), onRightClick(), OnSize(), TEMPLATE_WIDGET_BASE::TEMPLATE_WIDGET_BASE(), and Unselect().

Member Function Documentation

◆ GetDescription()

wxString TEMPLATE_WIDGET::GetDescription ( ) const
inline

Definition at line 86 of file dialog_template_selector.h.

References m_description.

◆ GetTemplate()

PROJECT_TEMPLATE * TEMPLATE_WIDGET::GetTemplate ( )
inline

Definition at line 79 of file dialog_template_selector.h.

References m_currTemplate.

Referenced by DIALOG_TEMPLATE_SELECTOR::SetWidget().

◆ IsSelected()

bool TEMPLATE_WIDGET::IsSelected ( ) const
inline

Definition at line 105 of file dialog_template_selector.h.

References m_selected.

◆ IsUserTemplate()

bool TEMPLATE_WIDGET::IsUserTemplate ( ) const
inline

Definition at line 93 of file dialog_template_selector.h.

References m_isUserTemplate.

◆ OnDoubleClick()

void TEMPLATE_WIDGET::OnDoubleClick ( wxMouseEvent & event)
protected

Definition at line 294 of file dialog_template_selector.cpp.

References m_dialog, and Select().

Referenced by TEMPLATE_WIDGET().

◆ onDuplicateTemplate()

void TEMPLATE_WIDGET::onDuplicateTemplate ( wxCommandEvent & event)
protected

Definition at line 360 of file dialog_template_selector.cpp.

References _, DisplayErrorMessage(), DisplayInfoMessage(), PROJECT_TREE_TRAVERSER::GetErrors(), m_currTemplate, and m_dialog.

Referenced by onRightClick().

◆ onEditTemplate()

void TEMPLATE_WIDGET::onEditTemplate ( wxCommandEvent & event)
protected

Definition at line 327 of file dialog_template_selector.cpp.

References _, DisplayErrorMessage(), m_currTemplate, and m_dialog.

Referenced by onRightClick().

◆ OnKillFocus()

void TEMPLATE_WIDGET::OnKillFocus ( wxFocusEvent & event)
protected

◆ OnMouse()

void TEMPLATE_WIDGET::OnMouse ( wxMouseEvent & event)
protected

Definition at line 287 of file dialog_template_selector.cpp.

References Select().

Referenced by TEMPLATE_WIDGET().

◆ onRightClick()

void TEMPLATE_WIDGET::onRightClick ( wxMouseEvent & event)
protected

Definition at line 302 of file dialog_template_selector.cpp.

References _, m_currTemplate, m_isUserTemplate, onDuplicateTemplate(), and onEditTemplate().

Referenced by TEMPLATE_WIDGET().

◆ OnSize()

void TEMPLATE_WIDGET::OnSize ( wxSizeEvent & event)
protected

Definition at line 261 of file dialog_template_selector.cpp.

References m_description, and TEMPLATE_WIDGET_BASE::m_staticDescription.

Referenced by TEMPLATE_WIDGET().

◆ Select()

void TEMPLATE_WIDGET::Select ( )

Definition at line 177 of file dialog_template_selector.cpp.

References m_dialog, m_selected, TEMPLATE_WIDGET_BASE::m_staticDescription, TEMPLATE_WIDGET_BASE::m_staticTitle, and Refresh().

Referenced by OnDoubleClick(), and OnMouse().

◆ SelectWithoutStateChange()

void TEMPLATE_WIDGET::SelectWithoutStateChange ( )

Definition at line 188 of file dialog_template_selector.cpp.

References m_selected, TEMPLATE_WIDGET_BASE::m_staticDescription, TEMPLATE_WIDGET_BASE::m_staticTitle, and Refresh().

◆ SetDescription()

void TEMPLATE_WIDGET::SetDescription ( const wxString & aDescription)

Definition at line 247 of file dialog_template_selector.cpp.

References m_description, and TEMPLATE_WIDGET_BASE::m_staticDescription.

Referenced by DIALOG_TEMPLATE_SELECTOR::BuildTemplateList().

◆ SetIsUserTemplate()

void TEMPLATE_WIDGET::SetIsUserTemplate ( bool aIsUser)
inline

Set whether this template widget represents a user template.

Parameters
aIsUsertrue if this is a user template (can be edited/duplicated)

Definition at line 92 of file dialog_template_selector.h.

References m_isUserTemplate.

Referenced by DIALOG_TEMPLATE_SELECTOR::BuildTemplateList().

◆ SetTemplate()

void TEMPLATE_WIDGET::SetTemplate ( PROJECT_TEMPLATE * aTemplate)

Set the project template for this widget, which will determine the icon and title associated with this project template widget.

Definition at line 208 of file dialog_template_selector.cpp.

References PROJECT_TEMPLATE::GetIcon(), KIUI::GetInfoFont(), PROJECT_TEMPLATE::GetTitle(), icon_kicad, KiBitmapBundleDef(), TEMPLATE_WIDGET_BASE::m_bitmapIcon, m_currTemplate, TEMPLATE_WIDGET_BASE::m_staticTitle, and scale.

Referenced by DIALOG_TEMPLATE_SELECTOR::BuildTemplateList().

◆ Unselect()

void TEMPLATE_WIDGET::Unselect ( )

Definition at line 198 of file dialog_template_selector.cpp.

References m_selected, TEMPLATE_WIDGET_BASE::m_staticDescription, TEMPLATE_WIDGET_BASE::m_staticTitle, and Refresh().

Referenced by TEMPLATE_WIDGET().

Member Data Documentation

◆ m_bitmapIcon

wxStaticBitmap* TEMPLATE_WIDGET_BASE::m_bitmapIcon
protectedinherited

Definition at line 102 of file dialog_template_selector_base.h.

Referenced by TEMPLATE_WIDGET::SetTemplate(), TEMPLATE_WIDGET::TEMPLATE_WIDGET(), and TEMPLATE_WIDGET_BASE().

◆ m_currTemplate

PROJECT_TEMPLATE* TEMPLATE_WIDGET::m_currTemplate
protected

Definition at line 115 of file dialog_template_selector.h.

Referenced by GetTemplate(), onDuplicateTemplate(), onEditTemplate(), onRightClick(), SetTemplate(), and TEMPLATE_WIDGET().

◆ m_description

wxString TEMPLATE_WIDGET::m_description
protected

Definition at line 113 of file dialog_template_selector.h.

Referenced by GetDescription(), OnSize(), and SetDescription().

◆ m_dialog

DIALOG_TEMPLATE_SELECTOR* TEMPLATE_WIDGET::m_dialog
protected

Definition at line 108 of file dialog_template_selector.h.

Referenced by OnDoubleClick(), onDuplicateTemplate(), onEditTemplate(), Select(), and TEMPLATE_WIDGET().

◆ m_isUserTemplate

bool TEMPLATE_WIDGET::m_isUserTemplate
protected

Definition at line 112 of file dialog_template_selector.h.

Referenced by IsUserTemplate(), onRightClick(), SetIsUserTemplate(), and TEMPLATE_WIDGET().

◆ m_panel

wxPanel* TEMPLATE_WIDGET::m_panel
protected

Definition at line 110 of file dialog_template_selector.h.

◆ m_parent

wxWindow* TEMPLATE_WIDGET::m_parent
protected

Definition at line 109 of file dialog_template_selector.h.

Referenced by TEMPLATE_WIDGET().

◆ m_selected

bool TEMPLATE_WIDGET::m_selected
protected

Definition at line 111 of file dialog_template_selector.h.

Referenced by IsSelected(), Select(), SelectWithoutStateChange(), and Unselect().

◆ m_staticDescription

wxStaticText* TEMPLATE_WIDGET_BASE::m_staticDescription
protectedinherited

Definition at line 104 of file dialog_template_selector_base.h.

Referenced by TEMPLATE_WIDGET::OnSize(), TEMPLATE_WIDGET::Select(), TEMPLATE_WIDGET::SelectWithoutStateChange(), TEMPLATE_WIDGET::SetDescription(), TEMPLATE_WIDGET::TEMPLATE_WIDGET(), TEMPLATE_WIDGET_BASE(), and TEMPLATE_WIDGET::Unselect().

◆ m_staticTitle

wxStaticText* TEMPLATE_WIDGET_BASE::m_staticTitle
protectedinherited

Definition at line 103 of file dialog_template_selector_base.h.

Referenced by TEMPLATE_WIDGET::Select(), TEMPLATE_WIDGET::SelectWithoutStateChange(), TEMPLATE_WIDGET::SetTemplate(), TEMPLATE_WIDGET::TEMPLATE_WIDGET(), TEMPLATE_WIDGET_BASE(), and TEMPLATE_WIDGET::Unselect().

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