PANEL_JOBS Class Reference

#include <panel_jobs.h>

Inheritance diagram for PANEL_JOBS:

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 ()
wxString	GetFilePath () const
void	UpdateTitle ()
JOBSET *	GetJobsFile ()
bool	OpenJobOptionsForListItem (size_t aItemIndex)
void	OnJobButtonDelete (wxCommandEvent &aEvent) override
virtual bool	canWindowClose ()
virtual void	doWindowClose ()
void	SetProjectTied (bool aYes)
bool	GetProjectTied ()
void	SetClosable (bool aYes)
bool	GetClosable () const

Protected Member Functions
virtual void	OnSizeGrid (wxSizeEvent &aEvent) override
virtual void	OnAddJobClick (wxCommandEvent &aEvent) override
virtual void	OnAddOutputClick (wxCommandEvent &aEvent) 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
WX_GRID *	m_jobsGrid
STD_BITMAP_BUTTON *	m_buttonAddJob
STD_BITMAP_BUTTON *	m_buttonUp
STD_BITMAP_BUTTON *	m_buttonDown
STD_BITMAP_BUTTON *	m_buttonDelete
wxScrolledWindow *	m_outputList
wxBoxSizer *	m_outputListSizer
STD_BITMAP_BUTTON *	m_buttonOutputAdd
wxButton *	m_buttonSave
wxButton *	m_buttonRunAllOutputs

Private Member Functions
void	rebuildJobList ()
void	buildOutputList ()
void	addJobOutputPanel (JOBSET_OUTPUT *aOutput)

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 58 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 536 of file panel_jobs.cpp.

References buildOutputList(), KiBitmapBundle(), PANEL_JOBS_BASE::m_buttonAddJob, PANEL_JOBS_BASE::m_buttonDelete, PANEL_JOBS_BASE::m_buttonDown, PANEL_JOBS_BASE::m_buttonOutputAdd, PANEL_JOBS_BASE::m_buttonRunAllOutputs, PANEL_JOBS_BASE::m_buttonUp, m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, WX_GRID::OverrideMinSize(), rebuildJobList(), and STD_BITMAP_BUTTON::SetBitmap().

~PANEL_JOBS()

PANEL_JOBS::~PANEL_JOBS

(

)

Definition at line 566 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobsGrid.

Member Function Documentation

addJobOutputPanel()

void PANEL_JOBS::addJobOutputPanel ( JOBSET_OUTPUT *  aOutput )

private

Definition at line 654 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 666 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 854 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 833 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().

GetFilePath()

wxString PANEL_JOBS::GetFilePath

(

)

const

Definition at line 898 of file panel_jobs.cpp.

References m_jobsFile.

Referenced by KICAD_MANAGER_FRAME::OpenJobsFile().

GetJobsFile()

JOBSET * PANEL_JOBS::GetJobsFile ( )

inline

Definition at line 73 of file panel_jobs.h.

References m_jobsFile.

Referenced by JOBS_GRID_TRICKS::handleDoubleClick().

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 725 of file panel_jobs.cpp.

References _, JOB_REGISTRY::GetRegistry(), EDA_LIST_DIALOG::GetTextSelection(), m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, OpenJobOptionsForListItem(), 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 786 of file panel_jobs.cpp.

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

OnJobButtonDelete()

void PANEL_JOBS::OnJobButtonDelete ( wxCommandEvent &  aEvent )

overridevirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 948 of file panel_jobs.cpp.

References WX_GRID::CommitPendingChanges(), m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, and rebuildJobList().

Referenced by JOBS_GRID_TRICKS::doPopupSelection().

OnJobButtonDown()

void PANEL_JOBS::OnJobButtonDown ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 926 of file panel_jobs.cpp.

References WX_GRID::CommitPendingChanges(), m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, and rebuildJobList().

OnJobButtonUp()

void PANEL_JOBS::OnJobButtonUp ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 904 of file panel_jobs.cpp.

References WX_GRID::CommitPendingChanges(), m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, and rebuildJobList().

OnRunAllJobsClick()

void PANEL_JOBS::OnRunAllJobsClick ( wxCommandEvent &  event )

overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 979 of file panel_jobs.cpp.

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

OnSaveButtonClick()

void PANEL_JOBS::OnSaveButtonClick ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 718 of file panel_jobs.cpp.

References m_jobsFile, and UpdateTitle().

OnSizeGrid()

