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

#include <panel_jobs.h>

Inheritance diagram for JOBS_GRID_TRICKS:
GRID_TRICKS

Public Member Functions

 JOBS_GRID_TRICKS (PANEL_JOBS *aParent, WX_GRID *aGrid)
 
 ~JOBS_GRID_TRICKS () override=default
 
void SetTooltipEnable (int aCol, bool aEnable=true)
 Enable the tooltip for a column.
 
bool GetTooltipEnabled (int aCol)
 Query if the tooltip for a column is enabled.
 

Protected Member Functions

void showPopupMenu (wxMenu &menu, wxGridEvent &aEvent) override
 
void doPopupSelection (wxCommandEvent &event) override
 
bool handleDoubleClick (wxGridEvent &aEvent) override
 
void init ()
 Shared initialization for various ctors.
 
void getSelectedArea ()
 Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.
 
void onGridCellLeftClick (wxGridEvent &event)
 
void onGridCellLeftDClick (wxGridEvent &event)
 
void onGridCellRightClick (wxGridEvent &event)
 
void onGridLabelLeftClick (wxGridEvent &event)
 
void onGridLabelRightClick (wxGridEvent &event)
 
void onPopupSelection (wxCommandEvent &event)
 
void onKeyDown (wxKeyEvent &event)
 
void onCharHook (wxKeyEvent &event)
 
void onUpdateUI (wxUpdateUIEvent &event)
 
void onGridMotion (wxMouseEvent &event)
 
bool isTextEntry (int aRow, int aCol)
 
bool isCheckbox (int aRow, int aCol)
 
bool isReadOnly (int aRow, int aCol)
 
virtual bool toggleCell (int aRow, int aCol, bool aPreserveSelection=false)
 
bool showEditor (int aRow, int aCol)
 
virtual void paste_clipboard ()
 
virtual void paste_text (const wxString &cb_text)
 
virtual void cutcopy (bool doCopy, bool doDelete)
 

Protected Attributes

PANEL_JOBS * m_parent
 
int m_doubleClickRow
 
WX_GRID * m_grid
 I don't own the grid, but he owns me.
 
int m_sel_row_start
 
int m_sel_col_start
 
int m_sel_row_count
 
int m_sel_col_count
 
std::function< void(wxCommandEvent &)> m_addHandler
 
std::bitset< GRIDTRICKS_MAX_COL > m_tooltipEnabled
 
bool m_enableSingleClickEdit
 
bool m_multiCellEditEnabled
 

Private Types

enum  { JOB_DESCRIPTION = GRIDTRICKS_FIRST_CLIENT_ID , JOB_PROPERTIES }
 

Detailed Description

Definition at line 34 of file panel_jobs.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
JOB_DESCRIPTION 
JOB_PROPERTIES 

Definition at line 36 of file panel_jobs.h.

Constructor & Destructor Documentation

◆ JOBS_GRID_TRICKS()

JOBS_GRID_TRICKS::JOBS_GRID_TRICKS ( PANEL_JOBS *  aParent,
WX_GRID *  aGrid 
)
explicit

Definition at line 503 of file panel_jobs.cpp.

References GRID_TRICKS::m_enableSingleClickEdit, and GRID_TRICKS::m_multiCellEditEnabled.

◆ ~JOBS_GRID_TRICKS()

JOBS_GRID_TRICKS::~JOBS_GRID_TRICKS ( )
overridedefault

Member Function Documentation

◆ cutcopy()

void GRID_TRICKS::cutcopy ( bool  doCopy,
bool  doDelete 
)
protectedvirtualinherited

Definition at line 842 of file grid_tricks.cpp.

References COL_SEP, GRID_TRICKS::isReadOnly(), GRID_TRICKS::isTextEntry(), GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, and ROW_SEP.

Referenced by GRID_TRICKS::doPopupSelection(), and GRID_TRICKS::onKeyDown().

◆ doPopupSelection()

void JOBS_GRID_TRICKS::doPopupSelection ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 537 of file panel_jobs.cpp.

References GRID_TRICKS::doPopupSelection(), dummy, GRIDTRICKS_ID_DELETE, JOB_DESCRIPTION, JOB_PROPERTIES, GRID_TRICKS::m_grid, m_parent, PANEL_JOBS::OnJobButtonDelete(), and PANEL_JOBS::OpenJobOptionsForListItem().

◆ getSelectedArea()

void GRID_TRICKS::getSelectedArea ( )
protectedinherited

