atk/atkvalue.c

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001, 2002, 2003 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 <string.h>
  21 #include "atkvalue.h"
  22
  23 GType
  24 atk_value_get_type (void)
  25 {
  26   static GType type = 0;
  27
  28   if (!type) {
  29     GTypeInfo tinfo =
  30     {
  31       sizeof (AtkValueIface),
  32       (GBaseInitFunc) NULL,
  33       (GBaseFinalizeFunc) NULL,
  34
  35     };
  36
  37     type = g_type_register_static (G_TYPE_INTERFACE, "AtkValue", &tinfo, 0);
  38   }
  39
  40   return type;
  41 }
  42
  43 /**
  44  * atk_value_get_current_value:
  45  * @obj: a GObject instance that implements AtkValueIface
  46  * @value: a #GValue representing the current accessible value
  47  *
  48  * Gets the value of this object.
  49  **/
  50 void
  51 atk_value_get_current_value (AtkValue *obj,
  52                              GValue   *value)
  53 {
  54   AtkValueIface *iface;
  55
  56   g_return_if_fail (value != NULL);
  57   g_return_if_fail (ATK_IS_VALUE (obj));
  58
  59   iface = ATK_VALUE_GET_IFACE (obj);
  60
  61   if (iface->get_current_value)
  62     {
  63       if (G_IS_VALUE (value))
  64         g_value_unset (value);
  65       else
  66         memset (value, 0, sizeof (*value));
  67
  68       (iface->get_current_value) (obj, value);
  69     }
  70 }
  71
  72 /**
  73  * atk_value_get_maximum_value:
  74  * @obj: a GObject instance that implements AtkValueIface
  75  * @value: a #GValue representing the maximum accessible value
  76  *
  77  * Gets the maximum value of this object.
  78  **/
  79 void
  80 atk_value_get_maximum_value  (AtkValue *obj,
  81                               GValue   *value)
  82 {
  83   AtkValueIface *iface;
  84
  85   g_return_if_fail (value != NULL);
  86   g_return_if_fail (ATK_IS_VALUE (obj));
  87
  88   iface = ATK_VALUE_GET_IFACE (obj);
  89
  90   if (iface->get_maximum_value)
  91     {
  92       if (G_IS_VALUE (value))
  93         g_value_unset (value);
  94       else
  95         memset (value, 0, sizeof (*value));
  96
  97       (iface->get_maximum_value) (obj, value);
  98     }
  99 }
 100
 101 /**
 102  * atk_value_get_minimum_value:
 103  * @obj: a GObject instance that implements AtkValueIface
 104  * @value: a #GValue representing the minimum accessible value
 105  *
 106  * Gets the minimum value of this object.
 107  **/
 108 void
 109 atk_value_get_minimum_value (AtkValue *obj,
 110                              GValue   *value)
 111 {
 112   AtkValueIface *iface;
 113
 114   g_return_if_fail (value != NULL);
 115   g_return_if_fail (ATK_IS_VALUE (obj));
 116
 117   iface = ATK_VALUE_GET_IFACE (obj);
 118
 119   if (iface->get_minimum_value)
 120     {
 121       if (G_IS_VALUE (value))
 122         g_value_unset (value);
 123       else
 124         memset (value, 0, sizeof (*value));
 125
 126       (iface->get_minimum_value) (obj, value);
 127     }
 128 }
 129
 130 /**
 131  * atk_value_get_minimum_increment:
 132  * @obj: a GObject instance that implements AtkValueIface
 133  * @value: a #GValue representing the minimum increment by which the accessible value may be changed
 134  *
 135  * Gets the minimum increment by which the value of this object may be changed.  If zero,
 136  * the minimum increment is undefined, which may mean that it is limited only by the
 137  * floating point precision of the platform.
 138  *
 139  * Since: ATK 1.12
 140  **/
 141 void
 142 atk_value_get_minimum_increment (AtkValue *obj,
 143                              GValue   *value)
 144 {
 145   AtkValueIface *iface;
 146
 147   g_return_if_fail (value != NULL);
 148   g_return_if_fail (ATK_IS_VALUE (obj));
 149
 150   iface = ATK_VALUE_GET_IFACE (obj);
 151
 152   if (iface->get_minimum_increment)
 153     {
 154       if (G_IS_VALUE (value))
 155         g_value_unset (value);
 156       else
 157         memset (value, 0, sizeof (*value));
 158
 159       (iface->get_minimum_increment) (obj, value);
 160     }
 161 }
 162
 163 /**
 164  * atk_value_set_current_value:
 165  * @obj: a GObject instance that implements AtkValueIface
 166  * @value: a #GValue which is the desired new accessible value.
 167  *
 168  * Sets the value of this object.
 169  *
 170  * Returns: %TRUE if new value is successfully set, %FALSE otherwise.
 171  **/
 172 gboolean
 173 atk_value_set_current_value (AtkValue       *obj,
 174                              const GValue   *value)
 175 {
 176   AtkValueIface *iface;
 177
 178   g_return_val_if_fail (ATK_IS_VALUE (obj), FALSE);
 179   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
 180
 181   iface = ATK_VALUE_GET_IFACE (obj);
 182
 183   if (iface->set_current_value)
 184     return (iface->set_current_value) (obj, value);
 185   else
 186     return FALSE;
 187 }