Phoenix Logo

phoenix_title wx.html.HtmlCellEvent

This event class is used for the events generated by wx.html.HtmlWindow.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.html.HtmlCellEvent parameter.

  • EVT_HTML_CELL_HOVER: User moved the mouse over a wx.html.HtmlCell.
  • EVT_HTML_CELL_CLICKED: User clicked on a wx.html.HtmlCell. When handling this event, remember to use HtmlCell.SetLinkClicked(true) if the cell contains a link.

class_hierarchy Class Hierarchy

Inheritance diagram for class HtmlCellEvent:

method_summary Methods Summary

__init__ The constructor is not normally used by the user code.
GetCell Returns the wx.html.HtmlCellEvent associated with the event.
GetLinkClicked Returns True if SetLinkClicked(true) has previously been called; False otherwise.
GetMouseEvent Returns the wx.MouseEvent associated with the event.
GetPoint Returns the wx.Point associated with the event.
SetLinkClicked 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).

api Class API



class wx.html.HtmlCellEvent(CommandEvent)

Possible constructors:

HtmlCellEvent(commandType, id, cell, point, ev)

This event class is used for the events generated by HtmlWindow.


Methods



__init__(self, commandType, id, cell, point, ev)

The constructor is not normally used by the user code.

Parameters:


GetCell(self)

Returns the wx.html.HtmlCellEvent associated with the event.

Return type: wx.html.HtmlCell


GetLinkClicked(self)

Returns True if SetLinkClicked(true) has previously been called; False otherwise.

Return type:bool


GetMouseEvent(self)

Returns the wx.MouseEvent associated with the event.

Return type:MouseEvent


GetPoint(self)

Returns the wx.Point associated with the event.

Return type:Point


SetLinkClicked(self, 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 which sent the event.

Parameters:linkclicked (bool) –

Properties



Cell

See GetCell



LinkClicked

See GetLinkClicked and SetLinkClicked



MouseEvent

See GetMouseEvent



Point

See GetPoint