#include <deque>
#include <core/typeinfo.h>
#include <wx/fdrepdlg.h>
#include <bitmap_types.h>
#include <view/view_item.h>
#include <kiid.h>

Classes
class	EDA_ITEM
	EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards. More...

Macros
#define	IS_CHANGED (1 << 0)
	std::function passed to nested users by ref, avoids copying std::function More...

#define	IS_LINKED (1 << 1)
	Used in calculation to mark linked items (temporary use) More...

#define	IN_EDIT (1 << 2)
	Item currently edited. More...

#define	IS_MOVED (1 << 3)
	Item being moved. More...

#define	IS_NEW (1 << 4)
	New item, just created. More...

#define	IS_RESIZED (1 << 5)
	Item being resized. More...

#define	IS_DRAGGED (1 << 6)
	Item being dragged. More...

#define	IS_DELETED (1 << 7)

#define	IS_WIRE_IMAGE (1 << 8)
	Item to be drawn as wireframe while editing. More...

#define	STARTPOINT (1 << 9)
	When a line is selected, these flags indicate which. More...

#define	ENDPOINT (1 << 10)
	ends. (Used to support dragging.) More...

#define	SELECTED (1 << 11)

#define	TEMP_SELECTED (1 << 12)
	flag indicating that the structure has already selected More...

#define	STRUCT_DELETED (1 << 13)
	flag indication structures to be erased More...

#define	CANDIDATE (1 << 14)
	flag indicating that the structure is connected More...

#define	SKIP_STRUCT (1 << 15)
	flag indicating that the structure should be ignored More...

#define	DO_NOT_DRAW (1 << 16)
	Used to disable draw function. More...

#define	IS_PASTED (1 << 17)
	Modifier on IS_NEW which indicates it came from clipboard. More...

#define	TRACK_LOCKED (1 << 18)
	Pcbnew: track locked: protected from global deletion. More...

#define	TRACK_AR (1 << 19)
	Pcbnew: autorouted track. More...

#define	MALFORMED_F_COURTYARD (1 << 20)

#define	MALFORMED_B_COURTYARD (1 << 21)

#define	MALFORMED_COURTYARDS ( MALFORMED_F_COURTYARD \| MALFORMED_B_COURTYARD )

#define	BEGIN_ONPAD (1 << 22)
	Pcbnew: flag set for track segment starting on a pad. More...

#define	END_ONPAD (1 << 23)
	Pcbnew: flag set for track segment ending on a pad. More...

#define	HOLE_PROXY (1 << 24)
	Indicates the BOARD_ITEM is a proxy for its hole. More...

#define	IS_ROLLOVER (1 << 25)
	Rollover active. Used for hyperlink highlighting. More...

#define	BRIGHTENED (1 << 26)
	item is drawn with a bright contour More...

#define	DP_COUPLED (1 << 27)
	item is coupled with another item making a differential pair More...

#define	UR_TRANSIENT (1 << 28)
	indicates the item is owned by the undo/redo stack More...

#define	IS_DANGLING (1 << 29)
	indicates a pin is dangling More...

#define	EDA_ITEM_ALL_FLAGS -1

Typedefs
typedef std::function< SEARCH_RESULT(EDA_ITEM aItem, void aTestData) >	INSPECTOR_FUNC
	Typedef INSPECTOR is used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T objects. More...

typedef const INSPECTOR_FUNC &	INSPECTOR

typedef unsigned	STATUS_FLAGS

typedef std::vector< EDA_ITEM * >	EDA_ITEMS
	Define list of drawing items for screens. More...

Enumerations
enum	SEARCH_RESULT { SEARCH_RESULT::QUIT, SEARCH_RESULT::CONTINUE }

enum	FIND_REPLACE_FLAGS { FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1, FR_SEARCH_ALL_FIELDS = wxFR_MATCHCASE << 2, FR_SEARCH_ALL_PINS = wxFR_MATCHCASE << 3, FR_MATCH_WILDCARD = wxFR_MATCHCASE << 4, FR_SEARCH_WRAP = wxFR_MATCHCASE << 5, FR_SEARCH_REPLACE = wxFR_MATCHCASE << 7, FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8, FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9 }
	Additional flag values wxFindReplaceData::m_Flags. More...

