Back to Seed Clases

Atk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Atk.Object
Atk.Socket

Class Atk.Socket

Import line:	Atk = imports.gi.Atk;
GIR File:	Atk-1.0.gir
C documentation:	AtkSocket
Class :	Socket
Implements:	Atk.Component
Extends:	Atk.Object

Properties
Properties		Defined By
	accessible_component_layer : gint32 read only	Atk.Object
	accessible_component_mdi_zorder : gint32 read only	Atk.Object
	accessible_description : String	Atk.Object
	accessible_hypertext_nlinks : gint32 read only	Atk.Object
	accessible_name : String	Atk.Object
	accessible_parent : Atk.Object	Atk.Object
	accessible_role : gint32	Atk.Object
	accessible_table_caption : String	Atk.Object
	accessible_table_caption_object : Atk.Object	Atk.Object
	accessible_table_column_description : String	Atk.Object
	accessible_table_column_header : Atk.Object	Atk.Object
	accessible_table_row_description : String	Atk.Object
	accessible_table_row_header : Atk.Object	Atk.Object
	accessible_table_summary : Atk.Object	Atk.Object
	accessible_value : gdouble	Atk.Object
	description : String read only	Atk.Object
	embedded_plug_id : String read only	Atk.Socket
	layer : Atk.Layer read only	Atk.Object
	name : String read only	Atk.Object
	parent : Atk.Object read only	Atk.Socket
	relation_set : Atk.RelationSet read only	Atk.Object
	role : Atk.Role read only	Atk.Object

