KiCad PCB EDA Suite
Public Member Functions | Public Attributes | List of all members
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 42 of file board_project_settings.h.

Constructor & Destructor Documentation

◆ SELECTION_FILTER_OPTIONS()

SELECTION_FILTER_OPTIONS::SELECTION_FILTER_OPTIONS ( )
inline

Definition at line 56 of file board_project_settings.h.

57 {
58 lockedItems = true;
59 footprints = true;
60 text = true;
61 tracks = true;
62 vias = true;
63 pads = true;
64 graphics = true;
65 zones = true;
66 keepouts = true;
67 dimensions = true;
68 otherItems = true;
69 }
SELECTION_FILTER_OPTIONS::zones
bool zones
Copper zones.
Definition: board_project_settings.h:51
SELECTION_FILTER_OPTIONS::graphics
bool graphics
Graphic lines, shapes, polygons.
Definition: board_project_settings.h:50
SELECTION_FILTER_OPTIONS::text
bool text
Text (free or attached to a footprint)
Definition: board_project_settings.h:46
SELECTION_FILTER_OPTIONS::pads
bool pads
Footprint pads.
Definition: board_project_settings.h:49
SELECTION_FILTER_OPTIONS::vias
bool vias
Vias (all types>
Definition: board_project_settings.h:48
SELECTION_FILTER_OPTIONS::lockedItems
bool lockedItems
Allow selecting locked items.
Definition: board_project_settings.h:44
SELECTION_FILTER_OPTIONS::tracks
bool tracks
Copper tracks.
Definition: board_project_settings.h:47
SELECTION_FILTER_OPTIONS::footprints
bool footprints
Allow selecting entire footprints.
Definition: board_project_settings.h:45
SELECTION_FILTER_OPTIONS::keepouts
bool keepouts
Keepout zones.
Definition: board_project_settings.h:52
SELECTION_FILTER_OPTIONS::dimensions
bool dimensions
Dimension items.
Definition: board_project_settings.h:53
SELECTION_FILTER_OPTIONS::otherItems
bool otherItems
Anything not fitting one of the above categories.
Definition: board_project_settings.h:54

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 83 of file board_project_settings.h.

84 {
85 return ( footprints && text && tracks && vias && pads && graphics && zones
86 && keepouts && dimensions && otherItems );
87 }

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 74 of file board_project_settings.h.

75 {
76 return ( footprints || text || tracks || vias || pads || graphics || zones
77 || keepouts || dimensions || otherItems );
78 }

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

Member Data Documentation

◆ dimensions

bool SELECTION_FILTER_OPTIONS::dimensions

Dimension items.

Definition at line 53 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ footprints

bool SELECTION_FILTER_OPTIONS::footprints

Allow selecting entire footprints.

Definition at line 45 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ graphics

bool SELECTION_FILTER_OPTIONS::graphics

Graphic lines, shapes, polygons.

Definition at line 50 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ keepouts

bool SELECTION_FILTER_OPTIONS::keepouts

Keepout zones.

Definition at line 52 of file board_project_settings.h.

Referenced by All(), Any(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ lockedItems

bool SELECTION_FILTER_OPTIONS::lockedItems

Allow selecting locked items.

Definition at line 44 of file board_project_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ otherItems

bool SELECTION_FILTER_OPTIONS::otherItems

Anything not fitting one of the above categories.

Definition at line 54 of file board_project_settings.h.

Referenced by All(), Any(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ pads

bool SELECTION_FILTER_OPTIONS::pads

Footprint pads.

Definition at line 49 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ text

bool SELECTION_FILTER_OPTIONS::text

Text (free or attached to a footprint)

Definition at line 46 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ tracks

bool SELECTION_FILTER_OPTIONS::tracks

Copper tracks.

Definition at line 47 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ vias

bool SELECTION_FILTER_OPTIONS::vias

Vias (all types>

Definition at line 48 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

◆ zones

bool SELECTION_FILTER_OPTIONS::zones

Copper zones.

Definition at line 51 of file board_project_settings.h.

Referenced by All(), Any(), PCB_GRID_HELPER::computeAnchors(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_SELECTION_TOOL::itemPassesFilter(), PCB_SELECTION_TOOL::PCB_SELECTION_TOOL(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), SELECTION_FILTER_OPTIONS(), PANEL_SELECTION_FILTER::SetCheckboxesFromFilter(), and PANEL_SELECTION_FILTER::setFilterFromCheckboxes().

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