cspi/spi_action.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include <cspi/spi-private.h>
  25
  26 /**
  27  * AccessibleAction_ref:
  28  * @obj: a pointer to the #AccessibleAction on which to operate.
  29  *
  30  * Increment the reference count for an #AccessibleAction.
  31  **/
  32 void
  33 AccessibleAction_ref (AccessibleAction *obj)
  34 {
  35   cspi_object_ref (obj);
  36 }
  37
  38 /**
  39  * AccessibleAction_unref:
  40  * @obj: a pointer to the #AccessibleAction on which to operate.
  41  *
  42  * Decrement the reference count for an #AccessibleAction.
  43  **/
  44 void
  45 AccessibleAction_unref (AccessibleAction *obj)
  46 {
  47   cspi_object_unref (obj);
  48 }
  49
  50 /**
  51  * AccessibleAction_getNActions:
  52  * @obj: a pointer to the #AccessibleAction to query.
  53  *
  54  * Get the number of actions invokable on an #AccessibleAction implementor.
  55  *
  56  * Returns: a #long integer indicatin the number of invokable actions.
  57  **/
  58 long
  59 AccessibleAction_getNActions (AccessibleAction *obj)
  60 {
  61   long retval;
  62
  63   cspi_return_val_if_fail (obj != NULL, -1);
  64
  65   retval =
  66     Accessibility_Action__get_nActions (CSPI_OBJREF (obj), cspi_ev ());
  67
  68   cspi_return_val_if_ev ("getNActions", -1);
  69
  70   return retval;
  71 }
  72
  73 /**
  74  * AccessibleAction_getDescription:
  75  * @obj: a pointer to the #AccessibleAction implementor to query.
  76  * @i: a long integer indicating which action to query.
  77  *
  78  * Get the description of '@i-th' action invokable on an
  79  *      object implementing #AccessibleAction.
  80  *
  81  * Returns: a UTF-8 string describing the '@i-th' invokable action.
  82  **/
  83 char *
  84 AccessibleAction_getDescription (AccessibleAction *obj,
  85                                  long int          i)
  86 {
  87   char *retval;
  88   cspi_return_val_if_fail (obj != NULL, NULL);
  89
  90   retval =
  91     Accessibility_Action_getDescription (CSPI_OBJREF (obj),
  92                                          i,
  93                                          cspi_ev ());
  94
  95   cspi_return_val_if_ev ("getDescription", NULL);
  96
  97   return retval;
  98 }
  99
 100 /**
 101  * AccessibleAction_getKeyBinding:
 102  * @obj: a pointer to the #AccessibleAction implementor to query.
 103  * @i: a long integer indicating which action to query.
 104  *
 105  * Get the keybindings for the @i-th action invokable on an
 106  *      object implementing #AccessibleAction, if any are defined.
 107  *
 108  * Returns: a UTF-8 string which can be parsed to determine the @i-th
 109  *       invokable action's keybindings.
 110  **/
 111 char *
 112 AccessibleAction_getKeyBinding (AccessibleAction *obj,
 113                                 long int          i)
 114 {
 115   char *retval;
 116
 117   cspi_return_val_if_fail (obj != NULL, NULL);
 118
 119   retval =
 120     Accessibility_Action_getKeyBinding (CSPI_OBJREF (obj),
 121        i,
 122        cspi_ev ());
 123
 124   cspi_return_val_if_ev ("getKeyBinding", NULL);
 125
 126   return retval;
 127 }
 128
 129 /**
 130  * AccessibleAction_getName:
 131  * @obj: a pointer to the #AccessibleAction implementor to query.
 132  * @i: a long integer indicating which action to query.
 133  *
 134  * Get the name of the '@i-th' action invokable on an
 135  *      object implementing #AccessibleAction.
 136  *
 137  * Returns: the 'event type' name of the action, as a UTF-8 string.
 138  **/
 139 char *
 140 AccessibleAction_getName (AccessibleAction *obj,
 141                           long int          i)
 142 {
 143   char *retval;
 144
 145   cspi_return_val_if_fail (obj != NULL, NULL);
 146
 147   retval =
 148    Accessibility_Action_getName (CSPI_OBJREF (obj),
 149                                  i,
 150                                  cspi_ev ());
 151
 152   cspi_return_val_if_ev ("getName", NULL);
 153
 154   return retval;
 155 }
 156
 157 /**
 158  * AccessibleAction_doAction:
 159  * @obj: a pointer to the #AccessibleAction to query.
 160  * @i: an integer specifying which action to invoke.
 161  *
 162  * Invoke the action indicated by #index.
 163  *
 164  * Returns: #TRUE if the action is successfully invoked, otherwise #FALSE.
 165  **/
 166 SPIBoolean
 167 AccessibleAction_doAction (AccessibleAction *obj,
 168                            long int i)
 169 {
 170   SPIBoolean retval;
 171
 172   cspi_return_val_if_fail (obj != NULL, FALSE);
 173
 174   retval = Accessibility_Action_doAction (CSPI_OBJREF (obj),
 175                                    i,
 176                                    cspi_ev ());
 177
 178   cspi_return_val_if_ev ("doAction", FALSE);
 179
 180   return retval;
 181 }