# DOpus

The **DOpus** object is one of the two global script objects provided by Opus, and is available to _all_ scripts. It provides various helper methods, and collections that let you access things like Listers and toolbars.

| Property Name   | Return Type                                                                                        | Description                                                                                                                                                                                                                                              |
| --------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| aliases         | _object:_[**Aliases**](aliases)                                                                    | The \*\*[Aliases](aliases)\*\*object gives the script access to the defined [folder aliases](../../../basic_concepts/the_lister/navigation/aliases).                                                                                                     |
| favoriteformats | _collection_:[**Format**](format)                                                                  | Returns a collection of [**Format**](format) objects representing the used-defined favorite formats.                                                                                                                                                     |
| favorites       | _object:_[**Favorites**](favorites)                                                                | Returns a \*\*[Favorites](favorites)\*\*object which lets you query and modify the user-defined favorite folders.                                                                                                                                        |
| filetypegroups  | _object_:[**FiletypeGroups**](filetypegroups)                                                      | Returns a [**FiletypeGroups**](filetypegroups) object which lets you enumerate and query the configured [file type groups](../../../file_types/file_type_groups).                                                                                        |
| filters         | _object:_[**GlobalFilters**](../../../basic_concepts/folder_options/folder_options_dialog/filters) | Returns a [**GlobalFilters**](globalfilters) object which lets you access information about the global filter settings (configured on the [**Filters**](../../../preferences/preferences_categories/filtering_and_sorting/filters) page in Preferences). |
| language        | _string_                                                                                           | Returns a string representing the current user interface language.                                                                                                                                                                                       |
| listers         | _object:_[**Listers**](listers)                                                                    | Returns a [**Listers**](listers) object which represents any currently open Lister windows (each one is represented by a [**Lister**](lister) object).                                                                                                   |
| smartfavorites  | _object:_[**SmartFavorites**](smartfavorites)                                                      | Returns a [**SmartFavorites**](smartfavorites) object which lets you query the [SmartFavorites](../../../basic_concepts/the_lister/navigation/smartfavorites)data.                                                                                       |
| spacingscheme   | _string_                                                                                           | Returns the name of the current [UI spacing scheme](../../../preferences/preferences_categories/user_interface/spacing) (if any).                                                                                                                        |
| strings         | _object:_[**ScriptStrings**](scriptstrings)                                                        | Returns a [**ScriptStrings**](scriptstrings) object which lets your script access any strings defined as [string resources](../../../scripting/resources/string_resources).                                                                              |
| tabgroups       | _object:_[**TabGroups**](tabgroups)                                                                | Returns a [**TabGroups**](tabgroups) object which lets your script access and manipulate the configured [folder tab groups](../../../basic_concepts/the_lister/tabs/tab_groups).                                                                         |
| vars            | _object:_[**Vars**](vars)                                                                          | This [**Vars**](vars) object represents all defined variables with _global scope_.                                                                                                                                                                       |
| version         | _object:_[**Version**](version)                                                                    | The [**Version**](version) object provides information about the current Opus program version.                                                                                                                                                           |
| viewers         | _object:_[**Viewers**](viewers)                                                                    | Returns a **Viewers** object which represents any currently open [standalone image viewers](../../../additional_functionality/viewing_images) (each one is represented by a [**Viewer**](viewer) object).                                                |

