KiCad PCB EDA Suite: TEXT_SEARCH_HANDLER Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <search_handlers.h>

Inheritance diagram for TEXT_SEARCH_HANDLER:

Public Member Functions
	TEXT_SEARCH_HANDLER (SCH_EDIT_FRAME *aFrame)

int	Search (const wxString &aQuery) override

	TEXT_SEARCH_HANDLER (PCB_EDIT_FRAME *aFrame)

int	Search (const wxString &aQuery) override

void	ActivateItem (long aItemRow) override

wxString	GetResultCell (int aRow, int aCol) override

void	FindAll (const std::function< bool(SCH_ITEM , SCH_SHEET_PATH )> &aCollector)

void	Sort (int aCol, bool aAscending, std::vector< long > *aSelection) override

void	SelectItems (std::vector< long > &aItemRows) override

wxString	GetName () const

std::vector< std::tuple< wxString, int, wxListColumnFormat > >	GetColumns () const

wxString	GetResultCell (int aRow, int aCol) override

void	Sort (int aCol, bool aAscending, std::vector< long > *aSelection) override

void	SelectItems (std::vector< long > &aItemRows) override

void	ActivateItem (long aItemRow) override

wxString	GetName () const

std::vector< std::tuple< wxString, int, wxListColumnFormat > >	GetColumns () const

Protected Member Functions
wxString	getResultCell (const SCH_SEARCH_HIT &hit, int aCol) override

Protected Attributes
SCH_EDIT_FRAME *	m_frame

std::vector< SCH_SEARCH_HIT >	m_hitlist

wxString	m_name

std::vector< std::tuple< wxString, int, wxListColumnFormat > >	m_columns

PCB_EDIT_FRAME *	m_frame

std::vector< BOARD_ITEM * >	m_hitlist

wxString	m_name

std::vector< std::tuple< wxString, int, wxListColumnFormat > >	m_columns

Private Member Functions
wxString	getResultCell (BOARD_ITEM *aItem, int aCol) override

Detailed Description

Definition at line 99 of file eeschema/widgets/search_handlers.h.

Constructor & Destructor Documentation

◆ TEXT_SEARCH_HANDLER() [1/2]

TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER ( SCH_EDIT_FRAME * aFrame )

Definition at line 328 of file eeschema/widgets/search_handlers.cpp.

References _HKI, SEARCH_HANDLER::m_columns, and SCH_SEARCH_HANDLER::SCH_SEARCH_HANDLER().

◆ TEXT_SEARCH_HANDLER() [2/2]

TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER ( PCB_EDIT_FRAME * aFrame )

Definition at line 275 of file pcbnew/widgets/search_handlers.cpp.

References _HKI, SEARCH_HANDLER::m_columns, and PCB_SEARCH_HANDLER::PCB_SEARCH_HANDLER().

Member Function Documentation

◆ ActivateItem() [1/2]

void PCB_SEARCH_HANDLER::ActivateItem ( long aItemRow )

overridevirtualinherited

Reimplemented from SEARCH_HANDLER.

Reimplemented in RATSNEST_SEARCH_HANDLER.

Definition at line 40 of file pcbnew/widgets/search_handlers.cpp.

References m_frame, PCB_ACTIONS::properties, and SelectItems().

◆ ActivateItem() [2/2]

void SCH_SEARCH_HANDLER::ActivateItem ( long aItemRow )

overridevirtualinherited

Reimplemented from SEARCH_HANDLER.

Definition at line 34 of file eeschema/widgets/search_handlers.cpp.

References m_frame, SCH_ACTIONS::properties, and SelectItems().

◆ FindAll()

void SCH_SEARCH_HANDLER::FindAll ( const std::function< bool(SCH_ITEM *, SCH_SHEET_PATH *)> & aCollector )

inherited

Definition at line 43 of file eeschema/widgets/search_handlers.cpp.

References SCH_SCREENS::BuildClientSheetPathList(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), m_frame, and m_hitlist.

Referenced by GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), and TEXT_SEARCH_HANDLER::Search().

◆ GetColumns() [1/2]

std::vector< std::tuple< wxString, int, wxListColumnFormat > > SEARCH_HANDLER::GetColumns ( ) const

inlineinherited

Definition at line 47 of file search_pane.h.

References m_columns.

◆ GetColumns() [2/2]

std::vector< std::tuple< wxString, int, wxListColumnFormat > > SEARCH_HANDLER::GetColumns ( ) const

inlineinherited

Definition at line 47 of file search_pane.h.

References m_columns.

◆ GetName() [1/2]

wxString SEARCH_HANDLER::GetName ( ) const

inlineinherited

Definition at line 45 of file search_pane.h.

References m_name.

Referenced by GROUP_SEARCH_HANDLER::getResultCell(), and SEARCH_PANE::OnLanguageChange().

◆ GetName() [2/2]

wxString SEARCH_HANDLER::GetName ( ) const

inlineinherited

Definition at line 45 of file search_pane.h.

References m_name.

Referenced by GROUP_SEARCH_HANDLER::getResultCell(), and SEARCH_PANE::OnLanguageChange().

◆ GetResultCell() [1/2]

wxString PCB_SEARCH_HANDLER::GetResultCell	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Implements SEARCH_HANDLER.

Definition at line 42 of file pcbnew/widgets/search_handlers.h.

References getResultCell(), m_frame, and m_hitlist.

◆ GetResultCell() [2/2]

wxString SCH_SEARCH_HANDLER::GetResultCell	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Implements SEARCH_HANDLER.

Definition at line 49 of file eeschema/widgets/search_handlers.h.

References getResultCell(), SCH_SEARCH_HIT::item, m_frame, and m_hitlist.

◆ getResultCell() [1/2]

wxString TEXT_SEARCH_HANDLER::getResultCell	(	BOARD_ITEM *	aItem,
		int	aCol )

overrideprivatevirtual

Implements PCB_SEARCH_HANDLER.

Definition at line 317 of file pcbnew/widgets/search_handlers.cpp.

