Class: Wx::HTML::HtmlCellEvent

Inherits:
CommandEvent show all
Defined in:
lib/wx/doc/gen/html/html_cell_event.rb

Overview

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

Events using this class

The following event-handler methods redirect the events to member method or handler blocks for HtmlCellEvent events. Event handler methods:

Category: Wx::HTML, Events

Requires:

  • USE_HTML

Instance Method Summary collapse

Methods inherited from CommandEvent

#client_data, #client_data=, #get_client_data, #get_client_object, #get_int, #get_selection, #get_string, #is_checked, #is_selection, #set_client_data, #set_client_object, #set_extra_long, #set_int, #set_string

Methods inherited from Event

#clone, #get_event_category, #get_event_object, #get_event_type, #get_id, #get_skipped, #get_timestamp, #is_command_event, #resume_propagation, #set_event_object, #set_event_type, #set_id, #set_timestamp, #should_propagate, #skip, #stop_propagation

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(commandType, id, cell, point, ev) ⇒ Wx::HTML::HtmlCellEvent

The constructor is not normally used by the user code.

Parameters:



34
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 34

def initialize(commandType, id, cell, point, ev) end

Instance Method Details

#get_cell ⇒ Wx::HTML::HtmlCell, Wx::HTML::HtmlContainerCell Also known as: cell

Returns the Wx::HTML::HtmlCellEvent associated with the event.

Returns:



38
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 38

def get_cell; end

#get_link_clicked ⇒ Boolean Also known as: link_clicked

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

Returns:

  • (Boolean) 


43
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 43

def get_link_clicked; end

#get_mouse_event ⇒ Wx::MouseEvent Also known as: mouse_event

Returns the MouseEvent associated with the event.

Returns:



53
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 53

def get_mouse_event; end

#get_point ⇒ Wx::Point Also known as: point

Returns the Point associated with the event.

Returns:



48
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 48

def get_point; end

#set_link_clicked(linkclicked) ⇒ void Also known as: link_clicked=

This method returns an undefined value.

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 (Boolean) 


61
 
# File 'lib/wx/doc/gen/html/html_cell_event.rb', line 61

def set_link_clicked(linkclicked) end