Module: Atk::Image

Defined in:

(unknown)

Overview

Atk::Image should be implemented by #AtkObject subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement Atk::Image.

Atk::Image primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.

Instance Method Summary

• #get_image_description(image) ⇒ String

  A string representing the image description.

• #get_image_locale(image) ⇒ String

  A string corresponding to the POSIX ‘LC_MESSAGES` locale used by the image description, or nil if the image does not specify a locale.

• #get_image_position(image, x, y, coord_type) ⇒ nil

  or to the components top level window.

• #get_image_size(image, width, height) ⇒ nil
• #image_description ⇒ String

  Get a textual description of this image.

• #image_description=(description) ⇒ TrueClass

  Sets the textual description for this image.

• #image_locale ⇒ String

  Retrieves the locale identifier associated to the Atk::Image.

• #set_image_description(image, description) ⇒ TrueClass

  not be completed.

Instance Method Details

#get_image_description(image) ⇒ String

Returns a string representing the image description.

Parameters:

• image (Atk::Image) —

  a #GObject instance that implements AtkImageIface

Returns:

• (String) —

  a string representing the image description

#get_image_locale(image) ⇒ String

Returns a string corresponding to the POSIX ‘LC_MESSAGES` locale used by the image description, or nil if the image does not specify a locale.

Parameters:

• image (Atk::Image) —

  An Atk::Image

Returns:

• (String) —

  a string corresponding to the POSIX ‘LC_MESSAGES` locale used by the image description, or nil if the image does not specify a locale.

#get_image_position(image, x, y, coord_type) ⇒ nil

or to the components top level window

Parameters:

• image (Atk::Image) —

  a #GObject instance that implements AtkImageIface

• x (Integer) —

  address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.

• y (Integer) —

  address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.

• coord_type (Atk::CoordType) —

  specifies whether the coordinates are relative to the screen

Returns:

• (nil)

#get_image_size(image, width, height) ⇒ nil

Parameters:

• image (Atk::Image) —

  a #GObject instance that implements AtkImageIface

• width (Integer) —

  filled with the image width, or -1 if the value cannot be obtained.

• height (Integer) —

  filled with the image height, or -1 if the value cannot be obtained.

Returns:

• (nil)

#image_description ⇒ String

Get a textual description of this image.

Returns:

• (String) —

  a string representing the image description

#image_description=(description) ⇒ TrueClass

Sets the textual description for this image. not be completed.

Parameters:

• description (String) —

  a string description to set for image

Returns:

• (TrueClass) —

  boolean TRUE, or FALSE if operation could

#image_locale ⇒ String

Retrieves the locale identifier associated to the Atk::Image.

Returns:

• (String) —

  a string corresponding to the POSIX ‘LC_MESSAGES` locale used by the image description, or nil if the image does not specify a locale.

#set_image_description(image, description) ⇒ TrueClass

not be completed.

Parameters:

• image (Atk::Image) —

  a #GObject instance that implements AtkImageIface

• description (String) —

  a string description to set for image

Returns:

• (TrueClass) —

  boolean TRUE, or FALSE if operation could