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

#include <search_pane.h>

Inheritance diagram for SEARCH_HANDLER:
PCB_SEARCH_HANDLER SCH_SEARCH_HANDLER FOOTPRINT_SEARCH_HANDLER GROUP_SEARCH_HANDLER NETS_SEARCH_HANDLER RATSNEST_SEARCH_HANDLER TEXT_SEARCH_HANDLER ZONE_SEARCH_HANDLER GROUP_SEARCH_HANDLER LABEL_SEARCH_HANDLER POWER_SEARCH_HANDLER SYMBOL_SEARCH_HANDLER TEXT_SEARCH_HANDLER

Public Member Functions

 SEARCH_HANDLER (const wxString &aName)
 
virtual ~SEARCH_HANDLER ()
 
wxString GetName () const
 
std::vector< std::tuple< wxString, int, wxListColumnFormat > > GetColumns () const
 
virtual int Search (const wxString &string)=0
 
virtual wxString GetResultCell (int row, int col)=0
 
virtual void Sort (int aCol, bool aAscending, std::vector< long > *aSelection)=0
 
virtual void SelectItems (std::vector< long > &aItemRows)
 
virtual void ActivateItem (long aItemRow)
 

Protected Attributes

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

Detailed Description

Definition at line 35 of file search_pane.h.

Constructor & Destructor Documentation

◆ SEARCH_HANDLER()

SEARCH_HANDLER::SEARCH_HANDLER ( const wxString &  aName)
inline

Definition at line 38 of file search_pane.h.

◆ ~SEARCH_HANDLER()

virtual SEARCH_HANDLER::~SEARCH_HANDLER ( )
inlinevirtual

Definition at line 42 of file search_pane.h.

Member Function Documentation

◆ ActivateItem()

virtual void SEARCH_HANDLER::ActivateItem ( long  aItemRow)
inlinevirtual

Reimplemented in SCH_SEARCH_HANDLER, PCB_SEARCH_HANDLER, NETS_SEARCH_HANDLER, and RATSNEST_SEARCH_HANDLER.

Definition at line 57 of file search_pane.h.

◆ GetColumns()

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

Definition at line 47 of file search_pane.h.

References m_columns.

◆ GetName()

wxString SEARCH_HANDLER::GetName ( ) const
inline

Definition at line 45 of file search_pane.h.

References m_name.

Referenced by GROUP_SEARCH_HANDLER::getResultCell().

◆ GetResultCell()

virtual wxString SEARCH_HANDLER::GetResultCell ( int  row,
int  col 
)
pure virtual

Implemented in SCH_SEARCH_HANDLER, and PCB_SEARCH_HANDLER.

◆ Search()

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

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

◆ SelectItems()

virtual void SEARCH_HANDLER::SelectItems ( std::vector< long > &  aItemRows)
inlinevirtual

Reimplemented in SCH_SEARCH_HANDLER, PCB_SEARCH_HANDLER, NETS_SEARCH_HANDLER, and RATSNEST_SEARCH_HANDLER.

Definition at line 56 of file search_pane.h.

◆ Sort()

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

Implemented in SCH_SEARCH_HANDLER, and PCB_SEARCH_HANDLER.

Member Data Documentation

◆ m_columns

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

Definition at line 61 of file search_pane.h.

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

◆ m_name

wxString SEARCH_HANDLER::m_name
protected

Definition at line 60 of file search_pane.h.

Referenced by GetName().

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