References _, ORIGIN_TRANSFORMS::ABS_X_COORD, ORIGIN_TRANSFORMS::ABS_Y_COORD, PCB_TEXT::ClassOf(), PCB_TEXTBOX::ClassOf(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_SEARCH_HANDLER::m_frame, and UnescapeString().

◆ getResultCell() [2/2]

wxString TEXT_SEARCH_HANDLER::getResultCell	(	const SCH_SEARCH_HIT &	hit,
		int	aCol )

overrideprotectedvirtual

Implements SCH_SEARCH_HANDLER.

Definition at line 372 of file eeschema/widgets/search_handlers.cpp.

References _, SCH_SHEET_PATH::GetPageNumber(), SCH_SHAPE::GetPosition(), SCH_TEXT::GetPosition(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_SEARCH_HIT::item, SCH_SEARCH_HANDLER::m_frame, SCH_TEXT_T, SCH_TEXTBOX_T, SCH_SEARCH_HIT::sheetPath, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Search() [1/2]

int TEXT_SEARCH_HANDLER::Search ( const wxString & aQuery )

overridevirtual

Implements SEARCH_HANDLER.

Definition at line 339 of file eeschema/widgets/search_handlers.cpp.

References SCH_SEARCH_HANDLER::FindAll(), EDA_SEARCH_DATA::findString, SCH_SEARCH_HANDLER::m_frame, SCH_SEARCH_HANDLER::m_hitlist, EDA_ITEM::Matches(), EDA_SEARCH_DATA::matchMode, PERMISSIVE, SCH_TEXT_T, SCH_TEXTBOX_T, APP_SETTINGS_BASE::SEARCH_PANE::search_hidden_fields, APP_SETTINGS_BASE::SEARCH_PANE::search_metadata, EDA_SEARCH_DATA::searchAllFields, SCH_SEARCH_DATA::searchCurrentSheetOnly, EDA_SEARCH_DATA::searchMetadata, and EDA_ITEM::Type().

◆ Search() [2/2]

int TEXT_SEARCH_HANDLER::Search ( const wxString & aQuery )

overridevirtual

Implements SEARCH_HANDLER.

◆ SelectItems() [1/2]

void PCB_SEARCH_HANDLER::SelectItems ( std::vector< long > & aItemRows )

overridevirtualinherited

Reimplemented from SEARCH_HANDLER.

Reimplemented in RATSNEST_SEARCH_HANDLER.

Definition at line 84 of file pcbnew/widgets/search_handlers.cpp.

References ACTIONS::centerSelection, m_frame, m_hitlist, APP_SETTINGS_BASE::SEARCH_PANE::NONE, APP_SETTINGS_BASE::SEARCH_PANE::PAN, APP_SETTINGS_BASE::SEARCH_PANE::selection_zoom, ACTIONS::selectionClear, ACTIONS::selectItems, APP_SETTINGS_BASE::SEARCH_PANE::ZOOM, and ACTIONS::zoomFitSelection.

Referenced by ActivateItem().

◆ SelectItems() [2/2]

void SCH_SEARCH_HANDLER::SelectItems ( std::vector< long > & aItemRows )

overridevirtualinherited

Reimplemented from SEARCH_HANDLER.

Definition at line 103 of file eeschema/widgets/search_handlers.cpp.

References ACTIONS::centerSelection, SCH_ACTIONS::changeSheet, m_frame, m_hitlist, APP_SETTINGS_BASE::SEARCH_PANE::NONE, APP_SETTINGS_BASE::SEARCH_PANE::PAN, APP_SETTINGS_BASE::SEARCH_PANE::selection_zoom, ACTIONS::selectionClear, ACTIONS::selectItems, APP_SETTINGS_BASE::SEARCH_PANE::ZOOM, and ACTIONS::zoomFitSelection.

Referenced by ActivateItem().

◆ Sort() [1/2]

void PCB_SEARCH_HANDLER::Sort	(	int	aCol,
		bool	aAscending,
		std::vector< long > *	aSelection )

overridevirtualinherited

Implements SEARCH_HANDLER.

Definition at line 49 of file pcbnew/widgets/search_handlers.cpp.

References alg::contains(), and m_hitlist.

◆ Sort() [2/2]

void SCH_SEARCH_HANDLER::Sort	(	int	aCol,
		bool	aAscending,
		std::vector< long > *	aSelection )

overridevirtualinherited

Implements SEARCH_HANDLER.

Definition at line 69 of file eeschema/widgets/search_handlers.cpp.

References alg::contains(), and m_hitlist.

Member Data Documentation

◆ m_columns [1/2]

std::vector<std::tuple<wxString, int, wxListColumnFormat> > SEARCH_HANDLER::m_columns

protectedinherited

Definition at line 61 of file search_pane.h.

Referenced by DRILL_SEARCH_HANDLER::DRILL_SEARCH_HANDLER(), FOOTPRINT_SEARCH_HANDLER::FOOTPRINT_SEARCH_HANDLER(), GetColumns(), GROUP_SEARCH_HANDLER::GROUP_SEARCH_HANDLER(), GROUP_SEARCH_HANDLER::GROUP_SEARCH_HANDLER(), LABEL_SEARCH_HANDLER::LABEL_SEARCH_HANDLER(), NETS_SEARCH_HANDLER::NETS_SEARCH_HANDLER(), POWER_SEARCH_HANDLER::POWER_SEARCH_HANDLER(), RATSNEST_SEARCH_HANDLER::RATSNEST_SEARCH_HANDLER(), SYMBOL_SEARCH_HANDLER::SYMBOL_SEARCH_HANDLER(), TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER(), TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER(), and ZONE_SEARCH_HANDLER::ZONE_SEARCH_HANDLER().

◆ m_columns [2/2]

std::vector<std::tuple<wxString, int, wxListColumnFormat> > SEARCH_HANDLER::m_columns

protectedinherited

Definition at line 61 of file search_pane.h.

Referenced by DRILL_SEARCH_HANDLER::DRILL_SEARCH_HANDLER(), FOOTPRINT_SEARCH_HANDLER::FOOTPRINT_SEARCH_HANDLER(), GetColumns(), GROUP_SEARCH_HANDLER::GROUP_SEARCH_HANDLER(), GROUP_SEARCH_HANDLER::GROUP_SEARCH_HANDLER(), LABEL_SEARCH_HANDLER::LABEL_SEARCH_HANDLER(), NETS_SEARCH_HANDLER::NETS_SEARCH_HANDLER(), POWER_SEARCH_HANDLER::POWER_SEARCH_HANDLER(), RATSNEST_SEARCH_HANDLER::RATSNEST_SEARCH_HANDLER(), SYMBOL_SEARCH_HANDLER::SYMBOL_SEARCH_HANDLER(), TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER(), TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER(), and ZONE_SEARCH_HANDLER::ZONE_SEARCH_HANDLER().

◆ m_frame [1/2]

PCB_EDIT_FRAME* PCB_SEARCH_HANDLER::m_frame

protectedinherited

Definition at line 67 of file pcbnew/widgets/search_handlers.h.

Referenced by NETS_SEARCH_HANDLER::ActivateItem(), ActivateItem(), RATSNEST_SEARCH_HANDLER::ActivateItem(), GetResultCell(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), PCB_SEARCH_HANDLER(), FOOTPRINT_SEARCH_HANDLER::Search(), NETS_SEARCH_HANDLER::Search(), RATSNEST_SEARCH_HANDLER::Search(), ZONE_SEARCH_HANDLER::Search(), NETS_SEARCH_HANDLER::SelectItems(), SelectItems(), and RATSNEST_SEARCH_HANDLER::SelectItems().

◆ m_frame [2/2]

SCH_EDIT_FRAME* SCH_SEARCH_HANDLER::m_frame

protectedinherited

Definition at line 73 of file eeschema/widgets/search_handlers.h.

Referenced by ActivateItem(), FindAll(), GetResultCell(), GROUP_SEARCH_HANDLER::getResultCell(), GROUP_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), POWER_SEARCH_HANDLER::getResultCell(), SYMBOL_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), SCH_SEARCH_HANDLER(), GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), and SelectItems().

