# wxListItem Class Reference
[Data Structures]

`#include <wx/listctrl.h>`

Inheritance diagram for wxListItem:
[legend]

## Detailed Description

This class stores information about a wxListCtrl item or column.

wxListItem is a class which contains informations about:

- Zero based item position; see SetId() and GetId().
- Zero based column index; see SetColumn() and GetColumn().
- The label (or header for columns); see SetText() and GetText().
- The zero based index into an image list; see GetImage() and SetImage().
- Application defined data; see SetData() and GetData().
- For columns only: the width of the column; see SetWidth() and GetWidth().
- For columns only: the format of the column; one of `wxLIST_FORMAT_LEFT`, `wxLIST_FORMAT_RIGHT`, `wxLIST_FORMAT_CENTRE`. See SetAlign() and GetAlign().
- The state of the item; see SetState() and GetState(). This is a bitlist of the following flags:
  - `wxLIST_STATE_FOCUSED:` The item has the focus.
  - `wxLIST_STATE_SELECTED:` The item is selected.
  - `wxLIST_STATE_DONTCARE:` Don't care what the state is. Win32 only.
  - `wxLIST_STATE_DROPHILITED:` The item is highlighted to receive a drop event. Win32 only.
  - `wxLIST_STATE_CUT:` The item is in the cut state. Win32 only.
- A mask indicating which state flags are valid; this is a bitlist of the flags reported above for the item state. See SetStateMask() and GetStateMask().
- A mask indicating which fields of this class are valid; see SetMask() and GetMask(). This is a bitlist of the following flags:
  - `wxLIST_MASK_STATE:` The state field is valid.
  - `wxLIST_MASK_TEXT:` The label field is valid.
  - `wxLIST_MASK_IMAGE:` The image field is valid.
  - `wxLIST_MASK_DATA:` The application-defined data field is valid.
  - `wxLIST_MASK_WIDTH:` The column width field is valid.
  - `wxLIST_MASK_FORMAT:` The column format field is valid.

The wxListItem object can also contain item-specific colour and font information: for this you need to call one of SetTextColour(), SetBackgroundColour() or SetFont() functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.

##

Library: wxBase

Category: Data Structures

See also:
  wxListCtrl

## Public Member Functions
| wxListItem ()
| Constructor.
void | Clear ()
| Resets the item state to the default.
wxListColumnFormat | GetAlign () const
| Returns the alignment for this item.
wxColour | GetBackgroundColour () const
| Returns the background colour for this item.
int | GetColumn () const
| Returns the zero-based column; meaningful only in report mode.
wxUIntPtr | GetData () const
| Returns client data associated with the control.
wxFont | GetFont () const
| Returns the font used to display the item.
long | GetId () const
| Returns the zero-based item position.
int | GetImage () const
| Returns the zero-based index of the image associated with the item into the image list.
long | GetMask () const
| Returns a bit mask indicating which fields of the structure are valid.
long | GetState () const
| Returns a bit field representing the state of the item.
const wxString & | GetText () const
| Returns the label/header text.
wxColour | GetTextColour () const
| Returns the text colour.
int | GetWidth () const
| Meaningful only for column headers in report mode.
void | SetAlign (wxListColumnFormat align)
| Sets the alignment for the item.
void | SetBackgroundColour (const wxColour &colBack)
| Sets the background colour for the item.
void | SetColumn (int col)
| Sets the zero-based column.
void | SetFont (const wxFont &font)
| Sets the font for the item.
void | SetId (long id)
| Sets the zero-based item position.
void | SetImage (int image)
| Sets the zero-based index of the image associated with the item into the image list.
void | SetMask (long mask)
| Sets the mask of valid fields.
void | SetState (long state)
| Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see wxListItem::SetStateMask).
void | SetStateMask (long stateMask)
| Sets the bitmask that is used to determine which of the state flags are to be set.
void | SetText (const wxString &text)
| Sets the text label for the item.
void | SetTextColour (const wxColour &colText)
| Sets the text colour for the item.
void | SetWidth (int width)
| Meaningful only for column headers in report mode.
void | SetData (long data)
| Sets client data for the item.
void | SetData (void *data)
| Sets client data for the item.

