docs/tmpl/atkhyperlinkimpl.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkHyperlinkImpl
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An interface from which the AtkHyperlink associated with an
   6 AtkObject may be obtained.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 AtkHyperlinkImpl allows AtkObjects to
  11 refer to their associated AtkHyperlink instance, if one
  12 exists.  AtkHyperlinkImpl differs from AtkHyperlink in that
  13 AtkHyperlinkImpl is an interface, whereas AtkHyperlink is
  14 a object type.  The AtkHyperlinkImpl interface allows
  15 a client to query an AtkObject for the availability of
  16 an associated AtkHyperlink instance, and obtain that
  17 instance.  It is thus particularly useful in cases where
  18 embedded content or inline content within a text object
  19 is present, since the embedding text object implements
  20 AtkHypertext and the inline/embedded objects are
  21 exposed as children which implement AtkHyperlinkImpl,
  22 in addition to their being obtainable via AtkHypertext:getLink
  23 followed by AtkHyperlink:getObject.
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28
  29 </para>
  30
  31 <!-- ##### SECTION Stability_Level ##### -->
  32
  33
  34 <!-- ##### SECTION Image ##### -->
  35
  36
  37 <!-- ##### STRUCT AtkHyperlinkImpl ##### -->
  38 <para>
  39 A queryable interface which allows AtkHyperlink instances associated with an
  40 AtkObject to be obtained.  AtkHyperlinkImpl corresponds to AT-SPI's
  41 Hyperlink interface, and differs from AtkHyperlink in that AtkHyperlink
  42 is an object type, rather than an interface, and thus cannot be directly
  43 queried.
  44 </para>
  45
  46
  47 <!-- ##### FUNCTION atk_hyperlink_impl_get_hyperlink ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @obj:
  53 @Returns:
  54
  55