@async

The command following this modifier will be run asynchronously - Opus will not wait for it to exit before running the next command in the function (or before running this command again for the next selected file).

The default behaviour is for a function that consists of a single command to run that command asynchronously for each selected file; a function that consists of multiple commands will run each command synchronously. The default behaviour can be changed with the function_default_async option on the Miscellaneous / Advanced page in Preferences, or it can be overridden on a per-command basis with this modifier.

@async:notepad.exe {f}   - runs Notepad asynchronously

 

@confirm

Displays a confirmation dialog. If the user clicks the cancel button, the function is aborted at this point.

The template for this modifier is: @confirm:<message>|<positive text>|<negative text>

<message> is the text shown in the dialog, <positive text> is the text shown on the "OK" button, and <negative text> is the text shown on the "Cancel" button. These three strings are all optional - if not provided, default strings will be used. If you provide <positive text> but not <negative text> then the dialog will have an "OK" button but no "Cancel" button at all.

You can include line-breaks in the message text using the special code \n (and if you need to include a literal \n sequence in the text you must escape the \ character, as in \\n).

@confirm:Really copy files?                   - uses default text for the OK and Cancel buttons

@confirm:Really proceed?|Oui!|Non!     - specifies custom text for the two buttons

@confirm:All finished|Acknowledged     - custom text for the OK button; no Cancel button at all

 

@disablenosel

The command will be disabled when no files or folders are selected. This is done automatically for certain standard commands and the modifier lets you make your own commands behave in a similar way.

@disablenosel                        - disable button when nothing is selected

@filesfromdroponly

Accepts files and folders only via drag-and-drop. A button with this modifier will ignore any selected files or folders in the Lister - only files dropped onto the button will be used by a command within it.

@filesfromdroponly          - accept files only via drag-and-drop

@firstfileonly

The function will operate on only the first selected file, irrespective of how many items are selected or dropped onto the button.

@firstfileonly                    - operate on only the first selected file

@ifset

Allows simple conditional behaviour based on tests for various Set command conditions.

For example, you could configure a button to read a folder into the right file display in a dual-display Lister, or into the current file display otherwise.

@ifset:DUAL=on                                //  if DUAL mode is on
Set FOCUS=right                               //     give focus to the right file display
Go /mypictures OPENINRIGHT            //     read directory into that file display
@ifset:else                                       //  otherwise
Go /mypictures                                //      read directory into current file display
@ifset:common                                //  common commands (always executed)
Set VIEW=thumbnails                       //  set view to thumbnails mode

 The possible forms of this modifier are:

@ifset:<Set argument> - test for a specific Set command condition
@ifset:else                 - an "else" clause that is executed if nothing else matches
@ifset:common          - common instructions that are always executed

@leavedoswindowopen

The console window opened for an MS-DOS batch function will remain open when the function has completed. Without this modifier the window will close when the function finishes, which may make it hard to read the output of any command-line programs.

Leaving the DOS window opens relies on passing a particular argument (/K) to the system command interpreter, cmd.exe. If you have modified the default command processor on your system by setting the %ComSpec% environment variable, Opus will not pass /K as there is no way for it to know if this argument would be understood by the new command processor. Instead, you can set the %ComSpecLeaveOpenArg% environment variable, and this will be used instead of %ComSpec% whenever @leavedoswindowopen is used.

@leavedoswindowopen        - leave DOS prompt open when function finishes

@nodeselect

Files and folders will remain selected at the end of the function. This lets you override the Deselect files used in functions option on the File Operations / Options page in Preferences, on a per-function basis.

@nodeselect                     - do not deselect items used by this function

@nofilenamequoting

Disables the automatic quoting that Opus performs when external codes like {filepath} are used to pass the name of a file that contains spaces. By default Opus will wrap names with embedded spaces in quotes, but occasionally you may want to disable this - some external programs may not need or understand quotes on their command line, and you may also want to provide explicit quotes in a function in case the automatic quoting gets confused by complicated command structures.

@nofilenamequoting          - do not automatically quote file names and paths

@norunbatch

When an MS-DOS batch function combines internal and external commands, the default behaviour is for Opus to split the function at every internal command, and execute all the external commands that came before it. For example, imagine the following (rather pointless) function:

echo one
Help ABOUT
echo two
@leavedoswindowopen

The default behaviour of this function would be to open a DOS window and print the string "one", then display the Opus About dialog, and then open another DOS window and print the string "two". If, however, the function were changed as follows:

@norunbatch
echo one
Help ABOUT
echo two
@leavedoswindowopen

The new behaviour would be to first display the About dialog, and then open a single DOS window and print both the strings "one" and "two". The @norunbatch modifier causes all Opus internal commands to be executed first, followed by all external commands.

@norunbatch                  - do not split batch functions because of internal commands

@runbatch

Force the execution of an MS-DOS batch function at a certain point. The default behaviour is for such functions to be executed at the very end of the function - using this modifier you can force a break in the function at any line. For example:

echo one
@runbatch
echo two
@leavedoswindowopen

This will cause two separate DOS windows to open, one displaying the text "one" and the other displaying "two". Without the @runbatch directive, the two commands would have been executed in the one window.

@runbatch                     - force a DOS batch function to execute at a certain point

@runonce

Forces the command following the modifier to only be run once per function, instead of once per file.

@runonce:<command>     - the specified command will only be run once

@set

Sets the value of a named variable that can be used by the remainder of the commands in the function. You can pass the value of a variable to internal and external commands using the {$}control code. Variables are most useful in the situation where the value is defined by a {dlgstring} code. For example,

@set dir={dlgstring|Enter new folder name to copy files to}
CreateFolder ".\{$dir}"
Copy TO ".\{$dir}"

Variables do not persist from one invocation of the function to another, and you can not refer to variables set in one function from another.

@set <name>=<value>     - sets the named variable to the specified value

@toggle

For buttons that act as toggles (e.g. Set VIEW=details), this modifier lets you change the highlight state of the button. Taking this command as an example, ordinarily the button would appear highlighted when the file display was in details mode, and unhighlighted when it was in any other mode. The @toggle modifier can change this:

@toggle:invert                - inverts the usual highlight state of the toolbar button
@toggle:disable              - prevents the button from ever appearing highlighted