Class

AtkHyperlink

Description [src]

class Atk.Hyperlink : GObject.Object {
  parent: GObject
}

An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object.

Hierarchy

hierarchy this AtkHyperlink implements_0 AtkAction this--implements_0 ancestor_0 AtkObject ancestor_0--this

Ancestors

Implements

Instance methods

atk_hyperlink_get_end_index

Gets the index with the hypertext document at which this link ends.

atk_hyperlink_get_n_anchors

Gets the number of anchors associated with this hyperlink.

atk_hyperlink_get_object

Returns the item associated with this hyperlinks nth anchor. For instance, the returned AtkObject will implement AtkText if link_ is a text hyperlink, AtkImage if link_ is an image hyperlink etc.

atk_hyperlink_get_start_index

Gets the index with the hypertext document at which this link begins.

atk_hyperlink_get_uri

Get a the URI associated with the anchor specified by i of link_.

atk_hyperlink_is_inline

Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return FALSE, but an inline <src> HTML element will return TRUE.

atk_hyperlink_is_selected_link

Determines whether this AtkHyperlink is selected.

Available since: 1.4

Deprecated since: 1.8

atk_hyperlink_is_valid

Since the document that a link is associated with may have changed this method returns TRUE if the link is still valid (with respect to the document it references) and FALSE otherwise.

Methods inherited from AtkObject (26)
atk_object_add_relationship

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

atk_object_connect_property_change_handler

Calls handler on property changes.

Deprecated since: 2.12

atk_object_get_accessible_id

Gets the accessible id of the accessible.

Available since: 2.34

atk_object_get_attributes

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.

Available since: 1.12

atk_object_get_description

Gets the accessible description of the accessible.

atk_object_get_index_in_parent

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

atk_object_get_layer

Gets the layer of the accessible.

atk_object_get_mdi_zorder

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

atk_object_get_n_accessible_children

Gets the number of accessible children of the accessible.

atk_object_get_name

Gets the accessible name of the accessible.

atk_object_get_object_locale

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

Available since: 2.8

atk_object_get_parent

Gets the accessible parent of the accessible. By default this is the one assigned with atk_object_set_parent(), 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_set_parent(), and will return it with this method.

atk_object_get_role

Gets the role of the accessible.

atk_object_initialize

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.

atk_object_notify_state_change

Emits a state-change signal for the specified state.

atk_object_peek_parent

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

atk_object_ref_accessible_child

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.

atk_object_ref_relation_set

Gets the AtkRelationSet associated with the object.

atk_object_ref_state_set

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

atk_object_remove_property_change_handler

Removes a property change handler.

Deprecated since: 2.12

atk_object_remove_relationship

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

atk_object_set_accessible_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.

Available since: 2.34

atk_object_set_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 “”.

Methods inherited from AtkAction (7)
atk_action_do_action

Perform the specified action on the object.

atk_action_get_description

Returns a description of the specified action of the object.

atk_action_get_keybinding

Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format “mnemonic;sequence;shortcut”.

atk_action_get_localized_name

Returns the localized name of the specified action of the object.

atk_action_get_n_actions

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the “default” action of the object.

atk_action_get_name

Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the ‘interaction type’ which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. “click”, “press”, “release”, “drag”, “drop”, “popup”, etc. The “popup” action should be used to pop up a context menu for the object, if one exists.

atk_action_set_description

Sets a description of the specified action of the object.

Properties

Atk.Hyperlink:end-index
No description available.
Atk.Hyperlink:number-of-anchors
No description available.
Atk.Hyperlink:selected-link

Selected link.

Deprecated since: 1.8

Atk.Hyperlink:start-index
No description available.
Properties inherited from AtkObject (15)
Atk.Object:accessible-component-layer
No description available.
Atk.Object:accessible-component-mdi-zorder
No description available.
Atk.Object:accessible-description
No description available.
Atk.Object:accessible-hypertext-nlinks
No description available.
Atk.Object:accessible-name
No description available.
Atk.Object:accessible-parent
No description available.
Atk.Object:accessible-role
No description available.
Atk.Object:accessible-table-caption