void PANEL_JOBS::OnSizeGrid ( wxSizeEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBS_BASE.

Definition at line 1015 of file panel_jobs.cpp.

References PANEL_JOBS_BASE::m_jobsGrid.

OpenJobOptionsForListItem()

bool PANEL_JOBS::OpenJobOptionsForListItem

(

size_t

aItemIndex

)

Definition at line 680 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(), DIALOG_SHIM::ShowModal(), and UpdateTitle().

Referenced by JOBS_GRID_TRICKS::doPopupSelection(), JOBS_GRID_TRICKS::handleDoubleClick(), and OnAddJobClick().

rebuildJobList()

void PANEL_JOBS::rebuildJobList ( )

private

Definition at line 596 of file panel_jobs.cpp.

References STD_BITMAP_BUTTON::Enable(), PANEL_JOBS_BASE::m_buttonDown, PANEL_JOBS_BASE::m_buttonRunAllOutputs, PANEL_JOBS_BASE::m_buttonUp, m_jobsFile, PANEL_JOBS_BASE::m_jobsGrid, m_outputPanelMap, PANEL_JOB_OUTPUT::UpdateStatus(), and UpdateTitle().

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

RemoveOutput()

void PANEL_JOBS::RemoveOutput

(

JOBSET_OUTPUT *

aOutput

)

Definition at line 573 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::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

(

)

Definition at line 642 of file panel_jobs.cpp.

References m_jobsFile, and m_parentBook.

Referenced by PANEL_JOB_OUTPUT::onMenu(), OnSaveButtonClick(), OpenJobOptionsForListItem(), and rebuildJobList().

Member Data Documentation

m_buttonAddJob

STD_BITMAP_BUTTON* PANEL_JOBS_BASE::m_buttonAddJob

protectedinherited

Definition at line 54 of file panel_jobs_base.h.

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

m_buttonDelete

STD_BITMAP_BUTTON* PANEL_JOBS_BASE::m_buttonDelete

protectedinherited

Definition at line 57 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

STD_BITMAP_BUTTON* PANEL_JOBS_BASE::m_buttonDown

protectedinherited

Definition at line 56 of file panel_jobs_base.h.

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

m_buttonOutputAdd

STD_BITMAP_BUTTON* PANEL_JOBS_BASE::m_buttonOutputAdd

protectedinherited

Definition at line 60 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 62 of file panel_jobs_base.h.

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

m_buttonSave

wxButton* PANEL_JOBS_BASE::m_buttonSave

protectedinherited

Definition at line 61 of file panel_jobs_base.h.

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

m_buttonUp

STD_BITMAP_BUTTON* PANEL_JOBS_BASE::m_buttonUp

protectedinherited

Definition at line 55 of file panel_jobs_base.h.

Referenced by PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), rebuildJobList(), 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 96 of file panel_jobs.h.

Referenced by addJobOutputPanel(), EnsurePcbSchFramesOpen(), OnAddOutputClick(), OnRunAllJobsClick(), and OpenJobOptionsForListItem().

m_jobsFile

std::unique_ptr<JOBSET> PANEL_JOBS::m_jobsFile

private

Definition at line 97 of file panel_jobs.h.

Referenced by addJobOutputPanel(), buildOutputList(), GetCanClose(), GetFilePath(), GetJobsFile(), OnAddJobClick(), OnAddOutputClick(), OnJobButtonDelete(), OnJobButtonDown(), OnJobButtonUp(), OnRunAllJobsClick(), OnSaveButtonClick(), OpenJobOptionsForListItem(), PANEL_JOBS(), rebuildJobList(), RemoveOutput(), and UpdateTitle().

m_jobsGrid

WX_GRID* PANEL_JOBS_BASE::m_jobsGrid

protectedinherited

Definition at line 53 of file panel_jobs_base.h.

Referenced by OnAddJobClick(), OnJobButtonDelete(), OnJobButtonDown(), OnJobButtonUp(), OnSizeGrid(), PANEL_JOBS(), PANEL_JOBS_BASE::PANEL_JOBS_BASE(), rebuildJobList(), ~PANEL_JOBS(), and PANEL_JOBS_BASE::~PANEL_JOBS_BASE().

m_outputList

wxScrolledWindow* PANEL_JOBS_BASE::m_outputList

protectedinherited

Definition at line 58 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 59 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 99 of file panel_jobs.h.

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

m_parentBook

wxAuiNotebook* PANEL_JOBS::m_parentBook

private

Definition at line 95 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().

---

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

• panel_jobs.h
• panel_jobs.cpp