1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.html.HtmlLinkInfo:
==========================================================================================================================================
|phoenix_title| **wx.html.HtmlLinkInfo**
==========================================================================================================================================
This class stores all necessary information about hypertext links (as represented by <A> tag in HTML documents).
In current implementation it stores URL and target frame name.
.. note::
Frames are not currently supported by HTML!
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>HtmlLinkInfo</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.html.HtmlLinkInfo_inheritance.png" alt="Inheritance diagram of HtmlLinkInfo" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.html.HtmlLinkInfo.html" title="wx.html.HtmlLinkInfo" alt="" coords="4,83,157,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="40,5,121,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.html.HtmlLinkInfo.__init__` Default constructor.
:meth:`~wx.html.HtmlLinkInfo.GetEvent` Return pointer to event that generated OnLinkClicked() event.
:meth:`~wx.html.HtmlLinkInfo.GetHref` Return ``HREF`` value of the <A> tag.
:meth:`~wx.html.HtmlLinkInfo.GetHtmlCell` Return pointer to the cell that was clicked.
:meth:`~wx.html.HtmlLinkInfo.GetTarget` Return ``TARGET`` value of the <A> tag (this value is used to specify in which frame should be the page pointed by :meth:`~HtmlLinkInfo.GetHref` Href opened).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.html.HtmlLinkInfo.Event` See :meth:`~wx.html.HtmlLinkInfo.GetEvent`
:attr:`~wx.html.HtmlLinkInfo.Href` See :meth:`~wx.html.HtmlLinkInfo.GetHref`
:attr:`~wx.html.HtmlLinkInfo.HtmlCell` See :meth:`~wx.html.HtmlLinkInfo.GetHtmlCell`
:attr:`~wx.html.HtmlLinkInfo.Target` See :meth:`~wx.html.HtmlLinkInfo.GetTarget`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.html.HtmlLinkInfo(Object)
**Possible constructors**::
HtmlLinkInfo()
HtmlLinkInfo(href, target="")
This class stores all necessary information about hypertext links (as
represented by <A> tag in HTML documents).
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, href, target=EmptyString)`
Construct hypertext link from ``HREF`` (aka URL) and ``TARGET`` (name of target frame).
:param `href`:
:type `href`: string
:param `target`:
:type `target`: string
**~~~**
.. method:: GetEvent(self)
Return pointer to event that generated OnLinkClicked() event.
Valid only within :meth:`wx.html.HtmlWindow.OnLinkClicked` , ``None`` otherwise.
:rtype: :ref:`MouseEvent`
.. method:: GetHref(self)
Return ``HREF`` value of the <A> tag.
:rtype: `string`
.. method:: GetHtmlCell(self)
Return pointer to the cell that was clicked.
Valid only within :meth:`wx.html.HtmlWindow.OnLinkClicked` , ``None`` otherwise.
:rtype: :ref:`wx.html.HtmlCell`
.. method:: GetTarget(self)
Return ``TARGET`` value of the <A> tag (this value is used to specify in which frame should be the page pointed by :meth:`GetHref` Href opened).
:rtype: `string`
.. attribute:: Event
See :meth:`~wx.html.HtmlLinkInfo.GetEvent`
.. attribute:: Href
See :meth:`~wx.html.HtmlLinkInfo.GetHref`
.. attribute:: HtmlCell
See :meth:`~wx.html.HtmlLinkInfo.GetHtmlCell`
.. attribute:: Target
See :meth:`~wx.html.HtmlLinkInfo.GetTarget`
|