Sfairadora

  • Reference Guide

Command List

Here, you can find a list of all commands that may be sent to dispels. Commands can be sent and information about them retrieved by means of the relevant functions in the Enki language. If a command has a parameter, its type is included in the description.
Item
Description
CMD_CLOSE
Closes the active document. If it has not been saved, a prompt appears, asking the user whether he wants to save it. Corresponds to the File|Close Document menu command.
CMD_CREATE_OUTPUT_TEMPLATE
Creates a new output template in the document based on a parameter. The parameter is a structure with the following elements:
name (String) – name of the template to be created.
text (Rich_text) – the template to be saved.
CMD_CREATE_OUTPUT_TEMPLATE_DIALOG
Opens a dialog allowing the user to specify a name of a new Enkidu language template used to create a text representation of a table. Corresponds to the Create Output Template command in the context menu of a table.
CMD_CREATE_OUTPUT_TEMPLATE_IMPL
Creates a new output template in the document for the data item the reference to which is passed as a parameter. The parameter is a structure with the following elements:
name (String) – name of the template to be created.
ref (Dref) – reference to the data item based on which the template is to be created. If the command’s recipient is a table, the reference is ignored and the template is created from the table, instead.
doc_info (Doc_info) – page settings etc.
default_cformat (Rich_cformat) – standard character format for the template.
CMD_CREATE_OUTPUT_TEXT
Creates a new data item in the document and saves the text identified by the parameter into it. The parameter is a structure with the following elements:
name (String) – name of the new data item.
new_document (Bool) – if TRUE, a new document is created; otherwise the item is saved in the current document.
text (Rich_text) – the text to be saved.
If a new document is being created, the rich_text_format.s-d-fman file manipulator is used.
See also CMD_SAVE_SNAPSHOT_IMPL.
CMD_CREATE_OUTPUT_TEXT_DIALOG
Opens a dialog allowing the user to specify a name for the text representation of a table. Corresponds to the Create Output Text command in the context menu of a table.
CMD_CREATE_OUTPUT_TEXT_IMPL
Based on a data item, reference to which is passed as a parameter, a new data item is created containing textual representation of the data item being passed as parameter. The parameter is a structure with the following elements:
name (String) – name of the new data item.
new_document (Bool) – if TRUE, a new document is created; otherwise the item is saved in the current document.
ref (Dref) – reference to the data item based on which the text is to be created. If the command’s recipient is a table, the reference is ignored and the text is created from the table, instead.
doc_info (Doc_info) – page settings etc.
default_cformat (Rich_cformat) – standard character format for the text.
CMD_DELETE
Deletes an element of the sequence editor, table, or disp-folder. Corresponds to the Edit|Delete menu command.
CMD_DUPLICATE
Creates a copy of the active document. Corresponds to the File|Duplicate Document menu command.
CMD_COPY_TEMPORARY
Copies marked item to the clipboard. Corresponds to the Edit|Copy menu command.
CMD_CUT_TEMPORARY
Moves marked item to the clipboard. Corresponds to the Edit|Cut menu command.
CMD_EDIT_CFORMAT
Opens a window for character format specification. Corresponds to the Format|Character Format menu command.
CMD_EDIT_DEF_OBJ
Launches editing of the current presentation of an active indirect dispel or universal dispel.
CMD_EDIT_DISPLAY
Launches editing of the respective presentation. Corresponds to the Edit presentation context menu command.
CMD_EDIT_PFORMAT
Opens a window for paragraph format specification. Corresponds to the Format| Paragraph Format menu command.
CMD_EDIT_PICTURE
Opens a window for formatting pictures inserted in the text. Corresponds to the Format|Picture Format menu command.
CMD_EDIT_STYLE_TABLE
Opens a window for editing the table of styles. Corresponds to the Settings|Text Formatting Styles menu command.
CMD_EDIT_TABLE
Opens a window for editing text table properties. Corresponds to the Format|Table Format menu command.
CMD_EXIT
Saves the current layout of the application into the configuration file, and ends the application.
CMD_FIND_IN_DOCUMENT
Searches for the occurrence of defined data in the document. The parameter is of the Bool type. If TRUE, the first occurrence is searched for; if FALSE, the next occurrence is searched for. The actual data used for searching is saved in the system document under the system.state.find_info item.
CMD_FIND_IN_TABLE
Like CMD_FIND_IN_DOCUMENT, but only the active data table is searched.
CMD_FIND_IN_TEXT
Like CMD_FIND_IN_DOCUMENT, but only the contents of the active line editor, text editor, or rich text editor are searched.
CMD_GROUP_ITEMS
If a data table is active, this command groups it by the specified column. If a parameter of the Atom type is specified, it identifies the column by which the table should be grouped. If the parameter is not specified, the table is grouped by the active column or by selected columns.
Corresponds to the Group by Column context menu command.
CMD_INSERT_COLUMN
Inserts a new column into the current data table according to the data passed in the parameter.
CMD_INSERT_COLUMN_DIALOG
If a data table is active, a dialog for column insertion is opened. Corresponds to the Table|New Column menu command.
CMD_INSERT_NEW_TABLE
Inserts a table into a rich text editor at the cursor position. Corresponds to the Insert|Insert Table to Text menu command.
CMD_INSERT_NEW_ROW_UP
Inserts a new row into a text table (in a rich text editor) above the row where the cursor is located. Corresponds to the Table|Insert Row Above menu command.
CMD_INSERT_NEW_ROW_DOWN
Inserts a new row into a text table (in a rich text editor) below the row where the cursor is located. Corresponds to the Table|Insert Row Below menu command.
CMD_INSERT_NEW_COLUMN_LEFT
Inserts a new column into a text table (in a rich text editor) to the left of the column where the cursor is located. Corresponds to the Table|Insert Column Left menu command.
CMD_INSERT_NEW_COLUMN_RIGHT
Inserts a new column into a text table (in a rich text editor) to the right of the column where the cursor is located. Corresponds to the Table|Insert Column Right menu command.
CMD_INSERT_STRING
If a text editor or a rich text editor is active, the string (type String) passed as the parameter is inserted at the cursor position.
CMD_INSERT_PICTURE
Displays the standard operating system dialog to select an image file to be inserted into the active rich text editor or image editor.
CMD_INSERT_RICH_STRING
If a rich text editor is active, the string identified by the parameter is inserted at the cursor position. The parameter is either a string of the Rich_string type or a structure:
text (Rich_string) – inserted string.
new_paragraph (Bool) – if TRUE, the string is inserted as a separate paragraph; otherwise it is inserted normally into the text.
cursor_offset (Int) – shift of the cursor in the inserted string (0 – beginning of the inserted string).
CMD_INSERT_RICH_TEXT
If a rich text editor is active, the text identified by the parameter is inserted at the cursor position. The parameter is of the Rich_text type.
CMD_JOIN_TABLE
Joins the current data table in the presentation with another table according to the information passed in the parameter.
CMD_JOIN_TABLE_DIALOG
If a data table is active, a dialog for joining another table appears. Corresponds to the Table|Join Table menu command.
CMD_NEW
Creates a new empty document. Corresponds to the File|New menu command.
CMD_OPEN
Displays the standard operating system dialog to open a file. Corresponds to the File|Open Document menu command.
CMD_ORIGINAL_DISPLAY
Resets the presentation to the original state. Corresponds to the Reset Presentation context menu command.
CMD_ORIGINAL_VIEW
Resets the table view to the original state. Corresponds to the Reset View command in the context menu of a table.
CMD_PASTE_TEMPORARY
Inserts data from the clipboard. Corresponds to the Edit|Paste menu command.
CMD_PRINT
Prints the contents of a text editor or rich text editor. Corresponds to the Print command in the tool bar. In contrast to the CMD_PRINT_DLG command, this command does not open a printing dialog, but prints immediately.
CMD_PRINT_DLG
Allows the user to print the contents of a text editor or rich text editor. First, it displays the standard operating system printing dialog to select a printer and specify printing attributes. Corresponds to the File|Print…menu command.
CMD_REDO
Restores the changes reverted by the “Undo” function. Corresponds to the Edit|Redo menu command.
CMD_REMOVE_COLUMNS
Removes columns from the current data table according to information passed in the parameter.
CMD_REMOVE_COLUMNS_DIALOG
If a data table is active, a window for column removal is displayed. Corresponds to the Table|Delete Column menu command.
CMD_REMOVE_TEXT_TABLE_ROW
Removes the row where the cursor is located from a text table (in a rich text editor). Corresponds to the Table|Delete Row menu command.
CMD_REMOVE_TEXT_TABLE_COLUMN
Removes the column where the cursor is located from a text table (in a rich text editor). Corresponds to the Table|Delete Column menu command.
CMD_REMOVE_TEXT_TABLE_CELL
Removes the cell where the cursor is located from a text table (in a rich text editor). Corresponds to the Table|Delete Cell menu command.
CMD_SAVE
Saves the active document. Corresponds to the File|Save menu command.
CMD_SAVE_COPY
Saves a copy of the document. The file name associated with the document is left unchanged (unlike CMD_SAVE_AS command).
The parameter is a string containing file name under which is the copy saved. When not specified, the standard dialog to choose file name is displayed.
CMD_SAVE_AS
Displays the standard operating system dialog to specify the name under which the active document will be saved. Corresponds to the File|Save as…menu command.
The parameter is a string containing file name newly assigned to the document. When not specified, the standard dialog to choose file name is displayed.
CMD_SAVE_SNAPSHOT
Displays a window allowing the user to specify a name under which the instant state of the data table view will be saved. Corresponds to the Save Instant State command in the context menu of a table.
CMD_SAVE_SNAPSHOT_IMPL
Creates a new data item in the document and saves the data identified by the parameter into it. The parameter is a structure with the following elements:
name (String) – name of the new data item.
new_document (Bool) – if TRUE, a new document is created; otherwise it is saved into the current document.
snapshot (any type) – the data to be saved.
CMD_SAVE_STATE
Saves the current state of the application into the configuration file.
CMD_SAVE_VIEW
Opens a window allowing the user to specify a name for saving a data table view. Corresponds to the Save View command in the context menu of a table.
CMD_SPLIT_TABLE
Divides a text table (in a rich text editor) into two above the line where the cursor is located. Corresponds to the Table|Divide Table menu command.
CMD_UNDO
Reverts one change made by the user. Corresponds to the Edit|Undo menu command.
CMD_UNGROUP_ITEMS
If a data table is active, this command ungroups the required column containing a nested sequence. If a parameter of the Atom type is specified, it identifies the column that should be ungrouped. If the parameter is not specified, the parent sequence of the active column or selected columns is ungrouped.
Corresponds to the Ungroup Sequence context menu command.