| Method Name     | **Arguments**                                                                                                                                                                           | Return Type                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ClearOutput     | _none_                                                                                                                                                                                  | _none_                                                                                                   | Clears the script output log.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Create          | _none_                                                                                                                                                                                  | _object:_[**DOpusFactory**](dopusfactory)                                                                | Creates and returns a new [**DOpusFactory**](dopusfactory) object, which can be used to create various lightweight helper objects like [**Blob**](blob), [**Map**](map) and [**Vector**](vector).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Delay           | \<int:time>                                                                                                                                                                             | _none_                                                                                                   | Delays for the specified number of milliseconds before returning.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Dlg             | _none_                                                                                                                                                                                  | _object:_[**Dialog**](dialog)                                                                            | <p>Creates a new <a href="dialog"><strong>Dialog</strong></a> object, that lets you display dialogs and popup menus.</p><p><strong>Note:</strong> Scripts should not usually use this when responding to events triggered by toolbars or folder tabs. The <strong>Dialog</strong> returned by <strong>DOpus.Dlg</strong> will not have its parent window configured. Most scripting events provide you an object which can either create a pre-configured <strong>Dialog</strong> or which includes a <strong>SourceTab</strong> property or similar which can do the same. In almost all situations you should use those instead.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| DPI             | _none_                                                                                                                                                                                  | _object:_[**DPI**](dpi)                                                                                  | Creates the [**DPI**](dpi) helper object which assists when dealing with different system scaling settings (e.g. high-DPI monitors).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| FlushConfig     | _none_                                                                                                                                                                                  | _none_                                                                                                   | Forces Opus to write any configuration changes to disk immediately.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| FSUtil          | _none_                                                                                                                                                                                  | _object:_[**FSUtil**](fsutil)                                                                            | Creates a new [**FSUtil**](fsutil) object, that provides helper methods for accessing the file system.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| GetClip         | <p><em>none</em><br>or &#x3C;string:type></p>                                                                                                                                           | <p><em>string</em><br>or <em>object:</em><a href="items"><strong>Items</strong></a></p>                  | <p>Retrieves the current contents of the system clipboard, if it contains either text or files.</p><p>You can control the returned type by passing either "<strong>text</strong>" or "<strong>files</strong>" for the <em>&#x3C;type></em> argument - Opus will convert to the requested type if possible.</p><p>If <em>&#x3C;type></em> is not specified the contents will be returned in their native format.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| GetClipFormat   | _none_ or \<string:flags>                                                                                                                                                               | _string_                                                                                                 | <p>Returns a string indicating the native format of the clipboard contents.</p><p>Optional flags:</p><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>c</strong></td><td>Differentiate between cut and copied files</td></tr></tbody></table><p>Possible return values:</p><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><strong>files</strong></td><td>Files, if <strong>flags</strong> omitted or doesn't include <strong>c</strong></td><td></td></tr><tr><td><strong>files_copy</strong></td><td>Files via Copy (Ctrl-C), if <strong>flags</strong> includes <strong>c</strong></td><td></td></tr><tr><td><strong>files_cut</strong></td><td>Files via Cut (Ctrl-X), if <strong>flags</strong> includes <strong>c</strong></td><td></td></tr><tr><td><strong>image</strong></td><td>Bitmap data</td><td></td></tr><tr><td><strong>text</strong></td><td>Text data</td><td></td></tr><tr><td>&#x3C;empty string></td><td>Empty clipboard, or any other type of data</td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td>GetListers</td><td></td><td></td></tr></tbody></table><p><em>none</em><br>or &#x3C;string:flags></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | _object:_[**Listers**](listers) | <p>Returns a <a href="listers"><strong>Listers</strong></a> object which represents any currently open Lister windows (each one is represented by a <a href="lister"><strong>Lister</strong></a> object). This is the same as using the <strong>listers</strong> property, except that you can specify the optional flags:</p><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><strong>c</strong></td><td>Current desktop only. Only returns Listers from the current virtual desktop.</td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td>GetQualifiers</td><td></td><td></td></tr></tbody></table><p><em>none</em></p>                                                                                                                                                                                                                                                                                                    | _string_ | <p>Returns a string indicating which qualifier keys are currently held down. If none are held down, the string will be "<strong>none</strong>". Otherwise, the string can contain any or all of the following, separated by commas: "<strong>shift</strong>", "<strong>ctrl</strong>", "<strong>alt</strong>", "<strong>lwin</strong>", "<strong>rwin</strong>".</p><p>Note that many events pass you a similar list of qualifiers. If you are passed a list of qualifiers, you should generally use that list rather than call DOpus.GetQualifiers.</p><p>For example, script commands are passed a <a href="func"><strong>Func</strong></a> object with a <em>qualifiers</em> property. That property will tell you which keys were held down when the command was triggered, and that may be different to the keys held down a few seconds later. When the user clicks a button to run a command, they normally expect the command to use the keys they held when they clicked, not the keys they are touching later while waiting for it to finish.</p><p>Similarly, events like <a href="../scripting_events/onbeforefolderchange"><strong>OnBeforeFolderChange</strong></a> will often pass you an object like <a href="beforefolderchangedata"><strong>BeforeFolderChangeData</strong></a> containing a <em>qualifiers</em> property which indicates key state when the event was triggered. You should normally use that instead of calling DOpus.GetQualifiers.</p><p>If you do call DOpus.GetQualifiers, you would normally want to call it as soon as possible and then store the result, so there is less time for the user to let go of a key after triggering your script.</p><p>If you call DOpus.GetQualifiers more than once, you may get a different result each time, due to keys being pushed or released between calls. Call it once and store the result if you need to do multiple checks and need them to be consistent. This does not generally affect the <em>qualifiers</em> properties mentioned earlier, since they are usually stored snapshots of the key state.</p> |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **c**           | Differentiate between cut and copied files                                                                                                                                              |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **files**       | Files, if **flags** omitted or doesn't include **c**                                                                                                                                    |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **files\_copy** | Files via Copy (Ctrl-C), if **flags** includes **c**                                                                                                                                    |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **files\_cut**  | Files via Cut (Ctrl-X), if **flags** includes **c**                                                                                                                                     |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **image**       | Bitmap data                                                                                                                                                                             |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **text**        | Text data                                                                                                                                                                               |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| \<empty string> | Empty clipboard, or any other type of data                                                                                                                                              |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| GetListers      |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **c**           | Current desktop only. Only returns Listers from the current virtual desktop.                                                                                                            |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| GetQualifiers   |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| LoadImage       | <p>&#x3C;string:filename> or &#x3C;object:<a href="blob"><strong>Blob</strong></a>><br>[&#x3C;string:typehint>]<br>[&#x3C;int:width>]<br>[&#x3C;int:height>]<br>[&#x3C;bool:alpha>]</p> | object:[**Image**](image)                                                                                | <p>Loads an image file from the specified file. You can optionally specify the desired size to load the image at, and whether the alpha channel (if any) should be loaded or not. Note that the <em>typehint</em> argument should only be provided if passing a <strong>Blob</strong>.</p><p>You can load icons from the internal icon set using <code>#iconname</code>. E.g. <code>#copy</code> would load the copy image from the default set. By default the large size is returned; use <code>#0:iconname</code> for the small size. You can also specify a particular icon set using <code>#setname:iconname</code> or <code>#0:setname:iconname</code>.</p><p>Images can be extracted from DLLs and EXEs by appending the icon index to the filename, e.g. <code>/system/zipfldr.dll,1</code>.</p><p>You can also provide a <a href="blob"><strong>Blob</strong></a> object containing the image data instead of a filename. If you do this, the second parameter can be a <em>typehint</em> string to provide a type-hint for the data format (e.g. pass ".jpg" if you know it's JPEG data).</p><p>The returned <a href="image"><strong>Image</strong></a> object can be given as the value of the <a href="control"><strong>Control</strong></a><strong>.label</strong> property for a static control in a <a href="../../../scripting/script_dialogs">script dialog</a> (when that control is in "image" mode). You can also assign it as the <strong>icon</strong> property of a <a href="dialog"><strong>Dialog</strong></a> object to specify a custom window icon for your script dialog.</p><p>The defaults for <em>width</em> and <em>height</em> if not provided are 0, meaning to load the image at its native size. Images are loaded transparently (with alpha) by default; set the <em>alpha</em> argument to <strong>False</strong> if you want to disable that.</p> |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| LoadThumbnail   | <p>&#x3C;string:filename><br>[&#x3C;int:timeout>]<br>[&#x3C;int:width>]<br>[&#x3C;int:height>]<br>[&#x3C;string:flags>]</p>                                                             | <p>object:<a href="image"><strong>Image</strong></a><br>or<br><em>bool</em> (<strong>False</strong>)</p> | <p>Extracts a thumbnail from the specified external file. You can optionally specify a timeout (in milliseconds) and the desired size to load the thumbnail at.</p><p>The optional <strong>flags</strong> value supports the following flags (supplied as a string):</p><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>i</strong></td><td>prevents Opus from waiting for thumbnails that may take some time to generate, and instead returns a large icon if the thumbnail can't be generated immediately</td></tr><tr><td><strong>c</strong></td><td>modifies the <strong>i</strong> flag to only apply to Cloud storage folders</td></tr></tbody></table><p>If loading fails (or the timeout expires before the thumbnail could be generated) this method returns <strong>False</strong>.</p><p>The returned <a href="image"><strong>Image</strong></a> object can be given as the value of the <a href="control"><strong>Control</strong></a><strong>.label</strong> property for a static control in a <a href="../../../scripting/script_dialogs">script dialog</a> (when that control is in "image" mode). You can also assign as to the <strong>icon</strong> property of a <a href="dialog"><strong>Dialog</strong></a> object to specify a custom window icon for your script dialog.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **i**           | prevents Opus from waiting for thumbnails that may take some time to generate, and instead returns a large icon if the thumbnail can't be generated immediately                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **c**           | modifies the **i** flag to only apply to Cloud storage folders                                                                                                                          |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| MusicGenres     | _none_                                                                                                                                                                                  | object:[**Vector**](vector)                                                                              | Returns a [Vector](vector) of strings representing the music genres configured to be shown in the Genre field of the metadata panel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Notify          | <p>&#x3C;string:title><br>&#x3C;string:message><br>[&#x3C;string:flags>]</p>                                                                                                            | _none_                                                                                                   | <p>Displays a system notification (or in Windows 7, a balloon tooltip). This requires the Opus taskbar icon to be added to the taskbar notification area so if it's turned off in Preferences, it will be added temporarily and then removed again.</p><p>The optional flags are:</p><table><thead><tr><th></th><th></th><th></th></tr></thead><tbody><tr><td><strong>n</strong></td><td>No sound. Prevents the system from playing a sound when the notification is displayed.</td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td></td><td></td><td></td></tr><tr><td>Output</td><td></td><td></td></tr></tbody></table><p>&#x3C;string:text><br>[&#x3C;bool:error>]<br>[&#x3C;bool:timestamp>]</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | _none_                          | <p>Prints the specified text string to the script output log (found in the <a href="../../../basic_concepts/the_lister/utility_panel">Utility Panel, </a> the <a href="../../../additional_functionality/cli">CLI</a> in script mode, the <em>Rename</em> dialog and the <em>Command Editor</em> in script mode).</p><p>If the second argument is provided and set to <strong>True</strong>, the message will be displayed as an error. This means the text will be displayed in red and if no log windows are currently open, a warning icon will flash in the Lister status bar to alert the user of an error condition.</p><p>If the optional third argument is provided and set to <strong>True</strong> then the log message will have a timestamp prepended to it. Timestamps only appear in the utility panel, not in places like the Command Editor's output panel. Error messages always get timestamps so if the second argument is <strong>True</strong> then the third is ignored</p> |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **n**           | No sound. Prevents the system from playing a sound when the notification is displayed.                                                                                                  |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                 |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Output          |                                                                                                                                                                                         |                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ReloadScript    | \<string:file>                                                                                                                                                                          | _none_                                                                                                   | Causes Opus to reload and reinitialize the specified script. You must provide the full pathname of the script on disk (if a script add-in wants to reload itself you can pass the value of the [**Script**](script)**.file** property).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SendCustomMsg   | <p>&#x3C;string:msg><br>[&#x3C;int:data> or<br>&#x3C;object:data>]</p>                                                                                                                  | _bool_                                                                                                   | <p>Sends a named message to any existing script dialogs that have registered to receive that message via <a href="dialog"><strong>Dialog</strong></a><strong>.AddCustomMsg</strong>.</p><p>Any dialogs that have registered for the message will receive a "custom" <a href="msg"><strong>Msg</strong></a> in their message loop, with the message name in the <code>name</code> property.</p><p>You can optionally pass a single numeric value, or a container object (e.g. a <a href="map"><strong>Map</strong></a>) along with the message, which will be received by the dialog in either the <code>data</code> or <code>object</code> property of the <strong>Msg</strong>.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SendKey         | \<string:key>                                                                                                                                                                           | _bool_                                                                                                   | <p>Sends the specified keystroke to the system. The key will be routed to whichever window currently has focus. For example, <code>DOpus.SendKey("win+v");</code> sends the Win+V key to the system, which opens the Windows clipboard viewer.</p><p>Supported qualifier keys are <code>shift</code>, <code>ctrl</code>, <code>alt</code> and <code>win</code>.</p><p>As well as letters and numbers, the following named keys are also supported: <code>backspace</code>, <code>capslock</code>, <code>delete</code>, <code>down</code>, <code>end</code>, <code>enter</code>, <code>escape</code>, <code>home</code>, <code>insert</code>, <code>left</code>, <code>numlock</code>, <code>pagedown</code>, <code>pageup</code>, <code>pause</code>, <code>printscr</code>, <code>right</code>, <code>scrlock</code>, <code>space</code>, <code>tab</code>, <code>up</code>.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SetClip         | <p>&#x3C;string:text><br>or <em>object:</em><a href="items"><strong>Items</strong></a><br>or <em>none</em></p>                                                                          | _none_                                                                                                   | <p>Places the specified text, or <a href="items"><strong>Items</strong></a> object (or similar, see below) on the system clipboard. If called with no arguments the clipboard will be cleared.</p><p>When passing a file list, you can also give a <a href="vector"><strong>Vector</strong></a> of <a href="item"><strong>Item</strong></a> or <a href="path"><strong>Path</strong></a> objects, or full path strings, instead of a collection. Or a <a href="stringset"><strong>StringSet</strong></a> or <a href="unorderedset"><strong>UnorderedSet</strong></a> of full path strings.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Toolbars        | \<string:type>                                                                                                                                                                          | object:\*\*[Toolbars](toolbars) \*\*                                                                     | <p>Returns a <a href="toolbars"><strong>Toolbars</strong></a> object which lets you enumerate all defined toolbars (whether they are currently open or not).</p><p>You can restrict this object to only return in-use toolbars by specifying the optional <em>type</em> parameter - specify <strong>"listers"</strong> to only return toolbars currently turned on in a Lister, and <strong>"docks"</strong> to only return toolbars that are currently floating.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| TypeOf          | _any_                                                                                                                                                                                   | _string_                                                                                                 | Returns a string indicating the type of an object or variable.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
