summaryrefslogtreecommitdiff
path: root/atspi/atspi-hypertext.c
diff options
context:
space:
mode:
authorMike Gorse <mgorse@novell.com>2010-11-20 10:59:06 -0500
committerMike Gorse <mgorse@novell.com>2010-11-20 10:59:06 -0500
commit585683c4e828aaa1dbb883df9274d14753a58088 (patch)
treee3920da08c8ef8ead088e59314addf36f7e7394b /atspi/atspi-hypertext.c
parent3f65b7902ce9f63a33c76bdc093e02ffa742a50a (diff)
downloadat-spi2-core-585683c4e828aaa1dbb883df9274d14753a58088.tar.gz
Add Hypertext and Hyperlink and some refactoring to support them
AtspiAccessible is now derived from a base class called AtspiObject which defines the object's application and object path, since this is common with AtspiHyperlink.
Diffstat (limited to 'atspi/atspi-hypertext.c')
-rw-r--r--atspi/atspi-hypertext.c123
1 files changed, 123 insertions, 0 deletions
diff --git a/atspi/atspi-hypertext.c b/atspi/atspi-hypertext.c
new file mode 100644
index 00000000..4b1814d1
--- /dev/null
+++ b/atspi/atspi-hypertext.c
@@ -0,0 +1,123 @@
+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include "atspi-private.h"
+
+/**
+ * atspi_hypertext_get_n_links:
+ * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
+ *
+ * Get the total number of #AtspiHyperlinks which an
+ * #AtspiHypertext implementor has.
+ *
+ * Returns: a #gint indicating the number of #AtspiHyperlinks
+ * of the #AtspiHypertext implementor, or -1 if
+ * the number cannot be determined (for example, if the
+ * #AtspiHypertext object is so large that it is not
+ * all currently in the memory cache).
+ **/
+gint
+atspi_hypertext_get_n_links (AtspiHypertext *obj, GError **error)
+{
+ dbus_int32_t retval = 0;
+
+ g_return_val_if_fail (obj != NULL, FALSE);
+
+ _atspi_dbus_call (obj, atspi_interface_hypertext, "GetNLinks", error, "=>i", &retval);
+
+ return retval;
+}
+
+/**
+ * atspi_hypertext_get_link:
+ * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
+ * @link_index: a (zero-index) integer indicating which hyperlink to query.
+ *
+ * Get the #AtspiHyperlink object at a specified index.
+ *
+ * Returns: (transfer full): the #AtspiHyperlink object specified by
+ * #link_index.
+ **/
+AtspiHyperlink *
+atspi_hypertext_get_link (AtspiHypertext *obj, gint link_index, GError **error)
+{
+ dbus_int32_t d_link_index = link_index;
+ DBusMessage *reply;
+
+ g_return_val_if_fail (obj != NULL, NULL);
+
+ reply = _atspi_dbus_call_partial (obj, atspi_interface_hypertext, "GetLink", error, "i", d_link_index);
+
+ return _atspi_dbus_return_hyperlink_from_message (reply);
+}
+
+/**
+ * atspi_hypertext_get_link_index:
+ * @obj: a pointer to the #AtspiHypertext implementor on which to operate.
+ * @character_offset: an integer specifying the character offset to query.
+ *
+ * Get the index of the #AtspiHyperlink object at a specified
+ * character offset.
+ *
+ * Returns: the linkIndex of the #AtspiHyperlink active at
+ * character offset @character_offset, or -1 if there is
+ * no hyperlink at the specified character offset.
+ **/
+int
+atspi_hypertext_get_link_index (AtspiHypertext *obj,
+ gint character_offset,
+ GError **error)
+{
+ dbus_int32_t d_character_offset = character_offset;
+ dbus_int32_t retval = -1;
+
+ g_return_val_if_fail (obj != NULL, -1);
+
+ _atspi_dbus_call (obj, atspi_interface_hypertext, "GetLinkIndex", error, "i=>i", d_character_offset, &retval);
+
+ return retval;
+}
+
+static void
+atspi_hypertext_base_init (AtspiHypertext *klass)
+{
+}
+
+GType
+atspi_hypertext_get_type (void)
+{
+ static GType type = 0;
+
+ if (!type) {
+ static const GTypeInfo tinfo =
+ {
+ sizeof (AtspiHypertext),
+ (GBaseInitFunc) atspi_hypertext_base_init,
+ (GBaseFinalizeFunc) NULL,
+ };
+
+ type = g_type_register_static (G_TYPE_INTERFACE, "AtspiHypertext", &tinfo, 0);
+
+ }
+ return type;
+}