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

#include <panel_plugin_settings.h>

Inheritance diagram for PANEL_PLUGIN_SETTINGS:
PANEL_PLUGIN_SETTINGS_BASE RESETTABLE_PANEL

Public Member Functions

 PANEL_PLUGIN_SETTINGS (wxWindow *aParent)
 
void ResetPanel () override
 Reset the contents of this panel.
 
virtual wxString GetResetTooltip () const
 Get the tooltip the reset button should display when showing this panel.
 
wxString GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override
 Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.
 

Public Attributes

wxStaticText * m_stPythonStatus
 

Protected Member Functions

bool TransferDataFromWindow () override
 
bool TransferDataToWindow () override
 
void OnPythonInterpreterChanged (wxFileDirPickerEvent &event) override
 
void OnBtnDetectAutomaticallyClicked (wxCommandEvent &aEvent) override
 
void OnEnableApiChecked (wxCommandEvent &aEvent) override
 

Protected Attributes

wxStaticText * m_staticText3
 
wxCheckBox * m_cbEnableApi
 
wxStaticText * m_stApiStatus
 
wxStaticText * m_staticText2
 
wxFilePickerCtrl * m_pickerPythonInterpreter
 
wxButton * m_btnDetectAutomatically
 

Private Member Functions

void updateApiStatusText ()
 
void validatePythonInterpreter ()
 

Private Attributes

bool m_pythonInterpreterValid
 

Detailed Description

Definition at line 29 of file panel_plugin_settings.h.

Constructor & Destructor Documentation

◆ PANEL_PLUGIN_SETTINGS()

PANEL_PLUGIN_SETTINGS::PANEL_PLUGIN_SETTINGS ( wxWindow *  aParent)

Definition at line 30 of file panel_plugin_settings.cpp.

References KIUI::GetInfoFont(), PANEL_PLUGIN_SETTINGS_BASE::m_stApiStatus, and PANEL_PLUGIN_SETTINGS_BASE::m_stPythonStatus.

Member Function Documentation

◆ GetHelpTextAtPoint()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint ( const wxPoint &  aPt,
wxHelpEvent::Origin  aOrigin 
) const
inlineoverrideinherited

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

References RESETTABLE_PANEL::GetResetTooltip().

◆ GetResetTooltip()

virtual wxString RESETTABLE_PANEL::GetResetTooltip ( ) const
inlinevirtualinherited

Get the tooltip the reset button should display when showing this panel.

Returns
the tooltip

Reimplemented in PANEL_COLOR_SETTINGS, and PANEL_HOTKEYS_EDITOR.

Definition at line 64 of file resettable_panel.h.

References _.

Referenced by RESETTABLE_PANEL::GetHelpTextAtPoint().

◆ OnBtnDetectAutomaticallyClicked()

void PANEL_PLUGIN_SETTINGS::OnBtnDetectAutomaticallyClicked ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_PLUGIN_SETTINGS_BASE.

Definition at line 79 of file panel_plugin_settings.cpp.

References PANEL_PLUGIN_SETTINGS_BASE::m_pickerPythonInterpreter, and validatePythonInterpreter().

◆ OnEnableApiChecked()

void PANEL_PLUGIN_SETTINGS::OnEnableApiChecked ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_PLUGIN_SETTINGS_BASE.

Definition at line 91 of file panel_plugin_settings.cpp.

References updateApiStatusText(), and validatePythonInterpreter().

◆ OnPythonInterpreterChanged()

void PANEL_PLUGIN_SETTINGS::OnPythonInterpreterChanged ( wxFileDirPickerEvent &  event)
overrideprotectedvirtual

Reimplemented from PANEL_PLUGIN_SETTINGS_BASE.

Definition at line 73 of file panel_plugin_settings.cpp.

References validatePythonInterpreter().

◆ ResetPanel()

void PANEL_PLUGIN_SETTINGS::ResetPanel ( )
overridevirtual

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Definition at line 39 of file panel_plugin_settings.cpp.

◆ TransferDataFromWindow()

bool PANEL_PLUGIN_SETTINGS::TransferDataFromWindow ( )
overrideprotected

Definition at line 58 of file panel_plugin_settings.cpp.

References COMMON_SETTINGS::API::enable_server, SETTINGS_MANAGER::GetCommonSettings(), PGM_BASE::GetSettingsManager(), COMMON_SETTINGS::m_Api, PANEL_PLUGIN_SETTINGS_BASE::m_cbEnableApi, PANEL_PLUGIN_SETTINGS_BASE::m_pickerPythonInterpreter, m_pythonInterpreterValid, Pgm(), and COMMON_SETTINGS::API::python_interpreter.

