atk/atkimage.c

   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 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.
   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  * Lesser General Public License for more details.
  13  *
  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.
  18  */
  19
  20 #include "atkimage.h"
  21
  22 GType
  23 atk_image_get_type ()
  24 {
  25   static GType type = 0;
  26
  27   if (!type) {
  28     static const GTypeInfo tinfo =
  29     {
  30       sizeof (AtkImageIface),
  31       (GBaseInitFunc) NULL,
  32       (GBaseFinalizeFunc) NULL,
  33
  34     };
  35
  36     type = g_type_register_static (G_TYPE_INTERFACE, "AtkImage", &tinfo, 0);
  37   }
  38
  39   return type;
  40 }
  41
  42 /**
  43  * atk_image_get_image_description:
  44  * @image: a #GObject instance that implements AtkImageIface
  45  *
  46  * Get a textual description of this image.
  47  *
  48  * Returns: a string representing the image description
  49  **/
  50 G_CONST_RETURN gchar*
  51 atk_image_get_image_description (AtkImage *image)
  52 {
  53   AtkImageIface *iface;
  54
  55   g_return_val_if_fail (image != NULL, NULL);
  56   g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
  57
  58   iface = ATK_IMAGE_GET_IFACE (image);
  59
  60   if (iface->get_image_description)
  61     {
  62       return (iface->get_image_description) (image);
  63     }
  64   else
  65     {
  66       return NULL;
  67     }
  68 }
  69
  70 /**
  71  * atk_image_get_image_size:
  72  * @image: a #GObject instance that implements AtkImageIface
  73  * @height: filled with the image height
  74  * @width: filled with the image width
  75  *
  76  * Get the height and width in pixels for the specified image.
  77  **/
  78 void
  79 atk_image_get_image_size (AtkImage *image, int *height, int *width)
  80 {
  81   AtkImageIface *iface;
  82
  83   g_return_if_fail (image != NULL);
  84   g_return_if_fail (ATK_IS_IMAGE (image));
  85
  86   iface = ATK_IMAGE_GET_IFACE (image);
  87
  88   if (iface->get_image_size)
  89     iface->get_image_size (image, height, width);
  90 }
  91
  92 /**
  93  * atk_image_set_image_description:
  94  * @image: a #GObject instance that implements AtkImageIface
  95  * @description: a string description to set for @image
  96  *
  97  * Sets the textual description for this image.
  98  *
  99  * Returns: boolean TRUE, or FALSE if operation could
 100  * not be completed.
 101  **/
 102 gboolean
 103 atk_image_set_image_description (AtkImage        *image,
 104                               const gchar     *description)
 105 {
 106   AtkImageIface *iface;
 107
 108   g_return_val_if_fail (image != NULL, FALSE);
 109   g_return_val_if_fail (ATK_IS_IMAGE (image), FALSE);
 110
 111   iface = ATK_IMAGE_GET_IFACE (image);
 112
 113   if (iface->set_image_description)
 114     {
 115       return (iface->set_image_description) (image, description);
 116     }
 117   else
 118     {
 119       return FALSE;
 120     }
 121 }
 122
 123 /**
 124  * atk_image_get_position:
 125  * @image: a #GObject instance that implements AtkImageIface
 126  * @x: address of #gint to put x coordinate position
 127  * @y: address of #gint to put y coordinate position
 128  * @coord_type: specifies whether the coordinates are relative to the screen
 129  * or to the components top level window
 130  *
 131  * Gets the position of the image in the form of a point specifying the
 132  * images top-left corner
 133  **/
 134 void
 135 atk_image_get_position (AtkImage *image,
 136                         gint *x,
 137                         gint *y,
 138                         AtkCoordType coord_type)
 139 {
 140   AtkImageIface *iface;
 141
 142   g_return_if_fail (image != NULL);
 143   g_return_if_fail (ATK_IS_IMAGE (image));
 144
 145   iface = ATK_IMAGE_GET_IFACE (image);
 146
 147   if (iface->get_position)
 148     (iface->get_position) (image, x, y, coord_type);
 149 }
 150
 151
 152
 153
 154
 155