Index: 09_appendix/action_reference.html
===================================================================
--- 09_appendix/action_reference.html (revision 9169)
+++ 09_appendix/action_reference.html (revision 9170)
@@ -21,7 +21,7 @@
| ActionString | Execute a pcb-rnd action parsing a string; syntac: "action(arg,arg,arg)" | ActionString(action) | script plugin |
| AddTimer (RND) | Add a new timer | AddTimer(action, period, [repeat], [userdata]) | script plugin |
| AnyLoad (RND) | Load "anything" from path (or offer a file selectio dialog if no path specified) | AnyLoad([path]) | |
-
| AttributeDialog | Bring up the Attribute Editor Dialog for an object. | AttributeDialog([last-click|parent|object[:idpath]], [target_key]) | sch_dialogs |
+
| AttributeDialog | Bring up the Attribute Editor Dialog for an object. | AttributeDialog([last-click|parent|sheet|object[:idpath]], [target_key]) | sch_dialogs |
| AttributePick | Bring up the Attribute Pick Dialog and ask the user to pick an attribute of an object. | AttributePick([last-click|parent|object[:idpath]], [target_key]) | sch_dialogs |
| awk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| Backann | Load a back annotation file for interactive back annotation | Backann([filename]) | backann plugin |
@@ -45,12 +45,16 @@
| cli_PromptFor | Intenal: CLI frontend action. Do not use directly. | | |
| Command | Displays the command line input in the status area. | Command() | lib_hid_common plugin |
| CompileProject | Compile the abstract model of the current project, using the current view (or the view named) | CompileProject([view_name]) | project_act |
+
| ConditionalDialog | Open the conditional helper dialog for an object. | ConditionalDialog(object, dnp|omit) | sch_dialogs |
| conf | Perform various operations on the configuration tree. | conf(set, path, value, [role], [policy]) - change a config setting to an absolute value
conf(delta, path, value, [role], [policy]) - change a config setting by a delta value (numerics-only)
conf(toggle, path, [role]) - invert boolean value of a flag; if no role given, overwrite the highest prio config
conf(reset, role) - reset the in-memory lihata of a role
conf(iseq, path, value) - returns whether the value of a conf item matches value (for menu checked's) | |
+
| confget | Return conf node value or property from the merged in-memory/native storage. Returns nil if node is unset (for value query) or not found. Intended for scripting. | ConfGet(path, [value]) - return the value of a conf node; units, colors and lists are returned as string.
ConfGet(path, desc) - return the human readable description
ConfGet(path, ArraySize) - number of elements
ConfGet(path, ReadOnly) - returns 1 if node is read-only, 0 otherwise
ConfGet(path, ConfRev) - conf (merge) rev number the value last changed | |
| Convert | Convert objects into a polygon or a group. | Convert(selected|buffer|object|list, poly[gon]|group|sym[bol]|term[inal], [oidlist]) | construct plugin |
| CreateMenu | Creates a new menu, popup (only path specified) or submenu (at least path and action are specified) | CreateMenu(path)
CreateMenu(path, action, tooltip, cookie, [accel]) | |
| Cursor (RND) | Move the cursor. | Cursor(Type,DeltaUp,DeltaRight,Units) | |
| d1 | debug action for development | d1() | diag plugin |
-
| dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog
dad(dlgname, label, text) - append a label widget
dad(dlgname, button, text) - append a button widget
dad(dlgname, button_closes, label, retval, ...) - standard close buttons
dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list
dad(dlgname, bool) - append an checkbox widget (default off)
dad(dlgname, integer|real|coord, min, max) - append an input field
dad(dlgname, string) - append a single line text input field
dad(dlgname, default, val) - set the default value of a widet while creating the dialog
dad(dlgname, help, tooltip) - set the help (tooltip) text for the current widget
dad(dlgname, progress) - append a progress bar (set to 0)
dad(dlgname, preview, cb_act_prefix, minsize_x, minsize_y, [ctx]) - append a preview with a viewbox of 10*10mm, minsize in pixels
dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values
dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer
dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer
dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer
dad(dlgname, begin_hbox) - begin horizontal box
dad(dlgname, begin_vbox) - begin vertical box
dad(dlgname, begin_hpane) - begin horizontal paned box
dad(dlgname, begin_vpane) - begin vertical paned box
dad(dlgname, begin_table, cols) - begin table layout box
dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has
dad(dlgname, end) - end the last begin
dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget
dad(dlgname, onchange, action) - set the action to be called on widget change
dad(dlgname, run, title) - present dlgname as a non-modal dialog
dad(dlgname, run_modal, title) - present dlgname as a modal dialog
dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1)
dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog
dad(dlgname, get, widgetID, [unit]) - return the current value of a widget | lib_hid_common plugin |
+
| dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog
dad(dlgname, label, text) - append a label widget
dad(dlgname, button, text) - append a button widget
dad(dlgname, button_closes, label, retval, ...) - standard close buttons
dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list
dad(dlgname, bool) - append an checkbox widget (default off)
dad(dlgname, integer|real|coord, min, max) - append an input field
dad(dlgname, string) - append a single line text input field
dad(dlgname, default, val) - set the default value of a widet while creating the dialog
dad(dlgname, help, tooltip) - set the help (tooltip) text for the current widget
dad(dlgname, progress) - append a progress bar (set to 0)
dad(dlgname, preview, cb_act_prefix, minsize_x, minsize_y, [ctx]) - append a preview with a viewbox of 10*10mm, minsize in pixels
dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values
dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer
dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer
dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer
dad(dlgname, begin_hbox) - begin horizontal box
dad(dlgname, begin_vbox) - begin vertical box
dad(dlgname, begin_hpane) - begin horizontal paned box
dad(dlgname, begin_vpane) - begin vertical paned box
dad(dlgname, begin_table, cols) - begin table layout box
dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has
dad(dlgname, end) - end the last begin
dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget
dad(dlgname, onchange, action) - set the action to be called on widget change
dad(dlgname, run, title) - present dlgname as a non-modal dialog
dad(dlgname, run_modal, title) - present dlgname as a modal dialog
dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1)
dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog
dad(dlgname, get, widgetID, [unit]) - return the current value of a widget
dad(dlgname, iterate) - runs a global GUI iteration (event dispatch, redraw)
dad(dlgname, raise) - pops up window in front
dad(dlgname, close) - close the dialog (and return 0 from modal run) | lib_hid_common plugin |
+
| DevmaplibCleanLocal | Remove all local-lib devmaps from the current sheet; they are re-loaded from external libs into the local lib upon the next compilation. Useful to refresh local lib from disk. | DevmaplibCleanLocal() | devmap |
+
| DevmaplibRehash | Rebuild the in-memory tree of devmaps | DevmaplibRehash() | devmap |
| dlg_confval_edit | Present a dialog box for editing the value of a conf node at path. | dlg_confval_edit(path, idx, role, [modal]) | lib_hid_common plugin |
| DrawArc | Draw an arc. Angles are in degrees. | DrawArc([noundo], [retptr], scope, cx, cy, r, start_ang, delta_ang, [pen]) | draw plugin |
| DrawCircle | Draw a 360 degree arc (full circle). | DrawCircle([noundo], [retptr], scope, cx, cy, r, [pen]) | draw plugin |
@@ -76,6 +80,7 @@
| fbas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| FontFind | Finds a font by the same name:style combo pens use | FontFind(name, style) | diag plugin |
| fpas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
+
| FsdSimple | File selection dialog, simplified API; for meaning of the arguments, see the HID API doc. | FsdSimple(title, descr, default_file, default_ext, history_tag, [read]) | lib_hid_common plugin |
| 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) | |
| GetObjType | Return the type of the object named in oidpath as a string. | GetObjType([root_data,] idpath) | act_read |
@@ -133,6 +138,7 @@
| perl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
| PlaceAttrib | Place an attribute floater dyntext | PlaceAttrib([sheet|buffer]) | place plugin |
| PlaceTerminal | Place a terminal group template | PlaceTerminal([sheet|buffer]) | place plugin |
+
| PlotTest | Open the plot test dialog | PlotTest() | sim_gui |
| Popup | Bring up the popup menu specified by MenuName, optionally modified with the object type under the cursor. | Popup(MenuName, [obj-type]) | sch_rnd_gui |
| Preferences | Present the preferences dialog, optionally opening the tab requested. | Preferences([tabname]) | lib_hid_common plugin |
| Print (RND) | Present the print export dialog for printing the layout from the GUI. | Print() | |
@@ -159,12 +165,16 @@
| query | Perform various queries on concrete model 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(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | query plugin |
| QueryCompileField | With "compile": precompiles textual field name to field ID; with "free": frees the memory allocated for a previously precompiled fieldID. | QueryCompileField(compile, fieldname)
QueryCompileField(free, fieldID) | query plugin |
| QueryObj | Return the value of a field of an object, addressed by the object's idpath and the field's name or precompiled ID. Returns NIL on error. | QueryObj(idpath, [.fieldname|fieldID]) | query plugin |
-
| QuickAttr | Qucik Attribute Edit on key | QuickAttr(last-click|parent|object[:idpath], key) | sch_dialogs |
+
| QuickAttr | Quick Attribute Edit on key | QuickAttr(last-click|parent|object[:idpath], key) | sch_dialogs |
| QuickAttrEditable | Returns 1 if obj:key has a quick attribute edit | QuickAttrEditable(last-click|parent|object[:idpath], key) | sch_dialogs |
-
| quick_attr_connect | Qucik Attribute Edit for core data model's symbol connect attribute (attribute based symbol terminal to network connection table) | quick_attr_connect(objptr) | std_cschem |
-
| quick_attr_devmap | Qucik Attribute Edit for devmap using the devmap library | quick_attr_devmap(objptr) | devmap |
+
| quick_attr_connect | Quick Attribute Edit for core data model's symbol connect attribute (attribute based symbol terminal to network connection table) | quick_attr_connect(objptr) | std_cschem |
+
| quick_attr_devmap | Quick Attribute Edit for devmap using the devmap library | quick_attr_devmap(objptr) | devmap |
+
| quick_attr_forge__if__dnp | Quick Attribute Edit for the standard forge-if/dnp attribute | quick_attr_forge__if__dnp(objptr) | sch_dialogs |
+
| quick_attr_forge__if__omit | Quick Attribute Edit for the standard forge-if/omit attribute | quick_attr_forge__if__dnp(objptr) | sch_dialogs |
+
| quick_attr_forge__if__test_bench | Quick Attribute Edit for core data model's symbol connect attribute (attribute based symbol terminal to network connection table) | quick_attr_forge__if__test_bench(objptr) | std_forge |
| quick_attr_portmap | Quick Attribute Edit for core data model's symbol portmap attribute (attribute based "symbol terminal to network" portmap table) | quick_attr_portmap(objptr) | devmap |
-
| quick_attr_role | Qucik Attribute Edit for core data model's role attribute | quick_attr_role(objptr) | sch_dialogs |
+
| quick_attr_role | Quick Attribute Edit for core data model's role attribute | quick_attr_role(objptr) | sch_dialogs |
+
| quick_attr_spice__model | Quick Attribute Edit for spice/model using the devmap library | quick_attr_spice__model(objptr) | target_spice/spicelib |
| Quit | Quits sch-rnd after confirming. | Quit() | |
| Redo | Redo recent "undo" operations. | redo() | libcschem/undo.c |
| Redraw | Redraw the entire screen | Redraw() | |
@@ -191,27 +201,65 @@
| rnd_zoom | Change zoom level (relative, absolute, window, ...) | Zoom()
Zoom([+|-|=]factor)
Zoom(x1, y1, x2, y2)
Zoom(?)
Zoom(get) | lib_hid_common plugin |
| Rotate90 | Rotate object or buffer CCW in 90 degree steps. Default target is auto. Default steps is 1. | Rotate90([object|buffer|auto], [steps])
Rotate90(idpath, steps, idp, x, y) | sch_rnd_gui |
| Rotate | Rotate object or buffer CCW in def degrees. Default target is auto. Default deg is ask (which prompts for a value). | Rotate([object|buffer|auto], [deg|ask]) | sch_rnd_gui |
+
| RtreeList | Return a list of idpaths for objects overlapping with the box specified (empty list if no object is found). Error is indicated by returning nil. If coordinates are not specified the whole tree is searched. | RtreeList[rtree_name, [x1, y1, x2, y2]) | act_read |
| ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
+
| SafeFsclearerr | Same as clearerr(3) | SafeFsclearerr(f) | |
+
| SafeFsFclose | Closes a file previously open using SafeFsFopen() | SafeFsFclose(f) | |
+
| SafeFsFeof | Returns 1 if file has reached EOF, 0 otherwise | SafeFsFeof(f) | |
+
| SafeFsFerror | Returns 1 if file had errors, 0 otherwise | SafeFsFerror(f) | |
+
| SafeFsFgets | Reads and returns a line from f (open with SafeFsFopen()). Stops reading after maxlen (subsequent call will continue reading the same line). Returns nil on error or eof or empty line. Maxlen is 64k by default. Note: string heap allocation is made for maxlen. | SafeFsFgets(f, [maxlen]) | |
+
| SafeFsFileMtime | Return the last modification time of a file, from Epoch, or -1 on error. | SafeFsFileMtime(path) | |
+
| SafeFsFileSize | Return the size of a file in bytes, or -1 on error. | SafeFsFileSize(path) | |
+
| SafeFsFopen | Opens a file using fopen, returns FILE *. If mode is not specified, r is assumed. Returns nil on error. | SafeFsFopen(path, [mode]) | |
+
| SafeFsFputs | Writes str to file f (previously opne with SafeFsFopen)) | SafeFsFputs(f, str) | |
+
| SafeFsFread | Reads and returns at most len bytes from a file (open with SafeFsFopen()). Returns nil on error or eof or empty line. | SafeFsFread(f, len) | |
+
| SafeFsFreadSep | Reads characters that are either all non-seps or all seps. Reads at most maxlen bytes. Returns the string read or nil on eof or error. Seps is a string that contains every separator character. Maxlen is 64k by default. | SafeFsFreadSep(f, seps, [maxlen]) | |
+
| SafeFsFseek | Same as fseek(3); whence is a string, one of set, cur or end not specified (set is used when not specified) | SafeFsFseek(f, offs, [whence]) | |
+
| SafeFsFtell | Same as ftell(3). | SafeFsFtell(f) | |
+
| SafeFsIsDir | Return 1 if path exists and is a directory, else return 0. | SafeFsIsDir(path) | |
+
| SafeFsMkdir | Mkdir a file from the file system. If mode is a string, it is converted from octal. Return value is the same as mkdir(2)'s | SafeFsMkdir(path, mode) | |
+
| SafeFsPathSep | Return the system dependet path separator character (normally slash). | SafeFsPathSep(path) | |
+
| SafeFsReadFile | Reads a text file into one long string, returned, but at most maxlen bytes. If maxlen is not specified, 64k is used. Returns nil on error or empty file. | SafeFsReadFile(path, [maxlen]) | |
+
| SafeFsRealPath | Returns the realpath(3) of path, or NULL on error. | SafeFsRealPath(path) | |
+
| SafeFsRemove | Remove an object from the file system. Return value is the same as remove(3)'s | SafeFsRemove(path) | |
+
| SafeFsRename | Rename an object on the file system. Return value is the same as rename(2)'s | SafeFsRename(old_path, new_path) | |
+
| SafeFsRewind | Same as rewind(3) | SafeFsRewind(f) | |
+
| SafeFsSystem | Runs cmdline with a shell using librnd safe_fs. Return value is the same integer as system()'s | SafeFsSystem(cmdline) | |
+
| SafeFsUnlink | Unlink a file from the file system. Return value is the same as unlink(2)'s | SafeFsUnlink(path) | |
| Save | Save a project or a schmeatics sheet trying to preserve original file name. | Save()
Save(Project|Sheet) | sch_rnd_gui |
| SaveAll | Save all unsaved sheets in current project (currprj) | SaveAll([currprj]) | |
| SaveAs | Save a project or a schmeatics sheet using a new file name. | SaveAs(Project|Sheet, [filename]) | sch_rnd_gui |
| SaveTo | Save project or sheet to a file. | SaveTo(Sheet|Project,filename[,format]) | plug_io_act |
+
| SchGetXY | Return the cursor (or crosshair) x or y coord. Msg is a string displayed when cursor coord is requested but cursor is not active (see GetXY()). | SchGetXY(cursor|crosshair, msg, X|Y) | act_read |
| ScriptCookie (RND) | Return a cookie specific to the current script instance during script initialization | ScriptCookie() | script plugin |
| ScriptPersistency (RND) | Read or remove script persistency data savd on preunload | ScriptPersistency(read|remove) | script plugin |
| Scroll (RND) | Scroll the viewport. | Scroll(up|down|left|right, [pixels]) | lib_hid_common plugin |
| SearchDialog | Open the log dialog. | SearchDialog() | query plugin |
+
| SearchObjAt | Return the most preferred object at mouse cursor (or crosshair) or x;y coord; search in a raduis of r coords. The unsel variant ignores selected objects. The GuiInspect variant uses the priorities right-click does. Msg is a string displayed when cursor coord is requested but cursor is not active (see GetXY()). Returns nil or an idpath. | SearchObjAt[UnSel|GuiInspect](cursor|crosshair, msg, [r])
SearchObjAt[UnSel|GuiInspect](x, y, [r]) | act_read |
+
| SearchObjAtGuiInspect | Return the most preferred object at mouse cursor (or crosshair) or x;y coord; search in a raduis of r coords. The unsel variant ignores selected objects. The GuiInspect variant uses the priorities right-click does. Msg is a string displayed when cursor coord is requested but cursor is not active (see GetXY()). Returns nil or an idpath. | SearchObjAt[UnSel|GuiInspect](cursor|crosshair, msg, [r])
SearchObjAt[UnSel|GuiInspect](x, y, [r]) | act_read |
+
| SearchObjAtUnsel | Return the most preferred object at mouse cursor (or crosshair) or x;y coord; search in a raduis of r coords. The unsel variant ignores selected objects. The GuiInspect variant uses the priorities right-click does. Msg is a string displayed when cursor coord is requested but cursor is not active (see GetXY()). Returns nil or an idpath. | SearchObjAt[UnSel|GuiInspect](cursor|crosshair, msg, [r])
SearchObjAt[UnSel|GuiInspect](x, y, [r]) | act_read |
| Select | Select objects; all=all visible; invert=invert selection; default is all. | Select([All|Invert]) | |
| SetGrid | Change grid size. | SetGrid(delta|*mult|/div, [unit]) | |
| SetGridOffs (RND) | Change grid offset (alignment) to x_offs and y_offs. Offsets should be specified with units. | SetGridOffs(x_offs, y_offs) | |
| SetUnits (RND) | Set the default measurement units. | SetUnits(mm|mil) | |
+
| SimActivate | Activate the simulation for the setup_name+veiw_name combo; setup_name is the name of the sim setup to use, view name is the name of a view that has a suitable sim target. Triggers timed autocompile. | SimActivate(setup_name, view_name) | sim |
+
| SimDialog | Open the sim(ulation) dialog | SimDlg() | sim_gui |
+
| SimDlg | Open the sim(ulation) dialog | SimDlg() | sim_gui |
+
| SimRun | Activate and run the simulation, see SimActivate() | SimRun(setup_name, view_name, [output_filename]) | sim |
+
| SimSetupDialog | Open the sim(ulation) setup/run dialog for the named setup in the current project | SimDlg(setup_name) | sim_gui |
+
| SimSetupDlg | Open the sim(ulation) setup/run dialog for the named setup in the current project | SimDlg(setup_name) | sim_gui |
+
| StanceDialog | Open the current project's stance configuration dialog. | StanceDialog() | sch_dialogs |
| StatusSetText | Replace status printout with text temporarily; turn status printout back on if text is not provided. | StatusSetText([text]) | sch_rnd_gui |
| 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 |
| SwitchRelative | Switch to a different sheet by traversing integer steps on the linked list of sheets loaded | SwitchRelative(steps) | sch_rnd_gui |
| SymlibRehash | Rebuild the in-memory tree of symbol libraries | SymlibRehash() | |
+
| SymlibReloadAllLocal | Replace all local symbols from a newer version of the same symbol from the symbol library | SymlibReloadAllLocal() | |
| SymLocLib | Convert between "embedded" symbols (full copy) and local lib symbol references | SymLocLib(object[:idpath]|selected, [toref|togrp]) | symlib_local |
| System | Run shell command | System(shell_cmd) | |
| tcl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
+
| TestBenchDialog | Open the test bench selector for the current object or for selected objects. | TestBenchDialog(object[:oidpath]|selected) | std_forge |
+
| TestBenchModify | Modify test bench affiliation of object(s), adding or deleting test benches in which the given objects are participating. | TestBenchModify(object[:oidpath]|selected, add|del, testbench_name) | std_forge |
| ToggleFloaters | Toggle the setting for only-floaters ot lock-floaters | ToggleFloaters(only|lock) | |
| Tool (RND) | Change or use the tool mode. | Tool(Arc|Arrow|Copy|InsertPoint|Line|Lock|Move|None|PasteBuffer)
Tool(Poly|Rectangle|Remove|Rotate|Text|Thermal|Via)
Tool(Press|Release|Cancel|Stroke)
Tool(Save|Restore) | |
| TreeDialog | Bring up the sheet's object tree dialog. If object is specified, move cursor to that object in the tree. | TreeDialog([object[=idpath]|objarr,vtp0ptr]) | sch_dialogs |