KiCad PCB EDA Suite
eda_item_flags.h File Reference
#include <cstdint>

Go to the source code of this file.

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_MOVING   (1 << 3)
 Item being moved. More...
 
#define IS_NEW   (1 << 4)
 New item, just created. More...
 
#define IS_RESIZING   (1 << 5)
 Item being resized. More...
 
#define IS_DRAGGING   (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   UINT32_MAX
 

Typedefs

typedef std::uint32_t EDA_ITEM_FLAGS
 

Macro Definition Documentation

◆ BEGIN_ONPAD

#define BEGIN_ONPAD   (1 << 22)

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

Definition at line 61 of file eda_item_flags.h.

◆ BRIGHTENED

#define BRIGHTENED   (1 << 26)

item is drawn with a bright contour

Definition at line 65 of file eda_item_flags.h.

◆ CANDIDATE

#define CANDIDATE   (1 << 14)

flag indicating that the structure is connected

Definition at line 51 of file eda_item_flags.h.

◆ DO_NOT_DRAW

#define DO_NOT_DRAW   (1 << 16)

Used to disable draw function.

Definition at line 53 of file eda_item_flags.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 67 of file eda_item_flags.h.

◆ EDA_ITEM_ALL_FLAGS

#define EDA_ITEM_ALL_FLAGS   UINT32_MAX

Definition at line 77 of file eda_item_flags.h.

◆ END_ONPAD

#define END_ONPAD   (1 << 23)

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

Definition at line 62 of file eda_item_flags.h.

◆ ENDPOINT

#define ENDPOINT   (1 << 10)

ends. (Used to support dragging.)

Definition at line 47 of file eda_item_flags.h.

◆ ENTERED

#define ENTERED   (1 << 30)

indicates a group has been entered

Definition at line 72 of file eda_item_flags.h.

◆ HOLE_PROXY

#define HOLE_PROXY   (1 << 24)

Indicates the BOARD_ITEM is a proxy for its hole.

Definition at line 63 of file eda_item_flags.h.

◆ IN_EDIT

#define IN_EDIT   (1 << 2)

Item currently edited.

Definition at line 39 of file eda_item_flags.h.

◆ IS_CHANGED

#define IS_CHANGED   (1 << 0)

Item was edited, and modified.

Definition at line 37 of file eda_item_flags.h.

◆ IS_DANGLING

#define IS_DANGLING   (1 << 29)

indicates a pin is dangling

Definition at line 71 of file eda_item_flags.h.

◆ IS_DELETED

#define IS_DELETED   (1 << 7)

Definition at line 44 of file eda_item_flags.h.

◆ IS_DRAGGING

#define IS_DRAGGING   (1 << 6)

Item being dragged.

Definition at line 43 of file eda_item_flags.h.

◆ IS_LINKED

#define IS_LINKED   (1 << 1)

Used in calculation to mark linked items (temporary use)

Definition at line 38 of file eda_item_flags.h.

◆ IS_MOVING

#define IS_MOVING   (1 << 3)

Item being moved.

Definition at line 40 of file eda_item_flags.h.

◆ IS_NEW

#define IS_NEW   (1 << 4)

New item, just created.

Definition at line 41 of file eda_item_flags.h.

◆ IS_PASTED

#define IS_PASTED   (1 << 17)

Modifier on IS_NEW which indicates it came from clipboard.

Definition at line 54 of file eda_item_flags.h.

◆ IS_RESIZING

#define IS_RESIZING   (1 << 5)

Item being resized.

Definition at line 42 of file eda_item_flags.h.

◆ IS_ROLLOVER

#define IS_ROLLOVER   (1 << 25)

Rollover active. Used for hyperlink highlighting.

Definition at line 64 of file eda_item_flags.h.

◆ IS_WIRE_IMAGE

#define IS_WIRE_IMAGE   (1 << 8)

Item to be drawn as wireframe while editing.

Definition at line 45 of file eda_item_flags.h.

◆ LOCKED

#define LOCKED   (1 << 18)

Pcbnew: locked from movement and deletion.

NB: stored in m_status flags, NOT m_flags.

Definition at line 55 of file eda_item_flags.h.

◆ MALFORMED_B_COURTYARD

#define MALFORMED_B_COURTYARD   (1 << 21)

Definition at line 59 of file eda_item_flags.h.

◆ MALFORMED_COURTYARDS

#define MALFORMED_COURTYARDS   ( MALFORMED_F_COURTYARD | MALFORMED_B_COURTYARD )

Definition at line 60 of file eda_item_flags.h.

◆ MALFORMED_F_COURTYARD

#define MALFORMED_F_COURTYARD   (1 << 20)

Definition at line 58 of file eda_item_flags.h.

◆ SELECTED

#define SELECTED   (1 << 11)

Definition at line 48 of file eda_item_flags.h.

◆ SKIP_STRUCT

#define SKIP_STRUCT   (1 << 15)

flag indicating that the structure should be ignored

Definition at line 52 of file eda_item_flags.h.

◆ STARTPOINT

#define STARTPOINT   (1 << 9)

When a line is selected, these flags indicate which.

Definition at line 46 of file eda_item_flags.h.

◆ STRUCT_DELETED

#define STRUCT_DELETED   (1 << 13)

flag indication structures to be erased

Definition at line 50 of file eda_item_flags.h.

◆ TEMP_SELECTED

#define TEMP_SELECTED   (1 << 12)

flag indicating that the structure has already selected

Definition at line 49 of file eda_item_flags.h.

◆ UNUSED

#define UNUSED   (1 << 19)

Definition at line 57 of file eda_item_flags.h.

◆ UR_TRANSIENT

#define UR_TRANSIENT   (1 << 28)

indicates the item is owned by the undo/redo stack

Definition at line 69 of file eda_item_flags.h.

Typedef Documentation

◆ EDA_ITEM_FLAGS

typedef std::uint32_t EDA_ITEM_FLAGS

Definition at line 79 of file eda_item_flags.h.