KiCad PCB EDA Suite
Loading...
Searching...
No Matches
FOOTPRINT_MATCH_QUERY Struct Reference

All the information needed to query the footprint libraries for matching footprints. More...

#include <footprint_library_query.h>

Public Attributes

std::vector< wxString > m_Patterns
 Wildcard patterns matched against the footprint name, or against "library:footprint" when a pattern contains ':'.
 
std::optional< int > m_PinCount
 When greater than zero, only footprints with this many pads are returned.
 
int m_MaxResults = 400
 Limits the number of returned footprints; zero means no limit.
 
bool m_ZeroFilters = true
 When true, a query with no patterns (and no pin count) matches nothing rather than everything.
 

Detailed Description

All the information needed to query the footprint libraries for matching footprints.

Definition at line 34 of file footprint_library_query.h.

Member Data Documentation

◆ m_MaxResults

int FOOTPRINT_MATCH_QUERY::m_MaxResults = 400

Limits the number of returned footprints; zero means no limit.

Definition at line 44 of file footprint_library_query.h.

Referenced by FP_FILTER_MATCHER::fetchMatches(), QueryMatchingFootprints(), and FOOTPRINT_SELECT_WIDGET::UpdateList().

◆ m_Patterns

std::vector<wxString> FOOTPRINT_MATCH_QUERY::m_Patterns

Wildcard patterns matched against the footprint name, or against "library:footprint" when a pattern contains ':'.

Definition at line 38 of file footprint_library_query.h.

Referenced by FP_FILTER_MATCHER::fetchMatches(), QueryMatchingFootprints(), and FOOTPRINT_SELECT_WIDGET::UpdateList().

◆ m_PinCount

std::optional<int> FOOTPRINT_MATCH_QUERY::m_PinCount

When greater than zero, only footprints with this many pads are returned.

Definition at line 41 of file footprint_library_query.h.

Referenced by QueryMatchingFootprints(), and FOOTPRINT_SELECT_WIDGET::UpdateList().

◆ m_ZeroFilters

bool FOOTPRINT_MATCH_QUERY::m_ZeroFilters = true

When true, a query with no patterns (and no pin count) matches nothing rather than everything.

Definition at line 48 of file footprint_library_query.h.

Referenced by QueryMatchingFootprints(), and FOOTPRINT_SELECT_WIDGET::UpdateList().


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