Class: Wx::HeaderCtrlEvent

Inherits:
NotifyEvent show all
Defined in:
lib/wx/doc/gen/header_ctrl_event.rb

Overview

Event class representing the events generated by HeaderCtrl.

Category: Events

See Also:

Instance Method Summary collapse

Methods inherited from NotifyEvent

#allow, #is_allowed, #veto

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 = Wx::EVT_NULL, winid = 0) ⇒ Wx::HeaderCtrlEvent #initialize(event) ⇒ Wx::HeaderCtrlEvent

Returns a new instance of HeaderCtrlEvent.

Overloads:



92
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 92

def initialize(*args) end

Instance Method Details

#get_column ⇒ Integer Also known as: column

Return the index of the column affected by this event.

This method can be called for all header control events.

Returns:

  • (Integer) 


98
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 98

def get_column; end

#get_new_order ⇒ Integer Also known as: new_order

Return the new order of the column.

This method can only be called for a reorder event for which it indicates the tentative new position for the column #get_column selected by the user. If the event is not vetoed, this will become the new column position in Wx::HeaderCtrl#get_columns_order.

Returns:

  • (Integer) 


122
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 122

def get_new_order; end

#get_width ⇒ Integer Also known as: width

Return the current width of the column.

This method can only be called for the dragging events.

Returns:

  • (Integer) 


110
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 110

def get_width; end

#set_column(col) ⇒ void Also known as: column=

This method returns an undefined value.

Parameters:

  • col (Integer) 


103
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 103

def set_column(col) end

#set_new_order(order) ⇒ void Also known as: new_order=

This method returns an undefined value.

Parameters:

  • order (Integer) 


127
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 127

def set_new_order(order) end

#set_width(width) ⇒ void Also known as: width=

This method returns an undefined value.

Parameters:

  • width (Integer) 


115
 
# File 'lib/wx/doc/gen/header_ctrl_event.rb', line 115

def set_width(width) end