Index: 09_appendix/action_reference.html =================================================================== --- 09_appendix/action_reference.html (revision 31543) +++ 09_appendix/action_reference.html (revision 31544) @@ -13,7 +13,7 @@
Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | dialogs plugin | @@ -96,11 +96,17 @@
distribute | Distribute objects | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin |
distributetext | Distribute objects | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin |
djopt | Perform various optimizations on the current board. | djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull) djopt(auto) - all of the above djopt(miter) | djopt | +
dlg_confval_edit | Present a dialog box for editing the value of a conf node at path. | dlg_confval_edit(path, idx, role, [modal]) | dialogs plugin | +
dlg_obj_list | Let the user select an object from a list of objects | dlg_obj_list() | dialogs plugin |
dlg_test | test the attribute dialog | dlg_test() | dialogs plugin |
DRC | Invoke the DRC check. Results are presented as the argument requests. | DRC([list|simple|print|log|dump]) | |
DrcDialog | Execute drc checks and invoke a view list dialog box for presenting the results | DrcDialog([list|simple]) | dialogs plugin | +
DrcQueryDefMod | Automated DRC rule editing (for scripting and import) | DrcQueryDefMod(clear, source) DrcQueryDefMod(create, rule_name) DrcQueryDefMod(get, rule_name, field_name) DrcQueryDefMod(set, rule_name, field_name, value) | drc_query |
DrcQueryEditRule | Interactive, GUI based DRC rule editor | DrcQueryEditRule(role, path, rule) DrcQueryEditRule(role, rule) | drc_query | +
DrcQueryExport | Export a rule and related definitions to a file. | DrcQueryExport(ruleID, [filename], [format]) | drc_query | +
DrcQueryImport | Import a rule and related definitions from a file. | DrcQueryImport([filename]) | drc_query |
DrcQueryListRules | List all drc rules implemented in drc_query | DrcQueryListRules() | drc_query | +
DrcQueryRuleMod | Automated DRC rule editing (for scripting and import) | DrcQueryRuleMod(clear, source) DrcQueryRuleMod(create, rule_name) DrcQueryRuleMod(get, rule_name, field_name) DrcQueryRuleMod(set, rule_name, field_name, value) | drc_query |
DumpActions | Dump all actions available. | DumpActions() | |
dumpconf | Perform various operations on the configuration tree. | dumpconf(native, [verbose], [prefix]) - dump the native (binary) config tree to stdout dumpconf(lihata, role, [prefix]) - dump in-memory lihata representation of a config tree | diag plugin |
DumpCsect | Print the cross-section of the board (layer stack) | DumpCsect() | draw_csect | @@ -156,6 +162,7 @@
Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) | |
GroupPropGui | Change group flags and properties | GroupPropGui(groupid) | dialogs plugin |
gui_FallbackColorPick | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | +|
gui_fpmap_choose | Internal call action for a dialog to select a footprint from a map. | gui_fpmap_choose(map) | dialogs plugin |
gui_MayOverwriteFile | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | |
gui_MessageBox | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | |
gui_PromptFor | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | @@ -173,6 +180,7 @@|
IntersectObjObj | Returns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else. | IntersectObjObj(idpath, idpath) | act_read |
IOIncompatList | Present the format incompatibilities of the last save to file operation. | IOIncompatList([list|simple]) | |
IOIncompatListDialog | Present the format incompatibilities of the last save to file operation in a GUI dialog. | IOIncompatListDialog([list|simple]) | dialogs plugin | +
irc | non-modal, single-instance, single-server, single-channel irc window for online support | irc() | irc plugin |
IsPointOnArc | Returns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else. | IsPointOnArc(x, y, r, idpath) | act_read |
IsPointOnLine | Returns 1 if point x;y with radius r is on the line addressed by idpath, 0 else. | IsPointOnLine(x, y, r, idpath) | act_read |
jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin | @@ -205,7 +213,7 @@
LoadMentorFrom | Loads the specified Mentor Graphics Design Capture schematics flat .edf file. | LoadMentorFrom(filename) | mentor_sch importer |
LoadMucsFrom | Loads the specified mucs routing file. | LoadMucsFrom(filename) | mucs importer |
LoadScript | Load a fungw script | LoadScript(id, filename, [language]) | script plugin | -
LoadTedaxFrom | Loads the specified block from a tedax file. | LoadTedaxFrom(netlist|board|footprint|stackup|layer, filename, [block_id, [silent]]) | tEDAx IO | +
LoadTedaxFrom | Loads the specified block from a tedax file. | LoadTedaxFrom(netlist|board|footprint|stackup|layer|drc|drc_query, filename, [block_id, [silent, [src]]]) | tEDAx IO |
LoadTinycadFrom | Loads the specified tinycad .net file - the netlist must be tinycad netlist output. | LoadTinycadFrom(filename) | tinycad importer |
LoadTtfGlyphs | Loads glyphs from an outline ttf in the specified source range, optionally remapping them to dstchars range in the pcb-rnd font | LoadTtfGlyphs(filename, srcglyps, [dstchars]) | ttf importer |
LoadVendorFrom | Loads the specified vendor lihata file. | LoadVendorFrom(filename) | vendor drill mapping | @@ -321,7 +329,7 @@
SaveFontTo | Save PCB font to a file | SaveFontTo([file, id]) | |
SaveLib | Saves all subcircuits to a library file or directory from a board or buffer. | SaveLib(file|dir, board|buffer, [filename], [fmt]) | |
SavePatch | Save netlist patch for back annotation. | SavePatch(filename) | - |
SaveTedax | Saves the specific type of data in a tEDAx file. | SaveTedax(netlist|board-footprints|stackup|layer|board|drc|etest, filename) | tEDAx IO | +
SaveTedax | Saves the specific type of data in a tEDAx file. | SaveTedax(netlist|board-footprints|stackup|layer|board|drc|etest, filename) SaveTedax(drc_query, filename, [rule_name]) | tEDAx IO |
SaveTo | Saves data to a file. | SaveTo(Layout|LayoutAs,filename,[fmt]) SaveTo(PasteBuffer,filename,[fmt]) | |
ScaleBuffer | Scales the buffer by multiplying all coordinates by a floating point number. If only x is given, it is also used for y and thickness too. If subc is not empty, subcircuits are also scaled | ScaleBuffer(x [,y [,thickness [,subc]]]) | |
ScriptCookie | Return a cookie specific to the current script instance during script initialization | ScriptCookie() | script plugin | @@ -351,6 +359,7 @@
System | Run shell command | System(shell_cmd) | |
tang | Draw a line to be tangential to a circle | tang() | ddraft plugin |
Teardrops | teardrops plugin | +||
TedaxTestParse | Returns 1 if the file looks like tEDAx (0 if not) | TedaxTestParse(filename|FILE*) | tEDAx IO |
TextNew | Create a pcb text on a layer. For now data must be "pcb". Font id 0 is the default font. Thickness 0 means default, calculated thickness. Scale=100 is the original font size. Returns the idpath of the new object or 0 on error. | TextNew([noundo,] data, layer, fontID, x, y, rot, scale, thickness, text_string, flags) | act_draw |
ToggleHideName | oldactions plugin | ||
ToggleVendor | Toggles the state of automatic drill size mapping. | ToggleVendor() | oldactions plugin |