Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | sch_dialogs |
AbstractDialog | Bring up the current project's abstract model dialog. If abstract object id, abst_id is specified, left-side cursor is set at that object initially. If attr_name is specified, right-side cursor is set on that attribute. | AbstractDialog([abst_id [,attr_name]]) | sch_dialogs |
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 |
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 |
bas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Benchmark (RND) | Benchmark the GUI speed. | Benchmark() | |
Breakup | Breakup group(s) found in context named in first arg, place resulting objects in the context named in second arg if present or on sheet if not present | Breakup(selected|buffer|object, group|poly[gon]|all, [sheet|grp-oid]) | construct plugin |
BrowseScripts | Present a dialog box for browsing scripts | BrowseScripts() | script plugin |
BufferChk | Chk content of buffer; if first arg is symbol, the first symbol group is saved, if sheet the whole buffer is saved as sheet | BufferChk([group|symbol|sheet, [filename], [fmt]) | |
BufferClear | Empty currently active paste buffer. | BufferClear() | |
BufferCopy | Copy selection to currently active paste buffer. | BufferCopy() | |
BufferCut | Cut selection to currently active paste buffer: copy objects then remove them from the sheet. | BufferCut() | |
BufferLoad | Load content of buffer; if first arg is symbol, the first symbol group is saved, if sheet the whole buffer is saved as sheet | BufferLoad([group|symbol|all, [filename], [fmt]) | |
BufferSave | Save content of buffer; if first arg is symbol, the first symbol group is saved, if sheet the whole buffer is saved as sheet | BufferSave([group|symbol|all, [filename], [fmt]) | |
BufferSwitch | Switch content of buffer; if first arg is symbol, the first symbol group is saved, if sheet the whole buffer is saved as sheet | BufferSwitch([group|symbol|sheet, [filename], [fmt]) | |
Center (RND) | Moves the pointer to the center of the window. | Center() | lib_hid_common plugin |
ChkGridSize | Return 1 if the currently selected grid matches the expected_size. If argument is "none" return 1 if there is no grid. | ChkGridSize(expected_size) ChkGridSize(none) | |
ChkGridUnits | Return 1 if currently selected grid unit matches the expected (normally mm or mil) | ChkGridUnits(expected) | |
ChkMode | Return 1 if the currently selected mode is the expected_mode | ChkMode(expected_mode) | |
cli_MessageBox | Intenal: CLI frontend action. Do not use directly. | ||
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 |
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) | |
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 |
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 |
DrawGroup | Create a new concrete group. Optionally create key=value string attributes in the new group. | DrawGroup([noundo], [retptr], scope, [key, value], [key, value]...) | draw plugin |
DrawLine | Draw a decoration line. | DrawLine([noundo], [retptr], scope, x1, y1, x2, y2, [pen]) | draw plugin |
DrawRelease | Release the pointer of an object. Call this after Draw*(retptr,...) when the object is no longer needed. Unreleased objects are leaked. Warning: there is NO reference counting; getting the same object twice will get only one registration, then releasing "one of them" will release both! NEVER keep pointers across invocations. | DrawRelease(objptr) | draw plugin |
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_rnd |
DumpPluginDirs | Print plugins directories in a format digestable by scripts. | DumpPluginDirs() | |
DumpPlugins | Print plugins loaded in a format digestable by scripts. | DumpPlugins() | |
DumpVersion | Dump version in script readable format. | DumpVersion() | |
EditText | Bring up a text quick edit dialog. | EditText([object[=idpath]]) | sch_dialogs |
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_rnd |
ExecActionFile | Run actions from the given file. | ExecActionFile(filename) | |
ExecCommand | Run shell command | System(shell_cmd) | |
ExportDialog | Open the export dialog. | ExportDialog() | lib_hid_common plugin |
fawk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
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 |
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) | |
GetXY (RND) | Get a coordinate. If x or y specified, the return value of the action is the x or y coordinate. | GetXY([message, [x|y]]) | |
Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) grid(get) grid(ask) | |
gui_FallbackColorPick | Intenal: GUI frontend action. Do not use directly. | lib_hid_common 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 | |
Help | On-line action help | Help() | |
InfoBarFileChanged | Present the "file changed" warning info bar with buttons to reload or cancel | InfoBarFileChanged(open|close) | sch_dialogs |
Integrity | Run data integrity checks on current sheet. | Integrity() | libcschem/integrity.c |
irc | non-modal, single-instance, single-server, single-channel irc window for online support | irc() | irc plugin |
javascript | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
js | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
LibraryDialog | Bring up the library dialog. Default lib_type_name is "symbol". "Sheet" is the sheet's local library (one dialog per sheet), "global" is all symbols mapped for any sheet seen in this session. In modal mode returns the tree path of the selected entry. | LibraryDialog([lib_type_name, [sheet|global, [modal]]]) | sch_dialogs |
ListScripts (RND) | List fungw scripts, optionally filtered wiht regex pat. | ListScripts([pat]) | script plugin |
LiveScript (RND) | Manage a live script | LiveScript([new], [name]) LiveScript(load|save, name, [filame]) LiveScript(run|stop|rerun|undo, name) | script plugin |
Load | Load a project or a schematics sheet from a user-selected file. | Load() Load(Project|Sheet) | sch_rnd_gui |
LoadFrom | Load project or sheet data from a file. | LoadFrom(Sheet|Project,filename[,format]) | plug_io_act |
LoadScript (RND) | Load a fungw script | LoadScript(id, filename, [language]) | script plugin |
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 |
ManagePlugins | Manage plugins dialog. | ManagePlugins() | lib_hid_common plugin |
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) | |
Message (RND) | Writes a message to the log window. | message([ERROR|WARNING|INFO|DEBUG,] message) | |
MessageBox | Open a modal message dialog box with title and label. If icon string is not empty, display the named icon on the left. Present one or more window close buttons with different text and return value. | MessageBox(icon, title, label, button_txt, button_retval, ...) | |
Mirror | Mirror object or buffer. Default target is auto. Default direction is horizontal. | Mirror([object|buffer|auto], [horizontal|vertical]) | sch_rnd_gui |
Mode | 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) | |
MoveCursorTo | Move the cursor to absolute coords, pan the view as needed. | MoveCursorTo(x,y) | |
mruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Oneliner | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Pan (RND) | Start or stop panning (Mode = 1 to start, 0 to stop) | Pan(Mode) | lib_hid_common plugin |
pas | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
pcb_acos | script plugin | ||
pcb_asin | script plugin | ||
pcb_atan2 | script plugin | ||
pcb_atan | script plugin | ||
pcb_cos | script plugin | ||
pcb_rand | script plugin | ||
pcb_sin | script plugin | ||
pcb_sqrt | script plugin | ||
pcb_srand | script plugin | ||
pcb_tan | script plugin | ||
PenDialog | Bring up a modal pen selecton dialog. If idpath is specified, list pens starting from the group addressed by idpath. If second argument is non-modal, the dialog is not modal; else it is modal and the user selected pen is returned (as idpath) | PenDialog([object[=idpath]], [non-modal]) | sch_dialogs |
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 |
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() | |
PrintActions | Print all actions available. | PrintActions() | |
PrintCopyright | Print copyright notice. | PrintCopyright() | |
PrintDialog | Open the print dialog. | PrintDialog() | lib_hid_common plugin |
PrintFiles | Print files currently loaded. | PrintFiles() | |
PrintGUI | Open the print dialog. | PrintDialog() | sch_dialogs |
PrintPaths | Print full paths and search paths. | PrintPaths() | |
PrintUsage | Print command line arguments of sch-rnd or a plugin loaded. | PrintUsage() PrintUsage(plugin) | |
PrintVersion | Print version. | PrintVersion() | |
PromptFor (RND) | Prompt for a string. Returns the string (or NULL on cancel) | PromptFor([message[,default[,title]]]) | |
propedit | propedit(object[:id]|sheet|selection) | propedit | |
propget | Return the named property of scope or all selected objects to/by value. Scope is documented at PropEdit(). | propget([scope], name, [stattype]) | propedit |
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 |
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 |
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 |
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_portmap | Qucik Attribute Edit for core data model's symbol portmap attribute (attribute based symbol terminal to network portmapion 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 |
Quit | Quits sch-rnd after confirming. | Quit() | |
Redo | Redo recent "undo" operations. | redo() | libcschem/undo.c |
Redraw | Redraw the entire screen | Redraw() | |
ReloadScript (RND) | Reload a fungw script | ReloadScript(id) | script plugin |
RemoveMenu | Recursively removes a new menu, popup (only path specified) or submenu. | RemoveMenu(path, cookie) | |
RemoveSelected | Remove all selected objects | RemoveSelected() | |
Revert | Revert to on-disk version of file(s). Default target is sheet. | Revert([sheet|project]) | plug_io_act |
rnd_acos | script plugin | ||
rnd_asin | script plugin | ||
rnd_atan2 | script plugin | ||
rnd_atan | script plugin | ||
rnd_cos | script plugin | ||
rnd_dlg_xpm_by_name | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | |
rnd_rand | script plugin | ||
rnd_sin | script plugin | ||
rnd_sqrt | script plugin | ||
rnd_srand | script plugin | ||
rnd_tan | script plugin | ||
rnd_toolbar_init | For ringdove apps: initialize the toolbar. | lib_hid_common plugin | |
rnd_toolbar_uninit | For ringdove apps: uninitialize the toolbar. | lib_hid_common plugin | |
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]) | 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 |
ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Save | Save a project or a schmeatics sheet trying to preserve original file name. | Save() Save(Project|Sheet) | sch_rnd_gui |
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 |
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 |
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) | |
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() | |
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 |
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 |
Undo | Undo recent changes. | undo() undo(ClearList|FreezeSerial|UnfreezeSerial|FreezeAdd|UnfreezeAdd|IncSerial|GetSerial|Above) | libcschem/undo.c |
UndoDialog | Open the undo dialog. | UndoDialog() | sch_dialogs |
Unload | Unload (close) current project or sheet | Unload(Sheet|Project) | plug_io_act |
UnloadScript (RND) | Unload a fungw script | UnloadScript(id) | script plugin |
UnSelect | Unselect all objects. | UnSelect([All]) | |
ViewDialog | Bring up a modal dialog for selecting the current view or editing views of the current project. | ViewDialog() | sch_dialogs |
Zoom | GUI zoom | Zoom() Zoom([+|-|=]factor) Zoom(x1, y1, x2, y2) Zoom(?) Zoom(get) | sch_rnd_gui |
ZoomTo | GUI zoom | Zoom() Zoom([+|-|=]factor) Zoom(x1, y1, x2, y2) Zoom(?) Zoom(get) | sch_rnd_gui |
RND: this action comes from librnd and is common to all ringdove applications.