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

#include <panel_jobs.h>

Inheritance diagram for PANEL_JOBS:
PANEL_JOBS_BASE PANEL_NOTEBOOK_BASE

Public Member Functions

 PANEL_JOBS (wxAuiNotebook *aParent, KICAD_MANAGER_FRAME *aFrame, std::unique_ptr< JOBSET > aJobsFile)
 
 ~PANEL_JOBS ()
 
void RemoveOutput (JOBSET_OUTPUT *aOutput)
 
void EnsurePcbSchFramesOpen ()
 
virtual bool canWindowClose ()
 
virtual void doWindowClose ()
 
void SetProjectTied (bool aYes)
 
bool GetProjectTied ()
 
void SetClosable (bool aYes)
 
bool GetClosable () const
 

Protected Member Functions

virtual void OnAddJobClick (wxCommandEvent &aEvent) override
 
virtual void OnAddOutputClick (wxCommandEvent &aEvent) override
 
virtual void OnJobListDoubleClicked (wxListEvent &aEvent) override
 
virtual void OnJobListItemRightClick (wxListEvent &event) override
 
virtual void OnSaveButtonClick (wxCommandEvent &aEvent) override
 
virtual void OnJobButtonUp (wxCommandEvent &aEvent) override
 
virtual void OnJobButtonDown (wxCommandEvent &aEvent) override
 
virtual void OnRunAllJobsClick (wxCommandEvent &event) override
 
bool GetCanClose () override
 

Protected Attributes

wxStaticText * m_staticText1
 
wxListCtrl * m_jobList
 
wxBitmapButton * m_buttonAddJob
 
wxBitmapButton * m_buttonUp
 
wxBitmapButton * m_buttonDown
 
wxButton * m_buttonSave
 
wxStaticText * m_staticText4
 
wxBitmapButton * m_buttonOutputAdd
 
wxScrolledWindow * m_outputList
 
wxBoxSizer * m_outputListSizer
 
wxButton * m_buttonRunAllOutputs
 

Private Member Functions

void rebuildJobList ()
 
void updateTitle ()
 
void buildOutputList ()
 
void addJobOutputPanel (JOBSET_OUTPUT *aOutput)
 
void onJobListMenu (wxCommandEvent &aEvent)
 
void openJobOptionsForListItem (size_t aItemIndex)
 

Private Attributes

wxAuiNotebook * m_parentBook
 
KICAD_MANAGER_FRAME * m_frame
 
std::unique_ptr< JOBSET > m_jobsFile
 
std::unordered_map< JOBSET_OUTPUT *, PANEL_JOB_OUTPUT * > m_outputPanelMap
 
bool m_closable = false
 
bool m_projectTied = false
 

Detailed Description

Definition at line 32 of file panel_jobs.h.

Constructor & Destructor Documentation

◆ PANEL_JOBS()

PANEL_JOBS::PANEL_JOBS ( wxAuiNotebook *  aParent,
KICAD_MANAGER_FRAME *  aFrame,
std::unique_ptr< JOBSET >  aJobsFile 
)

Definition at line 304 of file panel_jobs.cpp.

References _, buildOutputList(), KiBitmapBundle(), PANEL_JOBS_BASE::m_buttonAddJob, PANEL_JOBS_BASE::m_buttonDown, PANEL_JOBS_BASE::m_buttonOutputAdd, PANEL_JOBS_BASE::m_buttonRunAllOutputs, PANEL_JOBS_BASE::m_buttonUp, PANEL_JOBS_BASE::m_jobList, m_jobsFile, onJobListMenu(), and rebuildJobList().

◆ ~PANEL_JOBS()

PANEL_JOBS::~PANEL_JOBS ( )

Definition at line 331 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobList, and onJobListMenu().

Member Function Documentation

◆ addJobOutputPanel()

void PANEL_JOBS::addJobOutputPanel ( JOBSET_OUTPUT *  aOutput)
private

Definition at line 388 of file panel_jobs.cpp.

