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_JOBSET Class Reference

#include <panel_jobset.h>

Inheritance diagram for PANEL_JOBSET:
PANEL_JOBSET_BASE PANEL_NOTEBOOK_BASE

Public Member Functions

 PANEL_JOBSET (wxAuiNotebook *aParent, KICAD_MANAGER_FRAME *aFrame, std::unique_ptr< JOBSET > aJobsFile)
 
 ~PANEL_JOBSET ()
 
void RemoveDestination (PANEL_DESTINATION *aPanel)
 
void EnsurePcbSchFramesOpen ()
 
wxString GetFilePath () const
 
void UpdateTitle ()
 
JOBSET * GetJobsFile ()
 
bool OpenJobOptionsForListItem (size_t aItemIndex)
 
void OnJobButtonDelete (wxCommandEvent &aEvent) override
 
std::vector< PANEL_DESTINATION * > GetDestinationPanels ()
 
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 OnAddDestinationClick (wxCommandEvent &aEvent) override
 
virtual void OnSaveButtonClick (wxCommandEvent &aEvent) override
 
virtual void OnJobButtonUp (wxCommandEvent &aEvent) override
 
virtual void OnJobButtonDown (wxCommandEvent &aEvent) override
 
virtual void OnGenerateAllDestinationsClick (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_destinationList
 
wxBoxSizer * m_destinationListSizer
 
STD_BITMAP_BUTTON * m_buttonAddDestination
 
wxButton * m_buttonSave
 
wxButton * m_buttonGenerateAllDestinations
 

Private Member Functions

void rebuildJobList ()
 
void buildDestinationList ()
 
void addDestinationPanel (JOBSET_DESTINATION *aDestination)
 

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 68 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 505 of file panel_jobset.cpp.

References buildDestinationList(), COL_NUMBER, COL_SOURCE, KiBitmapBundle(), PANEL_JOBSET_BASE::m_buttonAddDestination, PANEL_JOBSET_BASE::m_buttonAddJob, PANEL_JOBSET_BASE::m_buttonDelete, PANEL_JOBSET_BASE::m_buttonDown, PANEL_JOBSET_BASE::m_buttonUp, m_frame, m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, m_parentBook, move, PANEL_JOBSET_BASE::PANEL_JOBSET_BASE(), rebuildJobList(), small_down, small_plus, small_trash, and small_up.

◆ ~PANEL_JOBSET()

PANEL_JOBSET::~PANEL_JOBSET ( )

Definition at line 532 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_jobsGrid.

Member Function Documentation

◆ addDestinationPanel()

void PANEL_JOBSET::addDestinationPanel ( JOBSET_DESTINATION * aDestination)
private

Definition at line 608 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_destinationList, PANEL_JOBSET_BASE::m_destinationListSizer, m_frame, and m_jobsFile.

Referenced by buildDestinationList(), and OnAddDestinationClick().

◆ buildDestinationList()

void PANEL_JOBSET::buildDestinationList ( )
private

Definition at line 637 of file panel_jobset.cpp.

References addDestinationPanel(), 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 867 of file panel_jobset.cpp.

References FRAME_PCB_EDITOR, FRAME_SCH, FILEEXT::KiCadSchematicFileExtension, m_frame, KIWAY_PLAYER::OpenProjectFiles(), and project.

Referenced by OnGenerateAllDestinationsClick(), and OpenJobOptionsForListItem().

◆ GetCanClose()

bool PANEL_JOBSET::GetCanClose ( )
overrideprotectedvirtual

Reimplemented from PANEL_NOTEBOOK_BASE.

Definition at line 846 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 m_closable.

◆ GetDestinationPanels()

std::vector< PANEL_DESTINATION * > PANEL_JOBSET::GetDestinationPanels ( )

Definition at line 623 of file panel_jobset.cpp.

References PANEL_JOBSET_BASE::m_destinationListSizer.

Referenced by OnGenerateAllDestinationsClick(), and rebuildJobList().

◆ GetFilePath()

wxString PANEL_JOBSET::GetFilePath ( ) const

Definition at line 919 of file panel_jobset.cpp.

References m_jobsFile.

◆ GetJobsFile()

JOBSET * PANEL_JOBSET::GetJobsFile ( )
inline

Definition at line 83 of file panel_jobset.h.

References m_jobsFile.

◆ GetProjectTied()

bool PANEL_NOTEBOOK_BASE::GetProjectTied ( )
inlineinherited

Definition at line 41 of file panel_notebook_base.h.

References m_projectTied.

◆ OnAddDestinationClick()

void PANEL_JOBSET::OnAddDestinationClick ( wxCommandEvent & aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 799 of file panel_jobset.cpp.

References _, addDestinationPanel(), EDA_LIST_DIALOG::GetTextSelection(), EDA_LIST_DIALOG::HideFilter(), JobsetDestinationTypeInfos, m_frame, m_jobsFile, EDA_LIST_DIALOG::SetListLabel(), and DIALOG_SHIM::ShowModal().

◆ OnAddJobClick()

void PANEL_JOBSET::OnAddJobClick ( wxCommandEvent & aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 717 of file panel_jobset.cpp.

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

◆ OnGenerateAllDestinationsClick()

void PANEL_JOBSET::OnGenerateAllDestinationsClick ( wxCommandEvent & event)
overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 971 of file panel_jobset.cpp.

References _, DisplayError(), EnsurePcbSchFramesOpen(), GetDestinationPanels(), NULL_REPORTER::GetInstance(), m_frame, m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, project, Refresh(), and JOBS_RUNNER::RunJobsAllDestinations().

◆ OnGridCellChange()

void PANEL_JOBSET::OnGridCellChange ( wxGridEvent & aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 697 of file panel_jobset.cpp.

References COL_DESCR, m_jobsFile, and PANEL_JOBSET_BASE::m_jobsGrid.

◆ OnJobButtonDelete()

void PANEL_JOBSET::OnJobButtonDelete ( wxCommandEvent & aEvent)
overridevirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 788 of file panel_jobset.cpp.

References m_jobsFile, and PANEL_JOBSET_BASE::m_jobsGrid.

◆ OnJobButtonDown()

void PANEL_JOBSET::OnJobButtonDown ( wxCommandEvent & aEvent)
overrideprotectedvirtual

Reimplemented from PANEL_JOBSET_BASE.

Definition at line 948 of file panel_jobset.cpp.

References 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 925 of file panel_jobset.cpp.

References 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 707 of file panel_jobset.cpp.

References 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 1014 of file panel_jobset.cpp.

References COL_DESCR, COL_NUMBER, COL_SOURCE, and PANEL_JOBSET_BASE::m_jobsGrid.

◆ OpenJobOptionsForListItem()

bool PANEL_JOBSET::OpenJobOptionsForListItem ( size_t aItemIndex)

Definition at line 650 of file panel_jobset.cpp.

References EnsurePcbSchFramesOpen(), JOB_REGISTRY::GetKifaceType(), JOB::GetType(), KIWAY::KIWAY_FACE_COUNT, m_frame, JOBSET_JOB::m_job, m_jobsFile, JOBSET_JOB::m_type, DIALOG_SHIM::ShowModal(), DIALOG_SHIM::ShowQuasiModal(), and UpdateTitle().

Referenced by OnAddJobClick().

◆ rebuildJobList()

void PANEL_JOBSET::rebuildJobList ( )
private

Definition at line 554 of file panel_jobset.cpp.

References COL_DESCR, COL_NUMBER, COL_SOURCE, KIWAY::FACE_PCB, KIWAY::FACE_SCH, GetDestinationPanels(), JOB_REGISTRY::GetKifaceType(), KIWAY::KIWAY_FACE_COUNT, m_jobsFile, PANEL_JOBSET_BASE::m_jobsGrid, and UpdateTitle().

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

◆ RemoveDestination()

void PANEL_JOBSET::RemoveDestination ( PANEL_DESTINATION * aPanel)

Definition at line 539 of file panel_jobset.cpp.

References PANEL_DESTINATION::GetDestination(), PANEL_JOBSET_BASE::m_destinationList, PANEL_JOBSET_BASE::m_destinationListSizer, and m_jobsFile.

◆ SetClosable()

void PANEL_NOTEBOOK_BASE::SetClosable ( bool aYes)
inlineinherited

Definition at line 43 of file panel_notebook_base.h.

References 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 m_projectTied.

Referenced by KICAD_MANAGER_FRAME::OpenJobsFile().

◆ UpdateTitle()

void PANEL_JOBSET::UpdateTitle ( )

Definition at line 594 of file panel_jobset.cpp.

References m_jobsFile, and m_parentBook.

Referenced by OnSaveButtonClick(), OpenJobOptionsForListItem(), and rebuildJobList().

Member Data Documentation

◆ m_buttonAddDestination

STD_BITMAP_BUTTON* PANEL_JOBSET_BASE::m_buttonAddDestination
protectedinherited

Definition at line 56 of file panel_jobset_base.h.

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

◆ 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(), PANEL_JOBSET_BASE(), and ~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(), PANEL_JOBSET_BASE(), and ~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(), PANEL_JOBSET_BASE(), and ~PANEL_JOBSET_BASE().

◆ m_buttonGenerateAllDestinations

wxButton* PANEL_JOBSET_BASE::m_buttonGenerateAllDestinations
protectedinherited

Definition at line 58 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET_BASE(), and ~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(), and ~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(), PANEL_JOBSET_BASE(), and ~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 GetClosable(), and SetClosable().

◆ m_destinationList

wxScrolledWindow* PANEL_JOBSET_BASE::m_destinationList
protectedinherited

Definition at line 54 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET::addDestinationPanel(), PANEL_JOBSET_BASE(), and PANEL_JOBSET::RemoveDestination().

◆ m_destinationListSizer

wxBoxSizer* PANEL_JOBSET_BASE::m_destinationListSizer
protectedinherited

Definition at line 55 of file panel_jobset_base.h.

Referenced by PANEL_JOBSET::addDestinationPanel(), PANEL_JOBSET::GetDestinationPanels(), PANEL_JOBSET_BASE(), and PANEL_JOBSET::RemoveDestination().

◆ m_frame

KICAD_MANAGER_FRAME* PANEL_JOBSET::m_frame
private

Definition at line 109 of file panel_jobset.h.

Referenced by addDestinationPanel(), EnsurePcbSchFramesOpen(), OnAddDestinationClick(), OnGenerateAllDestinationsClick(), OpenJobOptionsForListItem(), and PANEL_JOBSET().

◆ m_jobsFile

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

Definition at line 110 of file panel_jobset.h.

Referenced by addDestinationPanel(), buildDestinationList(), GetCanClose(), GetFilePath(), GetJobsFile(), OnAddDestinationClick(), OnAddJobClick(), OnGenerateAllDestinationsClick(), OnGridCellChange(), OnJobButtonDelete(), OnJobButtonDown(), OnJobButtonUp(), OnSaveButtonClick(), OpenJobOptionsForListItem(), PANEL_JOBSET(), rebuildJobList(), RemoveDestination(), and UpdateTitle().

◆ m_jobsGrid

WX_GRID* PANEL_JOBSET_BASE::m_jobsGrid
protectedinherited

Definition at line 49 of file panel_jobset_base.h.

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

◆ m_parentBook

wxAuiNotebook* PANEL_JOBSET::m_parentBook
private

Definition at line 108 of file panel_jobset.h.

Referenced by PANEL_JOBSET(), and UpdateTitle().

◆ m_projectTied

bool PANEL_NOTEBOOK_BASE::m_projectTied = false
privateinherited

Definition at line 50 of file panel_notebook_base.h.

Referenced by GetProjectTied(), and SetProjectTied().

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