Puts the selected area into a sensible rectangle of m_sel_{row,col}_{start,count} above.

Definition at line 286 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, and GRID_TRICKS::m_sel_row_start.

Referenced by GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onKeyDown(), GRID_TRICKS::showPopupMenu(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ GetTooltipEnabled()

bool GRID_TRICKS::GetTooltipEnabled ( int  aCol)
inlineinherited

Query if the tooltip for a column is enabled.

Parameters
aColis the column to query
Returns
if the tooltip is enabled for the column

Definition at line 86 of file grid_tricks.h.

References GRID_TRICKS::m_tooltipEnabled.

◆ handleDoubleClick()

bool JOBS_GRID_TRICKS::handleDoubleClick ( wxGridEvent &  aEvent)
overrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 569 of file panel_jobs.cpp.

References WX_GRID::CancelPendingChanges(), WX_GRID::CancelShowEditorOnMouseUp(), JOBSET::GetJobs(), PANEL_JOBS::GetJobsFile(), m_doubleClickRow, GRID_TRICKS::m_grid, m_parent, and PANEL_JOBS::OpenJobOptionsForListItem().

◆ init()

void GRID_TRICKS::init ( )
protectedinherited

Shared initialization for various ctors.

Definition at line 62 of file grid_tricks.cpp.

References GRIDTRICKS_FIRST_ID, GRIDTRICKS_LAST_ID, GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, GRID_TRICKS::onCharHook(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onGridCellLeftDClick(), GRID_TRICKS::onGridCellRightClick(), GRID_TRICKS::onGridLabelLeftClick(), GRID_TRICKS::onGridLabelRightClick(), GRID_TRICKS::onGridMotion(), GRID_TRICKS::onKeyDown(), GRID_TRICKS::onPopupSelection(), and GRID_TRICKS::onUpdateUI().

Referenced by GRID_TRICKS::GRID_TRICKS().

◆ isCheckbox()

bool GRID_TRICKS::isCheckbox ( int  aRow,
int  aCol 
)
protectedinherited

Definition at line 106 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::toggleCell().

◆ isReadOnly()

bool GRID_TRICKS::isReadOnly ( int  aRow,
int  aCol 
)
protectedinherited

Definition at line 116 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::cutcopy(), GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), and GRID_TRICKS::showPopupMenu().

◆ isTextEntry()

bool GRID_TRICKS::isTextEntry ( int  aRow,
int  aCol 
)
protectedinherited

Definition at line 95 of file grid_tricks.cpp.

References editor, and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::cutcopy(), and GRID_TRICKS::showPopupMenu().

◆ onCharHook()

void GRID_TRICKS::onCharHook ( wxKeyEvent &  event)
protectedinherited

Definition at line 471 of file grid_tricks.cpp.

References WX_GRID::CancelPendingChanges(), COL_SEP, WX_GRID::CommitPendingChanges(), dummy, GRID_TRICKS::m_addHandler, GRID_TRICKS::m_grid, GRID_TRICKS::paste_text(), ROW_SEP, and ROW_SEP_R.

Referenced by GRID_TRICKS::init().

◆ onGridCellLeftClick()

void GRID_TRICKS::onGridCellLeftClick ( wxGridEvent &  event)
protectedinherited

Definition at line 202 of file grid_tricks.cpp.

References GRID_TRICKS::getSelectedArea(), GRID_TRICKS::m_enableSingleClickEdit, GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, GRID_TRICKS::showEditor(), and GRID_TRICKS::toggleCell().

Referenced by GRID_TRICKS::init(), and GRID_TRICKS::onGridCellLeftDClick().

◆ onGridCellLeftDClick()

void GRID_TRICKS::onGridCellLeftDClick ( wxGridEvent &  event)
protectedinherited

Definition at line 249 of file grid_tricks.cpp.

References GRID_TRICKS::handleDoubleClick(), and GRID_TRICKS::onGridCellLeftClick().

Referenced by GRID_TRICKS::init().

◆ onGridCellRightClick()

void GRID_TRICKS::onGridCellRightClick ( wxGridEvent &  event)
protectedinherited

Definition at line 326 of file grid_tricks.cpp.

References GRID_TRICKS::showPopupMenu().

Referenced by GRID_TRICKS::init().

◆ onGridLabelLeftClick()

void GRID_TRICKS::onGridLabelLeftClick ( wxGridEvent &  event)
protectedinherited

Definition at line 334 of file grid_tricks.cpp.

References WX_GRID::CommitPendingChanges(), and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

◆ onGridLabelRightClick()

void GRID_TRICKS::onGridLabelRightClick ( wxGridEvent &  event)
protectedinherited

Definition at line 342 of file grid_tricks.cpp.

References GRIDTRICKS_FIRST_SHOWHIDE, and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

◆ onGridMotion()

void GRID_TRICKS::onGridMotion ( wxMouseEvent &  event)
protectedinherited

Definition at line 256 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid, and GRID_TRICKS::m_tooltipEnabled.

Referenced by GRID_TRICKS::init().

◆ onKeyDown()

void GRID_TRICKS::onKeyDown ( wxKeyEvent &  event)
protectedinherited

Definition at line 536 of file grid_tricks.cpp.

References GRID_TRICKS::cutcopy(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::m_grid, GRID_TRICKS::paste_clipboard(), and GRID_TRICKS::toggleCell().

Referenced by GRID_TRICKS::init().

◆ onPopupSelection()

void GRID_TRICKS::onPopupSelection ( wxCommandEvent &  event)
protectedinherited

Definition at line 422 of file grid_tricks.cpp.

References GRID_TRICKS::doPopupSelection().

Referenced by GRID_TRICKS::init().

◆ onUpdateUI()

void GRID_TRICKS::onUpdateUI ( wxUpdateUIEvent &  event)
protectedinherited

Definition at line 889 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::init().

◆ paste_clipboard()

void GRID_TRICKS::paste_clipboard ( )
protectedvirtualinherited

Definition at line 694 of file grid_tricks.cpp.

References GRID_TRICKS::m_grid, GRID_TRICKS::paste_text(), and text.

Referenced by GRID_TRICKS::doPopupSelection(), and GRID_TRICKS::onKeyDown().

◆ paste_text()

void GRID_TRICKS::paste_text ( const wxString &  cb_text)
protectedvirtualinherited

Reimplemented in DESIGN_BLOCK_GRID_TRICKS, SYMBOL_GRID_TRICKS, and FP_GRID_TRICKS.

Definition at line 723 of file grid_tricks.cpp.

References COL_SEP, dummy, GRID_TRICKS::isReadOnly(), GRID_TRICKS::m_addHandler, GRID_TRICKS::m_grid, GRID_TRICKS::m_multiCellEditEnabled, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, and ROW_SEP.

Referenced by GRID_TRICKS::onCharHook(), GRID_TRICKS::paste_clipboard(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

◆ SetTooltipEnable()

void GRID_TRICKS::SetTooltipEnable ( int  aCol,
bool  aEnable = true 
)
inlineinherited

Enable the tooltip for a column.

The tooltip is read from the string contained in the cell data.

Parameters
aColis the column to use
aEnableis true to enable the tooltip (default)

Definition at line 75 of file grid_tricks.h.

References GRID_TRICKS::m_tooltipEnabled.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL().

◆ showEditor()

bool GRID_TRICKS::showEditor ( int  aRow,
int  aCol 
)
protectedinherited

Definition at line 162 of file grid_tricks.cpp.

References GRID_TRICKS::isReadOnly(), GRID_TRICKS::m_grid, GRID_TRICKS::m_sel_col_count, GRID_TRICKS::m_sel_col_start, GRID_TRICKS::m_sel_row_count, GRID_TRICKS::m_sel_row_start, and WX_GRID::ShowEditorOnMouseUp().

Referenced by GRID_TRICKS::onGridCellLeftClick().

◆ showPopupMenu()

void JOBS_GRID_TRICKS::showPopupMenu ( wxMenu &  menu,
wxGridEvent &  aEvent 
)
overrideprotectedvirtual

Reimplemented from GRID_TRICKS.

Definition at line 512 of file panel_jobs.cpp.

References _, GRIDTRICKS_ID_COPY, GRIDTRICKS_ID_DELETE, GRIDTRICKS_ID_SELECT, JOB_DESCRIPTION, JOB_PROPERTIES, and GRID_TRICKS::m_grid.

◆ toggleCell()

bool GRID_TRICKS::toggleCell ( int  aRow,
int  aCol,
bool  aPreserveSelection = false 
)
protectedvirtualinherited

Reimplemented in FP_GRID_TRICKS.

Definition at line 122 of file grid_tricks.cpp.

References GRID_TRICKS::isCheckbox(), and GRID_TRICKS::m_grid.

Referenced by GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onKeyDown(), and FP_GRID_TRICKS::toggleCell().

Member Data Documentation

◆ m_addHandler

std::function<void( wxCommandEvent& )> GRID_TRICKS::m_addHandler
protectedinherited

Definition at line 134 of file grid_tricks.h.

Referenced by GRID_TRICKS::onCharHook(), and GRID_TRICKS::paste_text().

◆ m_doubleClickRow

int JOBS_GRID_TRICKS::m_doubleClickRow
protected

Definition at line 55 of file panel_jobs.h.

Referenced by handleDoubleClick().

◆ m_enableSingleClickEdit

bool GRID_TRICKS::m_enableSingleClickEdit
protectedinherited

Definition at line 138 of file grid_tricks.h.

Referenced by JOBS_GRID_TRICKS(), and GRID_TRICKS::onGridCellLeftClick().

◆ m_grid

WX_GRID* GRID_TRICKS::m_grid
protectedinherited

I don't own the grid, but he owns me.

Definition at line 125 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), GRID_TRICKS::doPopupSelection(), EMBEDDED_FILES_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), SIGNALS_GRID_TRICKS::doPopupSelection(), CURSORS_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), doPopupSelection(), PLUGINS_GRID_TRICKS::doPopupSelection(), GRID_TRICKS::getSelectedArea(), handleDoubleClick(), GRID_TRICKS::init(), GRID_TRICKS::isCheckbox(), GRID_TRICKS::isReadOnly(), GRID_TRICKS::isTextEntry(), GRID_TRICKS::onCharHook(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::onGridLabelLeftClick(), GRID_TRICKS::onGridLabelRightClick(), GRID_TRICKS::onGridMotion(), GRID_TRICKS::onKeyDown(), GRID_TRICKS::onUpdateUI(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), GRID_TRICKS::paste_clipboard(), GRID_TRICKS::paste_text(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), GRID_TRICKS::showPopupMenu(), FIELDS_EDITOR_GRID_TRICKS::showPopupMenu(), FIELDS_GRID_TRICKS::showPopupMenu(), SIGNALS_GRID_TRICKS::showPopupMenu(), CURSORS_GRID_TRICKS::showPopupMenu(), MEASUREMENTS_GRID_TRICKS::showPopupMenu(), LIB_TABLE_GRID_TRICKS::showPopupMenu(), showPopupMenu(), PLUGINS_GRID_TRICKS::showPopupMenu(), and GRID_TRICKS::toggleCell().

◆ m_multiCellEditEnabled

bool GRID_TRICKS::m_multiCellEditEnabled
protectedinherited

Definition at line 139 of file grid_tricks.h.

Referenced by JOBS_GRID_TRICKS(), GRID_TRICKS::paste_text(), and GRID_TRICKS::showPopupMenu().

◆ m_parent

PANEL_JOBS* JOBS_GRID_TRICKS::m_parent
protected

Definition at line 54 of file panel_jobs.h.

Referenced by doPopupSelection(), and handleDoubleClick().

◆ m_sel_col_count

int GRID_TRICKS::m_sel_col_count
protectedinherited

Definition at line 132 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), and GRID_TRICKS::showPopupMenu().