◆ m_hitlist [1/2]

std::vector<BOARD_ITEM*> PCB_SEARCH_HANDLER::m_hitlist

protectedinherited

Definition at line 68 of file pcbnew/widgets/search_handlers.h.

Referenced by GetResultCell(), DRILL_SEARCH_HANDLER::Search(), FOOTPRINT_SEARCH_HANDLER::Search(), NETS_SEARCH_HANDLER::Search(), RATSNEST_SEARCH_HANDLER::Search(), ZONE_SEARCH_HANDLER::Search(), DRILL_SEARCH_HANDLER::SelectItems(), NETS_SEARCH_HANDLER::SelectItems(), SelectItems(), RATSNEST_SEARCH_HANDLER::SelectItems(), DRILL_SEARCH_HANDLER::Sort(), and Sort().

◆ m_hitlist [2/2]

std::vector<SCH_SEARCH_HIT> SCH_SEARCH_HANDLER::m_hitlist

protectedinherited

Definition at line 74 of file eeschema/widgets/search_handlers.h.

Referenced by FindAll(), GetResultCell(), GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), SelectItems(), and Sort().

◆ m_name [1/2]

wxString SEARCH_HANDLER::m_name

protectedinherited

Definition at line 60 of file search_pane.h.

Referenced by GetName(), and SEARCH_HANDLER().

◆ m_name [2/2]

wxString SEARCH_HANDLER::m_name

protectedinherited

Definition at line 60 of file search_pane.h.

Referenced by GetName(), and SEARCH_HANDLER().

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

TEXT_SEARCH_HANDLER
Generated on Sun Sep 21 2025 01:05:56 for KiCad PCB EDA Suite by 1.13.2