- Generated on Sun Apr 26 2026 00:07:00 for KiCad PCB EDA Suite by
1.13.2
|
KiCad PCB EDA Suite
|
#include <api/api_enums.h>#include <import_export.h>#include <api/common/types/base_types.pb.h>#include <api/common/types/enums.pb.h>#include <api/board/board.pb.h>#include <api/board/board_types.pb.h>#include <api/schematic/schematic_jobs.pb.h>#include <api/schematic/schematic_types.pb.h>#include <core/typeinfo.h>#include <eda_shape.h>#include <font/text_attributes.h>#include <jobs/job_export_sch_netlist.h>#include <jobs/job_export_sch_plot.h>#include <layer_ids.h>#include <page_info.h>#include <pin_type.h>#include <stroke_params.h>#include <widgets/report_severity.h>Go to the source code of this file.
Functions | |
| template<> | |
| KICAD_T | FromProtoEnum (types::KiCadObjectType aValue) |
| template<> | |
| types::KiCadObjectType | ToProtoEnum (KICAD_T aValue) |
| template<> | |
| PCB_LAYER_ID | FromProtoEnum (board::types::BoardLayer aValue) |
| template<> | |
| board::types::BoardLayer | ToProtoEnum (PCB_LAYER_ID aValue) |
| template<> | |
| JOB_PAGE_SIZE | FromProtoEnum (schematic::jobs::SchematicJobPageSize aValue) |
| template<> | |
| schematic::jobs::SchematicJobPageSize | ToProtoEnum (JOB_PAGE_SIZE aValue) |
| template<> | |
| JOB_EXPORT_SCH_NETLIST::FORMAT | FromProtoEnum (schematic::jobs::SchematicNetlistFormat aValue) |
| template<> | |
| schematic::jobs::SchematicNetlistFormat | ToProtoEnum (JOB_EXPORT_SCH_NETLIST::FORMAT aValue) |
| template<> | |
| GR_TEXT_H_ALIGN_T | FromProtoEnum (types::HorizontalAlignment aValue) |
| template<> | |
| types::HorizontalAlignment | ToProtoEnum (GR_TEXT_H_ALIGN_T aValue) |
| template<> | |
| GR_TEXT_V_ALIGN_T | FromProtoEnum (types::VerticalAlignment aValue) |
| template<> | |
| types::VerticalAlignment | ToProtoEnum (GR_TEXT_V_ALIGN_T aValue) |
| template<> | |
| LINE_STYLE | FromProtoEnum (types::StrokeLineStyle aValue) |
| template<> | |
| types::StrokeLineStyle | ToProtoEnum (LINE_STYLE aValue) |
| template<> | |
| FILL_T | FromProtoEnum (types::GraphicFillType aValue) |
| template<> | |
| types::GraphicFillType | ToProtoEnum (FILL_T aValue) |
| template<> | |
| ELECTRICAL_PINTYPE | FromProtoEnum (types::ElectricalPinType aValue) |
| template<> | |
| types::ElectricalPinType | ToProtoEnum (ELECTRICAL_PINTYPE aValue) |
| template<> | |
| types::RuleSeverity | ToProtoEnum (SEVERITY aValue) |
| template<> | |
| SEVERITY | FromProtoEnum (types::RuleSeverity aValue) |
| template<> | |
| PAGE_SIZE_TYPE | FromProtoEnum (types::PageSize aValue) |
| template<> | |
| types::PageSize | ToProtoEnum (PAGE_SIZE_TYPE aValue) |
| PCB_LAYER_ID FromProtoEnum | ( | board::types::BoardLayer | aValue | ) |
Definition at line 164 of file api_enums.cpp.
References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, Margin, Rescue, UNDEFINED_LAYER, UNSELECTED_LAYER, User_1, User_10, User_11, User_12, User_13, User_14, User_15, User_16, User_17, User_18, User_19, User_2, User_20, User_21, User_22, User_23, User_24, User_25, User_26, User_27, User_28, User_29, User_3, User_30, User_31, User_32, User_33, User_34, User_35, User_36, User_37, User_38, User_39, User_4, User_40, User_41, User_42, User_43, User_44, User_45, User_5, User_6, User_7, User_8, and User_9.
| JOB_PAGE_SIZE FromProtoEnum | ( | schematic::jobs::SchematicJobPageSize | aValue | ) |
Definition at line 386 of file api_enums.cpp.
References PAGE_SIZE_A, PAGE_SIZE_A4, and PAGE_SIZE_AUTO.
| JOB_EXPORT_SCH_NETLIST::FORMAT FromProtoEnum | ( | schematic::jobs::SchematicNetlistFormat | aValue | ) |
Definition at line 417 of file api_enums.cpp.
References JOB_EXPORT_SCH_NETLIST::ALLEGRO, JOB_EXPORT_SCH_NETLIST::CADSTAR, JOB_EXPORT_SCH_NETLIST::KICADSEXPR, JOB_EXPORT_SCH_NETLIST::KICADXML, JOB_EXPORT_SCH_NETLIST::ORCADPCB2, JOB_EXPORT_SCH_NETLIST::PADS, JOB_EXPORT_SCH_NETLIST::SPICE, and JOB_EXPORT_SCH_NETLIST::SPICEMODEL.
| ELECTRICAL_PINTYPE FromProtoEnum | ( | types::ElectricalPinType | aValue | ) |
Definition at line 619 of file api_enums.cpp.
References PT_BIDI, PT_INPUT, PT_NC, PT_NIC, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_POWER_OUT, PT_TRISTATE, and PT_UNSPECIFIED.
| FILL_T FromProtoEnum | ( | types::GraphicFillType | aValue | ) |
Definition at line 580 of file api_enums.cpp.
References CROSS_HATCH, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, HATCH, NO_FILL, and REVERSE_HATCH.
| GR_TEXT_H_ALIGN_T FromProtoEnum | ( | types::HorizontalAlignment | aValue | ) |
Definition at line 474 of file api_enums.cpp.
References GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.
| KICAD_T FromProtoEnum | ( | types::KiCadObjectType | aValue | ) |
Definition at line 44 of file api_enums.cpp.
References LIB_SYMBOL_T, PCB_ARC_T, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, TYPE_NOT_INIT, WSG_BITMAP_T, WSG_LINE_T, WSG_PAGE_T, WSG_POLY_T, WSG_RECT_T, and WSG_TEXT_T.
Referenced by ApplyBoardPlotSettings(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE::Deserialize(), EDA_TEXT::Deserialize(), FOOTPRINT::Deserialize(), PAD::Deserialize(), PADSTACK::Deserialize(), PCB_ARC::Deserialize(), PCB_BARCODE::Deserialize(), PCB_DIM_LEADER::Deserialize(), PCB_DIMENSION_BASE::Deserialize(), PCB_REFERENCE_IMAGE::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), PCB_TRACK::Deserialize(), PCB_VIA::Deserialize(), SCH_BUS_ENTRY_BASE::Deserialize(), SCH_DIRECTIVE_LABEL::Deserialize(), SCH_GLOBALLABEL::Deserialize(), SCH_HIERLABEL::Deserialize(), SCH_LINE::Deserialize(), SCH_PIN::Deserialize(), SCH_SHEET_PIN::Deserialize(), SCH_SYMBOL::Deserialize(), SCH_TEXTBOX::Deserialize(), ZONE::Deserialize(), DRC_RULE::FormatRuleFromProto(), API_HANDLER_PCB::handleCheckPadstackPresenceOnLayers(), API_HANDLER_PCB::handleGetBoardLayerName(), API_HANDLER_PCB::handleGetPadShapeAsPolygon(), API_HANDLER_PCB::handleGetStackup(), API_HANDLER_PCB::handleInjectDrcError(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportDxf(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), API_HANDLER_SCH::handleRunSchematicJobExportPdf(), API_HANDLER_SCH::handleRunSchematicJobExportPs(), API_HANDLER_SCH::handleRunSchematicJobExportSvg(), API_HANDLER_PCB::handleSetActiveLayer(), API_HANDLER_PCB::handleSetBoardDesignRules(), API_HANDLER_PCB::handleSetBoardEditorAppearanceSettings(), API_HANDLER_EDITOR::handleSetPageSettings(), API_HANDLER_PCB::handleSetVisibleLayers(), API_HANDLER_EDITOR::parseRequestedItemTypes(), testEnums(), PADSTACK::unpackCopperLayer(), unpackLabel(), and kiapi::board::UnpackLayerSet().
| PAGE_SIZE_TYPE FromProtoEnum | ( | types::PageSize | aValue | ) |
| SEVERITY FromProtoEnum | ( | types::RuleSeverity | aValue | ) |
Definition at line 690 of file api_enums.cpp.
References RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_INFO, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.
| LINE_STYLE FromProtoEnum | ( | types::StrokeLineStyle | aValue | ) |
Definition at line 542 of file api_enums.cpp.
References DASH, DASHDOT, DASHDOTDOT, DEFAULT, DOT, and SOLID.
| GR_TEXT_V_ALIGN_T FromProtoEnum | ( | types::VerticalAlignment | aValue | ) |
Definition at line 508 of file api_enums.cpp.
References GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, and GR_TEXT_V_ALIGN_TOP.
| types::ElectricalPinType ToProtoEnum | ( | ELECTRICAL_PINTYPE | aValue | ) |
Definition at line 644 of file api_enums.cpp.
References PT_BIDI, PT_INHERIT, PT_INPUT, PT_NC, PT_NIC, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_POWER_OUT, PT_TRISTATE, and PT_UNSPECIFIED.
| types::GraphicFillType ToProtoEnum | ( | FILL_T | aValue | ) |
Definition at line 600 of file api_enums.cpp.
References CROSS_HATCH, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, HATCH, NO_FILL, and REVERSE_HATCH.
| types::HorizontalAlignment ToProtoEnum | ( | GR_TEXT_H_ALIGN_T | aValue | ) |
Definition at line 492 of file api_enums.cpp.
References GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.
| types::VerticalAlignment ToProtoEnum | ( | GR_TEXT_V_ALIGN_T | aValue | ) |
Definition at line 526 of file api_enums.cpp.
References GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, and GR_TEXT_V_ALIGN_TOP.
| schematic::jobs::SchematicNetlistFormat ToProtoEnum | ( | JOB_EXPORT_SCH_NETLIST::FORMAT | aValue | ) |
Definition at line 446 of file api_enums.cpp.
References JOB_EXPORT_SCH_NETLIST::ALLEGRO, JOB_EXPORT_SCH_NETLIST::CADSTAR, JOB_EXPORT_SCH_NETLIST::KICADSEXPR, JOB_EXPORT_SCH_NETLIST::KICADXML, JOB_EXPORT_SCH_NETLIST::ORCADPCB2, JOB_EXPORT_SCH_NETLIST::PADS, JOB_EXPORT_SCH_NETLIST::SPICE, and JOB_EXPORT_SCH_NETLIST::SPICEMODEL.
| schematic::jobs::SchematicJobPageSize ToProtoEnum | ( | JOB_PAGE_SIZE | aValue | ) |
Definition at line 402 of file api_enums.cpp.
References PAGE_SIZE_A, PAGE_SIZE_A4, and PAGE_SIZE_AUTO.
| types::KiCadObjectType ToProtoEnum | ( | KICAD_T | aValue | ) |
Definition at line 105 of file api_enums.cpp.
References LIB_SYMBOL_T, PCB_ARC_T, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, WSG_BITMAP_T, WSG_LINE_T, WSG_PAGE_T, WSG_POLY_T, WSG_RECT_T, and WSG_TEXT_T.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), API_HANDLER_PCB::handleCheckPadstackPresenceOnLayers(), API_HANDLER_PCB::handleGetActiveLayer(), API_HANDLER_PCB::handleGetBoardDesignRules(), API_HANDLER_PCB::handleGetBoardEditorAppearanceSettings(), API_HANDLER_PCB::handleGetCustomDesignRules(), API_HANDLER_EDITOR::handleGetPageSettings(), API_HANDLER_PCB::handleGetVisibleLayers(), API_HANDLER_EDITOR::handleSetPageSettings(), packLabel(), kiapi::board::PackLayerSet(), BOARD_STACKUP::Serialize(), EDA_SHAPE::Serialize(), EDA_TEXT::Serialize(), FOOTPRINT::Serialize(), PAD::Serialize(), PADSTACK::Serialize(), PCB_ARC::Serialize(), PCB_BARCODE::Serialize(), PCB_DIM_LEADER::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), SCH_BUS_ENTRY_BASE::Serialize(), SCH_DIRECTIVE_LABEL::Serialize(), SCH_GLOBALLABEL::Serialize(), SCH_HIERLABEL::Serialize(), SCH_LINE::Serialize(), SCH_PIN::Serialize(), SCH_SHEET::Serialize(), SCH_SHEET_PIN::Serialize(), SCH_SYMBOL::Serialize(), SCH_TEXTBOX::Serialize(), ZONE::Serialize(), testEnums(), and DRC_CONSTRAINT::ToProto().
| types::StrokeLineStyle ToProtoEnum | ( | LINE_STYLE | aValue | ) |
Definition at line 562 of file api_enums.cpp.
References DASH, DASHDOT, DASHDOTDOT, DEFAULT, DOT, and SOLID.
| types::PageSize ToProtoEnum | ( | PAGE_SIZE_TYPE | aValue | ) |
| board::types::BoardLayer ToProtoEnum | ( | PCB_LAYER_ID | aValue | ) |
Definition at line 276 of file api_enums.cpp.
References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, Margin, Rescue, UNDEFINED_LAYER, UNSELECTED_LAYER, User_1, User_10, User_11, User_12, User_13, User_14, User_15, User_16, User_17, User_18, User_19, User_2, User_20, User_21, User_22, User_23, User_24, User_25, User_26, User_27, User_28, User_29, User_3, User_30, User_31, User_32, User_33, User_34, User_35, User_36, User_37, User_38, User_39, User_4, User_40, User_41, User_42, User_43, User_44, User_45, User_5, User_6, User_7, User_8, and User_9.
| types::RuleSeverity ToProtoEnum | ( | SEVERITY | aValue | ) |
Definition at line 670 of file api_enums.cpp.
References RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_INFO, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.
1.13.2