Functions
EDA_ITEM *	new_clone (const EDA_ITEM &aItem)
	Function new_clone provides cloning capabilities for all Boost pointer containers of EDA_ITEM pointers. More...

Macro Definition Documentation

◆ BEGIN_ONPAD

#define BEGIN_ONPAD (1 << 22)

Pcbnew: flag set for track segment starting on a pad.

Definition at line 125 of file eda_item.h.

◆ BRIGHTENED

#define BRIGHTENED (1 << 26)

item is drawn with a bright contour

Definition at line 129 of file eda_item.h.

◆ CANDIDATE

#define CANDIDATE (1 << 14)

flag indicating that the structure is connected

Definition at line 116 of file eda_item.h.

◆ DO_NOT_DRAW

#define DO_NOT_DRAW (1 << 16)

Used to disable draw function.

Definition at line 118 of file eda_item.h.

◆ DP_COUPLED

#define DP_COUPLED (1 << 27)

item is coupled with another item making a differential pair

(applies to segments only)

Definition at line 131 of file eda_item.h.

◆ EDA_ITEM_ALL_FLAGS

#define EDA_ITEM_ALL_FLAGS -1

Definition at line 140 of file eda_item.h.

◆ END_ONPAD

#define END_ONPAD (1 << 23)

Pcbnew: flag set for track segment ending on a pad.

Definition at line 126 of file eda_item.h.

◆ ENDPOINT

#define ENDPOINT (1 << 10)

ends. (Used to support dragging.)

Definition at line 112 of file eda_item.h.

◆ HOLE_PROXY

#define HOLE_PROXY (1 << 24)

Indicates the BOARD_ITEM is a proxy for its hole.

Definition at line 127 of file eda_item.h.

◆ IN_EDIT

#define IN_EDIT (1 << 2)

Item currently edited.

Definition at line 104 of file eda_item.h.

◆ IS_CHANGED

#define IS_CHANGED (1 << 0)

std::function passed to nested users by ref, avoids copying std::function

Item was edited, and modified

Definition at line 102 of file eda_item.h.

◆ IS_DANGLING

#define IS_DANGLING (1 << 29)

indicates a pin is dangling

Definition at line 135 of file eda_item.h.

◆ IS_DELETED

#define IS_DELETED (1 << 7)

Definition at line 109 of file eda_item.h.

◆ IS_DRAGGED

#define IS_DRAGGED (1 << 6)

Item being dragged.

Definition at line 108 of file eda_item.h.

◆ IS_LINKED

#define IS_LINKED (1 << 1)

Used in calculation to mark linked items (temporary use)

Definition at line 103 of file eda_item.h.

◆ IS_MOVED

#define IS_MOVED (1 << 3)

Item being moved.

Definition at line 105 of file eda_item.h.

◆ IS_NEW

#define IS_NEW (1 << 4)

New item, just created.

Definition at line 106 of file eda_item.h.

◆ IS_PASTED

#define IS_PASTED (1 << 17)

Modifier on IS_NEW which indicates it came from clipboard.

Definition at line 119 of file eda_item.h.

◆ IS_RESIZED

#define IS_RESIZED (1 << 5)

Item being resized.

Definition at line 107 of file eda_item.h.

◆ IS_ROLLOVER

#define IS_ROLLOVER (1 << 25)

Rollover active. Used for hyperlink highlighting.

Definition at line 128 of file eda_item.h.

◆ IS_WIRE_IMAGE

#define IS_WIRE_IMAGE (1 << 8)

Item to be drawn as wireframe while editing.

Definition at line 110 of file eda_item.h.

◆ MALFORMED_B_COURTYARD

#define MALFORMED_B_COURTYARD (1 << 21)

Definition at line 123 of file eda_item.h.

◆ MALFORMED_COURTYARDS

#define MALFORMED_COURTYARDS ( MALFORMED_F_COURTYARD | MALFORMED_B_COURTYARD )

Definition at line 124 of file eda_item.h.

◆ MALFORMED_F_COURTYARD

#define MALFORMED_F_COURTYARD (1 << 20)

Definition at line 122 of file eda_item.h.

◆ SELECTED

#define SELECTED (1 << 11)

Definition at line 113 of file eda_item.h.

◆ SKIP_STRUCT

#define SKIP_STRUCT (1 << 15)

flag indicating that the structure should be ignored

Definition at line 117 of file eda_item.h.

◆ STARTPOINT

