1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef __ATK_IMAGE_H__
21 #define __ATK_IMAGE_H__
23 #include <atk/atkobject.h>
27 #endif /* __cplusplus */
30 * The AtkImage interface should be supported by any object that has an
31 * associated image. This interface provides the standard mechanism for
32 * an assistive technology to get descriptive information about images.
35 #define ATK_TYPE_IMAGE (atk_image_get_type ())
36 #define ATK_IS_IMAGE(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMAGE)
37 #define ATK_IMAGE(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMAGE, AtkImage)
38 #define ATK_IMAGE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMAGE, AtkImageIface))
40 #ifndef _TYPEDEF_ATK_IMAGE_
41 #define _TYPEDEF_ATK_IMAGE_
42 typedef struct _AtkImage AtkImage;
57 GTypeInterface parent;
60 * Gets the type of representation being used to store image data
62 AtkImageType (*get_storage_type) (AtkImage *image);
64 * Gets the description of the image
66 G_CONST_RETURN gchar* ( *get_image_description) (AtkImage *image);
68 * Gets the height of the image
70 gint ( *get_image_height) (AtkImage *image);
72 * Gets the width of the image
74 gint ( *get_image_width) (AtkImage *image);
76 * Sets the description of the image
78 void ( *set_image_description) (AtkImage *image,
79 const gchar *description);
82 GType atk_image_get_type (void);
84 AtkImageType atk_image_get_storage_type (AtkImage *image);
85 G_CONST_RETURN gchar* atk_image_get_image_description (AtkImage *image);
87 gint atk_image_get_image_height (AtkImage *image);
89 gint atk_image_get_image_width (AtkImage *image);
91 void atk_image_set_image_description (AtkImage *image,
92 const gchar *description);
97 #endif /* __cplusplus */
100 #endif /* __ATK_IMAGE_H__ */