◆ TransferDataToWindow()

bool PANEL_PLUGIN_SETTINGS::TransferDataToWindow ( )
overrideprotected

Definition at line 44 of file panel_plugin_settings.cpp.

References COMMON_SETTINGS::API::enable_server, SETTINGS_MANAGER::GetCommonSettings(), PGM_BASE::GetSettingsManager(), COMMON_SETTINGS::m_Api, PANEL_PLUGIN_SETTINGS_BASE::m_cbEnableApi, PANEL_PLUGIN_SETTINGS_BASE::m_pickerPythonInterpreter, Pgm(), COMMON_SETTINGS::API::python_interpreter, updateApiStatusText(), and validatePythonInterpreter().

◆ updateApiStatusText()

void PANEL_PLUGIN_SETTINGS::updateApiStatusText ( )
private

Definition at line 98 of file panel_plugin_settings.cpp.

References _, PANEL_PLUGIN_SETTINGS_BASE::m_cbEnableApi, PANEL_PLUGIN_SETTINGS_BASE::m_stApiStatus, and Pgm().

Referenced by OnEnableApiChecked(), and TransferDataToWindow().

◆ validatePythonInterpreter()

void PANEL_PLUGIN_SETTINGS::validatePythonInterpreter ( )
private

Definition at line 116 of file panel_plugin_settings.cpp.

References _, PANEL_PLUGIN_SETTINGS_BASE::m_cbEnableApi, PANEL_PLUGIN_SETTINGS_BASE::m_pickerPythonInterpreter, m_pythonInterpreterValid, and PANEL_PLUGIN_SETTINGS_BASE::m_stPythonStatus.

Referenced by OnBtnDetectAutomaticallyClicked(), OnEnableApiChecked(), OnPythonInterpreterChanged(), and TransferDataToWindow().

Member Data Documentation

◆ m_btnDetectAutomatically

wxButton* PANEL_PLUGIN_SETTINGS_BASE::m_btnDetectAutomatically
protectedinherited

Definition at line 45 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE(), and PANEL_PLUGIN_SETTINGS_BASE::~PANEL_PLUGIN_SETTINGS_BASE().

◆ m_cbEnableApi

wxCheckBox* PANEL_PLUGIN_SETTINGS_BASE::m_cbEnableApi
protectedinherited

Definition at line 41 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE(), TransferDataFromWindow(), TransferDataToWindow(), updateApiStatusText(), validatePythonInterpreter(), and PANEL_PLUGIN_SETTINGS_BASE::~PANEL_PLUGIN_SETTINGS_BASE().

◆ m_pickerPythonInterpreter

wxFilePickerCtrl* PANEL_PLUGIN_SETTINGS_BASE::m_pickerPythonInterpreter
protectedinherited

Definition at line 44 of file panel_plugin_settings_base.h.

Referenced by OnBtnDetectAutomaticallyClicked(), PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE(), TransferDataFromWindow(), TransferDataToWindow(), validatePythonInterpreter(), and PANEL_PLUGIN_SETTINGS_BASE::~PANEL_PLUGIN_SETTINGS_BASE().

◆ m_pythonInterpreterValid

bool PANEL_PLUGIN_SETTINGS::m_pythonInterpreterValid
private

Definition at line 48 of file panel_plugin_settings.h.

Referenced by TransferDataFromWindow(), and validatePythonInterpreter().

◆ m_stApiStatus

wxStaticText* PANEL_PLUGIN_SETTINGS_BASE::m_stApiStatus
protectedinherited

Definition at line 42 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS(), PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE(), and updateApiStatusText().

◆ m_staticText2

wxStaticText* PANEL_PLUGIN_SETTINGS_BASE::m_staticText2
protectedinherited

Definition at line 43 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE().

◆ m_staticText3

wxStaticText* PANEL_PLUGIN_SETTINGS_BASE::m_staticText3
protectedinherited

Definition at line 40 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE().

◆ m_stPythonStatus

wxStaticText* PANEL_PLUGIN_SETTINGS_BASE::m_stPythonStatus
inherited

Definition at line 54 of file panel_plugin_settings_base.h.

Referenced by PANEL_PLUGIN_SETTINGS(), PANEL_PLUGIN_SETTINGS_BASE::PANEL_PLUGIN_SETTINGS_BASE(), and validatePythonInterpreter().

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