Picture - KstScript Documentation

Picture

A customizable picture object.

Inherits: BorderedViewObject

Constructors:

Methods:

Properties:

Collection class: ViewObjectCollection

Picture ( ViewObject parent )

ViewObject parent - The parent to place the new picture in. May also be a string containing the name of an existing ViewObject.

Creates a new picture and places it in the ViewObject parent.

Picture ( Window window )

Window window - The window to place the new picture in. May also be a string containing the name of an existing Window.

Creates a new picture and places it in the Window window.

boolean load ( string url )

string url - The URL to retrieve the image from.

Load an image from a give url. Returns true on success.

Image image

The raw image that is being displayed. You can take a copy of this, manipulate it, then set it back to change the image.

string url [Read-Only]

The URL of the image if it was loaded from a file and has not been modified.

number refreshTimer

A timer to automatically refresh the picture. Value of 0 means the timer is disabled. Units are in seconds.