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

favoriteformats

favorites

filetypegroups

filters

language

string

Returns a string representing the current user interface language.

listers

smartfavorites

spacingscheme

string

strings

tabgroups

vars

version

viewers

Method Name

Arguments

Return Type

Description

ClearOutput

none

none

Clears the script output log.

Create

none

Delay

<int:time>

none

Delays for the specified number of milliseconds before returning.

Dlg

none

Note: Scripts should not usually use this when responding to events triggered by toolbars or folder tabs. The Dialog returned by DOpus.Dlg will not have its parent window configured. Most scripting events provide you an object which can either create a pre-configured Dialog or which includes a SourceTab property or similar which can do the same. In almost all situations you should use those instead.

DPI

none

FlushConfig

none

none

Forces Opus to write any configuration changes to disk immediately.

FSUtil

none

GetClip

none or <string:type>

Retrieves the current contents of the system clipboard, if it contains either text or files.

You can control the returned type by passing either "text" or "files" for the <type> argument - Opus will convert to the requested type if possible.

If <type> is not specified the contents will be returned in their native format.

GetClipFormat

none or <string:flags>

string

Returns a string indicating the native format of the clipboard contents.

Optional flags:

c

Differentiate between cut and copied files

Possible return values:

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

none or <string:flags>

c

Current desktop only. Only returns Listers from the current virtual desktop.

GetQualifiers

none

string

Returns a string indicating which qualifier keys are currently held down. If none are held down, the string will be "none". Otherwise, the string can contain any or all of the following, separated by commas: "shift", "ctrl", "alt", "lwin", "rwin".

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.

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.

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 qualifiers properties mentioned earlier, since they are usually stored snapshots of the key state.

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

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 typehint argument should only be provided if passing a Blob.

You can load icons from the internal icon set using #iconname. E.g. #copy would load the copy image from the default set. By default the large size is returned; use #0:iconname for the small size. You can also specify a particular icon set using #setname:iconname or #0:setname:iconname.

Images can be extracted from DLLs and EXEs by appending the icon index to the filename, e.g. /system/zipfldr.dll,1.

The defaults for width and height if not provided are 0, meaning to load the image at its native size. Images are loaded transparently (with alpha) by default; set the alpha argument to False if you want to disable that.

LoadThumbnail

<string:filename> [<int:timeout>] [<int:width>] [<int:height>] [<string:flags>]

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.

The optional flags value supports the following flags (supplied as a string):

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

If loading fails (or the timeout expires before the thumbnail could be generated) this method returns False.

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

Notify

<string:title> <string:message> [<string:flags>]

none

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.

The optional flags are:

n

No sound. Prevents the system from playing a sound when the notification is displayed.

Output

<string:text> [<bool:error>] [<bool:timestamp>]

none

If the second argument is provided and set to True, 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.

If the optional third argument is provided and set to True 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 True then the third is ignored

n

No sound. Prevents the system from playing a sound when the notification is displayed.

Output

ReloadScript

<string:file>

none

SendCustomMsg

<string:msg> [<int:data> or <object:data>]

bool

SendKey

<string:key>

bool

Sends the specified keystroke to the system. The key will be routed to whichever window currently has focus. For example, DOpus.SendKey("win+v"); sends the Win+V key to the system, which opens the Windows clipboard viewer.

Supported qualifier keys are shift, ctrl, alt and win.

As well as letters and numbers, the following named keys are also supported: backspace, capslock, delete, down, end, enter, escape, home, insert, left, numlock, pagedown, pageup, pause, printscr, right, scrlock, space, tab, up.

SetClip

none

Toolbars

<string:type>

You can restrict this object to only return in-use toolbars by specifying the optional type parameter - specify "listers" to only return toolbars currently turned on in a Lister, and "docks" to only return toolbars that are currently floating.

TypeOf

any

string

Returns a string indicating the type of an object or variable.

最后更新于