2001-11-13 Michael Meeks <michael@ximian.com>
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_application.c
1
2 /*
3  *
4  * SpiAccessibleApplication function prototypes
5  *
6  */
7
8 /**
9  * SpiAccessibleApplication_ref:
10  * @obj: a pointer to the #AccessibleApplication on which to operate.
11  *
12  * Increment the reference count for an #AccessibleApplication.
13  *
14  * Returns: (no return code implemented yet).
15  *
16  **/
17 int
18 SpiAccessibleApplication_ref (SpiAccessibleApplication *obj)
19 {
20   Accessibility_Application_ref (*obj, &ev);
21   return 0;
22 }
23
24 /**
25  * SpiAccessibleApplication_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 int
34 SpiAccessibleApplication_unref (SpiAccessibleApplication *obj)
35 {
36   Accessibility_Application_unref (*obj, &ev);
37   return 0;
38 }
39
40 /**
41  * SpiAccessibleApplication_getToolkitName:
42  * @obj: a pointer to the #AccessibleApplication to query.
43  *
44  * Get the name of the UI toolkit used by an #AccessibleApplication.
45  *
46  * Returns: a UTF-8 string indicating which UI toolkit is
47  *          used by an application.
48  *
49  **/
50 char *
51 SpiAccessibleApplication_getToolkitName (SpiAccessibleApplication *obj)
52 {
53   return Accessibility_Application__get_toolkitName (*obj, &ev);
54 }
55
56 /**
57  * SpiAccessibleApplication_getVersion:
58  * @obj: a pointer to the #AccessibleApplication being queried.
59  *
60  * Get the version of the at-spi bridge exported by an
61  *      #AccessibleApplication instance.
62  *
63  * Returns: a UTF-8 string indicating the application's
64  *          at-spi version.
65  *
66  **/
67 char *
68 SpiAccessibleApplication_getVersion (SpiAccessibleApplication *obj)
69 {
70   return Accessibility_Application__get_version (*obj, &ev);
71 }
72
73 /**
74  * SpiAccessibleApplication_getID:
75  * @obj: a pointer to the #AccessibleApplication being queried.
76  *
77  * Get the unique ID assigned by the SpiRegistry to an
78  *      #AccessibleApplication instance.
79  * (Not Yet Implemented by the registry).
80  *
81  * Returns: a unique #long integer associated with the application
82  *          by the SpiRegistry, or 0 if the application is not registered.
83 long
84 SpiAccessibleApplication_getID (SpiAccessibleApplication *obj)
85 {
86   return Accessibility_Application__get_id (*obj, &ev);
87 }
88
89 /**
90  * SpiAccessibleApplication_pause:
91  *
92  * Attempt to pause the application (used when client event queue is
93  *  over-full).
94  * Not Yet Implemented.
95  *
96  * Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
97  *
98  **/
99 boolean
100 SpiAccessibleApplication_pause (SpiAccessibleApplication *obj)
101 {
102   return FALSE;
103 }
104
105 /**
106  * SpiAccessibleApplication_resume:
107  *
108  * Attempt to resume the application (used after #AccessibleApplication_pause).
109  * Not Yet Implemented.
110  *
111  * Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
112  *
113  **/
114 boolean
115 SpiAccessibleApplication_resume (SpiAccessibleApplication *obj)
116 {
117   return FALSE;
118 }
119
120