KiCad PCB EDA Suite
eeschema_id.h File Reference
#include <id.h>

Go to the source code of this file.

Macros

#define MAX_SELECT_ITEM_IDS   10
 The maximum number of items in the clarify selection context menu. More...
 
#define MAX_UNIT_COUNT_PER_PACKAGE   64
 The maximum number of units per package. More...
 

Enumerations

enum  id_eeschema_frm {
  ID_UPDATE_ONE_SHEET = ID_END_LIST, ID_SAVE_ONE_SHEET_UNDER_NEW_NAME, ID_IMPORT_NON_KICAD_SCH, ID_RESCUE_CACHED,
  ID_EDIT_SYM_LIB_TABLE, ID_REMAP_SYMBOLS, ID_EDIT_COMPONENTS_TO_SYMBOLS_LIB_ID, ID_HIERARCHY,
  ID_TO_LIBVIEW, ID_GET_ANNOTATE, ID_GET_ERC, ID_BACKANNO_ITEMS,
  ID_UPDATE_FIELDS, ID_GEN_PLOT_SCHEMATIC, ID_SCHEMATIC_VERTICAL_TOOLBAR_START, ID_HIGHLIGHT,
  ID_SCH_PLACE_COMPONENT, ID_PLACE_POWER_BUTT, ID_BUS_BUTT, ID_WIRE_BUTT,
  ID_BUSTOBUS_ENTRY_BUTT, ID_WIRETOBUS_ENTRY_BUTT, ID_LABEL_BUTT, ID_GLABEL_BUTT,
  ID_HIERLABEL_BUTT, ID_IMPORT_HLABEL_BUTT, ID_SHEET_PIN_BUTT, ID_NOCONN_BUTT,
  ID_JUNCTION_BUTT, ID_SHEET_SYMBOL_BUTT, ID_TEXT_COMMENT_BUTT, ID_LINE_COMMENT_BUTT,
  ID_ADD_IMAGE_BUTT, ID_SCHEMATIC_DELETE_ITEM_BUTT, ID_SCHEMATIC_VERTICAL_TOOLBAR_END, ID_TB_OPTIONS_HIDDEN_PINS,
  ID_TB_OPTIONS_BUS_WIRES_ORIENT, ID_POPUP_SCH_DUPLICATE_ITEM, ID_POPUP_START_RANGE, ID_POPUP_SCH_DELETE,
  ID_POPUP_SCH_BREAK_WIRE, ID_POPUP_SCH_BEGIN_WIRE, ID_POPUP_SCH_BEGIN_BUS, ID_POPUP_END_LINE,
  ID_POPUP_SCH_DELETE_CONNECTION, ID_POPUP_SCH_DELETE_NODE, ID_POPUP_SCH_DELETE_CMP, ID_POPUP_SCH_ENTRY_SELECT_SLASH,
  ID_POPUP_SCH_ENTRY_SELECT_ANTISLASH, ID_POPUP_SCH_INIT_CMP, ID_POPUP_SCH_SET_SHAPE_TEXT, ID_POPUP_SCH_END_SHEET,
  ID_POPUP_SCH_RESIZE_SHEET, ID_POPUP_SCH_CLEANUP_SHEET, ID_POPUP_IMPORT_HLABEL_TO_SHEETPIN, ID_POPUP_SCH_GENERIC_ORIENT_CMP,
  ID_POPUP_SCH_GENERIC_EDIT_CMP, ID_POPUP_SCH_EDIT_CONVERT_CMP, ID_POPUP_SCH_EDIT_FIELD, ID_POPUP_SCH_DISPLAYDOC_CMP,
  ID_POPUP_SCH_ENTER_SHEET, ID_POPUP_SCH_LEAVE_SHEET, ID_POPUP_SCH_SELECT_ON_PCB, ID_POPUP_SCH_ADD_JUNCTION,
  ID_POPUP_SCH_ADD_LABEL, ID_POPUP_SCH_ADD_GLABEL, ID_POPUP_SCH_GETINFO_MARKER, ID_POPUP_END_RANGE,
  ID_POPUP_SCH_CALL_LIBEDIT_AND_LOAD_CMP, ID_POPUP_SCH_SELECT_UNIT_CMP, ID_POPUP_SCH_SELECT_UNIT1, ID_POPUP_SCH_SELECT_UNIT_CMP_MAX,
  ID_POPUP_SCH_CHANGE_TYPE_TEXT, ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_LABEL, ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_GLABEL, ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_HLABEL,
  ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_COMMENT, ID_SELECT_ITEM_START, ID_SELECT_ITEM_END = ID_SELECT_ITEM_START + MAX_SELECT_ITEM_IDS, ID_SCH_MIRROR_X,
  ID_SCH_MIRROR_Y, ID_SCH_ORIENT_NORMAL, ID_SCH_ROTATE_CLOCKWISE, ID_SCH_ROTATE_COUNTERCLOCKWISE,
  ID_SCH_EDIT_ITEM, ID_SCH_EDIT_COMPONENT_VALUE, ID_SCH_EDIT_COMPONENT_REFERENCE, ID_SCH_EDIT_COMPONENT_FOOTPRINT,
  ID_SCH_MOVE_ITEM, ID_SCH_DRAG_ITEM, ID_AUTOPLACE_FIELDS, ID_CANCEL_CURRENT_COMMAND,
  ID_HOTKEY_HIGHLIGHT, ID_LIBEDIT_DIMENSIONS, ID_LIBEDIT_NEW_LIBRARY, ID_LIBEDIT_ADD_LIBRARY,
  ID_LIBEDIT_SAVE_LIBRARY, ID_LIBEDIT_SAVE_LIBRARY_AS, ID_LIBEDIT_SAVE_ALL_LIBS, ID_LIBEDIT_REVERT_LIBRARY,
  ID_LIBEDIT_NEW_PART, ID_LIBEDIT_EDIT_PART, ID_LIBEDIT_IMPORT_PART, ID_LIBEDIT_EXPORT_PART,
  ID_LIBEDIT_SAVE_PART, ID_LIBEDIT_REVERT_PART, ID_LIBEDIT_REMOVE_PART, ID_LIBEDIT_CUT_PART,
  ID_LIBEDIT_COPY_PART, ID_LIBEDIT_PASTE_PART, ID_LIBEDIT_DUPLICATE_PART, ID_DE_MORGAN_NORMAL_BUTT,
  ID_DE_MORGAN_CONVERT_BUTT, ID_LIBEDIT_EDIT_PIN_BY_PIN, ID_LIBEDIT_EDIT_PIN_BY_TABLE, ID_LIBEDIT_VIEW_DOC,
  ID_LIBEDIT_CHECK_PART, ID_LIBEDIT_GET_FRAME_EDIT_PART, ID_LIBEDIT_GET_FRAME_EDIT_FIELDS, ID_LIBEDIT_SELECT_PART_NUMBER,
  ID_LIBEDIT_SELECT_ALIAS, ID_LIBEDIT_PIN_BUTT, ID_LIBEDIT_BODY_LINE_BUTT, ID_LIBEDIT_BODY_ARC_BUTT,
  ID_LIBEDIT_BODY_CIRCLE_BUTT, ID_LIBEDIT_BODY_RECT_BUTT, ID_LIBEDIT_BODY_TEXT_BUTT, ID_LIBEDIT_ANCHOR_ITEM_BUTT,
  ID_LIBEDIT_IMPORT_BODY_BUTT, ID_LIBEDIT_EXPORT_BODY_BUTT, ID_LIBEDIT_DELETE_ITEM_BUTT, ID_LIBEDIT_ROTATE_ITEM,
  ID_LIBEDIT_MIRROR_X, ID_LIBEDIT_MIRROR_Y, ID_LIBEDIT_ORIENT_NORMAL, ID_LIBEDIT_EDIT_PIN,
  ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_ITEM, ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINSIZE_ITEM, ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINNAMESIZE_ITEM, ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINNUMSIZE_ITEM,
  ID_POPUP_LIBEDIT_BODY_EDIT_ITEM, ID_POPUP_LIBEDIT_DELETE_ITEM, ID_POPUP_LIBEDIT_MODIFY_ITEM, ID_POPUP_LIBEDIT_END_CREATE_ITEM,
  ID_POPUP_LIBEDIT_CANCEL_EDITING, ID_POPUP_LIBEDIT_MOVE_ITEM_REQUEST, ID_POPUP_LIBEDIT_FIELD_EDIT_ITEM, ID_POPUP_LIBEDIT_DELETE_CURRENT_POLY_SEGMENT,
  ID_LIBEDIT_SHOW_ELECTRICAL_TYPE, ID_LIBEDIT_SHOW_HIDE_SEARCH_TREE, ID_LIBEDIT_GEN_PNG_FILE, ID_LIBEDIT_GEN_SVG_FILE,
  ID_LIBVIEW_SELECT_PART, ID_LIBVIEW_NEXT, ID_LIBVIEW_PREVIOUS, ID_LIBVIEW_VIEWDOC,
  ID_LIBVIEW_DE_MORGAN_NORMAL_BUTT, ID_LIBVIEW_DE_MORGAN_CONVERT_BUTT, ID_LIBVIEW_SELECT_PART_NUMBER, ID_LIBVIEW_LIB_LIST,
  ID_LIBVIEW_CMP_LIST, ID_LIBVIEW_LIBWINDOW, ID_LIBVIEW_CMPWINDOW, ID_LIBVIEW_CMP_EXPORT_TO_SCHEMATIC,
  ID_SET_RELATIVE_OFFSET, ID_LIBVIEW_SHOW_ELECTRICAL_TYPE, ID_UPDATE_PCB_FROM_SCH, ID_UPDATE_SCH_FROM_PCB,
  ID_SIM_RUN, ID_SIM_TUNE, ID_SIM_PROBE, ID_SIM_SETTINGS,
  ID_SIM_ADD_SIGNALS, ID_SIM_SHOW, ID_END_EESCHEMA_ID_LIST
}
 Command IDs for the schematic editor. More...
 

