![]() |
KiCad PCB EDA Suite
|
#include <deque>
#include <core/typeinfo.h>
#include <wx/fdrepdlg.h>
#include <bitmap_types.h>
#include <view/view_item.h>
#include <kiid.h>
Go to the source code of this file.
Classes | |
class | EDA_ITEM |
A base class for most all the KiCad significant classes used in schematics and boards. More... | |
Macros | |
#define | IS_CHANGED (1 << 0) |
Item was edited, and modified. 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 | LOCKED (1 << 18) |
Pcbnew: locked from movement and deletion. More... | |
#define | UNUSED (1 << 19) |
#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 | ENTERED (1 << 30) |
indicates a group has been entered More... | |
#define | EDA_ITEM_ALL_FLAGS -1 |
Typedefs | |
typedef std::function< SEARCH_RESULT(EDA_ITEM *aItem, void *aTestData) > | INSPECTOR_FUNC |
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) |
Provide cloning capabilities for all Boost pointer containers of EDA_ITEM pointers. More... | |
#define BEGIN_ONPAD (1 << 22) |
Pcbnew: flag set for track segment starting on a pad.
Definition at line 126 of file eda_item.h.
#define BRIGHTENED (1 << 26) |
item is drawn with a bright contour
Definition at line 130 of file eda_item.h.
#define CANDIDATE (1 << 14) |
flag indicating that the structure is connected
Definition at line 116 of file eda_item.h.
#define DO_NOT_DRAW (1 << 16) |
Used to disable draw function.
Definition at line 118 of file eda_item.h.
#define DP_COUPLED (1 << 27) |
item is coupled with another item making a differential pair
(applies to segments only)
Definition at line 132 of file eda_item.h.
#define EDA_ITEM_ALL_FLAGS -1 |
Definition at line 142 of file eda_item.h.
#define END_ONPAD (1 << 23) |
Pcbnew: flag set for track segment ending on a pad.
Definition at line 127 of file eda_item.h.
#define ENDPOINT (1 << 10) |
ends. (Used to support dragging.)
Definition at line 112 of file eda_item.h.
#define ENTERED (1 << 30) |
indicates a group has been entered
Definition at line 137 of file eda_item.h.
#define HOLE_PROXY (1 << 24) |
Indicates the BOARD_ITEM is a proxy for its hole.
Definition at line 128 of file eda_item.h.
#define IN_EDIT (1 << 2) |
Item currently edited.
Definition at line 104 of file eda_item.h.
#define IS_CHANGED (1 << 0) |
Item was edited, and modified.
Definition at line 102 of file eda_item.h.
#define IS_DANGLING (1 << 29) |
indicates a pin is dangling
Definition at line 136 of file eda_item.h.
#define IS_DELETED (1 << 7) |
Definition at line 109 of file eda_item.h.
#define IS_DRAGGED (1 << 6) |
Item being dragged.
Definition at line 108 of file eda_item.h.
#define IS_LINKED (1 << 1) |
Used in calculation to mark linked items (temporary use)
Definition at line 103 of file eda_item.h.
#define IS_MOVED (1 << 3) |
Item being moved.
Definition at line 105 of file eda_item.h.
#define IS_NEW (1 << 4) |
New item, just created.
Definition at line 106 of file eda_item.h.
#define IS_PASTED (1 << 17) |
Modifier on IS_NEW which indicates it came from clipboard.
Definition at line 119 of file eda_item.h.
#define IS_RESIZED (1 << 5) |
Item being resized.
Definition at line 107 of file eda_item.h.
#define IS_ROLLOVER (1 << 25) |
Rollover active. Used for hyperlink highlighting.
Definition at line 129 of file eda_item.h.
#define IS_WIRE_IMAGE (1 << 8) |
Item to be drawn as wireframe while editing.
Definition at line 110 of file eda_item.h.
#define LOCKED (1 << 18) |
Pcbnew: locked from movement and deletion.
NB: stored in m_status flags, NOT m_flags.
Definition at line 120 of file eda_item.h.
#define MALFORMED_B_COURTYARD (1 << 21) |
Definition at line 124 of file eda_item.h.
#define MALFORMED_COURTYARDS ( MALFORMED_F_COURTYARD | MALFORMED_B_COURTYARD ) |
Definition at line 125 of file eda_item.h.
#define MALFORMED_F_COURTYARD (1 << 20) |
Definition at line 123 of file eda_item.h.
#define SELECTED (1 << 11) |
Definition at line 113 of file eda_item.h.
#define SKIP_STRUCT (1 << 15) |
flag indicating that the structure should be ignored
Definition at line 117 of file eda_item.h.
#define STARTPOINT (1 << 9) |
When a line is selected, these flags indicate which.
Definition at line 111 of file eda_item.h.
#define STRUCT_DELETED (1 << 13) |
flag indication structures to be erased
Definition at line 115 of file eda_item.h.
#define TEMP_SELECTED (1 << 12) |
flag indicating that the structure has already selected
Definition at line 114 of file eda_item.h.
#define UNUSED (1 << 19) |
Definition at line 122 of file eda_item.h.
#define UR_TRANSIENT (1 << 28) |
indicates the item is owned by the undo/redo stack
Definition at line 134 of file eda_item.h.
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 556 of file eda_item.h.
typedef const INSPECTOR_FUNC& INSPECTOR |
Definition at line 94 of file eda_item.h.
typedef std::function< SEARCH_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC |
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.
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. |
Definition at line 69 of file eda_item.h.
typedef unsigned STATUS_FLAGS |
Definition at line 144 of file eda_item.h.
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.
|
strong |
Enumerator | |
---|---|
QUIT | |
CONTINUE |
Definition at line 40 of file eda_item.h.
Provide cloning capabilities for all Boost pointer containers of EDA_ITEM pointers.
aItem | EDA_ITEM to clone. |
Definition at line 547 of file eda_item.h.
References EDA_ITEM::Clone().