next up previous contents index
Next: The FileTool Utility Up: Schematic Editor Functions Previous: Electrical Nodes   Contents   Index

Symbolic Mode

(int) IsShowSymbolic()
This function will return 1 if the current cell is being displayed in symbolic form in the main window, 0 otherwise. The return is always 0 in physical mode.

(int) ShowSymbolic(show)
This will set symbolic mode of the current cell, and display the symbolic representation, if possible, in the main window. The effect is similar to the effect of pressing or un-pressing the symbl button in the electrical side menu. The function call must be made in electrical display mode. When symbolic mode is asserted, by passing a boolean true argument, the current cell will be displayed in symbolic mode, unless the No Top Symbolic button in the Main Window sub-menu of the Attributes Menu is pressed. The return value is 1 on success, 0 if some error occurred, with an error message likely available from GetError.

(int) SetSymbolicFast(symb)
This will enable or disable symbolic mode of the current cell. It differs from ShowSymbolic in two ways. First, it applies only to cells with a symbolic representation, meaning that it has a symbolic form which may or may not be visible. Second, it will change the status of a flag in the cell, but there will be no updating of the screen or other internal things (such as undo logging). The caller must reset to the original state before a screen redisplay or any major operation. This is much faster than calling ShowSymbolic, and can be used when making quick changes to a cell.

The return value is 1 if the current cell was previously actively symbolic, 0 otherwise. In physical mode the return value is always 0 and the function has no effect.

(int) MakeSymbolic()
This will create a very simple symbolic representation of the electrical view of the current cell, consisting of a box with a name label, and wire stubs containing the terminals. Any existing symbolic representation will be overwritten (but the operation can be undone). In electrical mode, symbolic mode will be asserted.

On success, 1 is returned, 0 otherwise.


next up previous contents index
Next: The FileTool Utility Up: Schematic Editor Functions Previous: Electrical Nodes   Contents   Index
Stephen R. Whiteley 2017-03-22