Viewer

The Viewer object represents a standalone image viewer. A collection of Viewer objects is returned by the Viewers object, which is obtainable via the DOpus.viewers property. For functions launched from within a viewer (e.g. from its toolbar), the current Viewer object is provided by the ClickData.func.viewer property.

Property Name
Return Type
Description

bottom

int

Returns the bottom coordinate of the viewer window.

current

desktop

string

Returns the ID of the virtual desktop this viewer is on.

files

foreground

bool

Returns True if the viewer is currently the foreground (active) window in the system.

imagesize

index

int

Returns the index of the currently viewed image within the viewer's list of files.

lastactive

bool

Returns True if the viewer is the most recently active viewer.

left

int

Returns the left coordinate of the viewer window.

parentlister

There may be a parentlister object in situations where there is no longer a parenttab object. For example, if the tab was closed since the viewer opened, or if a request to open an image from something other than a folder tab was received by the viewer, then there will no longer be a parenttab but the parentlister property will persist.

This property is a snapshot of the situation when the Viewer scripting object was created; it won't change in reaction to script actions.

parentlisterlinked

bool

Returns True if the viewer is in Lister-Linked mode with the parent Lister. This means the viewer acts like a detached preview pane, displaying each file as it is selected in the Lister.

This property is a snapshot of the situation when the Viewer scripting object was created; it won't change in reaction to script actions.

parenttab

This property is a snapshot of the situation when the Viewer scripting object was created; it won't change in reaction to script actions.

right

int

Returns the right coordinate of the viewer window.

selection

title

string

Returns or sets the title bar string for the viewer window.

You can use several special "tokens" in the title string to insert various pieces of information:

int

Returns the top coordinate of the viewer window.

%P

full path of the currently viewed image

%N

name of the current displayed image

%R

drive root of the current image

%E

displays * if the image's metadata has been modified and not saved

%I

current image's index (number) in the list of images

%O

total number of images in the list

%W

width of the current image

%H

height of the current image

%D

depth of the current image (bits per pixel)

%M

current image's dimensions

%S

file size on disk

%F

folder name

%C

%L

%T

original title (useful for simply adding a prefix or suffix to the title)

%%%%%%

insert a literal % character

top

Method Name

Arguments

Return Type

Description

AddFile

<string:filepath> <int:index>

none

Command

none

IsOnCurrentDesktop

none

bool

Returns True if the viewer is on the current virtual desktop.

MoveToDesktop

<string:desktop>

bool

Moves the viewer window to the specified virtual desktop. Returns True if successful.

RemoveFile

<int:index> or <string:filepath>

none

SetTaskbarGroup

<string:group>

bool

Used to change how the viewer window is grouped with other Opus windows on the taskbar. Specify a group name to move the window into an alternative group, or omit the group argument to reset back to the default group. If one or more windows are moved into the same group, they will be grouped together, separate from other the default group.

This only works when taskbar grouping is enabled. Group names are limited to 103 characters and will be truncated if longer. Spaces and dots in group names are automatically converted to underscores.

Returns true on success.

最后更新于