Phoenix Logo

phoenix_title wx.HeaderCtrlEvent

Event class representing the events generated by wx.HeaderCtrl.

See also

wx.HeaderCtrl


class_hierarchy Class Hierarchy

Inheritance diagram for class HeaderCtrlEvent:


method_summary Methods Summary

__init__  
GetColumn Return the index of the column affected by this event.
GetNewOrder Return the new order of the column.
GetWidth Return the current width of the column.
SetColumn  
SetNewOrder  
SetWidth  

property_summary Properties Summary

Column See GetColumn and SetColumn
NewOrder See GetNewOrder and SetNewOrder
Width See GetWidth and SetWidth

api Class API



class wx.HeaderCtrlEvent(NotifyEvent)

Possible constructors:

HeaderCtrlEvent(commandType=wxEVT_NULL, winid=0)

HeaderCtrlEvent(event)

Event class representing the events generated by HeaderCtrl.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, commandType=wxEVT_NULL, winid=0)

Parameters:
  • commandType (wx.EventType) –
  • winid (int) –



__init__ (self, event)

Parameters:event (wx.HeaderCtrlEvent) –





GetColumn(self)

Return the index of the column affected by this event.

This method can be called for all header control events.

Return type:int


GetNewOrder(self)

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 GetColumn selected by the user. If the event is not vetoed, this will become the new column position in wx.HeaderCtrl.GetColumnsOrder .

Return type:int


GetWidth(self)

Return the current width of the column.

This method can only be called for the dragging events.

Return type:int


SetColumn(self, col)
Parameters:col (int) –


SetNewOrder(self, order)
Parameters:order (int) –


SetWidth(self, width)
Parameters:width (int) –

Properties



Column

See GetColumn and SetColumn



NewOrder

See GetNewOrder and SetNewOrder



Width

See GetWidth and SetWidth