KiCad PCB EDA Suite: GRID_CELL_PATH_EDITOR Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

Editor for wxGrid cells that adds a file/folder browser to the grid input field. More...

#include <grid_text_button_helpers.h>

Inheritance diagram for GRID_CELL_PATH_EDITOR:

Public Member Functions
	GRID_CELL_PATH_EDITOR (DIALOG_SHIM aParentDialog, WX_GRID aGrid, wxString aCurrentDir, bool aNormalize, const wxString &aNormalizeBasePath, std::function< wxString(WX_GRID grid, int row)> aFileFilterFn)
	Constructor.

	GRID_CELL_PATH_EDITOR (DIALOG_SHIM aParentDialog, WX_GRID aGrid, wxString *aCurrentDir, const wxString &aFileFilter, bool aNormalize=false, const wxString &aNormalizeBasePath=wxEmptyString)
	Constructor.

wxGridCellEditor *	Clone () const override

void	Create (wxWindow aParent, wxWindowID aId, wxEvtHandler aEventHandler) override

wxString	GetValue () const override

void	SetSize (const wxRect &aRect) override

void	StartingKey (wxKeyEvent &event) override

void	BeginEdit (int aRow, int aCol, wxGrid *aGrid) override

bool	EndEdit (int, int, const wxGrid , const wxString &, wxString aNewVal) override

void	ApplyEdit (int aRow, int aCol, wxGrid *aGrid) override

void	Reset () override

Protected Member Functions
wxComboCtrl *	Combo () const

	wxDECLARE_NO_COPY_CLASS (GRID_CELL_TEXT_BUTTON)

Protected Attributes
DIALOG_SHIM *	m_dlg

WX_GRID *	m_grid

wxString *	m_currentDir

bool	m_normalize

wxString	m_normalizeBasePath

wxString	m_fileFilter

std::function< wxString(WX_GRID *aGrid, int aRow)>	m_fileFilterFn

wxString	m_value

Detailed Description

Editor for wxGrid cells that adds a file/folder browser to the grid input field.

Definition at line 146 of file grid_text_button_helpers.h.

Constructor & Destructor Documentation

◆ GRID_CELL_PATH_EDITOR() [1/2]

GRID_CELL_PATH_EDITOR::GRID_CELL_PATH_EDITOR	(	DIALOG_SHIM *	aParentDialog,
		WX_GRID *	aGrid,
		wxString *	aCurrentDir,
		bool	aNormalize,
		const wxString &	aNormalizeBasePath,
		std::function< wxString(WX_GRID *grid, int row)>	aFileFilterFn
	)

inline

Constructor.

Parameters

aCurrentDir	is current directory the path editor will open at
aNormalize	indicates whether to normalize the selected path (replace part of path with variables or relative path)
aNormalizeBasePath	is the path to use when trying to base variables (generally current project path)
aFileFilterFn	a callback which provides a file extension(s) filter.

Definition at line 159 of file grid_text_button_helpers.h.

◆ GRID_CELL_PATH_EDITOR() [2/2]

GRID_CELL_PATH_EDITOR::GRID_CELL_PATH_EDITOR	(	DIALOG_SHIM *	aParentDialog,
		WX_GRID *	aGrid,
		wxString *	aCurrentDir,
		const wxString &	aFileFilter,
		bool	aNormalize = `false`,
		const wxString &	aNormalizeBasePath = `wxEmptyString`
	)

inline

Constructor.

Parameters

aCurrentDir	is current directory the path editor will open at
aFileFilter	is the file extension(s) to filter by. If empty, the path editor will switch to folder mode instead of file.
aNormalize	indicates whether to normalize the selected path (replace part of path with variables or relative path)
aNormalizeBasePath	is the path to use when trying to base variables (generally current project path)

Definition at line 181 of file grid_text_button_helpers.h.

Member Function Documentation

◆ ApplyEdit()

void GRID_CELL_TEXT_BUTTON::ApplyEdit	(	int	aRow,
		int	aCol,
		wxGrid *	aGrid
	)

overrideinherited

Definition at line 153 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::m_value.

◆ BeginEdit()

void GRID_CELL_TEXT_BUTTON::BeginEdit	(	int	aRow,
		int	aCol,
		wxGrid *	aGrid
	)

overrideinherited

Definition at line 123 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

◆ Clone()