◆ m_sel_col_start

int GRID_TRICKS::m_sel_col_start
protectedinherited

Definition at line 130 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), and GRID_TRICKS::showPopupMenu().

◆ m_sel_row_count

int GRID_TRICKS::m_sel_row_count
protectedinherited

Definition at line 131 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), GRID_TRICKS::showPopupMenu(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ m_sel_row_start

int GRID_TRICKS::m_sel_row_start
protectedinherited

Definition at line 129 of file grid_tricks.h.

Referenced by GRID_TRICKS::cutcopy(), LIB_TABLE_GRID_TRICKS::doPopupSelection(), GRID_TRICKS::getSelectedArea(), GRID_TRICKS::init(), GRID_TRICKS::onGridCellLeftClick(), GRID_TRICKS::paste_text(), GRID_TRICKS::showEditor(), GRID_TRICKS::showPopupMenu(), and LIB_TABLE_GRID_TRICKS::showPopupMenu().

◆ m_tooltipEnabled

std::bitset<GRIDTRICKS_MAX_COL> GRID_TRICKS::m_tooltipEnabled
protectedinherited

Definition at line 136 of file grid_tricks.h.

Referenced by GRID_TRICKS::GetTooltipEnabled(), GRID_TRICKS::onGridMotion(), and GRID_TRICKS::SetTooltipEnable().

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