<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>gtkmm: Atk::Hyperlink Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Hyperlink.html">Hyperlink</a> </div> </div> <div class="contents"> <h1>Atk::Hyperlink Class Reference</h1><!-- doxytag: class="Atk::Hyperlink" --><!-- doxytag: inherits="Glib::Object,Atk::Action" --> <p>Encapsulates a link or set of links in a hypertext document. <a href="#_details">More...</a></p> <p>Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>, and <a class="el" href="classAtk_1_1Action.html">Atk::Action</a>.</p> <div class="dynheader"> Collaboration diagram for Atk::Hyperlink:</div> <div class="dynsection"> <div class="center"><img src="classAtk_1_1Hyperlink__coll__graph.png" border="0" usemap="#Atk_1_1Hyperlink_coll__map" alt="Collaboration graph"/></div> <map name="Atk_1_1Hyperlink_coll__map" id="Atk_1_1Hyperlink_coll__map"> <area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,237,96,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="40,83,160,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="104,160,208,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="47,5,153,35"/><area shape="rect" href="classAtk_1_1Action.html" title="The ATK interface provided by UI components which the user can activate/interact..." alt="" coords="120,237,205,267"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classAtk_1_1Hyperlink-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#aa08e613adf23b0bbb0bf0977980a3ebe">~Hyperlink</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">AtkHyperlink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a99f2d77401d7707606714aaa2299a0b6">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a99f2d77401d7707606714aaa2299a0b6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const AtkHyperlink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#aa67b0c75fcc91b7c5eda616d8ee4f9bb">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aa67b0c75fcc91b7c5eda616d8ee4f9bb"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">AtkHyperlink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a8eab74455274d14ba2e6a9ff5ce523a1">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a8eab74455274d14ba2e6a9ff5ce523a1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a75ad4d2cc741a2500af3c626efca76ff">get_uri</a> (int i) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a the URI associated with the anchor specified by <em>i</em> of <em>link</em>. <a href="#a75ad4d2cc741a2500af3c626efca76ff"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a76a73ddbae151631481c61b8aff68605">get_object</a> (int i)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the item associated with this hyperlinks nth anchor. <a href="#a76a73ddbae151631481c61b8aff68605"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#ab0f85e1b6fcecde119887070327f3494">get_object</a> (int i) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the item associated with this hyperlinks nth anchor. <a href="#ab0f85e1b6fcecde119887070327f3494"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#aea6e544340f4b0880b6931e00020b5f8">get_end_index</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the index with the hypertext document at which this link ends. <a href="#aea6e544340f4b0880b6931e00020b5f8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a574e97644531c9d9433396afabd21259">get_start_index</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the index with the hypertext document at which this link begins. <a href="#a574e97644531c9d9433396afabd21259"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a35779f410dbeda1f015724d2e958500c">is_valid</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Since the document that a link is associated with may have changed this method returns <code>true</code> if the link is still valid (with respect to the document it references) and <code>false</code> otherwise. <a href="#a35779f410dbeda1f015724d2e958500c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#acba76981171a0c4cfa26c1e1d29d61c7">is_inline</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the link currently displays some or all of its content inline. <a href="#acba76981171a0c4cfa26c1e1d29d61c7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#af073b29368e1748f5e228800c3648156">get_n_anchors</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of anchors associated with this hyperlink. <a href="#af073b29368e1748f5e228800c3648156"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#aba904845db65fea23cc0133852cc0ac9">is_selected_link</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this AtkHyperlink is selected. <a href="#aba904845db65fea23cc0133852cc0ac9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a881cbeaedcf04da340f6592ebe5526d4">signal_link_activated</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/> < bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#abd1a0703639c37566ca99d84f0e2d8d7">property_selected_link</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether the AtkHyperlink object is selected. <a href="#abd1a0703639c37566ca99d84f0e2d8d7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a78780011c03371fbab1bf699f9f5760e">property_number_of_anchors</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of anchors associated with the AtkHyperlink object. <a href="#a78780011c03371fbab1bf699f9f5760e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#ac1f3fc708131c8feb3147c1becec4ad0">property_end_index</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The end index of the AtkHyperlink object. <a href="#ac1f3fc708131c8feb3147c1becec4ad0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a2e903b6f31f57e6605002031f04058d5">property_start_index</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The start index of the AtkHyperlink object. <a href="#a2e903b6f31f57e6605002031f04058d5"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual gchar* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#af194a7bef05db3e85171d175fdd60819">get_uri_vfunc</a> (int i) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a8afaed8f11fbc4914d7c3647c2917206">get_object_vfunc</a> (int i)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a9145f9091618c074bc66bf693ca724b3">get_end_index_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a26c09a6c6924d37df497d95af7168d3d">get_start_index_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a3e1742105026e816b353840a23258fe0">is_valid_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a97a6b13ef828068907045f1e7e3693d3">get_n_anchors_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a2663f5da6c0a19e514945d6704bbab9b">link_state_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a47498b1d5093e828a5740365d0e13905">is_selected_link_vfunc</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#a50b6602f4b136a7a48e1b6d199e2a2e7">on_link_activated</a> ()</td></tr> <tr><td colspan="2"><h2>Related Functions</h2></td></tr> <tr><td colspan="2"><p>(Note that these are not member functions.) </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Hyperlink.html">Atk::Hyperlink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Hyperlink.html#af90587b7c6392449e9e406f7cc6d3a8f">wrap</a> (AtkHyperlink* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#af90587b7c6392449e9e406f7cc6d3a8f"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Encapsulates a link or set of links in a hypertext document. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa08e613adf23b0bbb0bf0977980a3ebe"></a><!-- doxytag: member="Atk::Hyperlink::~Hyperlink" ref="aa08e613adf23b0bbb0bf0977980a3ebe" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Atk::Hyperlink::~Hyperlink </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aea6e544340f4b0880b6931e00020b5f8"></a><!-- doxytag: member="Atk::Hyperlink::get_end_index" ref="aea6e544340f4b0880b6931e00020b5f8" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Atk::Hyperlink::get_end_index </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Gets the index with the hypertext document at which this link ends. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The index with the hypertext document at which this link ends. </dd></dl> </div> </div> <a class="anchor" id="a9145f9091618c074bc66bf693ca724b3"></a><!-- doxytag: member="Atk::Hyperlink::get_end_index_vfunc" ref="a9145f9091618c074bc66bf693ca724b3" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Atk::Hyperlink::get_end_index_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af073b29368e1748f5e228800c3648156"></a><!-- doxytag: member="Atk::Hyperlink::get_n_anchors" ref="af073b29368e1748f5e228800c3648156" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Atk::Hyperlink::get_n_anchors </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Gets the number of anchors associated with this hyperlink. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The number of anchors associated with this hyperlink. </dd></dl> </div> </div> <a class="anchor" id="a97a6b13ef828068907045f1e7e3693d3"></a><!-- doxytag: member="Atk::Hyperlink::get_n_anchors_vfunc" ref="a97a6b13ef828068907045f1e7e3693d3" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Atk::Hyperlink::get_n_anchors_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab0f85e1b6fcecde119887070327f3494"></a><!-- doxytag: member="Atk::Hyperlink::get_object" ref="ab0f85e1b6fcecde119887070327f3494" args="(int i) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::Hyperlink::get_object </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the item associated with this hyperlinks nth anchor. </p> <p>For instance, the returned <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> will implement <a class="el" href="classAtk_1_1Text.html" title="The ATK interface implemented by components with text content.">Atk::Text</a> if <em>link</em> is a text hyperlink, <a class="el" href="classAtk_1_1Image.html" title="The ATK Interface implemented by components which expose image or pixmap content...">Atk::Image</a> if <em>link</em> is an image hyperlink etc.</p> <p>Multiple anchors are primarily used by client-side image maps. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>A (zero-index) integer specifying the desired anchor. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>An <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> associated with this hyperlinks i-th anchor. </dd></dl> </div> </div> <a class="anchor" id="a76a73ddbae151631481c61b8aff68605"></a><!-- doxytag: member="Atk::Hyperlink::get_object" ref="a76a73ddbae151631481c61b8aff68605" args="(int i)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::Hyperlink::get_object </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the item associated with this hyperlinks nth anchor. </p> <p>For instance, the returned <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> will implement <a class="el" href="classAtk_1_1Text.html" title="The ATK interface implemented by components with text content.">Atk::Text</a> if <em>link</em> is a text hyperlink, <a class="el" href="classAtk_1_1Image.html" title="The ATK Interface implemented by components which expose image or pixmap content...">Atk::Image</a> if <em>link</em> is an image hyperlink etc.</p> <p>Multiple anchors are primarily used by client-side image maps. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>A (zero-index) integer specifying the desired anchor. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>An <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> associated with this hyperlinks i-th anchor. </dd></dl> </div> </div> <a class="anchor" id="a8afaed8f11fbc4914d7c3647c2917206"></a><!-- doxytag: member="Atk::Hyperlink::get_object_vfunc" ref="a8afaed8f11fbc4914d7c3647c2917206" args="(int i)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>> Atk::Hyperlink::get_object_vfunc </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a574e97644531c9d9433396afabd21259"></a><!-- doxytag: member="Atk::Hyperlink::get_start_index" ref="a574e97644531c9d9433396afabd21259" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Atk::Hyperlink::get_start_index </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Gets the index with the hypertext document at which this link begins. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The index with the hypertext document at which this link begins. </dd></dl> </div> </div> <a class="anchor" id="a26c09a6c6924d37df497d95af7168d3d"></a><!-- doxytag: member="Atk::Hyperlink::get_start_index_vfunc" ref="a26c09a6c6924d37df497d95af7168d3d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Atk::Hyperlink::get_start_index_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a75ad4d2cc741a2500af3c626efca76ff"></a><!-- doxytag: member="Atk::Hyperlink::get_uri" ref="a75ad4d2cc741a2500af3c626efca76ff" args="(int i) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Atk::Hyperlink::get_uri </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get a the URI associated with the anchor specified by <em>i</em> of <em>link</em>. </p> <p>Multiple anchors are primarily used by client-side image maps. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>A (zero-index) integer specifying the desired anchor. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A string specifying the URI. </dd></dl> </div> </div> <a class="anchor" id="af194a7bef05db3e85171d175fdd60819"></a><!-- doxytag: member="Atk::Hyperlink::get_uri_vfunc" ref="af194a7bef05db3e85171d175fdd60819" args="(int i) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gchar* Atk::Hyperlink::get_uri_vfunc </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa67b0c75fcc91b7c5eda616d8ee4f9bb"></a><!-- doxytag: member="Atk::Hyperlink::gobj" ref="aa67b0c75fcc91b7c5eda616d8ee4f9bb" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const AtkHyperlink* Atk::Hyperlink::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classAtk_1_1Action.html#a2372fab551e83919d6d55010f881044f">Atk::Action</a>.</p> </div> </div> <a class="anchor" id="a99f2d77401d7707606714aaa2299a0b6"></a><!-- doxytag: member="Atk::Hyperlink::gobj" ref="a99f2d77401d7707606714aaa2299a0b6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">AtkHyperlink* Atk::Hyperlink::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classAtk_1_1Action.html#a922d5d2a5c8af62cdea07810b229094e">Atk::Action</a>.</p> </div> </div> <a class="anchor" id="a8eab74455274d14ba2e6a9ff5ce523a1"></a><!-- doxytag: member="Atk::Hyperlink::gobj_copy" ref="a8eab74455274d14ba2e6a9ff5ce523a1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">AtkHyperlink* Atk::Hyperlink::gobj_copy </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p> </div> </div> <a class="anchor" id="acba76981171a0c4cfa26c1e1d29d61c7"></a><!-- doxytag: member="Atk::Hyperlink::is_inline" ref="acba76981171a0c4cfa26c1e1d29d61c7" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Hyperlink::is_inline </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Indicates whether the link currently displays some or all of its content inline. </p> <p>Ordinary HTML links will usually return <code>false</code>, but an inline <src> HTML element will return <code>true</code>. a * </p> <dl class="return"><dt><b>Returns:</b></dt><dd>Whether or not this link displays its content inline. </dd></dl> </div> </div> <a class="anchor" id="aba904845db65fea23cc0133852cc0ac9"></a><!-- doxytag: member="Atk::Hyperlink::is_selected_link" ref="aba904845db65fea23cc0133852cc0ac9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Hyperlink::is_selected_link </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Determines whether this AtkHyperlink is selected. </p> <dl class="since_1_4"><dt><b><a class="el" href="since_1_4.html#_since_1_4000001">Since gtkmm 1.4:</a></b></dt><dd></dd></dl> <p><em>Deprecated:</em> This method is deprecated since ATK version 1.8. Please use ATK_STATE_SELECTED to indicate when a hyperlink within a <a class="el" href="classAtk_1_1Hypertext.html">Hypertext</a> container is selected. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>True is the AtkHyperlink is selected, False otherwise. </dd></dl> </div> </div> <a class="anchor" id="a47498b1d5093e828a5740365d0e13905"></a><!-- doxytag: member="Atk::Hyperlink::is_selected_link_vfunc" ref="a47498b1d5093e828a5740365d0e13905" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Atk::Hyperlink::is_selected_link_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a35779f410dbeda1f015724d2e958500c"></a><!-- doxytag: member="Atk::Hyperlink::is_valid" ref="a35779f410dbeda1f015724d2e958500c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::Hyperlink::is_valid </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Since the document that a link is associated with may have changed this method returns <code>true</code> if the link is still valid (with respect to the document it references) and <code>false</code> otherwise. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>Whether or not this link is still valid. </dd></dl> </div> </div> <a class="anchor" id="a3e1742105026e816b353840a23258fe0"></a><!-- doxytag: member="Atk::Hyperlink::is_valid_vfunc" ref="a3e1742105026e816b353840a23258fe0" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Atk::Hyperlink::is_valid_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a2663f5da6c0a19e514945d6704bbab9b"></a><!-- doxytag: member="Atk::Hyperlink::link_state_vfunc" ref="a2663f5da6c0a19e514945d6704bbab9b" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual guint Atk::Hyperlink::link_state_vfunc </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a50b6602f4b136a7a48e1b6d199e2a2e7"></a><!-- doxytag: member="Atk::Hyperlink::on_link_activated" ref="a50b6602f4b136a7a48e1b6d199e2a2e7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void Atk::Hyperlink::on_link_activated </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac1f3fc708131c8feb3147c1becec4ad0"></a><!-- doxytag: member="Atk::Hyperlink::property_end_index" ref="ac1f3fc708131c8feb3147c1becec4ad0" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Atk::Hyperlink::property_end_index </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>The end index of the AtkHyperlink object. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a78780011c03371fbab1bf699f9f5760e"></a><!-- doxytag: member="Atk::Hyperlink::property_number_of_anchors" ref="a78780011c03371fbab1bf699f9f5760e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Atk::Hyperlink::property_number_of_anchors </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>The number of anchors associated with the AtkHyperlink object. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="abd1a0703639c37566ca99d84f0e2d8d7"></a><!-- doxytag: member="Atk::Hyperlink::property_selected_link" ref="abd1a0703639c37566ca99d84f0e2d8d7" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Atk::Hyperlink::property_selected_link </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Specifies whether the AtkHyperlink object is selected. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a2e903b6f31f57e6605002031f04058d5"></a><!-- doxytag: member="Atk::Hyperlink::property_start_index" ref="a2e903b6f31f57e6605002031f04058d5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Atk::Hyperlink::property_start_index </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>The start index of the AtkHyperlink object. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a881cbeaedcf04da340f6592ebe5526d4"></a><!-- doxytag: member="Atk::Hyperlink::signal_link_activated" ref="a881cbeaedcf04da340f6592ebe5526d4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Atk::Hyperlink::signal_link_activated </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_link_activated()</code> </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="af90587b7c6392449e9e406f7cc6d3a8f"></a><!-- doxytag: member="Atk::Hyperlink::wrap" ref="af90587b7c6392449e9e406f7cc6d3a8f" args="(AtkHyperlink *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Hyperlink.html">Atk::Hyperlink</a> > wrap </td> <td>(</td> <td class="paramtype">AtkHyperlink * </td> <td class="paramname"> <em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>atkmm/hyperlink.h</li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:42 2010 for gtkmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>