AtkComponent

Name

AtkComponent -- 

Synopsis



struct      AtkComponent;
struct      AtkComponentIface;
guint       atk_component_add_focus_handler (AtkComponent *component,
                                             AtkFocusHandler handler);
gboolean    atk_component_contains          (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);
void        atk_component_get_extents       (AtkComponent *component,
                                             gint *x,
                                             gint *y,
                                             gint *width,
                                             gint *height,
                                             AtkCoordType coord_type);
void        atk_component_get_position      (AtkComponent *component,
                                             gint *x,
                                             gint *y,
                                             AtkCoordType coord_type);
void        atk_component_get_size          (AtkComponent *component,
                                             gint *width,
                                             gint *height);
gboolean    atk_component_grab_focus        (AtkComponent *component);
AtkObject*  atk_component_ref_accessible_at_point
                                            (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);
void        atk_component_remove_focus_handler
                                            (AtkComponent *component,
                                             guint handler_id);
gboolean    atk_component_set_extents       (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             gint width,
                                             gint height,
                                             AtkCoordType coord_type);
gboolean    atk_component_set_position      (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);
gboolean    atk_component_set_size          (AtkComponent *component,
                                             gint width,
                                             gint height);

Description

Details

struct AtkComponent

struct AtkComponent;


struct AtkComponentIface

struct AtkComponentIface
{
  GTypeInterface parent;

  guint          (* add_focus_handler)  (AtkComponent          *component,
                                         AtkFocusHandler        handler);
  gboolean       (* contains)           (AtkComponent          *component,
                                         gint                   x,
                                         gint                   y,
                                         AtkCoordType           coord_type);

  AtkObject*    (* ref_accessible_at_point)  (AtkComponent     *component,
                                         gint                   x,
                                         gint                   y,
                                         AtkCoordType           coord_type);
  void          (* get_extents)         (AtkComponent          *component,
                                         gint                  *x,
                                         gint                  *y,
                                         gint                  *width,
                                         gint                  *height,
                                         AtkCoordType          coord_type);
  void                     (* get_position)     (AtkComponent   *component,
                                                 gint           *x,
                                                 gint           *y,
                                                 AtkCoordType   coord_type);
  void                     (* get_size)                 (AtkComponent   *component,
                                                         gint           *width,
                                                         gint           *height);
  gboolean                 (* grab_focus)               (AtkComponent   *component);
  void                     (* remove_focus_handler)      (AtkComponent  *component,
                                                          guint         handler_id);
  gboolean                 (* set_extents)      (AtkComponent   *component,
                                                 gint           x,
                                                 gint           y,
                                                 gint           width,
                                                 gint           height,
                                                 AtkCoordType   coord_type);
  gboolean                 (* set_position)     (AtkComponent   *component,
                                                 gint           x,
                                                 gint           y,
                                                 AtkCoordType   coord_type);
  gboolean                 (* set_size)         (AtkComponent   *component,
                                                 gint           width,
                                                 gint           height);
};


atk_component_add_focus_handler ()

guint       atk_component_add_focus_handler (AtkComponent *component,
                                             AtkFocusHandler handler);

Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again

component : The AtkComponent to attach the handler to
handler : The AtkFocusHandler to be attached to component
Returns : a handler id which can be used in atk_component_remove_focus_handler or zero if the handler was already added.


atk_component_contains ()

gboolean    atk_component_contains          (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);

Checks whether the specified point is within the extent of the component.

component : the AtkComponent
x : x coordinate
y : y coordinate
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window
Returns : TRUE or FALSE indicating whether the specified point is within the extent of the component or not


atk_component_get_extents ()

void        atk_component_get_extents       (AtkComponent *component,
                                             gint *x,
                                             gint *y,
                                             gint *width,
                                             gint *height,
                                             AtkCoordType coord_type);

Gets the rectangle which gives the extent of the component.

component : an AtkComponent
x : address of gint to put x coordinate
y : address of gint to put y coordinate
width : address of gint to put width
height : address of gint to put height
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window


atk_component_get_position ()

void        atk_component_get_position      (AtkComponent *component,
                                             gint *x,
                                             gint *y,
                                             AtkCoordType coord_type);

Gets the position of component in the form of a point specifying component's top-left corner.

component : an AtkComponent
x : address of gint to put x coordinate position
y : address of gint to put y coordinate position
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window


atk_component_get_size ()

void        atk_component_get_size          (AtkComponent *component,
                                             gint *width,
                                             gint *height);

Gets the size of the component in terms of width and height.

component : an AtkComponent
width : address of gint to put width of component
height : address of gint to put height of component


atk_component_grab_focus ()

gboolean    atk_component_grab_focus        (AtkComponent *component);

Grabs focus for this component.

component : an AtkComponent
Returns : TRUE if successful, FALSE otherwise.


atk_component_ref_accessible_at_point ()

AtkObject*  atk_component_ref_accessible_at_point
                                            (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);

Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

component : the AtkComponent
x : x coordinate
y : y coordinate
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window
Returns : a reference to the accessible child, if one exists


atk_component_remove_focus_handler ()

void        atk_component_remove_focus_handler
                                            (AtkComponent *component,
                                             guint handler_id);

Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).

component : the AtkComponent to remove the focus handler from
handler_id : the handler id of the focus handler to be removed from component


atk_component_set_extents ()

gboolean    atk_component_set_extents       (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             gint width,
                                             gint height,
                                             AtkCoordType coord_type);

Sets the extents of component.

component : an AtkComponent
x : x coordinate
y : y coordinate
width : width to set for component
height : height to set for component
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window
Returns : TRUE or FALSE whether the extents were set or not


atk_component_set_position ()

gboolean    atk_component_set_position      (AtkComponent *component,
                                             gint x,
                                             gint y,
                                             AtkCoordType coord_type);

Sets the postition of component.

component : an AtkComponent
x : x coordinate
y : y coordinate
coord_type : specifies whether the coordinates are relative to the screen or to the components top level window
Returns : TRUE or FALSE whether or not the position was set or not


atk_component_set_size ()

gboolean    atk_component_set_size          (AtkComponent *component,
                                             gint width,
                                             gint height);

Set the size of the component in terms of width and height.

component : an AtkComponent
width : width to set for component
height : height to set for component
Returns : TRUE or FALSE whether the size was set or not