Methods / Constructors
Method / Constructor		Defined By
	new Atk.Socket (Object *properties) Create a new Atk.Socket Create a new Atk.Socket Parameters: Object properties*
	add_relationship (RelationType *relationship, Object target) : gboolean Adds a relationship of the specified type with the specified target. Adds a relationship of the specified type with the specified target. Returns TRUE if the relationship is added. Parameters: Atk.RelationType relationship* Required (not null) The AtkRelationType of the relation Atk.Object target Required (not null) The AtkObject which is to be the target of the relation. Returns: gboolean	Atk.Object
	contains (gint32 x, gint32 y, CoordType *coord_type) : gboolean Checks whether the specified point is within the extent of the component. Checks whether the specified point is within the extent of the component. the extent of the component* or not Parameters: gint32 x Required (not null) x coordinate gint32 y Required (not null) y coordinate Atk.CoordType coord_type Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: gboolean TRUE or FALSE indicating whether the specified point is within	Atk.Component
	embed (String *plug_id) : none Embeds the children of an AtkPlug* as the children of the AtkSocket. Embeds the children of an AtkPlug as the children of the AtkSocket. The plug may be in the same process or in a different process. Parameters: String plug_id Required (not null) the ID of an AtkPlug Returns: none	Atk.Socket
	get_alpha () : gdouble Returns the alpha value (i.e. Returns the alpha value (i.e. the opacity) for this (fully opaque). Returns: gdouble An alpha value from 0 to 1.0, inclusive.	Atk.Component
	get_attributes () : Array Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of name-value pairs. Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, as distinct from strongly-typed object data available via other get/set methods. Not all objects have explicit "name-value pair" AtkAttributeSet properties. properties/annotations applied to the object, or an empty set if the object has no name-value pair attributes assigned to it. Returns: Array an AtkAttributeSet consisting of all explicit	Atk.Object
	get_description () : String Gets the accessible description of the accessible. Gets the accessible description of the accessible. of the accessible. Returns: String a character string representing the accessible description	Atk.Object
	get_extents (gint32 x, gint32 y, gint32 *width, gint32 height, CoordType coord_type) : none Gets the rectangle which gives the extent of the component. Gets the rectangle which gives the extent of the component. Parameters: gint32 x Required (not null) address of gint* to put x coordinate gint32 y Required (not null) address of gint to put y coordinate gint32 width Required (not null) address of gint to put width gint32 height Required (not null) address of gint to put height Atk.CoordType coord_type Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: none	Atk.Component
	get_index_in_parent () : gint32 Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. Returns: gint32 an integer which is the index of the accessible in its parent	Atk.Object
	get_layer () : Atk.Layer Gets the layer of the component. Gets the layer of the component. Returns: Atk.Layer an AtkLayer which is the layer of the component	Atk.Component
	get_mdi_zorder () : gint32 Gets the zorder of the component. 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. which the component is shown in relation to other components in the same container. Returns: gint32 a gint which is the zorder of the component, i.e. the depth at	Atk.Component
	get_n_accessible_children () : gint32 Gets the number of accessible children of the accessible. Gets the number of accessible children of the accessible. of the accessible. Returns: gint32 an integer representing the number of accessible children	Atk.Object
	get_name () : String Gets the accessible name of the accessible. Gets the accessible name of the accessible. Returns: String a character string representing the accessible name of the object.	Atk.Object
	get_parent () : Atk.Object Gets the accessible parent of the accessible. Gets the accessible parent of the accessible. of the accessible Returns: Atk.Object a AtkObject representing the accessible parent	Atk.Object
	get_position (gint32 x, gint32 y, CoordType *coord_type) : none Gets the position of component* in the form of a point specifying component's top-left corner. Gets the position of component in the form of a point specifying component's top-left corner. Parameters: gint32 x Required (not null) address of gint to put x coordinate position gint32 y Required (not null) address of gint to put y coordinate position Atk.CoordType coord_type Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: none	Atk.Component
	get_role () : Atk.Role Gets the role of the accessible. Gets the role of the accessible. Returns: Atk.Role an AtkRole which is the role of the accessible	Atk.Object
	get_size (gint32 *width, gint32 height) : none Gets the size of the component* in terms of width and height. Gets the size of the component in terms of width and height. Parameters: gint32 width Required (not null) address of gint to put width of component gint32 height Required (not null) address of gint to put height of component Returns: none	Atk.Component
	grab_focus () : gboolean Grabs focus for this component. Grabs focus for this component. Returns: gboolean TRUE if successful, FALSE otherwise.	Atk.Component
	initialize (void* *data) : none This function is called when implementing subclasses of AtkObject. This function is called when implementing subclasses of AtkObject. It does initialization required for the new object. It is intended that this function should called only in the ..._new() functions used to create an instance of a subclass of AtkObject* Parameters: void* data Required (not null) a gpointer which identifies the object for which the AtkObject was created. Returns: none	Atk.Object
	is_occupied () : gboolean Determines whether or not the socket has an embedded plug. Determines whether or not the socket has an embedded plug. Returns: gboolean TRUE if a plug is embedded in the socket	Atk.Socket
	notify_state_change (guint64 *state, gboolean value) : none Emits a state-change signal for the specified state. Emits a state-change signal for the specified state. Parameters: guint64 state* Required (not null) an AtkState whose state is changed gboolean value Required (not null) a gboolean which indicates whether the state is being set on or off Returns: none	Atk.Object
	ref_accessible_at_point (gint32 x, gint32 y, CoordType *coord_type) : Atk.Object Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y. Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y. Parameters: gint32 x Required (not null) x coordinate gint32 y Required (not null) y coordinate Atk.CoordType coord_type* Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: Atk.Object a reference to the accessible child, if one exists	Atk.Component
	ref_accessible_child (gint32 i) : Atk.Object Gets a reference to the specified accessible child of the object. Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on. accessible child of the accessible. Parameters: gint32 i Required (not null) a gint representing the position of the child, starting from 0 Returns: Atk.Object an AtkObject representing the specified	Atk.Object
	ref_relation_set () : Atk.RelationSet Gets the AtkRelationSet associated with the object. Gets the AtkRelationSet associated with the object. of the object. Returns: Atk.RelationSet an AtkRelationSet representing the relation set	Atk.Object
	ref_state_set () : Atk.StateSet Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. set of the accessible Returns: Atk.StateSet a reference to an AtkStateSet which is the state	Atk.Object
	remove_focus_handler (guint32 *handler_id) : none Remove the handler specified by handler_id* from the list of functions to be executed when this object receives focus events (in or out). Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out). Parameters: guint32 handler_id Required (not null) the handler id of the focus handler to be removed from component Returns: none	Atk.Component
	remove_property_change_handler (guint32 *handler_id) : none Removes a property change handler. Removes a property change handler. Parameters: guint32 handler_id* Required (not null) a guint which identifies the handler to be removed. Returns: none	Atk.Object
	remove_relationship (RelationType *relationship, Object target) : gboolean Removes a relationship of the specified type with the specified target. Removes a relationship of the specified type with the specified target. Returns TRUE if the relationship is removed. Parameters: Atk.RelationType relationship* Required (not null) The AtkRelationType of the relation Atk.Object target Required (not null) The AtkObject which is the target of the relation to be removed. Returns: gboolean	Atk.Object
	set_description (String *description) : none Sets the accessible description of the accessible. Sets the accessible description of the accessible. Parameters: String description* Required (not null) a character string to be set as the accessible description Returns: none	Atk.Object
	set_extents (gint32 x, gint32 y, gint32 *width, gint32 height, CoordType coord_type) : gboolean Sets the extents of component. Sets the extents of component. Parameters: gint32 x Required (not null) x coordinate gint32 y Required (not null) y coordinate gint32 width* Required (not null) width to set for component gint32 height Required (not null) height to set for component Atk.CoordType coord_type Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: gboolean TRUE or FALSE whether the extents were set or not	Atk.Component
	set_name (String *name) : none Sets the accessible name of the accessible. Sets the accessible name of the accessible. Parameters: String name* Required (not null) a character string to be set as the accessible name Returns: none	Atk.Object
	set_parent (Object *parent) : none Sets the accessible parent of the accessible. Sets the accessible parent of the accessible. Parameters: Atk.Object parent* Required (not null) an AtkObject to be set as the accessible parent Returns: none	Atk.Object
	set_position (gint32 x, gint32 y, CoordType *coord_type) : gboolean Sets the postition of component. Sets the postition of component. Parameters: gint32 x Required (not null) x coordinate gint32 y Required (not null) y coordinate Atk.CoordType coord_type* Required (not null) specifies whether the coordinates are relative to the screen or to the components top level window Returns: gboolean TRUE or FALSE whether or not the position was set or not	Atk.Component
	set_role (Role *role) : none Sets the role of the accessible. Sets the role of the accessible. Parameters: Atk.Role role* Required (not null) an AtkRole to be set as the role Returns: none	Atk.Object
	set_size (gint32 *width, gint32 height) : gboolean Set the size of the component* in terms of width and height. Set the size of the component in terms of width and height. Parameters: gint32 width Required (not null) width to set for component gint32 height Required (not null) height to set for component Returns: gboolean TRUE or FALSE whether the size was set or not	Atk.Component

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	active_descendant_changed (Object *self, void *object) : none Parameters: Atk.Object self* void* object Returns: {none}	Atk.Object
	bounds_changed (Component *self, Rectangle object) : none Parameters: Atk.Component self* Atk.Rectangle object Returns: {none}	Atk.Component
	children_changed (Object *self, guint32 object, void p0) : none Parameters: Atk.Object self guint32 object void* p0 Returns: {none}	Atk.Object
	focus_event (Object *self, gboolean object) : none Parameters: Atk.Object self* gboolean object Returns: {none}	Atk.Object
	property_change (Object *self, void *object) : none Parameters: Atk.Object self* void* object Returns: {none}	Atk.Object
	state_change (Object *self, String object, gboolean p0) : none Parameters: Atk.Object self* String object gboolean p0 Returns: {none}	Atk.Object
	visible_data_changed (Object *self) : none Parameters: Atk.Object self* Returns: {none}	Atk.Object

Un-official Seed Documentation

Atk

Classes

Interfaces

Structs

Unions

Enums

Class Atk.Socket