![]() |
![]() |
![]() |
libatspi Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Known Implementations |
struct AtspiRect; #define ATSPI_TYPE_RECT AtspiRect * atspi_rect_copy (AtspiRect *src
); struct AtspiPoint; #define ATSPI_TYPE_POINT GType atspi_point_get_type (); AtspiPoint * atspi_point_copy (AtspiPoint *src
); GType atspi_component_get_type (); AtspiComponent; gboolean atspi_component_contains (AtspiComponent *obj
,gint x
,gint y
,AtspiCoordType ctype
,GError **error
); AtspiAccessible * atspi_component_get_accessible_at_point (AtspiComponent *obj
,gint x
,gint y
,AtspiCoordType ctype
,GError **error
); AtspiRect * atspi_component_get_extents (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
); AtspiPoint * atspi_component_get_position (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
); AtspiPoint * atspi_component_get_size (AtspiComponent *obj
,GError **error
); AtspiComponentLayer atspi_component_get_layer (AtspiComponent *obj
,GError **error
); gshort atspi_component_get_mdi_z_order (AtspiComponent *obj
,GError **error
); gboolean atspi_component_grab_focus (AtspiComponent *obj
,GError **error
); gdouble atspi_component_get_alpha (AtspiComponent *obj
,GError **error
);
#define ATSPI_TYPE_RECT (atspi_rect_get_type ())
The GType for a boxed type holding a AtspiRect.
#define ATSPI_TYPE_POINT (atspi_point_get_type ())
The GType for a boxed type holding a AtspiPoint.
gboolean atspi_component_contains (AtspiComponent *obj
,gint x
,gint y
,AtspiCoordType ctype
,GError **error
);
Queries whether a given AtspiComponent contains a particular point.
|
a pointer to the AtspiComponent to query. |
|
a gint specifying the x coordinate in question. |
|
a gint specifying the y coordinate in question. |
|
the desired coordinate system of the point (x , y )
(e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN). |
Returns : |
TRUE if the specified component contains the point (x , y ),
FALSE otherwise. |
AtspiAccessible * atspi_component_get_accessible_at_point (AtspiComponent *obj
,gint x
,gint y
,AtspiCoordType ctype
,GError **error
);
Gets the accessible child at a given coordinate within an AtspiComponent.
|
a pointer to the AtspiComponent to query. |
|
a gint specifying the x coordinate of the point in question. |
|
a gint specifying the y coordinate of the point in question. |
|
the coordinate system of the point (x , y )
(e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). |
Returns : |
a pointer to an
AtspiAccessible child of the specified component which
contains the point (x , y ), or NULL if no child contains
the point. [nullable][transfer full]
|
AtspiRect * atspi_component_get_extents (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
);
Gets the bounding box of the specified AtspiComponent.
|
a pointer to the AtspiComponent to query. |
|
the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). |
Returns : |
An AtspiRect giving the accessible's extents. |
AtspiPoint * atspi_component_get_position (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
);
Gets the minimum x and y coordinates of the specified AtspiComponent.
|
a pointer to the AtspiComponent to query. |
|
the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). |
Returns : |
An AtspiPoint giving the obj 's position. |
AtspiPoint * atspi_component_get_size (AtspiComponent *obj
,GError **error
);
Gets the size of the specified AtspiComponent.
|
a pointer to the AtspiComponent to query. |
Returns : |
An AtspiPoint giving the obj 's size. |
AtspiComponentLayer atspi_component_get_layer (AtspiComponent *obj
,GError **error
);
Queries which layer the component is painted into, to help determine its visibility in terms of stacking order.
|
a pointer to the AtspiComponent to query. |
Returns : |
the AtspiComponentLayer into which this component is painted. |
gshort atspi_component_get_mdi_z_order (AtspiComponent *obj
,GError **error
);
Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top)
|
a pointer to the AtspiComponent to query. |
Returns : |
a gshort indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer. |
gboolean atspi_component_grab_focus (AtspiComponent *obj
,GError **error
);
Attempts to set the keyboard input focus to the specified AtspiComponent.
|
a pointer to the AtspiComponent on which to operate. |
Returns : |
TRUE if successful, FALSE otherwise. |
gdouble atspi_component_get_alpha (AtspiComponent *obj
,GError **error
);
Gets the opacity/alpha value of a component, if alpha blending is in use.
|
The AtspiComponent to be queried. |
Returns : |
the opacity value of a component, as a gdouble between 0.0 and 1.0. |