Index: doc/user/09_appendix/action_reference.html =================================================================== --- doc/user/09_appendix/action_reference.html (revision 35730) +++ doc/user/09_appendix/action_reference.html (revision 35731) @@ -13,7 +13,7 @@
Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | dialogs plugin | @@ -34,6 +34,7 @@
autocrop | Autocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid aligned | autocrop() | autocrop plugin |
AutoPlaceSelected | Auto-place selected components. | AutoPlaceSelected() | autoplace plugin |
AutoRoute | Auto-route some or all rat lines. | AutoRoute(AllRats|SelectedRats) | autoroute plugin | +
awk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Backup | Backup the current layout - save using the same method that the timed backup function uses | Backup() | |
bas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Bell | Attempt to produce audible notification (e.g. beep the speaker). | Bell() | oldactions plugin | @@ -114,6 +115,7 @@
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) DrcQueryRuleMod(remove, rule_name) | drc_query | +
duktape | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
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 | @@ -135,6 +137,7 @@
ElementList | Adds the given element if it doesn't already exist. | ElementList(Start|Done|Need, | |
ElementSetAttr | Sets or clears an element-specific attribute. | ElementSetAttr(refdes,name[,value]) | |
EnableVendor | Enables automatic drill size mapping. | EnableVendor() | oldactions plugin | +
estutter | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
EvalConf | Perform various operations on the configuration tree. | EvalConf(path) - evaluate a config path in different config sources to figure how it ended up in the native database | diag plugin |
ExecActionFile | Run actions from the given file. | ExecuteFile(filename) | |
ExecCommand | Run shell command | System(shell_cmd) | @@ -163,6 +166,7 @@ |
fpas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
fp_rehash | Flush the library index; rescan all library search paths and rebuild the library index. Useful if there are changes in the library during a pcb-rnd session. | fp_rehash() | |
FreeRotateBuffer | Rotates the current paste buffer contents by the specified angle. The angle is given in degrees. If no angle is given, the user is prompted for one. | FreeRotateBuffer([Angle]) | + |
FsdTest | Central, DAD based File Selection Dialog demo | FsdTest() | lib_hid_common plugin |
FullScreen | Hide widgets to get edit area full screen | FullScreen(on|off|toggle) | |
GetMark | Return mark properties in numeric form. | GetMark(active|user_placed|x|y) | act_read |
GetParentData | Return the closest upstream pcb_data_t * parent of an object | GetParentData([root_data,] idpath) | act_read | @@ -199,7 +203,9 @@
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 | +
javascript | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin | +
js | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
l | Loads layout data. | l [name] [format] | shand_cmd plugin |
LayerBinding | Change the layer binding. | LayerBinding(object) LayerBinding(buffer) | dialogs plugin |
LayerByStack | Layer operations based on physical layer stacking | LayerByStack(select, prev|next) | @@ -242,9 +248,11 @@ |
LoadVendorFrom | Loads the specified vendor lihata file. If second argument is "yes" or "pure", load in pure mode without side effects: do not reset or apply, only incrementally load. | LoadVendorFrom(filename, [yes|no]) | vendor drill mapping |
Log | Manages the central, in-memory log. | Log(clear, [fromID, [toID]) Log(export, [filename, [text|lihata]) | |
LogDialog | Open the log dialog. | LogDialog() | lib_hid_common plugin | +
lua | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin |
ManagePlugins | Manage plugins dialog. | ManagePlugins() | lib_hid_common plugin |
MarkCrosshair | Set/Reset the pcb_crosshair mark. | MarkCrosshair() MarkCrosshair(Center) | + |
mawk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
MenuDebug | Menu debug helpers: save the merged menu in a file | MenuDebug(save, path) | |
MenuPatch | Manage menu patches | MenuPatch(load, cookie, path, desc) MenuPatch(unload, cookie) MenuPatch(list) MenuPatch(InhibitInc|InhibitDec) | |
mesh | generate a mesh for simulation | mesh() | openems HID | @@ -259,6 +267,7 @@
MoveLayer | Moves/Creates/Deletes Layers. | MoveLayer(old,new) MoveLayer(lid,group,gid) | |
MoveObject | Moves the object under the crosshair. | pcb_move_obj(X,Y,[units]) | |
MoveToCurrentLayer | Moves objects to the current layer. | MoveToCurrentLayer(Object|SelectedObjects) | + |
mruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
net | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | |
NetLength | Report physical network length | NetLength(clear) NetLength(object) | report plugin |
netlist | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | @@ -293,6 +302,7 @@ |
pcb_sqrt | script plugin | ||
pcb_srand | script plugin | ||
pcb_tan | script plugin | +||
perl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
perp | Draw a line perpendicular to another line | perp() | ddraft plugin |
Pinout | Present the subcircuit pinout box | Pinout() | dialogs plugin |
PolyBool | Perform polygon boolean operation on the clipped polygons referred. A poly is either and idpath, selected, found or object (for the object under the cursor). When not specified, two object polygons are used. | PstkProto([noundo,] unite|isect|sub, [poly1, poly2, [poly...]]) | act_draw | @@ -323,11 +333,13 @@
propprint | Print a property map of objects matching the scope. Scope is documented at PropEdit(). | PropPrint([scope]) | propedit |
propset | Change the named property of scope or all selected objects to/by value. Scope is documented at PropEdit(). | propset([scope], name, value) | propedit |
proptoggle | Toggle the named property of scope or all selected objects, assuming the property is boolean. Scope is documented at PropEdit(). If create is true, non-existing attributes are created as true. | proptoggle([scope], name, [create]) | propedit | -
pstklib | Present the padstack library dialog on board padstacks or the padstacks of a subcircuit | pstklib([board|subcid|object], [retpid, [preselect]]) | dialogs plugin | +
pstklib | Present the padstack library dialog on board padstacks or the padstacks of a subcircuit | pstklib([auto|board|subcid|object], [retpid, [preselect]]) | dialogs plugin |
PstkNew | Create a padstack. For now data must be "pcb". glob_clearance=0 turns off global clearance. Returns the idpath of the new object or 0 on error. | PstkNew([noundo,] data, protoID, x, y, glob_clearance, flags) | act_draw |
PstkProtoEdit | Edit a padstack prototype specified by its pointer. | PstkProto([noundo,] proto, remove, layer_type) PstkProto([noundo,] proto, copy, dst_layer_type, src_layer_type) PstkProto([noundo,] proto, hdia, dia) PstkProto([noundo,] proto, shape:line, layer_type, x1, y1, x2, y2, th, [square]) | act_draw |
PstkProtoTmp | Allocate, insert or free a temporary padstack prototype | PstkProto([noundo,] new) PstkProto([noundo,] dup, idpath) PstkProto([noundo,] dup, data, src_proto_id) PstkProto([noundo,] insert, idpath|data, proto) PstkProto([noundo,] insert_dup, idpath|data, proto) PstkProto([noundo,] free, proto) | act_draw |
Puller | Pull an arc-line junction tight. | pcb_act_Puller() | puller plugin | +
py | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
python | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
q! | Quits the application without confirming. | q! | shand_cmd plugin |
q | Quits the application after confirming. | q | shand_cmd plugin |
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout query(count, expr) - compile and evaluate an expression and return the number of matched objects (-1 on error) query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | query plugin | @@ -369,6 +381,7 @@
roundrect | Generate a rectangle with round corners | roundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]]) | shape plugin |
RouteStyle | Without second argument: copies the indicated routing style into the current pen; with second argument sets or gets a field of the routing style. | RouteStyle(style_id|style_name|@current, [set|get|del], [trace-thickness|trace-clearance|text-thickness|text-scale|font|via-proto|name], [value]]) RouteStyle(new, [name]) | |
RouteStylesChanged | Tells the GUI that the routing styles have changed. | RouteStylesChanged() | oldactions plugin | +
ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
s | Saves layout data. | s [name] w [name] | shand_cmd plugin |
Save | Save layout data to a user-selected file. | Save() Save(Layout|LayoutAs) Save(AllConnections|AllUnusedPins|ElementConnections) Save(PasteBuffer) Save(DialogByPattern, pcb|footprint|font|buffer, none|board|fp, prompt, [default_pattern]) | dialogs plugin |
SaveFontTo | Save PCB font to a file | SaveFontTo([file, id]) | @@ -397,10 +410,12 @@ |
split | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin |
StatusSetText | Replace status printout with text temporarily; turn status printout back on if text is not provided. | StatusSetText([text]) | lib_hid_pcbui/status |
stroke | Various gesture recognition related functions | stroke(gesture, seq) | stroke plugin | +
stt | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
subc | Various operations on subc | subc(hash, [board|selected]) subc(loose, on|off|toggle|check) | |
SwapSides | Swaps the side of the board you're looking at. | SwapSides(|v|h|r, [S]) | lib_hid_pcbui/actions |
System | Run shell command | System(shell_cmd) | |
tang | Draw a line to be tangential to a circle | tang() | ddraft plugin | +
tcl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script 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 |