Variables

enum id_eeschema_frm kiface
 

Macro Definition Documentation

#define MAX_SELECT_ITEM_IDS   10

The maximum number of items in the clarify selection context menu.

It is highly unlikely that there would ever be more than 10 items at the current cursor. Increase this number if that ever becomes a problem.

Definition at line 41 of file eeschema_id.h.

Referenced by LIB_EDIT_FRAME::locateItem(), and SCH_EDIT_FRAME::LocateItem().

#define MAX_UNIT_COUNT_PER_PACKAGE   64

The maximum number of units per package.

Increase this number if that ever becomes a problem, but remember the popup menu to select a given unit could be not easy to use.

Definition at line 48 of file eeschema_id.h.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and SCH_LEGACY_PLUGIN::loadComponent().

Enumeration Type Documentation

Command IDs for the schematic editor.

Please add IDs that are unique to the schematic editor (Eeschema) here and not in the global id.h file. This will prevent the entire project from being rebuilt when adding new command to Eeschema.

Enumerator
ID_UPDATE_ONE_SHEET 
ID_SAVE_ONE_SHEET_UNDER_NEW_NAME 
ID_IMPORT_NON_KICAD_SCH 
ID_RESCUE_CACHED 
ID_EDIT_SYM_LIB_TABLE 
ID_REMAP_SYMBOLS 
ID_EDIT_COMPONENTS_TO_SYMBOLS_LIB_ID 
ID_HIERARCHY 
ID_TO_LIBVIEW 
ID_GET_ANNOTATE 
ID_GET_ERC 
ID_BACKANNO_ITEMS 
ID_UPDATE_FIELDS 
ID_GEN_PLOT_SCHEMATIC 
ID_SCHEMATIC_VERTICAL_TOOLBAR_START 
ID_HIGHLIGHT 
ID_SCH_PLACE_COMPONENT 
ID_PLACE_POWER_BUTT 
ID_BUS_BUTT 
ID_WIRE_BUTT 
ID_BUSTOBUS_ENTRY_BUTT 
ID_WIRETOBUS_ENTRY_BUTT 
ID_LABEL_BUTT 
ID_GLABEL_BUTT 
ID_HIERLABEL_BUTT 
ID_IMPORT_HLABEL_BUTT 
ID_SHEET_PIN_BUTT 
ID_NOCONN_BUTT 
ID_JUNCTION_BUTT 
ID_SHEET_SYMBOL_BUTT 
ID_TEXT_COMMENT_BUTT 
ID_LINE_COMMENT_BUTT 
ID_ADD_IMAGE_BUTT 
ID_SCHEMATIC_DELETE_ITEM_BUTT 
ID_SCHEMATIC_VERTICAL_TOOLBAR_END 
ID_TB_OPTIONS_HIDDEN_PINS 
ID_TB_OPTIONS_BUS_WIRES_ORIENT 
ID_POPUP_SCH_DUPLICATE_ITEM 
ID_POPUP_START_RANGE 
ID_POPUP_SCH_DELETE 
ID_POPUP_SCH_BREAK_WIRE 
ID_POPUP_SCH_BEGIN_WIRE 
ID_POPUP_SCH_BEGIN_BUS 
ID_POPUP_END_LINE 
ID_POPUP_SCH_DELETE_CONNECTION 
ID_POPUP_SCH_DELETE_NODE 
ID_POPUP_SCH_DELETE_CMP 
ID_POPUP_SCH_ENTRY_SELECT_SLASH 
ID_POPUP_SCH_ENTRY_SELECT_ANTISLASH 
ID_POPUP_SCH_INIT_CMP 
ID_POPUP_SCH_SET_SHAPE_TEXT 
ID_POPUP_SCH_END_SHEET 
ID_POPUP_SCH_RESIZE_SHEET 
ID_POPUP_SCH_CLEANUP_SHEET 
ID_POPUP_IMPORT_HLABEL_TO_SHEETPIN 
ID_POPUP_SCH_GENERIC_ORIENT_CMP 
ID_POPUP_SCH_GENERIC_EDIT_CMP 
ID_POPUP_SCH_EDIT_CONVERT_CMP 
ID_POPUP_SCH_EDIT_FIELD 
ID_POPUP_SCH_DISPLAYDOC_CMP 
ID_POPUP_SCH_ENTER_SHEET 
ID_POPUP_SCH_LEAVE_SHEET 
ID_POPUP_SCH_SELECT_ON_PCB 
ID_POPUP_SCH_ADD_JUNCTION 
ID_POPUP_SCH_ADD_LABEL 
ID_POPUP_SCH_ADD_GLABEL 
ID_POPUP_SCH_GETINFO_MARKER 
ID_POPUP_END_RANGE 
ID_POPUP_SCH_CALL_LIBEDIT_AND_LOAD_CMP 
ID_POPUP_SCH_SELECT_UNIT_CMP 
ID_POPUP_SCH_SELECT_UNIT1 
ID_POPUP_SCH_SELECT_UNIT_CMP_MAX 
ID_POPUP_SCH_CHANGE_TYPE_TEXT 
ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_LABEL 
ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_GLABEL 
ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_HLABEL 
ID_POPUP_SCH_CHANGE_TYPE_TEXT_TO_COMMENT 
ID_SELECT_ITEM_START 
ID_SELECT_ITEM_END 
ID_SCH_MIRROR_X 
ID_SCH_MIRROR_Y 
ID_SCH_ORIENT_NORMAL 
ID_SCH_ROTATE_CLOCKWISE 
ID_SCH_ROTATE_COUNTERCLOCKWISE 
ID_SCH_EDIT_ITEM 
ID_SCH_EDIT_COMPONENT_VALUE 
ID_SCH_EDIT_COMPONENT_REFERENCE 
ID_SCH_EDIT_COMPONENT_FOOTPRINT 
ID_SCH_MOVE_ITEM 
ID_SCH_DRAG_ITEM 
ID_AUTOPLACE_FIELDS 
ID_CANCEL_CURRENT_COMMAND 
ID_HOTKEY_HIGHLIGHT 
ID_LIBEDIT_DIMENSIONS 
ID_LIBEDIT_NEW_LIBRARY 
ID_LIBEDIT_ADD_LIBRARY 
ID_LIBEDIT_SAVE_LIBRARY 
ID_LIBEDIT_SAVE_LIBRARY_AS 
ID_LIBEDIT_SAVE_ALL_LIBS 
ID_LIBEDIT_REVERT_LIBRARY 
ID_LIBEDIT_NEW_PART 
ID_LIBEDIT_EDIT_PART 
ID_LIBEDIT_IMPORT_PART 
ID_LIBEDIT_EXPORT_PART 
ID_LIBEDIT_SAVE_PART 
ID_LIBEDIT_REVERT_PART 
ID_LIBEDIT_REMOVE_PART 
ID_LIBEDIT_CUT_PART 
ID_LIBEDIT_COPY_PART 
ID_LIBEDIT_PASTE_PART 
ID_LIBEDIT_DUPLICATE_PART 
ID_DE_MORGAN_NORMAL_BUTT 
ID_DE_MORGAN_CONVERT_BUTT 
ID_LIBEDIT_EDIT_PIN_BY_PIN 
ID_LIBEDIT_EDIT_PIN_BY_TABLE 
ID_LIBEDIT_VIEW_DOC 
ID_LIBEDIT_CHECK_PART 
ID_LIBEDIT_GET_FRAME_EDIT_PART 
ID_LIBEDIT_GET_FRAME_EDIT_FIELDS 
ID_LIBEDIT_SELECT_PART_NUMBER 
ID_LIBEDIT_SELECT_ALIAS 
ID_LIBEDIT_PIN_BUTT 
ID_LIBEDIT_BODY_LINE_BUTT 
ID_LIBEDIT_BODY_ARC_BUTT 
ID_LIBEDIT_BODY_CIRCLE_BUTT 
ID_LIBEDIT_BODY_RECT_BUTT 
ID_LIBEDIT_BODY_TEXT_BUTT 
ID_LIBEDIT_ANCHOR_ITEM_BUTT 
ID_LIBEDIT_IMPORT_BODY_BUTT 
ID_LIBEDIT_EXPORT_BODY_BUTT 
ID_LIBEDIT_DELETE_ITEM_BUTT 
ID_LIBEDIT_ROTATE_ITEM 
ID_LIBEDIT_MIRROR_X 
ID_LIBEDIT_MIRROR_Y 
ID_LIBEDIT_ORIENT_NORMAL 
ID_LIBEDIT_EDIT_PIN 
ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_ITEM 
ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINSIZE_ITEM 
ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINNAMESIZE_ITEM 
ID_POPUP_LIBEDIT_PIN_GLOBAL_CHANGE_PINNUMSIZE_ITEM 
ID_POPUP_LIBEDIT_BODY_EDIT_ITEM 
ID_POPUP_LIBEDIT_DELETE_ITEM 
ID_POPUP_LIBEDIT_MODIFY_ITEM 
ID_POPUP_LIBEDIT_END_CREATE_ITEM 
ID_POPUP_LIBEDIT_CANCEL_EDITING 
ID_POPUP_LIBEDIT_MOVE_ITEM_REQUEST 
ID_POPUP_LIBEDIT_FIELD_EDIT_ITEM 
ID_POPUP_LIBEDIT_DELETE_CURRENT_POLY_SEGMENT 
ID_LIBEDIT_SHOW_ELECTRICAL_TYPE 
ID_LIBEDIT_SHOW_HIDE_SEARCH_TREE 
ID_LIBEDIT_GEN_PNG_FILE 
ID_LIBEDIT_GEN_SVG_FILE 
ID_LIBVIEW_SELECT_PART 
ID_LIBVIEW_NEXT 
ID_LIBVIEW_PREVIOUS 
ID_LIBVIEW_VIEWDOC 
ID_LIBVIEW_DE_MORGAN_NORMAL_BUTT 
ID_LIBVIEW_DE_MORGAN_CONVERT_BUTT 
ID_LIBVIEW_SELECT_PART_NUMBER 
ID_LIBVIEW_LIB_LIST 
ID_LIBVIEW_CMP_LIST 
ID_LIBVIEW_LIBWINDOW 
ID_LIBVIEW_CMPWINDOW 
ID_LIBVIEW_CMP_EXPORT_TO_SCHEMATIC 
ID_SET_RELATIVE_OFFSET 
ID_LIBVIEW_SHOW_ELECTRICAL_TYPE 
ID_UPDATE_PCB_FROM_SCH 
ID_UPDATE_SCH_FROM_PCB 
ID_SIM_RUN 
ID_SIM_TUNE 
ID_SIM_PROBE 
ID_SIM_SETTINGS 
ID_SIM_ADD_SIGNALS 
ID_SIM_SHOW 
ID_END_EESCHEMA_ID_LIST 

