*********************
wx.html.HtmlCellEvent
*********************
Inheritance diagram for `wx.html.HtmlCellEvent`:
|
.. inheritance-diagram:: wx.html.HtmlCellEvent
|
Description
===========
This event class is used for the events generated by `wx.html.HtmlWindow <../html/wx.html.HtmlWindow.html>`_.
Derived From
^^^^^^^^^^^^^
* `wx.CommandEvent `_
* `wx.Event `_
* `wx.Object <../Widgets/wx.Object.html>`_
Event Handling
^^^^^^^^^^^^^^
================================================== ==================================================
Event Name Description
================================================== ==================================================
wx.html.EVT_HTML_CELL_HOVER(id, func) User moved the mouse over a `wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_.
wx.html.EVT_HTML_CELL_CLICKED(id, func) User clicked on a `wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_. When handling this event, remember to use `SetLinkClicked <#SetLinkClicked>`_ if the cell contains a link.
================================================== ==================================================
Methods Summary
^^^^^^^^^^^^^^^
* `__init__ <#__init__>`_
* `GetCell <#GetCell>`_
* `GetLinkClicked <#GetLinkClicked>`_
* `GetMouseEvent <#GetMouseEvent>`_
* `GetPoint <#GetPoint>`_
* `SetLinkClicked <#SetLinkClicked>`_
Class API
=========
Methods
^^^^^^^
.. method:: __init__(commandType, id, cell, pt, ev)
The constructor is not normally used by the user code.
**Parameters:**
* `commandType` (eventtype)
* `id` (int)
* `cell` (`wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_)
* `pt` (`wx.Point <../Widgets/wx.Point.html>`_)
* `ev` (`wx.MouseEvent `_)
|
**Returns:**
`wx.html.HtmlCellEvent `_
--------
.. method:: GetCell()
Returns the `wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_ associated with the event.
|
**Returns:**
`wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_
--------
.. method:: GetLinkClicked()
Returns ``True`` if `SetLinkClicked <#SetLinkClicked>`_ has previously been called; ``False`` otherwise.
|
**Returns:**
`bool`
--------
.. method:: GetMouseEvent()
`No docstrings available for this method.`
--------
.. method:: GetPoint()
Returns the `wx.Point <../Widgets/wx.Point.html>`_ associated with the event.
|
**Returns:**
`wx.Point <../Widgets/wx.Point.html>`_
--------
.. method:: SetLinkClicked(linkclicked)
Call this function with `linkclicked` set to ``True`` if the cell which has been clicked contained a link or ``False``
otherwise (which is the default).
With this function the event handler can return info to the `wx.html.HtmlWindow <../html/wx.html.HtmlWindow.html>`_ which sent the event.
**Parameters:**
* `linkclicked` (bool)
|
**Returns:**
`bool`