References m_frame, m_jobsFile, PANEL_JOBS_BASE::m_outputList, PANEL_JOBS_BASE::m_outputListSizer, and m_outputPanelMap.

Referenced by buildOutputList(), and OnAddOutputClick().

◆ buildOutputList()

void PANEL_JOBS::buildOutputList ( )
private

Definition at line 400 of file panel_jobs.cpp.

References addJobOutputPanel(), m_jobsFile, and m_outputPanelMap.

Referenced by PANEL_JOBS().

◆ canWindowClose()

virtual bool PANEL_NOTEBOOK_BASE::canWindowClose ( )
inlinevirtualinherited

Definition at line 37 of file panel_notebook_base.h.

◆ doWindowClose()

virtual void PANEL_NOTEBOOK_BASE::doWindowClose ( )
inlinevirtualinherited

Definition at line 38 of file panel_notebook_base.h.

◆ EnsurePcbSchFramesOpen()

void PANEL_JOBS::EnsurePcbSchFramesOpen ( )

Definition at line 605 of file panel_jobs.cpp.

References FRAME_PCB_EDITOR, FRAME_SCH, FILEEXT::KiCadSchematicFileExtension, KIWAY_HOLDER::Kiway(), m_frame, KIWAY_PLAYER::OpenProjectFiles(), KIWAY::Player(), KIWAY::Prj(), and project.

Referenced by PANEL_JOB_OUTPUT::OnOutputRunClick(), OnRunAllJobsClick(), and openJobOptionsForListItem().

◆ GetCanClose()

bool PANEL_JOBS::GetCanClose ( )
overrideprotectedvirtual

Reimplemented from PANEL_NOTEBOOK_BASE.

Definition at line 584 of file panel_jobs.cpp.

References _, HandleUnsavedChanges(), and m_jobsFile.

◆ GetClosable()

bool PANEL_NOTEBOOK_BASE::GetClosable ( ) const
inlineinherited

Definition at line 44 of file panel_notebook_base.h.

References PANEL_NOTEBOOK_BASE::m_closable.

Referenced by KICAD_MANAGER_FRAME::onNotebookPageCloseRequest().

◆ GetProjectTied()

bool PANEL_NOTEBOOK_BASE::GetProjectTied ( )
inlineinherited

Definition at line 41 of file panel_notebook_base.h.

References PANEL_NOTEBOOK_BASE::m_projectTied.

Referenced by KICAD_MANAGER_FRAME::CloseProject().

◆ OnAddJobClick()

void PANEL_JOBS::OnAddJobClick ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 499 of file panel_jobs.cpp.

References _, JOB_REGISTRY::GetRegistry(), EDA_LIST_DIALOG::GetTextSelection(), m_jobsFile, rebuildJobList(), EDA_LIST_DIALOG::SetListLabel(), and DIALOG_SHIM::ShowModal().

◆ OnAddOutputClick()

void PANEL_JOBS::OnAddOutputClick ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 546 of file panel_jobs.cpp.

References _, addJobOutputPanel(), EDA_LIST_DIALOG::GetTextSelection(), EDA_LIST_DIALOG::HideFilter(), jobTypeInfos, PANEL_JOBS_BASE::m_buttonRunAllOutputs, m_jobsFile, EDA_LIST_DIALOG::SetListLabel(), and DIALOG_SHIM::ShowModal().

◆ OnJobButtonDown()

void PANEL_JOBS::OnJobButtonDown ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 662 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobList, m_jobsFile, and rebuildJobList().

◆ OnJobButtonUp()

void PANEL_JOBS::OnJobButtonUp ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 644 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobList, m_jobsFile, and rebuildJobList().

◆ OnJobListDoubleClicked()

