KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PCB_SEARCH_HANDLER Class Referenceabstract

#include <search_handlers.h>

Inheritance diagram for PCB_SEARCH_HANDLER:
SEARCH_HANDLER DRILL_SEARCH_HANDLER FOOTPRINT_SEARCH_HANDLER GROUP_SEARCH_HANDLER NETS_SEARCH_HANDLER RATSNEST_SEARCH_HANDLER TEXT_SEARCH_HANDLER ZONE_SEARCH_HANDLER

Public Member Functions

 PCB_SEARCH_HANDLER (const wxString &aName, PCB_EDIT_FRAME *aFrame)
 
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
 
virtual int Search (const wxString &string)=0
 

Protected Member Functions

virtual wxString getResultCell (BOARD_ITEM *aItem, int aCol)=0
 

Protected Attributes

PCB_EDIT_FRAME * m_frame
 
std::vector< BOARD_ITEM * > m_hitlist
 
wxString m_name
 
std::vector< std::tuple< wxString, int, wxListColumnFormat > > m_columns
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PCB_SEARCH_HANDLER()

PCB_SEARCH_HANDLER::PCB_SEARCH_HANDLER ( const wxString & aName,
PCB_EDIT_FRAME * aFrame )
inline

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

References m_frame, and SEARCH_HANDLER::SEARCH_HANDLER().

Referenced by DRILL_SEARCH_HANDLER::DRILL_SEARCH_HANDLER(), FOOTPRINT_SEARCH_HANDLER::FOOTPRINT_SEARCH_HANDLER(), GROUP_SEARCH_HANDLER::GROUP_SEARCH_HANDLER(), NETS_SEARCH_HANDLER::NETS_SEARCH_HANDLER(), RATSNEST_SEARCH_HANDLER::RATSNEST_SEARCH_HANDLER(), TEXT_SEARCH_HANDLER::TEXT_SEARCH_HANDLER(), and ZONE_SEARCH_HANDLER::ZONE_SEARCH_HANDLER().

Member Function Documentation

◆ ActivateItem()

void PCB_SEARCH_HANDLER::ActivateItem ( long aItemRow)
overridevirtual

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().

◆ GetColumns()

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()

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()

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

Implements SEARCH_HANDLER.

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

References getResultCell(), m_frame, and m_hitlist.

◆ getResultCell()

virtual wxString PCB_SEARCH_HANDLER::getResultCell ( BOARD_ITEM * aItem,
int aCol )
protectedpure virtual

Implemented in DRILL_SEARCH_HANDLER, FOOTPRINT_SEARCH_HANDLER, GROUP_SEARCH_HANDLER, NETS_SEARCH_HANDLER, RATSNEST_SEARCH_HANDLER, TEXT_SEARCH_HANDLER, and ZONE_SEARCH_HANDLER.

Referenced by GetResultCell().

◆ Search()

virtual int SEARCH_HANDLER::Search ( const wxString & string)
pure virtualinherited

Implemented in DRILL_SEARCH_HANDLER, FOOTPRINT_SEARCH_HANDLER, GROUP_SEARCH_HANDLER, GROUP_SEARCH_HANDLER, LABEL_SEARCH_HANDLER, NETS_SEARCH_HANDLER, POWER_SEARCH_HANDLER, RATSNEST_SEARCH_HANDLER, SYMBOL_SEARCH_HANDLER, TEXT_SEARCH_HANDLER, TEXT_SEARCH_HANDLER, and ZONE_SEARCH_HANDLER.

◆ SelectItems()

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

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().

◆ Sort()

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

Implements SEARCH_HANDLER.

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

References alg::contains(), and m_hitlist.

Member Data Documentation

◆ m_columns

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

PCB_EDIT_FRAME* PCB_SEARCH_HANDLER::m_frame
protected

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_hitlist

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

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_name

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: