AtkImage

Name

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

Synopsis



struct      AtkImage;
struct      AtkImageIface;
G_CONST_RETURN gchar* atk_image_get_image_description
                                            (AtkImage *image);
gboolean    atk_image_set_image_description (AtkImage *image,
                                             const gchar *description);

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;

  AtkImageType     (*get_storage_type)              (AtkImage              *image);
  G_CONST_RETURN   gchar* ( *get_image_description) (AtkImage              *image);
  gint     ( *get_image_height)      (AtkImage              *image);
  gint     ( *get_image_width)       (AtkImage              *image);
  gboolean ( *set_image_description) (AtkImage              *image,
                                      const gchar           *description);

};


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.