Interface

Atk-1.0 ▶ Atk ▶ Image ▶ Interface

Interface for implementing Image. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_image_description(): string;
    vfunc_get_image_locale(): string;
    vfunc_get_image_position(coord_type: Atk.CoordType): [number, number];
    vfunc_get_image_size(): [number, number];
    vfunc_set_image_description(description: string): boolean;
}

Hierarchy (View Summary)

Index

Methods

vfunc_get_image_description vfunc_get_image_locale vfunc_get_image_position vfunc_get_image_size vfunc_set_image_description

Methods

  • Gets the position of the image in the form of a point specifying the images top-left corner.

    If the position can not be obtained (e.g. missing support), x and y are set to -1.

    Parameters

    • coord_type: Atk.CoordType

      specifies whether the coordinates are relative to the screen or to the components top level window

    Returns [number, number]

  • Get the width and height in pixels for the specified image. The values of width and height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen).

    If the size can not be obtained (e.g. missing support), x and y are set to -1.

    Returns [number, number]

  • Sets the textual description for this image.

    Parameters

    • description: string

      a string description to set for image

    Returns boolean