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