wxGridCellEditor * GRID_CELL_PATH_EDITOR::Clone ( ) const

inlineoverride

Definition at line 192 of file grid_text_button_helpers.h.

References m_currentDir, m_dlg, m_fileFilter, m_fileFilterFn, m_grid, m_normalize, and m_normalizeBasePath.

◆ Combo()

wxComboCtrl * GRID_CELL_TEXT_BUTTON::Combo ( ) const

inlineprotectedinherited

Definition at line 61 of file grid_text_button_helpers.h.

Referenced by GRID_CELL_TEXT_BUTTON::BeginEdit(), GRID_CELL_SYMBOL_ID_EDITOR::Create(), GRID_CELL_FPID_EDITOR::Create(), GRID_CELL_URL_EDITOR::Create(), Create(), GRID_CELL_TEXT_BUTTON::EndEdit(), GRID_CELL_TEXT_BUTTON::GetValue(), GRID_CELL_TEXT_BUTTON::Reset(), and GRID_CELL_TEXT_BUTTON::StartingKey().

◆ Create()

void GRID_CELL_PATH_EDITOR::Create	(	wxWindow *	aParent,
		wxWindowID	aId,
		wxEvtHandler *	aEventHandler
	)

override

Definition at line 579 of file grid_text_button_helpers.cpp.

References WX_GRID::CellEditorSetMargins(), GRID_CELL_TEXT_BUTTON::Combo(), m_currentDir, m_dlg, m_fileFilter, m_fileFilterFn, m_grid, m_normalize, and m_normalizeBasePath.

◆ EndEdit()

bool GRID_CELL_TEXT_BUTTON::EndEdit	(	int	,
		int	,
		const wxGrid *	,
		const wxString &	,
		wxString *	aNewVal
	)

overrideinherited

Definition at line 137 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

◆ GetValue()

wxString GRID_CELL_TEXT_BUTTON::GetValue ( ) const

overrideinherited

Definition at line 57 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::Combo().

◆ Reset()

void GRID_CELL_TEXT_BUTTON::Reset ( )

overrideinherited

Definition at line 159 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

◆ SetSize()

void GRID_CELL_TEXT_BUTTON::SetSize ( const wxRect & aRect )

overrideinherited

Definition at line 63 of file grid_text_button_helpers.cpp.

References WX_GRID::CellEditorTransformSizeRect().

◆ StartingKey()

void GRID_CELL_TEXT_BUTTON::StartingKey ( wxKeyEvent & event )

overrideinherited

Definition at line 72 of file grid_text_button_helpers.cpp.

References GRID_CELL_TEXT_BUTTON::Combo().

◆ wxDECLARE_NO_COPY_CLASS()

GRID_CELL_TEXT_BUTTON::wxDECLARE_NO_COPY_CLASS ( GRID_CELL_TEXT_BUTTON )

protectedinherited

Member Data Documentation

◆ m_currentDir

wxString* GRID_CELL_PATH_EDITOR::m_currentDir

protected

Definition at line 211 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_dlg

DIALOG_SHIM* GRID_CELL_PATH_EDITOR::m_dlg

protected

Definition at line 209 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_fileFilter

wxString GRID_CELL_PATH_EDITOR::m_fileFilter

protected

Definition at line 215 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_fileFilterFn

std::function<wxString( WX_GRID* aGrid, int aRow )> GRID_CELL_PATH_EDITOR::m_fileFilterFn

protected

Definition at line 216 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_grid

WX_GRID* GRID_CELL_PATH_EDITOR::m_grid

protected

Definition at line 210 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_normalize

bool GRID_CELL_PATH_EDITOR::m_normalize

protected

Definition at line 212 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_normalizeBasePath

wxString GRID_CELL_PATH_EDITOR::m_normalizeBasePath

protected

Definition at line 213 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

◆ m_value

wxString GRID_CELL_TEXT_BUTTON::m_value

protectedinherited

Definition at line 67 of file grid_text_button_helpers.h.

Referenced by GRID_CELL_TEXT_BUTTON::ApplyEdit(), GRID_CELL_TEXT_BUTTON::BeginEdit(), GRID_CELL_TEXT_BUTTON::EndEdit(), and GRID_CELL_TEXT_BUTTON::Reset().

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

GRID_CELL_PATH_EDITOR
Generated on Tue Aug 12 2025 00:07:24 for KiCad PCB EDA Suite by 1.9.6