Table caption.

Atk.Object:accessible-table-caption-object
No description available.
Atk.Object:accessible-table-column-description

Accessible table column description.

Atk.Object:accessible-table-column-header

Accessible table column header.

Atk.Object:accessible-table-row-description

Accessible table row description.

Atk.Object:accessible-table-row-header

Accessible table row header.

Atk.Object:accessible-table-summary
No description available.
Atk.Object:accessible-value

Numeric value of this object, in case being and AtkValue.

Signals

Atk.Hyperlink::link-activated

The signal link-activated is emitted when a link is activated.

Signals inherited from AtkObject (6)
Atk.Object::active-descendant-changed

The “active-descendant-changed” signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

Atk.Object::children-changed

The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”

Atk.Object::focus-event

The signal “focus-event” is emitted when an object gained or lost focus.

Deprecated since: 2.9.4

Atk.Object::property-change

The signal “property-change” is emitted when an object’s property value changes. arg1 contains an AtkPropertyValues with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value.

Atk.Object::state-change

The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.

Atk.Object::visible-data-changed

The “visible-data-changed” signal is emitted when the visual appearance of the object changed.

Class structure

struct AtkHyperlinkClass {
  GObjectClass parent;
  gchar* (* get_uri) (
    AtkHyperlink* link_,
    gint i
  );
  AtkObject* (* get_object) (
    AtkHyperlink* link_,
    gint i
  );
  gint (* get_end_index) (
    AtkHyperlink* link_
  );
  gint (* get_start_index) (
    AtkHyperlink* link_
  );
  gboolean (* is_valid) (
    AtkHyperlink* link_
  );
  gint (* get_n_anchors) (
    AtkHyperlink* link_
  );
  guint (* link_state) (
    AtkHyperlink* link_
  );
  gboolean (* is_selected_link) (
    AtkHyperlink* link_
  );
  void (* link_activated) (
    AtkHyperlink* link_
  );
  AtkFunction pad1;
  
}
Class members
parent
GObjectClass
  No description available.
get_uri
gchar* (* get_uri) (
    AtkHyperlink* link_,
    gint i
  )
  No description available.
get_object
AtkObject* (* get_object) (
    AtkHyperlink* link_,
    gint i
  )
  No description available.
get_end_index
gint (* get_end_index) (
    AtkHyperlink* link_
  )
  No description available.
get_start_index
gint (* get_start_index) (
    AtkHyperlink* link_
  )
  No description available.
is_valid
gboolean (* is_valid) (
    AtkHyperlink* link_
  )
  No description available.
get_n_anchors
gint (* get_n_anchors) (
    AtkHyperlink* link_
  )
  No description available.
link_state
guint (* link_state) (
    AtkHyperlink* link_
  )
  No description available.
is_selected_link
gboolean (* is_selected_link) (
    AtkHyperlink* link_
  )
  No description available.
link_activated
void (* link_activated) (
    AtkHyperlink* link_
  )
  No description available.
pad1
AtkFunction
  No description available.

Virtual methods

Atk.HyperlinkClass.get_end_index

Gets the index with the hypertext document at which this link ends.

Atk.HyperlinkClass.get_n_anchors

Gets the number of anchors associated with this hyperlink.

Atk.HyperlinkClass.get_object

Returns the item associated with this hyperlinks nth anchor. For instance, the returned AtkObject will implement AtkText if link_ is a text hyperlink, AtkImage if link_ is an image hyperlink etc.

Atk.HyperlinkClass.get_start_index

Gets the index with the hypertext document at which this link begins.

Atk.HyperlinkClass.get_uri

Get a the URI associated with the anchor specified by i of link_.

Determines whether this AtkHyperlink is selected.

Available since: 1.4

Deprecated since: 1.8

Atk.HyperlinkClass.is_valid

Since the document that a link is associated with may have changed this method returns TRUE if the link is still valid (with respect to the document it references) and FALSE otherwise.

No description available.
No description available.