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