* Boston, MA 02111-1307, USA.
*/
+#include "config.h"
#include "atkhyperlink.h"
-#include "atkintl.h"
+#include <glib/gi18n-lib.h>
+
+/**
+ * SECTION:atkhyperlink
+ * @Short_description: An ATK object which encapsulates a link or set
+ * of links in a hypertext document.
+ * @Title:AtkHyperlink
+ *
+ * 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.
+ */
enum
{
klass->link_activated = NULL;
+ /**
+ * AtkHyperlink:selected-link:
+ *
+ * Selected link
+ *
+ * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links, and
+ * ATK_STATE_FOCUSED for focused links.
+ */
g_object_class_install_property (gobject_class,
PROP_SELECTED_LINK,
g_param_spec_boolean ("selected-link",
0,
G_PARAM_READABLE));
g_object_class_install_property (gobject_class,
- PROP_END_INDEX,
+ PROP_START_INDEX,
g_param_spec_int ("start-index",
_("Start index"),
_("The start index of the AtkHyperlink object"),
G_MAXINT,
0,
G_PARAM_READABLE));
+
+ /**
+ * AtkHyperlink::link-activated:
+ * @atkhyperlink: the object which received the signal.
+ *
+ * The signal link-activated is emitted when a link is activated.
+ */
atk_hyperlink_signals[LINK_ACTIVATED] =
g_signal_new ("link_activated",
G_TYPE_FROM_CLASS (klass),
switch (prop_id)
{
case PROP_SELECTED_LINK:
- g_value_set_boolean (value, atk_hyperlink_is_selected_link (link));
+ // This property is deprecated, also the method to get the value
+ g_value_set_boolean (value, FALSE);
break;
case PROP_NUMBER_ANCHORS:
g_value_set_int (value, atk_hyperlink_get_n_anchors (link));
*
* Multiple anchors are primarily used by client-side image maps.
*
- * Returns: an #AtkObject associated with this hyperlinks i-th anchor
+ * Returns: (transfer none): an #AtkObject associated with this hyperlinks
+ * i-th anchor
**/
AtkObject*
atk_hyperlink_get_object (AtkHyperlink *link,
* content inline. Ordinary HTML links will usually return
* %FALSE, but an inline <src> HTML element will return
* %TRUE.
-a *
+ *
* Returns: whether or not this link displays its content inline.
*
**/
*
* Determines whether this AtkHyperlink is selected
*
- * Since: ATK 1.4
+ * Since: 1.4
*
- * @Deprecated: This method is deprecated since ATK version 1.8.
- * Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
- * Hypertext container is selected.
+ * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links,
+ * and ATK_STATE_FOCUSED for focused links.
*
- * Returns: True is the AtkHyperlink is selected, False otherwise
+ * Returns: True if the AtkHyperlink is selected, False otherwise
**/
gboolean
atk_hyperlink_is_selected_link (AtkHyperlink *link)