Atspi.Component
Description: Reference for Atspi.Component

### Interface

# AtspiComponent

#### Description [src]

    interface Atspi.Component : GObject.Object

An interface implemented by objects which have onscreen visual representations.

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.

#### Prerequisite

In order to implement Component, your type must inherit from`GObject`.

#### Implementations

- AtspiAccessible

#### Instance methods

###### atspi_component_contains

Queries whether a given `AtspiComponent` contains a particular point.

###### atspi_component_get_accessible_at_point

Gets the accessible child at a given coordinate within an `AtspiComponent`.

###### atspi_component_get_alpha

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

###### atspi_component_get_extents

Gets the bounding box of the specified `AtspiComponent`. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_component_get_layer

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

###### atspi_component_get_mdi_z_order

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

###### atspi_component_get_position

Gets the minimum x and y coordinates of the specified `AtspiComponent`. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_component_get_size

Gets the size of the specified `AtspiComponent`. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING.

###### atspi_component_grab_focus

Attempts to set the keyboard input focus to the specified `AtspiComponent`.

###### atspi_component_scroll_to

Scrolls whatever container of the `AtspiComponent` object so it becomes visible on the screen.

###### atspi_component_scroll_to_point

Scrolls whatever container of the `AtspiComponent` object so it becomes visible on the screen at a given position.

###### atspi_component_set_extents

Moves and resizes the specified component.

###### atspi_component_set_position

Moves the component to the specified position.

###### atspi_component_set_size

Resizes the specified component to the given pixel dimensions.