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 FOOTPRINT_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 32 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 35 of file pcbnew/widgets/search_handlers.h.

Member Function Documentation

◆ ActivateItem()

void PCB_SEARCH_HANDLER::ActivateItem ( long  aItemRow)
overridevirtual

Reimplemented from SEARCH_HANDLER.

Reimplemented in NETS_SEARCH_HANDLER, and RATSNEST_SEARCH_HANDLER.

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

References TOOLS_HOLDER::GetToolManager(), m_frame, PCB_ACTIONS::properties, TOOL_MANAGER::RunAction(), and SelectItems().

◆ GetColumns()

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

Definition at line 39 of file search_pane.h.

References SEARCH_HANDLER::m_columns.

Referenced by SEARCH_PANE_LISTVIEW::RefreshColumnNames().

◆ GetName()

wxString SEARCH_HANDLER::GetName ( ) const
inlineinherited

Definition at line 37 of file search_pane.h.

References SEARCH_HANDLER::m_name.

Referenced by SEARCH_PANE::AddSearcher(), and SEARCH_PANE::OnLanguageChange().

◆ getResultCell()

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

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

Referenced by GetResultCell().

◆ GetResultCell()

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

Implements SEARCH_HANDLER.

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

References getResultCell(), and m_hitlist.

◆ Search()

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

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

Referenced by SEARCH_PANE_TAB::Search().

◆ SelectItems()

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

Reimplemented from SEARCH_HANDLER.

Reimplemented in NETS_SEARCH_HANDLER, and RATSNEST_SEARCH_HANDLER.

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

References PCB_BASE_FRAME::GetCanvas(), TOOLS_HOLDER::GetToolManager(), m_frame, m_hitlist, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, and PCB_ACTIONS::selectItems.

Referenced by ActivateItem().

◆ Sort()

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

Implements SEARCH_HANDLER.

Definition at line 45 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 53 of file search_pane.h.

Referenced by FOOTPRINT_SEARCH_HANDLER::FOOTPRINT_SEARCH_HANDLER(), SEARCH_HANDLER::GetColumns(), 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(), and ZONE_SEARCH_HANDLER::ZONE_SEARCH_HANDLER().

◆ m_frame

PCB_EDIT_FRAME* PCB_SEARCH_HANDLER::m_frame
protected

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

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

◆ m_hitlist

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

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

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

◆ m_name

wxString SEARCH_HANDLER::m_name
protectedinherited

Definition at line 52 of file search_pane.h.

Referenced by SEARCH_HANDLER::GetName().

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