.. 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.HeaderColumnSimple:
==========================================================================================================================================
|phoenix_title| **wx.HeaderColumnSimple**
==========================================================================================================================================
Simple container for the information about the column.
This is a concrete class implementing all :ref:`wx.SettableHeaderColumn` class methods in a trivial way, i.e. by just storing the information in the object itself. It is used by and with :ref:`wx.HeaderCtrlSimple`, e.g. ::
header = wx.HeaderCtrlSimple() # Fill in the constructor
col = wx.HeaderColumnSimple("Title")
col.SetWidth(100)
col.SetSortable(100)
header.AppendColumn(col)
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
HeaderColumnSimple:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HeaderColumnSimple.__init__` Constructor for a column header.
:meth:`~wx.HeaderColumnSimple.GetAlignment` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetBitmap` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetBitmapBundle` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetFlags` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetMinWidth` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetTitle` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.GetWidth` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.IsSortKey` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.IsSortOrderAscending` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetAlignment` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetBitmap` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetFlags` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetMinWidth` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetSortOrder` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetTitle` Trivial implementations of the base class pure virtual functions.
:meth:`~wx.HeaderColumnSimple.SetWidth` Trivial implementations of the base class pure virtual functions.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.HeaderColumnSimple.Alignment` See :meth:`~wx.HeaderColumnSimple.GetAlignment` and :meth:`~wx.HeaderColumnSimple.SetAlignment`
:attr:`~wx.HeaderColumnSimple.Bitmap` See :meth:`~wx.HeaderColumnSimple.GetBitmap` and :meth:`~wx.HeaderColumnSimple.SetBitmap`
:attr:`~wx.HeaderColumnSimple.BitmapBundle` See :meth:`~wx.HeaderColumnSimple.GetBitmapBundle`
:attr:`~wx.HeaderColumnSimple.Flags` See :meth:`~wx.HeaderColumnSimple.GetFlags` and :meth:`~wx.HeaderColumnSimple.SetFlags`
:attr:`~wx.HeaderColumnSimple.MinWidth` See :meth:`~wx.HeaderColumnSimple.GetMinWidth` and :meth:`~wx.HeaderColumnSimple.SetMinWidth`
:attr:`~wx.HeaderColumnSimple.Title` See :meth:`~wx.HeaderColumnSimple.GetTitle` and :meth:`~wx.HeaderColumnSimple.SetTitle`
:attr:`~wx.HeaderColumnSimple.Width` See :meth:`~wx.HeaderColumnSimple.GetWidth` and :meth:`~wx.HeaderColumnSimple.SetWidth`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HeaderColumnSimple(SettableHeaderColumn)
**Possible constructors**::
HeaderColumnSimple(title : str, width: int=COL_WIDTH_DEFAULT, align:
Alignment=ALIGN_NOT, flags: int=COL_DEFAULT_FLAGS) -> None
HeaderColumnSimple(bitmap : BitmapBundle, width: int=COL_WIDTH_DEFAULT,
align: Alignment=ALIGN_CENTER, flags: int=COL_DEFAULT_FLAGS) -> None
Simple container for the information about the column.
.. method:: __init__(self, *args, **kw)
Constructor for a column header.
The first constructor creates a header showing the given text `title` while the second one creates one showing the specified `bitmap` image.
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self, title : str, width: int=COL_WIDTH_DEFAULT, align: Alignment=ALIGN_NOT, flags: int=COL_DEFAULT_FLAGS)`
:param `title`:
:type `title`: string
:param `width`:
:type `width`: int
:param `align`:
:type `align`: wx.Alignment
:param `flags`:
:type `flags`: int
:rtype: `None`
:html:`
`
**__init__** `(self, bitmap : BitmapBundle, width: int=COL_WIDTH_DEFAULT, align: Alignment=ALIGN_CENTER, flags: int=COL_DEFAULT_FLAGS)`
:param `bitmap`:
:type `bitmap`: wx.BitmapBundle
:param `width`:
:type `width`: int
:param `align`:
:type `align`: wx.Alignment
:param `flags`:
:type `flags`: int
:rtype: `None`
:html:`
`
.. method:: GetAlignment(self)
Trivial implementations of the base class pure virtual functions.
:rtype: :ref:`wx.Alignment`
.. method:: GetBitmap(self)
Trivial implementations of the base class pure virtual functions.
:rtype: :ref:`wx.Bitmap`
.. method:: GetBitmapBundle(self)
Trivial implementations of the base class pure virtual functions.
:rtype: :ref:`wx.BitmapBundle`
.. method:: GetFlags(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `int`
.. method:: GetMinWidth(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `int`
.. method:: GetTitle(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `str`
.. method:: GetWidth(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `int`
.. method:: IsSortKey(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `bool`
.. method:: IsSortOrderAscending(self)
Trivial implementations of the base class pure virtual functions.
:rtype: `bool`
.. method:: SetAlignment(self, align : Alignment)
Trivial implementations of the base class pure virtual functions.
:param `align`:
:type `align`: wx.Alignment
:rtype: `None`
.. method:: SetBitmap(self, bitmap : BitmapBundle)
Trivial implementations of the base class pure virtual functions.
:param `bitmap`:
:type `bitmap`: wx.BitmapBundle
:rtype: `None`
.. method:: SetFlags(self, flags : int)
Trivial implementations of the base class pure virtual functions.
:param `flags`:
:type `flags`: int
:rtype: `None`
.. method:: SetMinWidth(self, minWidth : int)
Trivial implementations of the base class pure virtual functions.
:param `minWidth`:
:type `minWidth`: int
:rtype: `None`
.. method:: SetSortOrder(self, ascending : bool)
Trivial implementations of the base class pure virtual functions.
:param `ascending`:
:type `ascending`: bool
:rtype: `None`
.. method:: SetTitle(self, title : str)
Trivial implementations of the base class pure virtual functions.
:param `title`:
:type `title`: string
:rtype: `None`
.. method:: SetWidth(self, width : int)
Trivial implementations of the base class pure virtual functions.
:param `width`:
:type `width`: int
:rtype: `None`
.. attribute:: Alignment
See :meth:`~wx.HeaderColumnSimple.GetAlignment` and :meth:`~wx.HeaderColumnSimple.SetAlignment`
.. attribute:: Bitmap
See :meth:`~wx.HeaderColumnSimple.GetBitmap` and :meth:`~wx.HeaderColumnSimple.SetBitmap`
.. attribute:: BitmapBundle
See :meth:`~wx.HeaderColumnSimple.GetBitmapBundle`
.. attribute:: Flags
See :meth:`~wx.HeaderColumnSimple.GetFlags` and :meth:`~wx.HeaderColumnSimple.SetFlags`
.. attribute:: MinWidth
See :meth:`~wx.HeaderColumnSimple.GetMinWidth` and :meth:`~wx.HeaderColumnSimple.SetMinWidth`
.. attribute:: Title
See :meth:`~wx.HeaderColumnSimple.GetTitle` and :meth:`~wx.HeaderColumnSimple.SetTitle`
.. attribute:: Width
See :meth:`~wx.HeaderColumnSimple.GetWidth` and :meth:`~wx.HeaderColumnSimple.SetWidth`