Index: action_reference.html =================================================================== --- action_reference.html (revision 31543) +++ action_reference.html (revision 31544) @@ -13,7 +13,7 @@ @@ -96,11 +96,17 @@ + + + + + + @@ -156,6 +162,7 @@ + @@ -173,6 +180,7 @@ + @@ -205,7 +213,7 @@ - + @@ -321,7 +329,7 @@ - + @@ -351,6 +359,7 @@ +
-This is pcb-rnd 2.2.1 (svn r31115) an interactive printed circuit board editor , Revision: 31216 +This is pcb-rnd 2.2.1 (svn r31539) an interactive printed circuit board editor , Revision: 31543
Action Description Syntax Plugin
AboutPresent the about boxAbout()dialogs plugin
distributeDistribute objectsDistribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])distalign plugin
distributetextDistribute objectsDistribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])distalign plugin
djoptPerform various optimizations on the current board.djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull)
djopt(auto) - all of the above
djopt(miter)
djopt
dlg_confval_editPresent a dialog box for editing the value of a conf node at path.dlg_confval_edit(path, idx, role, [modal])dialogs plugin
dlg_obj_listLet the user select an object from a list of objectsdlg_obj_list()dialogs plugin
dlg_testtest the attribute dialogdlg_test()dialogs plugin
DRCInvoke the DRC check. Results are presented as the argument requests.DRC([list|simple|print|log|dump])
DrcDialogExecute drc checks and invoke a view list dialog box for presenting the resultsDrcDialog([list|simple])dialogs plugin
DrcQueryDefModAutomated 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
DrcQueryEditRuleInteractive, GUI based DRC rule editorDrcQueryEditRule(role, path, rule)
DrcQueryEditRule(role, rule)
drc_query
DrcQueryExportExport a rule and related definitions to a file.DrcQueryExport(ruleID, [filename], [format])drc_query
DrcQueryImportImport a rule and related definitions from a file.DrcQueryImport([filename])drc_query
DrcQueryListRulesList all drc rules implemented in drc_queryDrcQueryListRules()drc_query
DrcQueryRuleModAutomated 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
DumpActionsDump all actions available.DumpActions()
dumpconfPerform 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
DumpCsectPrint the cross-section of the board (layer stack)DumpCsect()draw_csect
GridSet the grid.grid(set, [name:]size[@offs][!unit])
grid(+|up)
grid(-|down)
grid(#N)
grid(idx, N)
GroupPropGuiChange group flags and propertiesGroupPropGui(groupid)dialogs plugin
gui_FallbackColorPickIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_fpmap_chooseInternal call action for a dialog to select a footprint from a map.gui_fpmap_choose(map)dialogs plugin
gui_MayOverwriteFileIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_MessageBoxIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
gui_PromptForIntenal: GUI frontend action. Do not use directly.lib_hid_common plugin
IntersectObjObjReturns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else.IntersectObjObj(idpath, idpath)act_read
IOIncompatListPresent the format incompatibilities of the last save to file operation.IOIncompatList([list|simple])
IOIncompatListDialogPresent the format incompatibilities of the last save to file operation in a GUI dialog.IOIncompatListDialog([list|simple])dialogs plugin
ircnon-modal, single-instance, single-server, single-channel irc window for online supportirc()irc plugin
IsPointOnArcReturns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else.IsPointOnArc(x, y, r, idpath)act_read
IsPointOnLineReturns 1 if point x;y with radius r is on the line addressed by idpath, 0 else.IsPointOnLine(x, y, r, idpath)act_read
jostleMake room by moving wires away.Jostle(diameter)jostle plugin
LoadMentorFromLoads the specified Mentor Graphics Design Capture schematics flat .edf file.LoadMentorFrom(filename)mentor_sch importer
LoadMucsFromLoads the specified mucs routing file.LoadMucsFrom(filename)mucs importer
LoadScriptLoad a fungw scriptLoadScript(id, filename, [language])script plugin
LoadTedaxFromLoads the specified block from a tedax file.LoadTedaxFrom(netlist|board|footprint|stackup|layer, filename, [block_id, [silent]])tEDAx IO
LoadTedaxFromLoads the specified block from a tedax file.LoadTedaxFrom(netlist|board|footprint|stackup|layer|drc|drc_query, filename, [block_id, [silent, [src]]])tEDAx IO
LoadTinycadFromLoads the specified tinycad .net file - the netlist must be tinycad netlist output.LoadTinycadFrom(filename)tinycad importer
LoadTtfGlyphsLoads glyphs from an outline ttf in the specified source range, optionally remapping them to dstchars range in the pcb-rnd fontLoadTtfGlyphs(filename, srcglyps, [dstchars])ttf importer
LoadVendorFromLoads the specified vendor lihata file.LoadVendorFrom(filename)vendor drill mapping
SaveFontToSave PCB font to a fileSaveFontTo([file, id])
SaveLibSaves all subcircuits to a library file or directory from a board or buffer.SaveLib(file|dir, board|buffer, [filename], [fmt])
SavePatchSave netlist patch for back annotation.SavePatch(filename)
SaveTedaxSaves the specific type of data in a tEDAx file.SaveTedax(netlist|board-footprints|stackup|layer|board|drc|etest, filename)tEDAx IO
SaveTedaxSaves 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
SaveToSaves data to a file.SaveTo(Layout|LayoutAs,filename,[fmt])
SaveTo(PasteBuffer,filename,[fmt])
ScaleBufferScales 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]]])
ScriptCookieReturn a cookie specific to the current script instance during script initializationScriptCookie()script plugin
SystemRun shell commandSystem(shell_cmd)
tangDraw a line to be tangential to a circletang()ddraft plugin
Teardropsteardrops plugin
TedaxTestParseReturns 1 if the file looks like tEDAx (0 if not)TedaxTestParse(filename|FILE*)tEDAx IO
TextNewCreate 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
ToggleHideNameoldactions plugin
ToggleVendorToggles the state of automatic drill size mapping.ToggleVendor()oldactions plugin