*********** wx.ListItem *********** Inheritance diagram for `wx.ListItem`: | .. inheritance-diagram:: wx.ListItem | Description =========== This class stores information about a `wx.ListCtrl `_ item or column. Derived From ^^^^^^^^^^^^^ * `wx.Object `_ Methods Summary ^^^^^^^^^^^^^^^ * `__init__ <#__init__>`_ * `Clear <#Clear>`_ * `ClearAttributes <#ClearAttributes>`_ * `GetAlign <#GetAlign>`_ * `GetAttributes <#GetAttributes>`_ * `GetBackgroundColour <#GetBackgroundColour>`_ * `GetColumn <#GetColumn>`_ * `GetData <#GetData>`_ * `GetFont <#GetFont>`_ * `GetId <#GetId>`_ * `GetImage <#GetImage>`_ * `GetMask <#GetMask>`_ * `GetState <#GetState>`_ * `GetText <#GetText>`_ * `GetTextColour <#GetTextColour>`_ * `GetWidth <#GetWidth>`_ * `HasAttributes <#HasAttributes>`_ * `SetAlign <#SetAlign>`_ * `SetBackgroundColour <#SetBackgroundColour>`_ * `SetColumn <#SetColumn>`_ * `SetData <#SetData>`_ * `SetFont <#SetFont>`_ * `SetId <#SetId>`_ * `SetImage <#SetImage>`_ * `SetMask <#SetMask>`_ * `SetState <#SetState>`_ * `SetStateMask <#SetStateMask>`_ * `SetText <#SetText>`_ * `SetTextColour <#SetTextColour>`_ * `SetWidth <#SetWidth>`_ Properties Summary ^^^^^^^^^^^^^^^^^^ * `Align <#Align>`_ * `Attributes <#Attributes>`_ * `BackgroundColour <#BackgroundColour>`_ * `Column <#Column>`_ * `Data <#Data>`_ * `Font <#Font>`_ * `Id <#Id>`_ * `Image <#Image>`_ * `Mask <#Mask>`_ * `State <#State>`_ * `Text <#Text>`_ * `TextColour <#TextColour>`_ * `Width <#Width>`_ * `m_col <#m_col>`_ * `m_data <#m_data>`_ * `m_format <#m_format>`_ * `m_image <#m_image>`_ * `m_itemId <#m_itemId>`_ * `m_mask <#m_mask>`_ * `m_state <#m_state>`_ * `m_stateMask <#m_stateMask>`_ * `m_text <#m_text>`_ * `m_width <#m_width>`_ Class API ========= Methods ^^^^^^^ .. method:: __init__() `No docstrings available for this method.` -------- .. method:: Clear() Resets the item state to the default. -------- .. method:: ClearAttributes() `No docstrings available for this method.` -------- .. method:: GetAlign() Returns the alignment for this item. Can be one of ``wx.LIST_FORMAT_LEFT``, ``wx.LIST_FORMAT_RIGHT`` or ``wx.LIST_FORMAT_CENTRE``. | **Returns:** `int` -------- .. method:: GetAttributes() `No docstrings available for this method.` -------- .. method:: GetBackgroundColour() Returns the background colour for this item. | **Returns:** `wx.Colour `_ -------- .. method:: GetColumn() Returns the zero-based column; meaningful only in report mode. | **Returns:** `int` -------- .. method:: GetData() Returns client data associated with the control. Please note that client data is associated with the item and not with subitems. | **Returns:** `long` -------- .. method:: GetFont() Returns the font used to display the item. | **Returns:** `wx.Font `_ -------- .. method:: GetId() Returns the zero-based item position. | **Returns:** `long` -------- .. method:: GetImage() Returns the zero-based index of the image associated with the item into the image list. | **Returns:** `int` -------- .. method:: GetMask() Returns a bit mask indicating which fields of the structure are valid; can be any combination of the following values: ================================ ======================================== Mask Flag Description ================================ ======================================== ``wx.LIST_MASK_STATE`` `GetState <#GetState>`_ is valid. ``wx.LIST_MASK_TEXT`` `GetText <#GetText>`_ is valid. ``wx.LIST_MASK_IMAGE`` `GetImage <#GetImage>`_ is valid. ``wx.LIST_MASK_DATA`` `GetData <#GetData>`_ is valid. ``wx.LIST_MASK_WIDTH`` `GetWidth <#GetWidth>`_ is valid. ``wx.LIST_MASK_FORMAT`` `GetFormat <#GetFormat>`_ is valid. ================================ ======================================== | **Returns:** `long` -------- .. method:: GetState() Returns a bit field representing the state of the item. Can be any combination of: ============================= ========================================= State Flag Description ============================= ========================================= ``wx.LIST_STATE_DONTCARE`` Don't care what the state is. Win32 only. ``wx.LIST_STATE_DROPHILITED`` The item is highlighted to receive a drop event. Win32 only. ``wx.LIST_STATE_FOCUSED`` The item has the focus. ``wx.LIST_STATE_SELECTED`` The item is selected. ``wx.LIST_STATE_CUT`` The item is in the cut state. Win32 only. ============================= ========================================= | **Returns:** `long` -------- .. method:: GetText() Returns the label/header text. | **Returns:** `string` -------- .. method:: GetTextColour() Returns the text colour. | **Returns:** `wx.Colour `_ -------- .. method:: GetWidth() Meaningful only for column headers in report mode. Returns the column width. | **Returns:** `int` -------- .. method:: HasAttributes() `No docstrings available for this method.` -------- .. method:: SetAlign(align) Sets the alignment for the item. **Parameters:** * `align` (int) .. seealso:: `GetAlign <#GetAlign>`_ -------- .. method:: SetBackgroundColour(colBack) Sets the background colour for the item. **Parameters:** * `colBack` (`wx.Colour `_) -------- .. method:: SetColumn(col) Sets the zero-based column. Meaningful only in report mode. **Parameters:** * `col` (int) -------- .. method:: SetData(data) Sets client data for the item. Please note that client data is associated with the item and not with subitems. **Parameters:** * `data` (long) -------- .. method:: SetFont(font) Sets the font for the item. **Parameters:** * `font` (`wx.Font `_) -------- .. method:: SetId(id) Sets the zero-based item position. **Parameters:** * `id` (long) -------- .. method:: SetImage(image) Sets the zero-based index of the image associated with the item into the image list. **Parameters:** * `image` (int) -------- .. method:: SetMask(mask) Sets the mask of valid fields. **Parameters:** * `mask` (long) .. seealso:: `GetMask <#GetMask>`_ -------- .. method:: SetState(state) Sets the item state flags (note that the valid state flags are influenced by the value of the state mask. See `GetState <#GetState>`_ for valid flag values. **Parameters:** * `state` (long) .. seealso:: `SetStateMask <#SetStateMask>`_, `GetState <#GetState>`_ -------- .. method:: SetStateMask(stateMask) Sets the bitmask that is used to determine which of the state flags are to be set. **Parameters:** * `stateMask` (long) .. seealso:: `SetState <#SetState>`_ -------- .. method:: SetText(text) Sets the text label for the item. **Parameters:** * `text` (string) -------- .. method:: SetTextColour(colText) Sets the text colour for the item. **Parameters:** * `colText` (`wx.Colour `_) -------- .. method:: SetWidth(width) Meaningful only for column headers in report mode. Sets the column width. **Parameters:** * `width` (int) -------- Properties ^^^^^^^^^^ .. attribute:: Align See `GetAlign <#GetAlign>`_ and `SetAlign <#SetAlign>`_ .. attribute:: Attributes See `GetAttributes <#GetAttributes>`_ .. attribute:: BackgroundColour See `GetBackgroundColour <#GetBackgroundColour>`_ and `SetBackgroundColour <#SetBackgroundColour>`_ .. attribute:: Column See `GetColumn <#GetColumn>`_ and `SetColumn <#SetColumn>`_ .. attribute:: Data See `GetData <#GetData>`_ and `SetData <#SetData>`_ .. attribute:: Font See `GetFont <#GetFont>`_ and `SetFont <#SetFont>`_ .. attribute:: Id See `GetId <#GetId>`_ and `SetId <#SetId>`_ .. attribute:: Image See `GetImage <#GetImage>`_ and `SetImage <#SetImage>`_ .. attribute:: Mask See `GetMask <#GetMask>`_ and `SetMask <#SetMask>`_ .. attribute:: State See `GetState <#GetState>`_ and `SetState <#SetState>`_ .. attribute:: Text See `GetText <#GetText>`_ and `SetText <#SetText>`_ .. attribute:: TextColour See `GetTextColour <#GetTextColour>`_ and `SetTextColour <#SetTextColour>`_ .. attribute:: Width See `GetWidth <#GetWidth>`_ and `SetWidth <#SetWidth>`_ .. attribute:: m_col .. attribute:: m_data .. attribute:: m_format .. attribute:: m_image .. attribute:: m_itemId .. attribute:: m_mask .. attribute:: m_state .. attribute:: m_stateMask .. attribute:: m_text .. attribute:: m_width