KiCad PCB EDA Suite
SELECTION_FILTER_OPTIONS Struct Reference

This file contains data structures that are saved in the project file or project local settings file that are specific to PcbNew. More...

#include <board_project_settings.h>

Public Member Functions

 SELECTION_FILTER_OPTIONS ()
 
bool Any ()
 
bool All ()
 

Public Attributes

bool lockedItems
 Allow selecting locked items. More...
 
bool footprints
 Allow selecting entire footprints. More...
 
bool text
 Text (free or attached to a footprint) More...
 
bool tracks
 Copper tracks. More...
 
bool vias
 Vias (all types> More...
 
bool pads
 Footprint pads. More...
 
bool graphics
 Graphic lines, shapes, polygons. More...
 
bool zones
 Copper zones. More...
 
bool keepouts
 Keepout zones. More...
 
bool dimensions
 Dimension items. More...
 
bool otherItems
 Anything not fitting one of the above categories. More...
 

Detailed Description

This file contains data structures that are saved in the project file or project local settings file that are specific to PcbNew.

This is done so that these structures are available in common.Selection filtering that applies all the time (not the "filter selection" dialog that modifies the current selection)

Definition at line 40 of file board_project_settings.h.

Constructor & Destructor Documentation

◆ SELECTION_FILTER_OPTIONS()

SELECTION_FILTER_OPTIONS::SELECTION_FILTER_OPTIONS ( )
inline

Definition at line 54 of file board_project_settings.h.

55  {
56  lockedItems = true;
57  footprints = true;
58  text = true;
59  tracks = true;
60  vias = true;
61  pads = true;
62  graphics = true;
63  zones = true;
64  keepouts = true;
65  dimensions = true;
66  otherItems = true;
67  }
bool otherItems
Anything not fitting one of the above categories.
bool text
Text (free or attached to a footprint)
bool dimensions
Dimension items.
bool graphics
Graphic lines, shapes, polygons.
bool footprints
Allow selecting entire footprints.
bool lockedItems
Allow selecting locked items.

References dimensions, footprints, graphics, keepouts, lockedItems, otherItems, pads, text, tracks, vias, and zones.

Member Function Documentation

◆ All()

bool SELECTION_FILTER_OPTIONS::All ( )
inline
Returns
true if all the item types are enabled (excluding "locked items" which is special)

Definition at line 81 of file board_project_settings.h.

82  {
83  return ( footprints && text && tracks && vias && pads && graphics && zones
84  && keepouts && dimensions && otherItems );
85  }
bool otherItems
Anything not fitting one of the above categories.
bool text
Text (free or attached to a footprint)
bool dimensions
Dimension items.
bool graphics
Graphic lines, shapes, polygons.
bool footprints
Allow selecting entire footprints.

References dimensions, footprints, graphics, keepouts, otherItems, pads, text, tracks, vias, and zones.

Referenced by PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ Any()

bool SELECTION_FILTER_OPTIONS::Any ( )
inline
Returns
true if any of the item types are enabled (excluding "locked items" which is special)

Definition at line 72 of file board_project_settings.h.

73  {
74  return ( footprints || text || tracks || vias || pads || graphics || zones
75  || keepouts || dimensions || otherItems );
76  }
bool otherItems
Anything not fitting one of the above categories.
bool text
Text (free or attached to a footprint)
bool dimensions
Dimension items.
bool graphics
Graphic lines, shapes, polygons.
bool footprints
Allow selecting entire footprints.

References dimensions, footprints, graphics, keepouts, otherItems, pads, text, tracks, vias, and zones.

Member Data Documentation

◆ dimensions

◆ footprints

◆ graphics

◆ keepouts

◆ lockedItems

◆ otherItems

◆ pads

◆ text

◆ tracks

◆ vias

◆ zones


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