void PANEL_JOBS::OnJobListDoubleClicked ( wxListEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 442 of file panel_jobs.cpp.

References openJobOptionsForListItem().

◆ OnJobListItemRightClick()

void PANEL_JOBS::OnJobListItemRightClick ( wxListEvent &  event)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 450 of file panel_jobs.cpp.

References _, and PANEL_JOBS_BASE::m_jobList.

◆ onJobListMenu()

void PANEL_JOBS::onJobListMenu ( wxCommandEvent &  aEvent)
private

Definition at line 460 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobList, m_jobsFile, openJobOptionsForListItem(), and rebuildJobList().

Referenced by PANEL_JOBS(), and ~PANEL_JOBS().

◆ OnRunAllJobsClick()

void PANEL_JOBS::OnRunAllJobsClick ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 679 of file panel_jobs.cpp.

References _, DisplayError(), EnsurePcbSchFramesOpen(), KIWAY_HOLDER::Kiway(), m_frame, m_jobsFile, Prj(), project, and JOBS_RUNNER::RunJobsAllOutputs().

◆ OnSaveButtonClick()

void PANEL_JOBS::OnSaveButtonClick ( wxCommandEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 492 of file panel_jobs.cpp.

References m_jobsFile, and updateTitle().

◆ openJobOptionsForListItem()

void PANEL_JOBS::openJobOptionsForListItem ( size_t  aItemIndex)
private

Definition at line 416 of file panel_jobs.cpp.

References EnsurePcbSchFramesOpen(), JOB_REGISTRY::GetKifaceType(), KIWAY_HOLDER::Kiway(), KIWAY::KIWAY_FACE_COUNT, m_frame, JOBSET_JOB::m_job, m_jobsFile, JOBSET_JOB::m_type, KIWAY::ProcessJobConfigDialog(), and DIALOG_SHIM::ShowModal().

Referenced by OnJobListDoubleClicked(), and onJobListMenu().

◆ rebuildJobList()

void PANEL_JOBS::rebuildJobList ( )
private

Definition at line 360 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobList, m_jobsFile, and updateTitle().

Referenced by OnAddJobClick(), OnJobButtonDown(), OnJobButtonUp(), onJobListMenu(), and PANEL_JOBS().

◆ RemoveOutput()

void PANEL_JOBS::RemoveOutput ( JOBSET_OUTPUT *  aOutput)

Definition at line 338 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_buttonRunAllOutputs, m_jobsFile, PANEL_JOBS_BASE::m_outputList, PANEL_JOBS_BASE::m_outputListSizer, and m_outputPanelMap.

Referenced by PANEL_JOB_OUTPUT::onMenu().

◆ SetClosable()

void PANEL_NOTEBOOK_BASE::SetClosable ( bool  aYes)
inlineinherited

Definition at line 43 of file panel_notebook_base.h.

References PANEL_NOTEBOOK_BASE::m_closable.

Referenced by KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), and KICAD_MANAGER_FRAME::OpenJobsFile().

◆ SetProjectTied()

void PANEL_NOTEBOOK_BASE::SetProjectTied ( bool  aYes)
inlineinherited

Definition at line 40 of file panel_notebook_base.h.

References PANEL_NOTEBOOK_BASE::m_projectTied.

Referenced by KICAD_MANAGER_FRAME::OpenJobsFile().

◆ updateTitle()

void PANEL_JOBS::updateTitle ( )
private

Definition at line 376 of file panel_jobs.cpp.

References m_jobsFile, and m_parentBook.

Referenced by OnSaveButtonClick(), and rebuildJobList().

Member Data Documentation

◆ m_buttonAddJob

wxBitmapButton* PANEL_JOBS_BASE::m_buttonAddJob
protectedinherited

Definition at line 50 of file panel_jobs_base.h.

Referenced by PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_buttonDown

wxBitmapButton* PANEL_JOBS_BASE::m_buttonDown
protectedinherited

Definition at line 52 of file panel_jobs_base.h.

Referenced by PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_buttonOutputAdd

wxBitmapButton* PANEL_JOBS_BASE::m_buttonOutputAdd
protectedinherited

Definition at line 55 of file panel_jobs_base.h.

Referenced by PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_buttonRunAllOutputs

wxButton* PANEL_JOBS_BASE::m_buttonRunAllOutputs
protectedinherited

Definition at line 58 of file panel_jobs_base.h.

Referenced by OnAddOutputClick(), PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), RemoveOutput(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_buttonSave

wxButton* PANEL_JOBS_BASE::m_buttonSave
protectedinherited

Definition at line 53 of file panel_jobs_base.h.

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

◆ m_buttonUp

wxBitmapButton* PANEL_JOBS_BASE::m_buttonUp
protectedinherited

Definition at line 51 of file panel_jobs_base.h.

Referenced by PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_closable

bool PANEL_NOTEBOOK_BASE::m_closable = false
privateinherited

Definition at line 49 of file panel_notebook_base.h.

Referenced by PANEL_NOTEBOOK_BASE::GetClosable(), and PANEL_NOTEBOOK_BASE::SetClosable().

◆ m_frame

KICAD_MANAGER_FRAME* PANEL_JOBS::m_frame
private

Definition at line 65 of file panel_jobs.h.

Referenced by addJobOutputPanel(), EnsurePcbSchFramesOpen(), OnRunAllJobsClick(), and openJobOptionsForListItem().

◆ m_jobList

wxListCtrl* PANEL_JOBS_BASE::m_jobList
protectedinherited

Definition at line 49 of file panel_jobs_base.h.

Referenced by OnJobButtonDown(), OnJobButtonUp(), OnJobListItemRightClick(), onJobListMenu(), PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), rebuildJobList(), ~PANEL_JOBS(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

◆ m_jobsFile

std::unique_ptr<JOBSET> PANEL_JOBS::m_jobsFile
private

Definition at line 66 of file panel_jobs.h.

Referenced by addJobOutputPanel(), buildOutputList(), GetCanClose(), OnAddJobClick(), OnAddOutputClick(), OnJobButtonDown(), OnJobButtonUp(), onJobListMenu(), OnRunAllJobsClick(), OnSaveButtonClick(), openJobOptionsForListItem(), PANEL_JOBS(), rebuildJobList(), RemoveOutput(), and updateTitle().

◆ m_outputList

wxScrolledWindow* PANEL_JOBS_BASE::m_outputList
protectedinherited

Definition at line 56 of file panel_jobs_base.h.

Referenced by addJobOutputPanel(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and RemoveOutput().

◆ m_outputListSizer

wxBoxSizer* PANEL_JOBS_BASE::m_outputListSizer
protectedinherited

Definition at line 57 of file panel_jobs_base.h.

Referenced by addJobOutputPanel(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), and RemoveOutput().

◆ m_outputPanelMap

std::unordered_map<JOBSET_OUTPUT*, PANEL_JOB_OUTPUT*> PANEL_JOBS::m_outputPanelMap
private

Definition at line 68 of file panel_jobs.h.

Referenced by addJobOutputPanel(), buildOutputList(), and RemoveOutput().

◆ m_parentBook

wxAuiNotebook* PANEL_JOBS::m_parentBook
private

Definition at line 64 of file panel_jobs.h.

Referenced by updateTitle().

◆ m_projectTied

bool PANEL_NOTEBOOK_BASE::m_projectTied = false
privateinherited

Definition at line 50 of file panel_notebook_base.h.

Referenced by PANEL_NOTEBOOK_BASE::GetProjectTied(), and PANEL_NOTEBOOK_BASE::SetProjectTied().

◆ m_staticText1

wxStaticText* PANEL_JOBS_BASE::m_staticText1
protectedinherited

Definition at line 48 of file panel_jobs_base.h.

Referenced by PANEL_JOBS_BASE::PANEL_JOBS_BASE().

◆ m_staticText4

wxStaticText* PANEL_JOBS_BASE::m_staticText4
protectedinherited

Definition at line 54 of file panel_jobs_base.h.

Referenced by PANEL_JOBS_BASE::PANEL_JOBS_BASE().

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