summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBill Haneman <billh@src.gnome.org>2006-06-29 17:18:49 +0000
committerBill Haneman <billh@src.gnome.org>2006-06-29 17:18:49 +0000
commitcce2ac695d7bd357bed8941b9086bce6f30b1ab8 (patch)
tree39bc8b5dfe6e7ebbf2bd2a4af9f3927eb6c087cc /docs
parentcb4ef999bc51cb5558a689abf0208e3994b88407 (diff)
downloadatk-cce2ac695d7bd357bed8941b9086bce6f30b1ab8.tar.gz
Added AtkHyperlinkImpl interface. See RFE #344284.
Diffstat (limited to 'docs')
-rw-r--r--docs/atk-sections.txt13
-rw-r--r--docs/tmpl/atkhyperlink.sgml7
-rw-r--r--docs/tmpl/atkhyperlinkimpl.sgml48
3 files changed, 66 insertions, 2 deletions
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index cb538b2..61cb8e3 100644
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -480,6 +480,19 @@ AtkHyperlinkClass
</SECTION>
<SECTION>
+<FILE>atkhyperlinkimpl</FILE>
+<TITLE>AtkHyperlinkImpl</TITLE>
+AtkHyperlinkImpl
+atk_hyperlink_impl_get_hyperlink
+<SUBSECTION Standard>
+ATK_HYPERLINK_IMPL
+ATK_IS_HYPERLINK_IMPL
+ATK_TYPE_HYPERLINK_IMPL
+atk_hyperlink_impl_get_type
+ATK_HYPERLINK_IMPL_GET_IFACE
+</SECTION>
+
+<SECTION>
<FILE>atkstate</FILE>
<TITLE>AtkState</TITLE>
AtkStateType
diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml
index b0bcc62..12ed025 100644
--- a/docs/tmpl/atkhyperlink.sgml
+++ b/docs/tmpl/atkhyperlink.sgml
@@ -6,8 +6,11 @@ An ATK object which encapsulates a link or set of links in a hypertext document.
<!-- ##### SECTION Long_Description ##### -->
<para>
-An ATK object which encapsulates a link or set of links in a hypertext document.
-It implements the AtkAction interface.
+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.
</para>
<!-- ##### SECTION See_Also ##### -->
diff --git a/docs/tmpl/atkhyperlinkimpl.sgml b/docs/tmpl/atkhyperlinkimpl.sgml
new file mode 100644
index 0000000..fd97906
--- /dev/null
+++ b/docs/tmpl/atkhyperlinkimpl.sgml
@@ -0,0 +1,48 @@
+<!-- ##### SECTION Title ##### -->
+AtkHyperlinkImpl
+
+<!-- ##### SECTION Short_Description ##### -->
+An interface from which the AtkHyperlink associated with an
+AtkObject may be obtained.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+AtkHyperlinkImpl allows AtkObjects to
+refer to their associated AtkHyperlink instance, if one
+exists. AtkHyperlinkImpl differs from AtkHyperlink in that
+AtkHyperlinkImpl is an interface, whereas AtkHyperlink is
+a object type. The AtkHyperlinkImpl interface allows
+a client to query an AtkObject for the availability of
+an associated AtkHyperlink instance, and obtain that
+instance. It is thus particularly useful in cases where
+embedded content or inline content within a text object
+is present, since the embedding text object implements
+AtkHypertext and the inline/embedded objects are
+exposed as children which implement AtkHyperlinkImpl,
+in addition to their being obtainable via AtkHypertext:getLink
+followed by AtkHyperlink:getObject.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT AtkHyperlinkImpl ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION atk_hyperlink_impl_get_hyperlink ##### -->
+<para>
+
+</para>
+
+@obj:
+@Returns:
+
+