xml/org.freedesktop.atspi.Hyperlink.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3
   4
   5
   6
   7
   8 <interface name="org.freedesktop.atspi.Hyperlink">
   9   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  10     <p>Instances of Hyperlink are returned by Hypertext objects, and are
  11       the means by which end users and clients interact with linked, and in
  12       some cases embedded, content.  Hyperlinks may have multiple "anchors",
  13       where an anchor corresponds to a reference to a particular resource with
  14       a corresponding resource identified (URI).  Hyperlinks may be
  15       queried for their URIs, or queried for the objects corresponding to their
  16       anchors.  The objects thus obtained are instances of Accessible,
  17       and may be queried, and manipulated via the Action interface.   </p>
  18
  19     <p>@note A Hyperlink implementor is normally NOT an Accessible;
  20       the preferred usage is for a Hyperlink's associated "objects"
  21       (accessed via the ::getObject method) are Accessibles.  This means
  22       that Actions such as "open link" are normally invoked on
  23       the result of Hyperlink::getObject rather than directly on the
  24       Hyperlink instance. For historical reasons some implementors of Hyperlink
  25       implement Action as well.  This usage on the part of implementing
  26       applications and toolkits is discouraged, but clients of Hyperlink
  27       should be aware of it and prepared to handle such usage.</p>
  28   </tp:docstring>
  29   <tp:property name="nAnchors" type="n" access="read">
  30   <tp:docstring>
  31     the number of separate anchors associated with this Hyperlink
  32   </tp:docstring>
  33   </tp:property>
  34   <tp:property name="startIndex" type="i" access="read">
  35   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  36     <p>the starting offset within the containing Hypertext content
  37       with which this Hyperlink is associated </p>
  38   </tp:docstring>
  39   </tp:property>
  40   <tp:property name="endIndex" type="i" access="read">
  41   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  42     <p>the ending offset within the containing Hypertext content
  43       with which this Hyperlink is associated; that is, the offset of the
  44       first element past the range within the Hypertext associated with
  45       this Hyperlink. </p>
  46   </tp:docstring>
  47   </tp:property>
  48   <method name="getObject">
  49     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  50       <p>Gets the i'th object, (where i is an integer between 0 and
  51         Hyperlink::numAnchors - 1, inclusive) associated with a Hyperlink.
  52         The objects returned are usually actionable (i.e. they should implement
  53         Accessibility::Action), and the available actions often include
  54         "open", "bookmark", "save link as", etc.  They may also implement
  55         Accessibility::StreamableContent, although clients can normally use
  56         ::getURI to obtain a resource locator via which the object's
  57         data may be accessed.    </p>
  58
  59       <p>@note the most common application for 'multi anchor'
  60         hyperlinks in HTML is probably "client side imagemaps".
  61         A clickable image which uses the HTML 'usemap' attribute
  62         should have one anchor for every &lt;area&gt; element that
  63         includes an HREF.  The objects corresponding to these map
  64         areas may implement Accessibility::Component, to represent
  65         their onscreen bounding box, and may expose their 'shape' as
  66         as name-value pair via Accessibility::Accessible::getAttributeSet.    </p>
  67     </tp:docstring>
  68     <arg direction="in" name="i" type="i"/>
  69     <arg direction="out" type="o" tp:type="Accessible">
  70     <tp:docstring>
  71       an Accessible object instance representing theHyperlink's ith anchor, or through which the content associated withthe \c ith anchor can beaccessed.
  72     </tp:docstring>
  73     </arg>
  74   </method>
  75   <method name="getURI">
  76     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  77       <p>Obtain a resource locator ('URI') which can be used to
  78         access the content to which this link "points" or is connected.</p>
  79     </tp:docstring>
  80     <arg direction="in" name="i" type="i"/>
  81     <arg direction="out" type="s">
  82     <tp:docstring>
  83       a string corresponding to the URI of the Hyperlink's'ith' anchor, if one exists, or a NIL string otherwise.
  84     </tp:docstring>
  85     </arg>
  86   </method>
  87   <method name="isValid">
  88     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  89       <p>Check the hyperlink to see if a connection to its backing
  90         content can be established, or if its URI is valid.
  91         @note instances of invalid hyperlinks include links with malformed
  92         URIs, or for which a contact to the service provider
  93         specified in the URI cannot be established.</p>
  94     </tp:docstring>
  95     <arg direction="out" type="b" tp:type="boolean">
  96     <tp:docstring>
  97       \c True if the object's content is available, or\c False if the hyperlink's URI is invalid, or a connection to the resource can not be established.
  98     </tp:docstring>
  99     </arg>
 100   </method>
 101   <method name="unImplemented">
 102     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 103       <p>\cond
 104         unImplemented:    </p>
 105
 106       <p>placeholders for future expansion.</p>
 107     </tp:docstring>
 108   </method>
 109   <method name="unImplemented2">
 110   </method>
 111   <method name="unImplemented3">
 112   </method>
 113   <method name="unImplemented4">
 114   </method>
 115 </interface>
 116 </node>