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 Lesser 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser 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.
25 static GType type = 0;
28 static const GTypeInfo tinfo =
30 sizeof (AtkImageIface),
32 (GBaseFinalizeFunc) NULL,
36 type = g_type_register_static (G_TYPE_INTERFACE, "AtkImage", &tinfo, 0);
43 * atk_image_get_image_description:
44 * @image: a #GObject instance that implements AtkImageIface
46 * Get a textual description of this image.
48 * Returns: a string representing the image description
51 atk_image_get_image_description (AtkImage *image)
55 g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
57 iface = ATK_IMAGE_GET_IFACE (image);
59 if (iface->get_image_description)
61 return (iface->get_image_description) (image);
70 * atk_image_get_image_size:
71 * @image: a #GObject instance that implements AtkImageIface
72 * @width: filled with the image width
73 * @height: filled with the image height
75 * Get the wdith and height in pixels for the specified image.
76 * The values of @width and @height are returned as -1 if the
77 * values cannot be obtained.
80 atk_image_get_image_size (AtkImage *image,
85 gint local_width, local_height;
86 gint *real_width, *real_height;
88 g_return_if_fail (ATK_IS_IMAGE (image));
93 real_width = &local_width;
97 real_height = &local_height;
99 iface = ATK_IMAGE_GET_IFACE (image);
101 if (iface->get_image_size)
103 iface->get_image_size (image, real_width, real_height);
113 * atk_image_set_image_description:
114 * @image: a #GObject instance that implements AtkImageIface
115 * @description: a string description to set for @image
117 * Sets the textual description for this image.
119 * Returns: boolean TRUE, or FALSE if operation could
123 atk_image_set_image_description (AtkImage *image,
124 const gchar *description)
126 AtkImageIface *iface;
128 g_return_val_if_fail (ATK_IS_IMAGE (image), FALSE);
130 iface = ATK_IMAGE_GET_IFACE (image);
132 if (iface->set_image_description)
134 return (iface->set_image_description) (image, description);
143 * atk_image_get_image_position:
144 * @image: a #GObject instance that implements AtkImageIface
145 * @x: address of #gint to put x coordinate position
146 * @y: address of #gint to put y coordinate position
147 * @coord_type: specifies whether the coordinates are relative to the screen
148 * or to the components top level window
150 * Gets the position of the image in the form of a point specifying the
151 * images top-left corner. The values of @x and @y are returned as -1
152 * if the values cannot be obtained.
155 atk_image_get_image_position (AtkImage *image,
158 AtkCoordType coord_type)
160 AtkImageIface *iface;
161 gint local_x, local_y;
162 gint *real_x, *real_y;
164 g_return_if_fail (ATK_IS_IMAGE (image));
175 iface = ATK_IMAGE_GET_IFACE (image);
177 g_return_if_fail (ATK_IS_IMAGE (image));
179 iface = ATK_IMAGE_GET_IFACE (image);
181 if (iface->get_image_position)
183 (iface->get_image_position) (image, real_x, real_y, coord_type);