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