cspi/spi_application.c

   1 /*
   2  *
   3  * AccessibleApplication function prototypes
   4  *
   5  */
   6
   7 #include <cspi/spi-private.h>
   8
   9 /**
  10  * AccessibleApplication_ref:
  11  * @obj: a pointer to the #AccessibleApplication on which to operate.
  12  *
  13  * Increment the reference count for an #AccessibleApplication.
  14  *
  15  **/
  16 void
  17 AccessibleApplication_ref (AccessibleApplication *obj)
  18 {
  19   cspi_object_ref (obj);
  20 }
  21
  22 /**
  23  * AccessibleApplication_unref:
  24  * @obj: a pointer to the #AccessibleApplication object on which to operate.
  25  *
  26  * Decrement the reference count for an #AccessibleApplication.
  27  *
  28  **/
  29 void
  30 AccessibleApplication_unref (AccessibleApplication *obj)
  31 {
  32   cspi_object_unref (obj);
  33 }
  34
  35 /**
  36  * AccessibleApplication_getToolkitName:
  37  * @obj: a pointer to the #AccessibleApplication to query.
  38  *
  39  * Get the name of the UI toolkit used by an #AccessibleApplication.
  40  *
  41  * Returns: a UTF-8 string indicating which UI toolkit is
  42  *          used by an application.
  43  **/
  44 char *
  45 AccessibleApplication_getToolkitName (AccessibleApplication *obj)
  46 {
  47   char *retval;
  48
  49   cspi_return_val_if_fail (obj != NULL, NULL);
  50
  51   retval =
  52     Accessibility_Application__get_toolkitName (CSPI_OBJREF (obj),
  53                                                 cspi_ev ());
  54
  55   cspi_return_val_if_ev ("toolkitName", NULL);
  56
  57   return retval;
  58 }
  59
  60 /**
  61  * AccessibleApplication_getVersion:
  62  * @obj: a pointer to the #AccessibleApplication being queried.
  63  *
  64  * Get the version of the at-spi bridge exported by an
  65  *      #AccessibleApplication instance.
  66  *
  67  * Returns: a UTF-8 string indicating the application's
  68  *          at-spi version.
  69  **/
  70 char *
  71 AccessibleApplication_getVersion (AccessibleApplication *obj)
  72 {
  73   char *retval;
  74
  75   cspi_return_val_if_fail (obj != NULL, NULL);
  76
  77   retval =
  78     Accessibility_Application__get_version (CSPI_OBJREF (obj),
  79                                             cspi_ev ());
  80
  81   cspi_return_val_if_ev ("getVersion", NULL);
  82
  83   return retval;
  84 }
  85
  86 /**
  87  * AccessibleApplication_getID:
  88  * @obj: a pointer to the #AccessibleApplication being queried.
  89  *
  90  * Get the unique ID assigned by the Registry to an
  91  *      #AccessibleApplication instance.
  92  * (Not Yet Implemented by the registry).
  93  *
  94  * Returns: a unique #long integer associated with the application
  95  *          by the Registry, or 0 if the application is not registered.
  96 **/
  97 long
  98 AccessibleApplication_getID (AccessibleApplication *obj)
  99 {
 100   long retval;
 101
 102   cspi_return_val_if_fail (obj != NULL, 0);
 103
 104   retval = Accessibility_Application__get_id (CSPI_OBJREF (obj),
 105                                               cspi_ev ());
 106
 107   cspi_return_val_if_ev ("get_id", 0);
 108
 109   return retval;
 110 }
 111
 112 /**
 113  * AccessibleApplication_pause:
 114  * @obj: a pointer to the #Accessible object on which to operate.
 115  *
 116  * Attempt to pause the application (used when client event queue is
 117  *  over-full).
 118  * Not Yet Implemented.
 119  *
 120  * Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
 121  *
 122  **/
 123 SPIBoolean
 124 AccessibleApplication_pause (AccessibleApplication *obj)
 125 {
 126   return FALSE;
 127 }
 128
 129 /**
 130  * AccessibleApplication_resume:
 131  * @obj: a pointer to the #Accessible object on which to operate.
 132  *
 133  * Attempt to resume the application (used after #AccessibleApplication_pause).
 134  * Not Yet Implemented.
 135  *
 136  * Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
 137  *
 138  **/
 139 SPIBoolean
 140 AccessibleApplication_resume (AccessibleApplication *obj)
 141 {
 142   return FALSE;
 143 }