Definition at line 59 of file eeschema_id.h.

60 {
64 
65  /* Schematic editor main menubar IDs. */
70 
71  /* Schematic editor horizontal toolbar IDs */
75  ID_GET_ERC,
79 
80  /* Schematic editor veritcal toolbar IDs */
102 
103  // Toolbar options id:
106 
107  /* Schematic editor context menu IDs. */
109 
121 
123 
142 
144 
145  // Unit select context menus command IDs.
148  // ... leave room for MAX_UNIT_COUNT_PER_PACKAGE IDs ,
149  // to select one unit among MAX_UNIT_COUNT_PER_PACKAGE in popup menu
150  ID_POPUP_SCH_SELECT_UNIT_CMP_MAX = ID_POPUP_SCH_SELECT_UNIT1
152 
153  // Change text type context menu command IDs.
159 
161  ID_SELECT_ITEM_END = ID_SELECT_ITEM_START + MAX_SELECT_ITEM_IDS,
162 
163  // Change orientation command IDs.
167 
176 
178 
179  // Schematic editor commmands. These are command IDs that are generated by multiple
180  // events (menus, toolbar, context menu, etc.) that result in the same event handler.
182 
184 
185  /* Library editor main menubar IDs. */
187 
188  /* Library editor: library edit events */
195 
196  /* Library editor: part edit events */
208 
209  /* Library editor horizontal toolbar IDs. */
218 
221 
222  /* Library editor vertical toolbar IDs. */
233 
234  /* Change orientation command ID */
239 
240  /* Library editor context menu IDs */
254 
255  /* Library editor toolbar options IDs */
258 
259  /* Library editor menubar IDs */
262 
263  /* Library viewer horizontal toolbar IDs */
278 
281 
282  ID_SIM_RUN,
283  ID_SIM_TUNE,
284  ID_SIM_PROBE,
287  ID_SIM_SHOW,
288 
290 };
#define MAX_SELECT_ITEM_IDS
The maximum number of items in the clarify selection context menu.
Definition: eeschema_id.h:41
#define MAX_UNIT_COUNT_PER_PACKAGE
The maximum number of units per package.
Definition: eeschema_id.h:48

Variable Documentation

enum id_eeschema_frm kiface