atk.Componentthe ATK interface provided by UI components that occupy a
physical area on the screen. Synopsisatk.Componentgobject.GInterfacecontainsxycoord_typeref_accessible_at_pointxycoord_typeget_extentscoord_typeget_positioncoord_typeget_sizegrab_focusremove_focus_handlerhandler_idset_extentsxywidthheightcoord_typeset_positionxycoord_typeset_sizewidthheightget_layerget_mdi_zorderatk.Component Signal Prototypes"bounds-changed"callbackatkcomponentrectuser_param1...Descriptionatk.Component
should be implemented by most if not all UI elements with an actual
on-screen presence, i.e. components which can be said to have a
screen-coordinate bounding box. Virtually all widgets will need to have
atk.Component
implementations provided for their corresponding atk.Object
class. In short, only UI elements which are *not* GUI elements will
omit this ATK interface.A possible exception might be textual information with a
transparent background, in which case text glyph bounding box
information is provided by atk.Text.Methodsatk.Component.containscontainsxycoord_typex :x coordinatey :y coordinatecoord_type :specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
Returns :True or
False indicating whether the specified point is
within the extent of the component or notChecks whether the specified point is within the extent of the
component.atk.Component.ref_accessible_at_pointref_accessible_at_pointxycoord_typex :x coordinatey :y coordinatecoord_type :specifies whether the coordinates are relative
to the screen or to the components top level
window - one of the
Returns :an atk.Object
reference to the accessible child, if one
existsGets a reference to the accessible child, if one exists, at the
coordinate point specified by x and
y.atk.Component.get_extentsget_extentscoord_typecoord_type :specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
Returns :a 4-tuple containing the x, y position
coordinates and the width and height of the
component.Gets the rectangle which gives the extent of the
component.atk.Component.get_positionget_positioncoord_typecoord_type :specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
Returns :a 2-tuple containing the x, y position
coordinates of the component.Gets the position of the component in the form of a point
specifying the component's top-left corner.atk.Component.get_sizeget_sizeReturns :a 2-tuple containing the width and height of
the component.Gets the size of the component in terms of width and
height.atk.Component.grab_focusgrab_focusReturns :True if successful,
False otherwise.Grabs focus for this component.atk.Component.remove_focus_handlerremove_focus_handlerhandler_idhandler_id :the handler id of the focus handler to be
removed from componentRemove the handler specified by
handler_id from the list of functions to be
executed when this object receives focus events (in or out).atk.Component.set_extentsset_extentsxywidthheightcoord_typex :x coordinatey :y coordinatewidth :width to set for the
componentheight :height to set for the
componentcoord_type :specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
Returns :True if the extents were
setSets the extents of the component.atk.Component.set_positionset_positionxycoord_typex :x coordinatey :y coordinatecoord_type :specifies whether the coordinates are relative
to the screen or to the components top level window - one of the
Returns :True if the position was
setSets the postition of the component.atk.Component.set_sizeset_sizewidthheightwidth :width to set for componentheight :height to set for componentReturns :True if the size was
setSet the size of the component in terms of width and
height.atk.Component.get_layerget_layerReturns :one of the which is the layer of
the componentGets the layer of the component.atk.Component.get_mdi_zorderget_mdi_zorderReturns :an integer which is the zorder of the
component, i.e. the depth at which the component is shown in
relation to other components in the same
container.Gets the zorder of the component. The value G_MININT will be
returned if the layer of the component is not
atk.LAYER_MDI or
atk.LAYER_WINDOW.SignalsThe "bounds-changed" atk.Component Signalcallbackatkcomponentrectuser_param1...atkcomponent :the object which received the signal.rect :The atk.Rectangle
giving the new position and size.user_param1 :the first user parameter (if any) specified
with the connect()
method... :additional user parameters (if any)The 'bounds-changed" signal is emitted when the bposition or
size of the a component changes.