AtkImage

Name

AtkImage -- accessibility interface for objects that have an associated image

Synopsis



struct      AtkImage;
struct      AtkImageIface;
void        atk_image_get_image_position    (AtkImage *image,
                                             gint *x,
                                             gint *y,
                                             AtkCoordType coord_type);
G_CONST_RETURN gchar* atk_image_get_image_description
                                            (AtkImage *image);
gboolean    atk_image_set_image_description (AtkImage *image,
                                             const gchar *description);
void        atk_image_get_image_size        (AtkImage *image,
                                             gint *width,
                                             gint *height);

Description

The AtkImage interface should be supported by any object that has an associated image. This interface provides the standard mechanism for an assistive technology to get descriptive information about images.

Details

struct AtkImage

struct AtkImage;


struct AtkImageIface

struct AtkImageIface
{
  GTypeInterface parent;
  void          	( *get_image_position)    (AtkImage		 *image,
                                                   gint                  *x,
				                   gint	                 *y,
    			                           AtkCoordType	         coord_type);
  G_CONST_RETURN gchar* ( *get_image_description) (AtkImage              *image);
  void                  ( *get_image_size)        (AtkImage              *image,
                                                   gint                  *width,
                                                   gint                  *height);
  gboolean              ( *set_image_description) (AtkImage              *image,
                                                   const gchar           *description);
};


atk_image_get_image_position ()

void        atk_image_get_image_position    (AtkImage *image,
                                             gint *x,
                                             gint *y,
                                             AtkCoordType coord_type);

Gets the position of the image in the form of a point specifying the images top-left corner. The values of x and y are returned as -1 if the values cannot be obtained.

image : a GObject instance that implements AtkImageIface
x : address of gint to put x coordinate position
y : address of gint to put y coordinate position
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window


atk_image_get_image_description ()

G_CONST_RETURN gchar* atk_image_get_image_description
                                            (AtkImage *image);

Get a textual description of this image.

image : a GObject instance that implements AtkImageIface
Returns : a string representing the image description


atk_image_set_image_description ()

gboolean    atk_image_set_image_description (AtkImage *image,
                                             const gchar *description);

Sets the textual description for this image.

image : a GObject instance that implements AtkImageIface
description : a string description to set for image
Returns : boolean TRUE, or FALSE if operation could not be completed.


atk_image_get_image_size ()

void        atk_image_get_image_size        (AtkImage *image,
                                             gint *width,
                                             gint *height);

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.

image : a GObject instance that implements AtkImageIface
width : filled with the image width
height : filled with the image height