#define STARTPOINT (1 << 9)

When a line is selected, these flags indicate which.

Definition at line 111 of file eda_item.h.

◆ STRUCT_DELETED

#define STRUCT_DELETED (1 << 13)

flag indication structures to be erased

Definition at line 115 of file eda_item.h.

◆ TEMP_SELECTED

#define TEMP_SELECTED (1 << 12)

flag indicating that the structure has already selected

Definition at line 114 of file eda_item.h.

◆ TRACK_AR

#define TRACK_AR (1 << 19)

Pcbnew: autorouted track.

Definition at line 121 of file eda_item.h.

◆ TRACK_LOCKED

#define TRACK_LOCKED (1 << 18)

Pcbnew: track locked: protected from global deletion.

Definition at line 120 of file eda_item.h.

◆ UR_TRANSIENT

#define UR_TRANSIENT (1 << 28)

indicates the item is owned by the undo/redo stack

Definition at line 133 of file eda_item.h.

Typedef Documentation

◆ EDA_ITEMS

typedef std::vector< EDA_ITEM* > EDA_ITEMS

Define list of drawing items for screens.

The standard C++ container was chosen so the pointer can be removed from a list without it being destroyed.

Definition at line 576 of file eda_item.h.

◆ INSPECTOR

typedef const INSPECTOR_FUNC& INSPECTOR

Definition at line 94 of file eda_item.h.

◆ INSPECTOR_FUNC

typedef std::function< SEARCH_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC

Typedef INSPECTOR is used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T objects.

Provide an implementation as needed to inspect EDA_ITEMs visited via EDA_ITEM::Visit() and EDA_ITEM::IterateForward().

FYI the std::function may hold a lambda, std::bind, pointer to func, or ptr to member function, per modern C++. It is used primarily for searching, but not limited to that. It can also collect or modify the scanned objects. 'Capturing' lambdas are particularly convenient because they can use context and this often means aTestData is not used.

Parameters

aItem	An EDA_ITEM to examine.
aTestData	is arbitrary data needed by the inspector to determine if the EDA_ITEM under test meets its match criteria, and is often NULL with the advent of capturing lambdas.

Returns: A SEARCH_RESULT type #SEARCH_QUIT if the iterator function is to stop the scan, else #SEARCH_CONTINUE;

Definition at line 69 of file eda_item.h.

◆ STATUS_FLAGS

typedef unsigned STATUS_FLAGS

Definition at line 142 of file eda_item.h.

Enumeration Type Documentation

◆ FIND_REPLACE_FLAGS

enum FIND_REPLACE_FLAGS

Additional flag values wxFindReplaceData::m_Flags.

Enumerator
FR_CURRENT_SHEET_ONLY
FR_SEARCH_ALL_FIELDS
FR_SEARCH_ALL_PINS
FR_MATCH_WILDCARD
FR_SEARCH_WRAP
FR_SEARCH_REPLACE
FR_REPLACE_ITEM_FOUND
FR_REPLACE_REFERENCES

Definition at line 50 of file eda_item.h.

 {
     // The last wxFindReplaceFlag enum is wxFR_MATCHCASE = 0x4.
     FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1,   // Search the current sheet only.
     FR_SEARCH_ALL_FIELDS  = wxFR_MATCHCASE << 2,   // Search hidden fields too.
     FR_SEARCH_ALL_PINS    = wxFR_MATCHCASE << 3,   // Search pin name and number.
     FR_MATCH_WILDCARD     = wxFR_MATCHCASE << 4,   // Use simple wild card matching (* & ?).
     FR_SEARCH_WRAP        = wxFR_MATCHCASE << 5,   // Wrap around the start or end of search.
     FR_SEARCH_REPLACE     = wxFR_MATCHCASE << 7,   // Search for a item that has replaceable text.
     FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8,   // Indicates an item with replaceable text has
                                                    // been found.
     FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9    // Don't replace in references.
 };

◆ SEARCH_RESULT

enum SEARCH_RESULT

strong

Enumerator
QUIT
CONTINUE

Definition at line 40 of file eda_item.h.

 {
     QUIT,
     CONTINUE
 };

Function Documentation

◆ new_clone()

EDA_ITEM* new_clone ( const EDA_ITEM & aItem )

inline

Function new_clone provides cloning capabilities for all Boost pointer containers of EDA_ITEM pointers.