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

#include <search_handlers.h>

Inheritance diagram for SCH_SEARCH_HANDLER:
SEARCH_HANDLER LABEL_SEARCH_HANDLER SYMBOL_SEARCH_HANDLER TEXT_SEARCH_HANDLER

Public Member Functions

 SCH_SEARCH_HANDLER (const wxString &aName, SCH_EDIT_FRAME *aFrame)
 
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) override
 
void SelectItems (std::vector< long > &aItemRows) 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 (const SCH_SEARCH_HIT &hit, int aCol)=0
 

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
 

Detailed Description

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

Constructor & Destructor Documentation

◆ SCH_SEARCH_HANDLER()

SCH_SEARCH_HANDLER::SCH_SEARCH_HANDLER ( const wxString &  aName,
SCH_EDIT_FRAME *  aFrame 
)
inline

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

Member Function Documentation

◆ ActivateItem()

void SCH_SEARCH_HANDLER::ActivateItem ( long  aItemRow)
overridevirtual

Reimplemented from SEARCH_HANDLER.

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

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

◆ FindAll()

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

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

References SCH_SCREENS::BuildClientSheetPathList(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), m_frame, m_hitlist, SCHEMATIC::Root(), and SCH_EDIT_FRAME::Schematic().

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

◆ 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 SCH_SEARCH_HANDLER::getResultCell ( const SCH_SEARCH_HIT &  hit,
int  aCol 
)
protectedpure virtual

Implemented in SYMBOL_SEARCH_HANDLER, TEXT_SEARCH_HANDLER, and LABEL_SEARCH_HANDLER.

Referenced by GetResultCell().

◆ GetResultCell()

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

Implements SEARCH_HANDLER.

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

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

◆ Search()

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

Implemented in SYMBOL_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 SCH_SEARCH_HANDLER::SelectItems ( std::vector< long > &  aItemRows)
overridevirtual

Reimplemented from SEARCH_HANDLER.

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

References EE_ACTIONS::addItemsToSel, EE_ACTIONS::clearSelection, SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), TOOLS_HOLDER::GetToolManager(), m_frame, m_hitlist, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), and SCH_EDIT_FRAME::SetCurrentSheet().

Referenced by ActivateItem().

◆ Sort()

void SCH_SEARCH_HANDLER::Sort ( int  aCol,
bool  aAscending 
)
overridevirtual

Implements SEARCH_HANDLER.

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

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

SCH_EDIT_FRAME* SCH_SEARCH_HANDLER::m_frame
protected

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

Referenced by ActivateItem(), FindAll(), SYMBOL_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), and SelectItems().

◆ m_hitlist

std::vector<SCH_SEARCH_HIT> SCH_SEARCH_HANDLER::m_hitlist
protected

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

Referenced by FindAll(), GetResultCell(), SYMBOL_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), 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: