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