Top |
atspi-componentatspi-component — An interface implemented by objects which have onscreen visual representations. |
Functions
Types and Values
struct | AtspiRect |
#define | ATSPI_TYPE_RECT |
struct | AtspiPoint |
#define | ATSPI_TYPE_POINT |
AtspiComponent |
Description
The Component interface is implemented by objects which occupy on-screen space, e.g. objects which have onscreen visual representations. The methods in Component allow clients to identify where the objects lie in the onscreen coordinate system, their relative size, stacking order, and position. It also provides a mechanism whereby keyboard focus may be transferred to specific user interface elements programmatically. This is a 2D API. Coordinates of 3D objects are projected into the 2-dimensional screen view for purposes of this interface.
Functions
atspi_component_contains ()
gboolean atspi_component_contains (AtspiComponent *obj
,gint x
,gint y
,AtspiCoordType ctype
,GError **error
);
Queries whether a given AtspiComponent contains a particular point.
Parameters
obj |
a pointer to the AtspiComponent to query. |
|
x |
a gint specifying the x coordinate in question. |
|
y |
a gint specifying the y coordinate in question. |
|
ctype |
the desired coordinate system of the point ( |
atspi_component_get_accessible_at_point ()
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.
Parameters
obj |
a pointer to the AtspiComponent to query. |
|
x |
a gint specifying the x coordinate of the point in question. |
|
y |
a gint specifying the y coordinate of the point in question. |
|
ctype |
the coordinate system of the point ( |
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]
atspi_component_get_extents ()
AtspiRect * atspi_component_get_extents (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
);
Gets the bounding box of the specified AtspiComponent.
Parameters
obj |
a pointer to the AtspiComponent to query. |
|
ctype |
the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). |
atspi_component_get_position ()
AtspiPoint * atspi_component_get_position (AtspiComponent *obj
,AtspiCoordType ctype
,GError **error
);
Gets the minimum x and y coordinates of the specified AtspiComponent.
Parameters
obj |
a pointer to the AtspiComponent to query. |
|
ctype |
the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). |
atspi_component_get_size ()
AtspiPoint * atspi_component_get_size (AtspiComponent *obj
,GError **error
);
Gets the size of the specified AtspiComponent.
atspi_component_get_layer ()
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.
atspi_component_get_mdi_z_order ()
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)
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.
atspi_component_grab_focus ()
gboolean atspi_component_grab_focus (AtspiComponent *obj
,GError **error
);
Attempts to set the keyboard input focus to the specified AtspiComponent.
atspi_component_get_alpha ()
gdouble atspi_component_get_alpha (AtspiComponent *obj
,GError **error
);
Gets the opacity/alpha value of a component, if alpha blending is in use.
Types and Values
ATSPI_TYPE_POINT
#define ATSPI_TYPE_POINT (atspi_point_get_type ())
The GType for a boxed type holding a AtspiPoint.