Plug

Toplevel for embedding into other processes

See class@AtkSocket

Constructors

this
this()

Creates a new #AtkPlug instance.

Members

Functions

getId
string getId()

Gets the unique ID of an #AtkPlug object, which can be used to embed inside of an #AtkSocket using atk.socket.Socket.embed.

setChild
void setChild(atk.object.ObjectAtk child)

Sets child as accessible child of plug and plug as accessible parent of child. child can be NULL.

Mixed In Members

From mixin ComponentT!()

contains
bool contains(int x, int y, atk.types.CoordType coordType)

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

getAlpha
double getAlpha()

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

getExtents
void getExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Gets the rectangle which gives the extent of the component.

getLayer
atk.types.Layer getLayer()

Gets the layer of the component.

getMdiZorder
int getMdiZorder()

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.

getPosition
void getPosition(int x, int y, atk.types.CoordType coordType)

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

getSize
void getSize(int width, int height)

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

grabFocus
bool grabFocus()

Grabs focus for this component.

refAccessibleAtPoint
atk.object.ObjectAtk refAccessibleAtPoint(int x, int y, atk.types.CoordType coordType)

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

removeFocusHandler
void removeFocusHandler(uint handlerId)

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

scrollTo
bool scrollTo(atk.types.ScrollType type)

Makes component visible on the screen by scrolling all necessary parents.

scrollToPoint
bool scrollToPoint(atk.types.CoordType coords, int x, int y)

Move the top-left of component to a given position of the screen by scrolling all necessary parents.

setExtents
bool setExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Sets the extents of component.

setPosition
bool setPosition(int x, int y, atk.types.CoordType coordType)

Sets the position of component.

setSize
bool setSize(int width, int height)

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

connectBoundsChanged
ulong connectBoundsChanged(T callback, Flag!"After" after)

Connect to BoundsChanged signal.

Inherited Members

From ObjectAtk

addRelationship
bool addRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target)

Adds a relationship of the specified type with the specified target.

getAccessibleId
string getAccessibleId()

Gets the accessible id of the accessible.

getDescription
string getDescription()

Gets the accessible description of the accessible.

getHelpText
string getHelpText()

Gets the help text associated with the accessible.

getIndexInParent
int getIndexInParent()

Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.

getLayer
atk.types.Layer getLayer()

Gets the layer of the accessible.

getMdiZorder
int getMdiZorder()

Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.

getNAccessibleChildren
int getNAccessibleChildren()

Gets the number of accessible children of the accessible.

getName
string getName()

Gets the accessible name of the accessible.

getObjectLocale
string getObjectLocale()

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible.

getParent
atk.object.ObjectAtk getParent()

Gets the accessible parent of the accessible. By default this is the one assigned with atk.object.ObjectAtk.setParent, but it is assumed that ATK implementors have ways to get the parent of the object without the need of assigning it manually with atk.object.ObjectAtk.setParent, and will return it with this method.

getRole
atk.types.Role getRole()

Gets the role of the accessible.

initialize
void initialize(void* data)

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

notifyStateChange
void notifyStateChange(atk.types.State state, bool value)

Emits a state-change signal for the specified state.

peekParent
atk.object.ObjectAtk peekParent()

Gets the accessible parent of the accessible, if it has been manually assigned with atk_object_set_parent. Otherwise, this function returns null.

refAccessibleChild
atk.object.ObjectAtk refAccessibleChild(int i)

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.

refRelationSet
atk.relation_set.RelationSet refRelationSet()

Gets the #AtkRelationSet associated with the object.

refStateSet
atk.state_set.StateSet refStateSet()

Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.

removePropertyChangeHandler
void removePropertyChangeHandler(uint handlerId)

Removes a property change handler.

removeRelationship
bool removeRelationship(atk.types.RelationType relationship, atk.object.ObjectAtk target)

Removes a relationship of the specified type with the specified target.

setAccessibleId
void setAccessibleId(string id)

Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.

setDescription
void setDescription(string description)

Sets the accessible description of the accessible. You can't set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

setHelpText
void setHelpText(string helpText)

Sets the help text associated with the accessible. This can be used to expose context-sensitive information to help a user understand how to interact with the object.

setName
void setName(string name)

Sets the accessible name of the accessible. You can't set the name to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".

setParent
void setParent(atk.object.ObjectAtk parent)

Sets the accessible parent of the accessible. parent can be NULL.

setRole
void setRole(atk.types.Role role)

Sets the role of the accessible.

connectActiveDescendantChanged
ulong connectActiveDescendantChanged(string detail, T callback, Flag!"After" after)

Connect to ActiveDescendantChanged signal.

connectAnnouncement
ulong connectAnnouncement(T callback, Flag!"After" after)

Connect to Announcement signal.

connectAttributeChanged
ulong connectAttributeChanged(T callback, Flag!"After" after)

Connect to AttributeChanged signal.

connectChildrenChanged
ulong connectChildrenChanged(string detail, T callback, Flag!"After" after)

Connect to ChildrenChanged signal.

connectFocusEvent
ulong connectFocusEvent(T callback, Flag!"After" after)

Connect to FocusEvent signal.

connectNotification
ulong connectNotification(T callback, Flag!"After" after)

Connect to Notification signal.

connectPropertyChange
ulong connectPropertyChange(string detail, T callback, Flag!"After" after)

Connect to PropertyChange signal.

connectStateChange
ulong connectStateChange(string detail, T callback, Flag!"After" after)

Connect to StateChange signal.

connectVisibleDataChanged
ulong connectVisibleDataChanged(T callback, Flag!"After" after)

Connect to VisibleDataChanged signal.

From Component

contains
bool contains(int x, int y, atk.types.CoordType coordType)

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

getAlpha
double getAlpha()

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

getExtents
void getExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Gets the rectangle which gives the extent of the component.

getLayer
atk.types.Layer getLayer()

Gets the layer of the component.

getMdiZorder
int getMdiZorder()

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.

getPosition
void getPosition(int x, int y, atk.types.CoordType coordType)

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

getSize
void getSize(int width, int height)

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

grabFocus
bool grabFocus()

Grabs focus for this component.

refAccessibleAtPoint
atk.object.ObjectAtk refAccessibleAtPoint(int x, int y, atk.types.CoordType coordType)

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

removeFocusHandler
void removeFocusHandler(uint handlerId)

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

scrollTo
bool scrollTo(atk.types.ScrollType type)

Makes component visible on the screen by scrolling all necessary parents.

scrollToPoint
bool scrollToPoint(atk.types.CoordType coords, int x, int y)

Move the top-left of component to a given position of the screen by scrolling all necessary parents.

setExtents
bool setExtents(int x, int y, int width, int height, atk.types.CoordType coordType)

Sets the extents of component.

setPosition
bool setPosition(int x, int y, atk.types.CoordType coordType)

Sets the position of component.

setSize
bool setSize(int width, int height)

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

connectBoundsChanged
ulong connectBoundsChanged(T callback, Flag!"After" after)

Connect to BoundsChanged signal.