Atk.Plug - Classes - Atk 1.0 (original) (raw)

g Atk.Component Atk.Component Atk.Plug Atk.Plug Atk.Component->Atk.Plug Atk.Object Atk.Object Atk.Object->Atk.Plug GObject.GInterface GObject.GInterface GObject.GInterface->Atk.Component GObject.Object GObject.Object GObject.Object->Atk.Object

Subclasses:

None

Methods¶

Inherited:

Atk.Object (27), GObject.Object (37), Atk.Component (15)

Structs:

GObject.ObjectClass (5)

Virtual Methods¶

Inherited:

Atk.Object (24), GObject.Object (7), Atk.Component (16)

Properties¶

Inherited:

Atk.Object (17)

Signals¶

Inherited:

Atk.Object (9), GObject.Object (1), Atk.Component (1)

Fields¶

Inherited:

Atk.Object (9), GObject.Object (1), Atk.Component (1)

Class Details¶

class Atk.Plug(**kwargs)¶

Bases:

Atk.Object, Atk.Component

Abstract:

No

Structure:

Atk.PlugClass

Toplevel for embedding into other processes

See [class`AtkSocket`]

classmethod new()[source]¶

Returns:

the newly created Atk.Plug

Return type:

Atk.Object

Creates a new Atk.Plug instance.

New in version 1.30.

get_id()[source]¶

Returns:

the unique ID for the plug

Return type:

str

Gets the unique ID of an Atk.Plug object, which can be used to embed inside of an Atk.Socket using Atk.Socket.embed().

Internally, this calls a class function that should be registered by the IPC layer (usually at-spi2-atk). The implementor of anAtk.Plug object should call this function (after atk-bridge is loaded) and pass the value to the process implementing theAtk.Socket, so it could embed the plug.

New in version 1.30.

set_child(child)[source]¶

Parameters:

child (Atk.Object) – an Atk.Object to be set as accessible child of self.

Sets child as accessible child of self and self as accessible parent ofchild. child can be None.

In some cases, one can not use the Atk.Plug type directly as accessible object for the toplevel widget of the application. For instance in the gtk case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and from Atk.Plug. In such a case, one can create, in addition to the standard accessible object for the toplevel widget, an Atk.Plug object, and make the former the child of the latter by calling Atk.Plug.set_child().

New in version 2.35.0.

do_get_object_id() virtual¶

Return type:

str