atk/atkvalue.h

   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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_VALUE_H__
  25 #define __ATK_VALUE_H__
  26
  27 #include <atk/atkobject.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /*
  32  * The AtkValue interface should be supported by any object that
  33  * supports a numerical value (e.g., a scroll bar). This interface
  34  * provides the standard mechanism for an assistive technology to
  35  * determine and set the numerical value as well as get the minimum
  36  * and maximum values.
  37  */
  38
  39 #define ATK_TYPE_VALUE                    (atk_value_get_type ())
  40 #define ATK_IS_VALUE(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_VALUE)
  41 #define ATK_VALUE(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_VALUE, AtkValue)
  42 #define ATK_VALUE_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_VALUE, AtkValueIface))
  43
  44 #ifndef _TYPEDEF_ATK_VALUE_
  45 #define _TYPEDEF_ATK_VALUE__
  46 typedef struct _AtkValue AtkValue;
  47 #endif
  48 typedef struct _AtkValueIface AtkValueIface;
  49
  50 struct _AtkValueIface
  51 {
  52   GTypeInterface parent;
  53
  54   void     (* get_current_value) (AtkValue     *obj,
  55                                   GValue       *value);
  56   void     (* get_maximum_value) (AtkValue     *obj,
  57                                   GValue       *value);
  58   void     (* get_minimum_value) (AtkValue     *obj,
  59                                   GValue       *value);
  60   gboolean (* set_current_value) (AtkValue     *obj,
  61                                   const GValue *value);
  62   void     (* get_minimum_increment) (AtkValue   *obj,
  63                                       GValue     *value);
  64 };
  65
  66 GType            atk_value_get_type (void);
  67
  68 void      atk_value_get_current_value (AtkValue     *obj,
  69                                        GValue       *value);
  70
  71
  72 void     atk_value_get_maximum_value  (AtkValue     *obj,
  73                                        GValue       *value);
  74
  75 void     atk_value_get_minimum_value  (AtkValue     *obj,
  76                                        GValue       *value);
  77
  78 gboolean atk_value_set_current_value  (AtkValue     *obj,
  79                                        const GValue *value);
  80
  81 void     atk_value_get_minimum_increment  (AtkValue     *obj,
  82                                            GValue       *value);
  83
  84 /*
  85  * Additional GObject properties exported by GaccessibleValue:
  86  *    "accessible_value"
  87  *       (the accessible value has changed)
  88  */
  89
  90 G_END_DECLS
  91
  92 #endif /* __ATK_VALUE_H__ */