1/* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
3 *
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.
8 *
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.
13 *
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.
18 */
19
20#ifndef __ATK_IMAGE_H__
21#define __ATK_IMAGE_H__
22
23#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
24#error "Only <atk/atk.h> can be included directly."
25#endif
26
27#include <atk/atkobject.h>
28#include <atk/atkutil.h>
29
30G_BEGIN_DECLS
31
32/*
33 * The AtkImage interface should be supported by any object that has an
34 * associated image. This interface provides the standard mechanism for
35 * an assistive technology to get descriptive information about images.
36 */
37
38#define ATK_TYPE_IMAGE (atk_image_get_type ())
39#define ATK_IS_IMAGE(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMAGE)
40#define ATK_IMAGE(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMAGE, AtkImage)
41#define ATK_IMAGE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMAGE, AtkImageIface))
42
43#ifndef _TYPEDEF_ATK_IMAGE_
44#define _TYPEDEF_ATK_IMAGE_
45typedef struct _AtkImage AtkImage;
46#endif
47typedef struct _AtkImageIface AtkImageIface;
48
49struct _AtkImageIface
50{
51 GTypeInterface parent;
52 void ( *get_image_position) (AtkImage *image,
53 gint *x,
54 gint *y,
55 AtkCoordType coord_type);
56 const gchar* ( *get_image_description) (AtkImage *image);
57 void ( *get_image_size) (AtkImage *image,
58 gint *width,
59 gint *height);
60 gboolean ( *set_image_description) (AtkImage *image,
61 const gchar *description);
62 const gchar* ( *get_image_locale) (AtkImage *image);
63};
64
65ATK_AVAILABLE_IN_ALL
66GType atk_image_get_type (void);
67
68ATK_AVAILABLE_IN_ALL
69const gchar* atk_image_get_image_description (AtkImage *image);
70
71ATK_AVAILABLE_IN_ALL
72void atk_image_get_image_size (AtkImage *image,
73 gint *width,
74 gint *height);
75
76ATK_AVAILABLE_IN_ALL
77gboolean atk_image_set_image_description (AtkImage *image,
78 const gchar *description);
79ATK_AVAILABLE_IN_ALL
80void atk_image_get_image_position (AtkImage *image,
81 gint *x,
82 gint *y,
83 AtkCoordType coord_type);
84
85ATK_AVAILABLE_IN_ALL
86const gchar* atk_image_get_image_locale (AtkImage *image);
87
88G_END_DECLS
89
90#endif /* __ATK_IMAGE_H__ */
91