Added additional documentation and fixed a couple of latent bugs.
[platform/upstream/at-spi2-core.git] / cspi / spi_image.c
1 /**
2  * AccessibleImage_ref:
3  * @obj: a pointer to the #AccessibleImage implementor on which to operate.
4  *
5  * Increment the reference count for an #AccessibleImage object.
6  *
7  * Returns: (no return code implemented yet).
8  *
9  **/
10 int
11 AccessibleImage_ref (AccessibleImage *obj)
12 {
13   Accessibility_Image_ref (*obj, &ev);
14   return 0;
15 }
16
17
18
19 /**
20  * AccessibleImage_unref:
21  * @obj: a pointer to the #AccessibleImage implementor on which to operate.
22  *
23  * Decrement the reference count for an #AccessibleImage object.
24  *
25  * Returns: (no return code implemented yet).
26  *
27  **/
28 int
29 AccessibleImage_unref (AccessibleImage *obj)
30 {
31   Accessibility_Image_unref (*obj, &ev);
32   return 0;
33 }
34
35
36 /**
37  * AccessibleImage_getImageDescription:
38  * @obj: a pointer to the #AccessibleImage implementor on which to operate.
39  *
40  * Get the description of the image displayed in an #AccessibleImage object.
41  *
42  * Returns: a UTF-8 string describing the image.
43  *
44  **/
45 char *
46 AccessibleImage_getImageDescription (AccessibleImage *obj)
47 {
48   return (char *)
49     Accessibility_Image__get_imageDescription (*obj, &ev);
50 }
51
52
53
54 /**
55  * AccessibleImage_getImageSize:
56  * @obj: a pointer to the #AccessibleImage to query.
57  * @width: a pointer to a #long into which the x extents (width) will be returned.
58  * @height: a pointer to a #long into which the y extents (height) will be returned.
59  *
60  * Get the size of the image displayed in a specified #AccessibleImage object.
61  *
62  **/
63 void
64 AccessibleImage_getImageSize (AccessibleImage *obj,
65                               long int *width,
66                               long int *height)
67 {
68   Accessibility_Image_getImageSize (*obj,
69                                     (CORBA_long *) width, (CORBA_long *) height, &ev);
70 }
71
72
73
74 /**
75  * AccessibleImage_getImagePosition:
76  * @obj: a pointer to the #AccessibleImage implementor to query.
77  * @x: a pointer to a #long into which the minimum x coordinate will be returned.
78  * @y: a pointer to a #long into which the minimum y coordinate will be returned.
79  * @ctype: the desired coordinate system into which to return the results,
80  *         (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
81  *
82  * Get the minimum x and y coordinates of the image displayed in a
83  *         specified #AccessibleImage implementor.
84  *
85  **/
86 void
87 AccessibleImage_getImagePosition (AccessibleImage *obj,
88                                   long *x,
89                                   long *y,
90                                   AccessibleCoordType ctype)
91 {
92   Accessibility_Image_getImagePosition (*obj,
93                                         (CORBA_long *) x, (CORBA_long *) y, (CORBA_short) ctype,
94                                         &ev);
95 }