PANEL_JOBSET Class Reference

#include <panel_jobset.h>

Inheritance diagram for PANEL_JOBSET:

Public Member Functions
	PANEL_JOBSET (wxAuiNotebook *aParent, KICAD_MANAGER_FRAME *aFrame, std::unique_ptr< JOBSET > aJobsFile)
	~PANEL_JOBSET ()
void	RemoveOutput (PANEL_JOBSET_OUTPUT *aPanel)
void	EnsurePcbSchFramesOpen ()
wxString	GetFilePath () const
void	UpdateTitle ()
JOBSET *	GetJobsFile ()
bool	OpenJobOptionsForListItem (size_t aItemIndex)
void	OnJobButtonDelete (wxCommandEvent &aEvent) override
std::vector< PANEL_JOBSET_OUTPUT * >	GetOutputPanels ()
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	OnGenerateAllOutputsClick (wxCommandEvent &event) override
virtual void	OnGridCellChange (wxGridEvent &aEvent) 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
bool	m_closable = false
bool	m_projectTied = false

Detailed Description

Definition at line 59 of file panel_jobset.h.

Constructor & Destructor Documentation

PANEL_JOBSET()

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

Definition at line 417 of file panel_jobset.cpp.

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

~PANEL_JOBSET()

PANEL_JOBSET::~PANEL_JOBSET

(

)

Definition at line 447 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_jobsGrid.

Member Function Documentation

addJobOutputPanel()

void PANEL_JOBSET::addJobOutputPanel ( JOBSET_OUTPUT *  aOutput )

private

Definition at line 510 of file panel_jobset.cpp.

References m_frame, m_jobsFile, PANEL_JOBSET_BASE::m_outputList, and PANEL_JOBSET_BASE::m_outputListSizer.

Referenced by buildOutputList(), and OnAddOutputClick().

buildOutputList()

void PANEL_JOBSET::buildOutputList ( )

private

Definition at line 539 of file panel_jobset.cpp.

References addJobOutputPanel(), and m_jobsFile.

Referenced by PANEL_JOBSET().

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_JOBSET::EnsurePcbSchFramesOpen

(

)

Definition at line 782 of file panel_jobset.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_JOBSET_OUTPUT::OnGenerate(), OnGenerateAllOutputsClick(), and OpenJobOptionsForListItem().

GetCanClose()

bool PANEL_JOBSET::GetCanClose ( )

overrideprotectedvirtual

Reimplemented from PANEL_NOTEBOOK_BASE.

Definition at line 761 of file panel_jobset.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_JOBSET::GetFilePath

(

)

const

Definition at line 834 of file panel_jobset.cpp.

References m_jobsFile.

GetJobsFile()

JOBSET * PANEL_JOBSET::GetJobsFile ( )

inline

Definition at line 74 of file panel_jobset.h.

References m_jobsFile.

Referenced by JOBS_GRID_TRICKS::handleDoubleClick().

GetOutputPanels()

std::vector< PANEL_JOBSET_OUTPUT * > PANEL_JOBSET::GetOutputPanels

(

)

Definition at line 525 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_outputListSizer.

Referenced by OnGenerateAllOutputsClick(), and rebuildJobList().

GetProjectTied()

bool PANEL_NOTEBOOK_BASE::GetProjectTied ( )

inlineinherited

Definition at line 41 of file panel_notebook_base.h.

References PANEL_NOTEBOOK_BASE::m_projectTied.

OnAddJobClick()

void PANEL_JOBSET::OnAddJobClick ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 619 of file panel_jobset.cpp.

References _, WX_GRID::CommitPendingChanges(), JOB_REGISTRY::GetRegistry(), EDA_LIST_DIALOG::GetTextSelection(), m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, OpenJobOptionsForListItem(), rebuildJobList(), EDA_LIST_DIALOG::SetListLabel(), and DIALOG_SHIM::ShowModal().

OnAddOutputClick()

void PANEL_JOBSET::OnAddOutputClick ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 714 of file panel_jobset.cpp.

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

OnGenerateAllOutputsClick()

void PANEL_JOBSET::OnGenerateAllOutputsClick ( wxCommandEvent &  event )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 886 of file panel_jobset.cpp.

References _, WX_GRID::CommitPendingChanges(), DisplayError(), EnsurePcbSchFramesOpen(), GetOutputPanels(), KIWAY_HOLDER::Kiway(), m_frame, m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, Prj(), project, and JOBS_RUNNER::RunJobsAllOutputs().

OnGridCellChange()

