atspi-component

## atspi-component atspi-component |

## Synopsis

                        AtspiRect;
    #define             ATSPI_TYPE_RECT
    AtspiRect *         atspi_rect_copy                     (AtspiRect *src);
                        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);

## Object Hierarchy

      GInterface
       +----AtspiComponent

## Known Implementations

AtspiComponent is implemented by AtspiAccessible.

## Description

## Details

### AtspiRect

    typedef struct {
      gint x;
      gint y;
      gint width;
      gint height;
    } AtspiRect;

### ATSPI_TYPE_RECT

    #define ATSPI_TYPE_RECT (atspi_rect_get_type ())

The GType for a boxed type holding a AtspiEvent.

### atspi_rect_copy ()

    AtspiRect *         atspi_rect_copy                     (AtspiRect *src);

`src` : |
Returns : |

### AtspiPoint

    typedef struct {
      gint x;
      gint y;
    } AtspiPoint;

### ATSPI_TYPE_POINT

    #define ATSPI_TYPE_POINT (atspi_point_get_type ())

The GType for a boxed type holding a AtspiPoint.

### atspi_point_get_type ()

    GType               atspi_point_get_type                ();

Returns : |

### atspi_point_copy ()

    AtspiPoint *        atspi_point_copy                    (AtspiPoint *src);

`src` : |
Returns : |

### atspi_component_get_type ()

    GType               atspi_component_get_type            ();

Returns : |

### AtspiComponent

    typedef struct _AtspiComponent AtspiComponent;

### atspi_component_contains ()

    gboolean            atspi_component_contains            (AtspiComponent *obj,
                                                             gint x,
                                                             gint y,
                                                             AtspiCoordType ctype,
                                                             GError **error);

Query whether a given AtspiComponent contains a particular point.

`obj` : | a pointer to the AtspiComponent to query.
`x` : | a long specifying the x coordinate in question.
`y` : | a long specifying the y coordinate in question.
`ctype` : | the desired coordinate system of the point (`x`, `y`) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
`error` : |
Returns : | a TRUE if the specified component contains the point (`x`, `y`), otherwise FALSE.

### atspi_component_get_accessible_at_point ()

    AtspiAccessible *   atspi_component_get_accessible_at_point
                                                            (AtspiComponent *obj,
                                                             gint x,
                                                             gint y,
                                                             AtspiCoordType ctype,
                                                             GError **error);

Get the accessible child at a given coordinate within an AtspiComponent.

`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 (`x`, `y`) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
`error` : |
Returns : | a pointer to an AtspiAccessible child of the specified component which contains the point (`x`, `y`), or NULL of no child contains the point. [transfer full]

### atspi_component_get_extents ()

    AtspiRect *         atspi_component_get_extents         (AtspiComponent *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);

`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).
`error` : |
Returns : | A AtspiRect giving the accessible's extents. Get the bounding box of the specified AtspiComponent.

### atspi_component_get_position ()

    AtspiPoint *        atspi_component_get_position        (AtspiComponent *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);

`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).
`error` : |
Returns : | A AtspiPoint giving the position. Get the minimum x and y coordinates of the specified AtspiComponent.

### atspi_component_get_size ()

    AtspiPoint *        atspi_component_get_size            (AtspiComponent *obj,
                                                             GError **error);

Get the size of the specified AtspiComponent.

`obj` : | a pointer to the AtspiComponent to query. returns: A AtspiPoint giving the size.
`error` : |
Returns : |

### atspi_component_get_layer ()

    AtspiComponentLayer  atspi_component_get_layer          (AtspiComponent *obj,
                                                             GError **error);

Query which layer the component is painted into, to help determine its visibility in terms of stacking order.

`obj` : | a pointer to the AtspiComponent to query.
`error` : |
Returns : | the AtspiComponentLayer into which this component is painted.

### atspi_component_get_mdi_z_order ()

    gshort              atspi_component_get_mdi_z_order     (AtspiComponent *obj,
                                                             GError **error);

Query the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top)

`obj` : | a pointer to the AtspiComponent to query.
`error` : |
Returns : | a short integer 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);

Attempt to set the keyboard input focus to the specified AtspiComponent.

`obj` : | a pointer to the AtspiComponent on which to operate.
`error` : |
Returns : | TRUE if successful, FALSE otherwise.

### atspi_component_get_alpha ()

    gdouble             atspi_component_get_alpha           (AtspiComponent *obj,
                                                             GError **error);

Get the opacity/alpha value of a component, if alpha blending is in use.

`obj` : | The AtspiComponent to be queried.
`error` : |
Returns : | the opacity value of a component, as a double between 0.0 and 1.0.