.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HeaderCtrlEvent:
==========================================================================================================================================
|phoenix_title| **wx.HeaderCtrlEvent**
==========================================================================================================================================
Event class representing the events generated by :ref:`wx.HeaderCtrl`.
.. seealso:: :ref:`wx.HeaderCtrl`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HeaderCtrlEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HeaderCtrlEvent.__init__`
:meth:`~wx.HeaderCtrlEvent.GetColumn` Return the index of the column affected by this event.
:meth:`~wx.HeaderCtrlEvent.GetNewOrder` Return the new order of the column.
:meth:`~wx.HeaderCtrlEvent.GetWidth` Return the current width of the column.
:meth:`~wx.HeaderCtrlEvent.SetColumn`
:meth:`~wx.HeaderCtrlEvent.SetNewOrder`
:meth:`~wx.HeaderCtrlEvent.SetWidth`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.HeaderCtrlEvent.Column` See :meth:`~wx.HeaderCtrlEvent.GetColumn` and :meth:`~wx.HeaderCtrlEvent.SetColumn`
:attr:`~wx.HeaderCtrlEvent.NewOrder` See :meth:`~wx.HeaderCtrlEvent.GetNewOrder` and :meth:`~wx.HeaderCtrlEvent.SetNewOrder`
:attr:`~wx.HeaderCtrlEvent.Width` See :meth:`~wx.HeaderCtrlEvent.GetWidth` and :meth:`~wx.HeaderCtrlEvent.SetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HeaderCtrlEvent(NotifyEvent)
**Possible constructors**::
HeaderCtrlEvent(commandType: EventType=wxEVT_NULL, winid: int=0) -> None
HeaderCtrlEvent(event : HeaderCtrlEvent) -> None
Event class representing the events generated by HeaderCtrl.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, commandType: EventType=wxEVT_NULL, winid: int=0)`
:param `commandType`:
:type `commandType`: wx.EventType
:param `winid`:
:type `winid`: int
:rtype: `None`
:html:`
`
**__init__** `(self, event : HeaderCtrlEvent)`
:param `event`:
:type `event`: wx.HeaderCtrlEvent
:rtype: `None`
:html:`
`
.. method:: GetColumn(self)
Return the index of the column affected by this event.
This method can be called for all header control events.
:rtype: `int`
.. method:: 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 :meth:`GetColumn` selected by the user. If the event is not vetoed, this will become the new column position in :meth:`wx.HeaderCtrl.GetColumnsOrder` .
:rtype: `int`
.. method:: GetWidth(self)
Return the current width of the column.
This method can only be called for the dragging events.
:rtype: `int`
.. method:: SetColumn(self, col : int)
:param `col`:
:type `col`: int
:rtype: `None`
.. method:: SetNewOrder(self, order : int)
:param `order`:
:type `order`: int
:rtype: `None`
.. method:: SetWidth(self, width : int)
:param `width`:
:type `width`: int
:rtype: `None`
.. attribute:: Column
See :meth:`~wx.HeaderCtrlEvent.GetColumn` and :meth:`~wx.HeaderCtrlEvent.SetColumn`
.. attribute:: NewOrder
See :meth:`~wx.HeaderCtrlEvent.GetNewOrder` and :meth:`~wx.HeaderCtrlEvent.SetNewOrder`
.. attribute:: Width
See :meth:`~wx.HeaderCtrlEvent.GetWidth` and :meth:`~wx.HeaderCtrlEvent.SetWidth`