void PANEL_JOBSET::OnGridCellChange ( wxGridEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 599 of file panel_jobset.cpp.

References m_jobsFile, and PANEL_JOBSET_BASE::m_jobsGrid.

OnJobButtonDelete()

void PANEL_JOBSET::OnJobButtonDelete ( wxCommandEvent &  aEvent )

overridevirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 683 of file panel_jobset.cpp.

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

Referenced by JOBS_GRID_TRICKS::doPopupSelection().

OnJobButtonDown()

void PANEL_JOBSET::OnJobButtonDown ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 863 of file panel_jobset.cpp.

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

OnJobButtonUp()

void PANEL_JOBSET::OnJobButtonUp ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 840 of file panel_jobset.cpp.

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

OnSaveButtonClick()

void PANEL_JOBSET::OnSaveButtonClick ( wxCommandEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 609 of file panel_jobset.cpp.

References WX_GRID::CommitPendingChanges(), m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, and UpdateTitle().

OnSizeGrid()

void PANEL_JOBSET::OnSizeGrid ( wxSizeEvent &  aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 925 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_jobsGrid.

OpenJobOptionsForListItem()

bool PANEL_JOBSET::OpenJobOptionsForListItem

(

size_t

aItemIndex

)

Definition at line 552 of file panel_jobset.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_JOBSET::rebuildJobList ( )

private

Definition at line 471 of file panel_jobset.cpp.

References GetOutputPanels(), m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, and UpdateTitle().

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

RemoveOutput()

void PANEL_JOBSET::RemoveOutput

(

PANEL_JOBSET_OUTPUT *

aPanel

)

Definition at line 454 of file panel_jobset.cpp.

References PANEL_JOBSET_OUTPUT::GetOutput(), PANEL_JOBSET_BASE::m_buttonRunAllOutputs, m_jobsFile, PANEL_JOBSET_BASE::m_outputList, and PANEL_JOBSET_BASE::m_outputListSizer.

Referenced by PANEL_JOBSET_OUTPUT::OnDelete().

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_JOBSET::UpdateTitle

(

)

Definition at line 498 of file panel_jobset.cpp.

References m_jobsFile, and m_parentBook.

Referenced by PANEL_JOBSET_OUTPUT::OnProperties(), OnSaveButtonClick(), OpenJobOptionsForListItem(), and rebuildJobList().

Member Data Documentation

m_buttonAddJob

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonAddJob

protectedinherited

Definition at line 50 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_buttonDelete

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonDelete

protectedinherited

Definition at line 53 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_buttonDown

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonDown

protectedinherited

Definition at line 52 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_buttonOutputAdd

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonOutputAdd

protectedinherited

Definition at line 56 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_buttonRunAllOutputs

wxButton* PANEL_JOBSET_BASE::m_buttonRunAllOutputs

protectedinherited

Definition at line 58 of file panel_jobset_base.h.

Referenced by OnAddOutputClick(), PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), RemoveOutput(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_buttonSave

wxButton* PANEL_JOBSET_BASE::m_buttonSave

protectedinherited

Definition at line 57 of file panel_jobset_base.h.

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

m_buttonUp

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonUp

protectedinherited

Definition at line 51 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_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_JOBSET::m_frame

private

Definition at line 100 of file panel_jobset.h.

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

m_jobsFile

std::unique_ptr<JOBSET> PANEL_JOBSET::m_jobsFile

private

Definition at line 101 of file panel_jobset.h.

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

m_jobsGrid

WX_GRID* PANEL_JOBSET_BASE::m_jobsGrid

protectedinherited

Definition at line 49 of file panel_jobset_base.h.

Referenced by OnAddJobClick(), OnGenerateAllOutputsClick(), OnGridCellChange(), OnJobButtonDelete(), OnJobButtonDown(), OnJobButtonUp(), OnSaveButtonClick(), OnSizeGrid(), PANEL_JOBSET(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), rebuildJobList(), ~PANEL_JOBSET(), and PANEL_JOBSET_BASE::~PANEL_JOBSET_BASE().

m_outputList

wxScrolledWindow* PANEL_JOBSET_BASE::m_outputList

protectedinherited

Definition at line 54 of file panel_jobset_base.h.

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

m_outputListSizer

wxBoxSizer* PANEL_JOBSET_BASE::m_outputListSizer

protectedinherited

Definition at line 55 of file panel_jobset_base.h.

Referenced by addJobOutputPanel(), GetOutputPanels(), PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), and RemoveOutput().

m_parentBook

wxAuiNotebook* PANEL_JOBSET::m_parentBook

private

Definition at line 99 of file panel_jobset.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_jobset.h
• panel_jobset.cpp