Index: doc/user/09_appendix/action_reference.html =================================================================== --- doc/user/09_appendix/action_reference.html (revision 11962) +++ doc/user/09_appendix/action_reference.html (revision 11963) @@ -10,7 +10,7 @@

Pcb-rnd Action Reference

@@ -41,6 +41,9 @@ + + + @@ -105,12 +108,15 @@ + + + - - + + @@ -142,7 +148,7 @@ - + @@ -153,15 +159,18 @@ + + + + + + - - - @@ -217,12 +226,14 @@ + + - + @@ -238,7 +249,7 @@ - + @@ -252,6 +263,9 @@ + + + @@ -258,24 +272,21 @@ - - - + + + + + + - - - - - - @@ -300,6 +311,9 @@ + + + @@ -342,6 +356,9 @@ + + + @@ -381,6 +398,9 @@ + + + @@ -396,6 +416,9 @@ + + + @@ -402,6 +425,9 @@ + + + @@ -429,6 +455,9 @@ + + +
-pcb-rnd version 1.2.3, Revision: 10393 +pcb-rnd version 1.2.4, Revision: 11962
Action Description Syntax
ElementSetAttr
Cursor Move the cursor. Cursor(Type,DeltaUp,DeltaRight,Units)
dumpflags dump flags, optionally using the format string provided by the userdumpflags([fmt])
ChkBuffer Return 1 if currently selected buffer's index matches idx ChkBuffer(idx)
distributetext Distribute Text Elements DistributeText(Y, [Lefts/Rights/Tops/Bottoms/Centers/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])
dlg_test test the attribute dialogdlg_test()
DumpActions Dump all actions available. DumpActions()
Attributes Let the user edit the attributes of the layout, current or given
layer, or selected element.
Attributes(Layout|Layer|Element)
Attributes(Layer,layername)
Let the user edit the attributes of the layout, current or given
layer, or selected element or subcircuit.
Attributes(Layout|Layer|Element|Subc)
Attributes(Layer,layername)
RenumberBlock
ToggleHideName Toggles the visibility of element names.DumpCsect()
Redo Redo recent "undo" operations.pcb_redo()redo()
Export Export the current layout, e.g. Export(png, --dpi, 600) Export(exporter, [exporter-args])
MoveLayer Moves/Creates/Deletes Layers. MoveLayer(old,new)
LoadHpglFrom Loads the specified hpgl plot file to the current bufferLoadHpglFrom(filename)
LibraryChanged Tells the GUI that the libraries have changed. LibraryChanged()
CreateMenu Creates a new menu, popup (only path specified) or submenu (at least path and action are specified)CreateMenu(path | path, action, mnemonic, accel, tooltip, cookie)
SavePatch Save netlist patch for back annotation. SavePatch(filename)
CreateMenu Creates a new menu, popup (only path specified) or submenu (at least path and action are specified)CreateMenu(path | path, action, mnemonic, accel, tooltip, cookie)
ChkGridUnits Return 1 if currently selected grid unit matches the expected (normally mm or mil) ChkGridUnits(expected)Some polygon related stuff. Polygon(Close|CloseHole|PreviousPoint)
autocrop Autocrops the board dimensions to extants + marginautocrop()
SelectLayer Select which layer is the current layer. SelectLayer(1..MAXLAYER|Silk|Rats)
distribute Distribute ElementsDistribute(Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])
Connection Searches connections of the object at the cursor position. Connection(Find|ResetLinesAndPolygons|ResetPinsAndVias|Reset)Report(Object|DrillReport|FoundPins|NetLength|AllNetLengths|[,name])
Undo Undo recent changes.pcb_undo()
pcb_undo(ClearList)
undo()
undo(ClearList)
CycleDrag Cycle through which object is being dragged CycleDrag()
FontEdit Convert the current font to a PCB for editing. FontEdit()
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
h Print a help message for commands. h
ApplyVendor Applies the currently loaded vendor drill table to the current design. ApplyVendor()
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
LayerBinding Change the layer binding.LayerBinding(object)
LayerBinding(selected)
LayerBinding(buffer)
Puller Pull an arc-line junction tight. pcb_act_Puller()
m Loads a layout into the current buffer.m [name]
l Loads layout data. l [name] [format]
m Loads a layout into the current buffer.m [name]
Delete Delete stuff. Delete(Object|Selected)
Delete(AllRats|SelectedRats)
DisperseElements Disperses elements.DisperseElements(All|Selected)
q Quits the application after confirming. q
MoveObject Moves the object under the crosshair. pcb_move_obj(X,Y,dim)
DisperseElements Disperses elements.DisperseElements(All|Selected)
Atomic Save or restore the undo serial number. Atomic(Save|Restore|Close|Block)
PCBChanged Tells the GUI that the whole PCB has changed. The optional "revert"parameter can be used as a hint to the GUI that the same design is beingreloaded, and that it might keep some viewport settings PCBChanged([revert])
Normalize Move all objects within the drawing area, align the drawing to 0;0Normalize()
ChangeClearSize Changes the clearance size of objects. ChangeClearSize(Object, delta|style)
ChangeClearSize(SelectedPins|SelectedPads|SelectedVias, delta|style)
ChangeClearSize(SelectedLines|SelectedArcs, delta|style)
ChangeClearSize(Selected|SelectedObjects, delta|style)
RemoveMenu Recursively removes a new menu, popup (only path specified) or submenu. RemoveMenu(path|cookie)
FlagEdit Change the layer binding.FlagEdit(object)
Flip Flip an element to the opposite side of the board. Flip(Object|Selected|SelectedElements)
dumpundo Print info about fonts dumpfonts()
PolyOffs replicate the outer contour of the selected polygon(s) with growing or shrinking them by offset; the new polygon is drawn on the current layerPolyOffs(offset)
le Loads an element into the current buffer. le [name]
MorphPolygon Converts dead polygon islands into separate polygons. pcb_poly_morph(Object|Selected)
ToPoly convert a closed loop of lines and arcs into a polygonToPoly()
ToPoly(outline)
AddRats Add one or more rat lines to the board. AddRats(AllRats|SelectedRats|Close)
EditGroup Change a property or attribute of a layer group. If the first argument starts with @, it is taken as the group name to manipulate, else the action uses the current layer's group. Without arguments or if only a layer name is specified, interactive runs editing. Editgroup([@group], [name=text|type=+bit|type=-bit])]
Editlayer([@layer], attrib, key=value)
ExportScadPoly exports all selected polygons to an openscad script; only the outmost contour of each poly is exportedScadExportPoly(filename)
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()