AtkImage

Name

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

Synopsis



struct      AtkImage;
struct      AtkImageIface;
enum        AtkImageType;
AtkImageType atk_image_get_storage_type     (AtkImage *image);
G_CONST_RETURN gchar* atk_image_get_image_description
                                            (AtkImage *image);
gint        atk_image_get_image_height      (AtkImage *image);
gint        atk_image_get_image_width       (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);

};


enum AtkImageType

typedef enum
{
  ATK_IMAGE_EMPTY,
  ATK_IMAGE_PIXMAP,
  ATK_IMAGE_IMAGE,
  ATK_IMAGE_PIXBUF,
  ATK_IMAGE_STOCK,
  ATK_IMAGE_ICON_SET
} AtkImageType;

The representation being used to store the image data


atk_image_get_storage_type ()

AtkImageType atk_image_get_storage_type     (AtkImage *image);

Gets the type of representation being used to store image data

image : a GObject instance that implements AtkImageIface
Returns : an AtkStorageType representing the image storage type


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_get_image_height ()

gint        atk_image_get_image_height      (AtkImage *image);

Get the height, in pixels/screen coords, of this image.

image : a GObject instance that implements AtkImageIface
Returns : an integer representing the image height in pixel coords


atk_image_get_image_width ()

gint        atk_image_get_image_width       (AtkImage *image);

Get the width, in pixel/screen coords, of this image.

image : a GObject instance that implements AtkImageIface
Returns : an integer representing the image width


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 desciption to set for image
Returns : boolean TRUE, or FALSE if operation could not be completed.