List of all members.

## Constructor & Destructor Documentation

wxListItem::wxListItem | ( |  | ) |

Constructor.

## Member Function Documentation

void wxListItem::Clear | ( |  | ) |

Resets the item state to the default.

wxListColumnFormat wxListItem::GetAlign | ( |  | ) | const

Returns the alignment for this item.

Can be one of `wxLIST_FORMAT_LEFT`, `wxLIST_FORMAT_RIGHT` or `wxLIST_FORMAT_CENTRE`.

wxColour wxListItem::GetBackgroundColour | ( |  | ) | const

Returns the background colour for this item.

int wxListItem::GetColumn | ( |  | ) | const

Returns the zero-based column; meaningful only in report mode.

wxUIntPtr wxListItem::GetData | ( |  | ) | const

Returns client data associated with the control.

Please note that client data is associated with the item and not with subitems.

wxFont wxListItem::GetFont | ( |  | ) | const

Returns the font used to display the item.

long wxListItem::GetId | ( |  | ) | const

Returns the zero-based item position.

int wxListItem::GetImage | ( |  | ) | const

Returns the zero-based index of the image associated with the item into the image list.

long wxListItem::GetMask | ( |  | ) | const

Returns a bit mask indicating which fields of the structure are valid.

Can be any combination of the following values:

- wxLIST_MASK_STATE: GetState is valid.
- wxLIST_MASK_TEXT: GetText is valid.
- wxLIST_MASK_IMAGE: GetImage is valid.
- wxLIST_MASK_DATA: GetData is valid.
- wxLIST_MASK_WIDTH: GetWidth is valid.
- wxLIST_MASK_FORMAT: GetFormat is valid.

long wxListItem::GetState | ( |  | ) | const

Returns a bit field representing the state of the item.

Can be any combination of:

- wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
- wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
- wxLIST_STATE_FOCUSED: The item has the focus.
- wxLIST_STATE_SELECTED: The item is selected.
- wxLIST_STATE_CUT: The item is in the cut state. Win32 only.

const wxString& wxListItem::GetText | ( |  | ) | const

Returns the label/header text.

wxColour wxListItem::GetTextColour | ( |  | ) | const

Returns the text colour.

int wxListItem::GetWidth | ( |  | ) | const

Meaningful only for column headers in report mode.

Returns the column width.

void wxListItem::SetAlign | ( | wxListColumnFormat | align | ) |

Sets the alignment for the item.

See also GetAlign()

void wxListItem::SetBackgroundColour | ( | const wxColour & | colBack | ) |

Sets the background colour for the item.

void wxListItem::SetColumn | ( | int | col | ) |

Sets the zero-based column.

Meaningful only in report mode.

void wxListItem::SetData | ( | void * | data | ) |

Sets client data for the item.

Please note that client data is associated with the item and not with subitems.

void wxListItem::SetData | ( | long | data | ) |

Sets client data for the item.

Please note that client data is associated with the item and not with subitems.

void wxListItem::SetFont | ( | const wxFont & | font | ) |

Sets the font for the item.

void wxListItem::SetId | ( | long | id | ) |

Sets the zero-based item position.

void wxListItem::SetImage | ( | int | image | ) |

Sets the zero-based index of the image associated with the item into the image list.

void wxListItem::SetMask | ( | long | mask | ) |

Sets the mask of valid fields.

See GetMask().

void wxListItem::SetState | ( | long | state | ) |

Sets the item state flags (note that the valid state flags are influenced by the value of the state mask, see wxListItem::SetStateMask).

See GetState() for valid flag values.

void wxListItem::SetStateMask | ( | long | stateMask | ) |

Sets the bitmask that is used to determine which of the state flags are to be set.

See also SetState().

void wxListItem::SetText | ( | const wxString & | text | ) |

Sets the text label for the item.

void wxListItem::SetTextColour | ( | const wxColour & | colText | ) |

Sets the text colour for the item.

void wxListItem::SetWidth | ( | int | width | ) |

Meaningful only for column headers in report mode.

Sets the column width.

|  | [ top ]