Back to Seed Clases

Atk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Atk.Hyperlink

Class Atk.Hyperlink

Import line:	Atk = imports.gi.Atk;
GIR File:	Atk-1.0.gir
C documentation:	AtkHyperlink
Class :	Hyperlink
Implements:	Atk.Action
Extends:	GObject.Object

Properties
Properties		Defined By
	end_index : gint32 read only	Atk.Hyperlink
	number_of_anchors : gint32 read only	Atk.Hyperlink
	parent : GObject.Object read only	Atk.Hyperlink
	selected_link : gboolean read only	Atk.Hyperlink
	start_index : gint32 read only	Atk.Hyperlink

Methods / Constructors
Method / Constructor		Defined By
	new Atk.Hyperlink (Object *properties) Create a new Atk.Hyperlink Create a new Atk.Hyperlink Parameters: Object properties*
	do_action (gint32 i) : gboolean Perform the specified action on the object. Perform the specified action on the object. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed Returns: gboolean TRUE if success, FALSE otherwise	Atk.Action
	get_description (gint32 i) : String Returns a description of the specified action of the object. Returns a description of the specified action of the object. Returns a description string, or NULL if action does not implement this interface. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed Returns: String	Atk.Action
	get_end_index () : gint32 Gets the index with the hypertext document at which this link ends. Gets the index with the hypertext document at which this link ends. Returns: gint32 the index with the hypertext document at which this link ends	Atk.Hyperlink
	get_keybinding (gint32 i) : String Returns a keybinding associated with this action, if one exists. Returns a keybinding associated with this action, if one exists. The returned string is in the format ";;" (i.e. semicolon-delimited), where is the keybinding which activates the object if it is presently enabled onscreen, corresponds to the keybinding or sequence of keys which invokes the action even if the relevant element is not currently posted on screen (for instance, for a menu item it posts the parent menus before invoking). The last token in the above string, if non-empty, represents a keyboard shortcut which invokes the same action without posting the component or its enclosing menus or dialogs. Returns a string representing the available keybindings, or NULL if there is no keybinding for this action. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed Returns: String	Atk.Action
	get_localized_name (gint32 i) : String Returns the localized name of the specified action of the object. Returns the localized name of the specified action of the object. Returns a name string, or NULL if action does not implement this interface. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed Returns: String	Atk.Action
	get_n_actions () : gint32 Gets the number of accessible actions available on the object. 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. implement this interface. Returns: gint32 a the number of actions, or 0 if action does not	Atk.Action
	get_n_anchors () : gint32 Gets the number of anchors associated with this hyperlink. Gets the number of anchors associated with this hyperlink. Returns: gint32 the number of anchors associated with this hyperlink	Atk.Hyperlink
	get_name (gint32 i) : String Returns a non-localized string naming the specified action of the object. 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 "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. For technical reasons, some toolkits cannot guarantee that the reported action is actually 'bound' to a nontrivial user event; i.e. the result of some actions via atk_action_do_action() may be NIL. Returns a name string, or NULL if action does not implement this interface. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed Returns: String	Atk.Action
	get_object (gint32 i) : Atk.Object Returns the item associated with this hyperlinks nth anchor. 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. Multiple anchors are primarily used by client-side image maps. i-th anchor Parameters: gint32 i Required (not null) a (zero-index) integer specifying the desired anchor Returns: Atk.Object an AtkObject associated with this hyperlinks	Atk.Hyperlink
	get_start_index () : gint32 Gets the index with the hypertext document at which this link begins. Gets the index with the hypertext document at which this link begins. Returns: gint32 the index with the hypertext document at which this link begins	Atk.Hyperlink
	get_uri (gint32 i) : String Get a the URI associated with the anchor specified by i of link_. Get a the URI associated with the anchor specified by i of link_. Multiple anchors are primarily used by client-side image maps. Parameters: gint32 i Required (not null) a (zero-index) integer specifying the desired anchor Returns: String a string specifying the URI	Atk.Hyperlink
	is_inline () : gboolean Indicates whether the link currently displays some or all of its content 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. Returns: gboolean whether or not this link displays its content inline.	Atk.Hyperlink
	is_valid () : gboolean 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. 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. Returns: gboolean whether or not this link is still valid	Atk.Hyperlink
	set_description (gint32 i, String *desc) : gboolean Sets a description of the specified action of the object. Sets a description of the specified action of the object. Parameters: gint32 i Required (not null) the action index corresponding to the action to be performed String desc* Required (not null) the description to be assigned to this action Returns: gboolean a gboolean representing if the description was successfully set;	Atk.Action

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	link_activated (Hyperlink *self) : none Parameters: Atk.Hyperlink self* Returns: {none}	Atk.Hyperlink

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Atk.HyperlinkImpl Method	get_hyperlink () : Atk.Hyperlink Gets the hyperlink associated with this object.
Atk.Hypertext Method	get_link (gint32 *link_index) : Atk.Hyperlink Gets the link in this hypertext document at index index link_index*

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:08:59 GMT+0800 (HKT)