The following is a list of the various command modifiers supported in toolbar buttons and hotkeys.
|
Modifier |
Description |
|---|---|
|
@admin |
The function requires administrator permissions under Vista and above.
This modifier will result in a UAC prompt appearing (unless the Lister is
already in administrator mode), and any
external programs run by this function will be elevated.
|
|
@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).
|
|
@codepage |
Changes the code page of an MS-DOS batch command. If not specified the default code page is 1252 (Windows-1252).
|
|
@confirm |
Displays a confirmation dialog. If the user clicks the cancel button,
the function is aborted at this point.
|
|
@dirsonly |
The function will operate only on selected folders, ignoring any files.
|
|
@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.
|
|
@externalonly |
Ignores any Opus internal commands specified in the function, and treats all commands as external. This lets you configure an MS-DOS batch function using commands like copy which would normally be overridden by the internal command set.
|
|
@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.
|
|
@filesonly |
The function will operate only on selected files, ignoring any folders.
|
|
@firstfileonly |
The function will operate on only the first selected file, irrespective of how many items are selected or dropped onto the button.
|
|
@functype |
This directive is only used within an embedded function. It
lets you specify the type of the embedded function (if not specified, the
embedded function is assumed to be a standard function - Opus or external
command). For example, the following command would open a new Lister with
an embedded script function that runs in the context of the new
Lister:
|
|
@icon |
The @icon directive lets you create buttons that
dynamically change their icon based on the test of a
Set-command clause (similar to @ifset).
The default View Mode Cycle button uses this to change its icon
to reflect the current view mode.
In the command editor, you can Ctrl+click the
@icon: string to select the icon
directly. |
|
@ifexists |
Allows simple conditional behaviour based on whether the specified
drive or path exists.
|
|
@ifpath |
Allows simple conditional behaviour based on the current source path. You can provide either an absolute path to test against, or a wildcard pattern (use @ifpath for standard wildcards, and @ifpathr for regular expressions). For example, you could use this to open different programs when
double-clicking on an image file, depending on where the file is stored.
If the following command was added to the Left double-click event for
the Imagesfile
type group, pictures located on the network will be opened in the
Opus viewer when they are double-clicked, whereas files located on a local
drive would open in Photoshop.
The possible forms of this modifier are:
|
|
@ifset |
Allows simple conditional behaviour based on tests for various Set command conditions. You can also test if a variable has been set by the @set directive. Additionally, a button on the File Display toolbar can test if it's tied to the left or right file display. 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.
The possible forms of this modifier are:
|
|
@keydown |
Allows simple conditional behaviour based on whether various qualifier keys are held down when the function is run. The qualifiers to test for are specified using one or more keywords
(shift, ctrl and alt)
which represent the Shift, Control and
Alt keys. For example, you could configure a button to
select all files, then copy, move or create shortcuts to them, depending
on which keys were held down.
The possible forms of this modifier are:
|
|
@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.
|
|
@nocall |
An MS-DOS batch function function that invokes an external .bat file will run it directly, rather than using call semantics. This means that control will not return to the parent function once the external .bat file has finished. The default behaviour is to use the DOS call instruction which returns control to the parent function at the end.
|
|
@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.
|
|
@noexpandenv |
Prevent the expansion of any environment variables in the function. Normally environment variables like %USERPROFILE% are expanded during the function parsing phase - this modifier causes variable names to be left intact.
|
|
@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.
|
|
@nolocalizefiles |
Prevents Opus from automatically downloading or extracting non-filesystem files when passing their paths to external programs. For example, you may want to use {filepath} to pass the ftp:// path of a file on a remote FTP server to an external program. By default Opus will download the file to a temporary file, and pass the name of the temporary file to the program - with this modifier, Opus will instead pass the original file path.
|
|
@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:
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:
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.
|
|
@resolvelinks |
Shortcuts or links passed to commands in this function will be resolved to their targets. Without this modifier, a selected .lnk file would be passed as-is.
|
|
@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:
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.
|
|
@runmode |
Modifies the "run" state of external programs launched by the function - that is, how its main window should appear. This is equivalent to the Run drop-down on the simple command editor. Not all programs will support this setting, so you will need to use trial and error to some extent. You should only set the mode to hide if you are sure of what you are doing - it is most useful for hiding the otherwise brief flash of a DOS window when running a DOS program.
|
|
@runonce |
Forces the command following the modifier to only be run once per function, instead of once per file.
|
|
@script |
Specifies the scripting language used for a script. This is
used for both Rename Scripts (including embedded rename
scripts) and for Script Functions. The
@script modifier must be followed by a keyword that
specifies the scripting language. For example,
Note that @script is not used for script add-ins, as in that case the file extension of the add-in itself specifies the language.
|
|
@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,
Normally 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. However this can be accomplished by prefixing the variable name with a special scope marker that determines which scope the variable will live in.
You can also mark variables to be saved on disk - their values will be
remembered from one Opus session to the next. To accomplish this, simply
add an exclamation mark (!) to the scope marker. For example,
glob!:<name> refers to a variable with
global scope that will be saved on disk.
|
|
@sync |
The command following this modifier will be run synchronously - Opus
will wait for it to exit before running the next command in the function
(or before running this command again for the next selected
file).
|
|
@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:
This directive can also control whether a button
appears highlighted based on the test of a
Set-command clause (similar to @ifset).
Normally buttons that run the Set command appear checked
or unchecked based on the state of that Set command
itself, but using @toggle you can run one
Set command and test for another. You can also test for
multiple Set clauses at once. For example:
The @toggle directive can also test for the existence of a variable (one set via the @set directive). For this to work, the directive must be the very first line of the button, and the variable you are testing must have tab, Lister or global scope. You can use this to create your own custom toggle buttons that keep track of their state using scoped variables. For example:
|
|
@useactivelister |
The function will operate on the active Lister rather than the current source Lister. Normally these will be the same thing, but this could be useful for a hotkey that you want to have operate on whatever Lister window is currently active, without having to make sure that Lister is set to source first.
|