wxListCtrl

Implements methods from the following classes

• wxControl

Methods

• wxListCtrl
  Default constructor.
• Arrange
  Arranges the items in icon or small icon view.
• AssignImageList
  Sets the image list associated with the control and takes ownership of it (i.e.
• ClearAll
  Deletes all items and all columns.
• Create
  Creates the list control.
• DeleteAllItems
  Deletes all items in the list control.
• DeleteColumn
  Deletes a column.
• DeleteItem
  Deletes the specified item.
• EditLabel
  Starts editing the label of the given item.
• EnsureVisible
  Ensures this item is visible.
• FindItem
  Find an item whose label matches this string, starting from start or the beginning if start is -1.
• GetColumn
  Gets information about this column.
• GetColumnCount
  Returns the number of columns.
• GetColumnWidth
  Gets the column width (report view only).
• GetCountPerPage
  Gets the number of items that can fit vertically in the visible area of the list control (list or report view) or the total number of items in the list control (icon or small icon view).
• GetEditControl
  Returns the edit control being currently used to edit a label.
• GetImageList
  Returns the specified image list.
• GetItem
  Gets information about the item.
• GetItemBackgroundColour
  Returns the colour for this item.
• GetItemCount
  Returns the number of items in the list control.
• GetItemFont
  Returns the item's font.
• GetItemPosition
  Returns the position of the item, in icon or small icon view.
• GetItemRect
  Returns the rectangle representing the item's size and position, in physical coordinates.
• GetItemSpacing
  Retrieves the spacing between icons in pixels: horizontal spacing is returned as x component of the wxSize object and the vertical spacing as its y component.
• GetItemState
  Gets the item state.
• GetItemText
  Gets the item text for this item.
• GetItemTextColour
  Returns the colour for this item.
• GetNextItem
  Searches for an item with the given geometry or state, starting from item but excluding the item itself.
• GetSelectedItemCount
  Returns the number of selected items in the list control.
• GetSubItemRect
  Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e.
• GetTextColour
  Gets the text colour of the list control.
• GetTopItem
  Gets the index of the topmost visible item when in list or report view.
• GetViewRect
  Returns the rectangle taken by all items in the control.
• InsertColumn
  For report view mode (only), inserts a column.
• InsertItem
  Inserts an item, returning the index of the new item if successful, -1 otherwise.
• OnGetItemAttr
  This function may be overridden in the derived class for a control with wxLC_VIRTUAL style.
• OnGetItemColumnImage
  Override this function in the derived class for a control with wxLC_VIRTUAL and wxLC_REPORT styles in order to specify the image index for the given line and column.
• OnGetItemImage
  This function must be overridden in the derived class for a control with wxLC_VIRTUAL style having an "image list" (see SetImageList(); if the control doesn't have an image list, it is not necessary to override it).
• OnGetItemText
  This function must be overridden in the derived class for a control with wxLC_VIRTUAL style.
• RefreshItem
  Redraws the given item.
• RefreshItems
  Redraws the items between itemFrom and itemTo.
• ScrollList
  Scrolls the list control.
• SetBackgroundColour
  Sets the background colour.
• SetColumn
  Sets information about this column.
• SetColumnWidth
  Sets the column width.
• SetImageList
  Sets the image list associated with the control.
• SetItem
  Sets an item string field at a particular column.
• SetItemBackgroundColour
  Sets the background colour for this item.
• SetItemColumnImage
  Sets the image associated with the item.
• SetItemCount
  This method can only be used with virtual list controls.
• SetItemData
  Associates application-defined data with this item.
• SetItemFont
  Sets the item's font.
• SetItemPosition
  Sets the position of the item, in icon or small icon view.
• SetItemState
  Sets the item state.
• SetItemText
  Sets the item text for this item.
• SetItemTextColour
  Sets the colour for this item.
• SetSingleStyle
  Adds or removes a single window style.
• SetTextColour
  Sets the text colour of the list control.
• SetWindowStyleFlag
  Sets the whole window style, deleting all items.

Static Methods

wxListCtrl

wxListCtrl ( )

Default constructor.
wxListCtrl ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxLC_ICON, wxValidator $validator=wxDefaultValidator, string $name=wxListCtrlNameStr )

Constructor, creating and showing a list control.

Arrange

bool Arrange ( integer $flag=wxLIST_ALIGN_DEFAULT )

Arranges the items in icon or small icon view.

AssignImageList

AssignImageList ( wxImageList &$imageList, integer $which )

Sets the image list associated with the control and takes ownership of it (i.e.

ClearAll

ClearAll ( )

Deletes all items and all columns.

Create

bool Create ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxLC_ICON, wxValidator $validator=wxDefaultValidator, string $name=wxListCtrlNameStr )

Creates the list control.

DeleteAllItems

bool DeleteAllItems ( )

Deletes all items in the list control.

DeleteColumn

bool DeleteColumn ( integer $col )

Deletes a column.

DeleteItem

bool DeleteItem ( integer $item )

Deletes the specified item.

EditLabel

wxTextCtrl& EditLabel ( integer $item, wxClassInfo &$textControlClass=wxCLASSINFO(wxTextCtrl) )

Starts editing the label of the given item.

EnsureVisible

bool EnsureVisible ( integer $item )

Ensures this item is visible.

FindItem

integer FindItem ( integer $start, string $str, bool $partial=false )

Find an item whose label matches this string, starting from start or the beginning if start is -1.
integer FindItem ( integer $start, integer $data )

Find an item whose data matches this data, starting from start or the beginning if 'start' is -1.
integer FindItem ( integer $start, wxPoint $pt, integer $direction )

Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.

GetColumn

bool GetColumn ( integer $col, wxListItem &$item )

Gets information about this column.

GetColumnCount

integer GetColumnCount ( )

Returns the number of columns.

GetColumnWidth

integer GetColumnWidth ( integer $col )

Gets the column width (report view only).

GetCountPerPage

integer GetCountPerPage ( )

Gets the number of items that can fit vertically in the visible area of the list control (list or report view) or the total number of items in the list control (icon or small icon view).

GetEditControl

wxTextCtrl& GetEditControl ( )

Returns the edit control being currently used to edit a label.

GetImageList

wxImageList& GetImageList ( integer $which )

Returns the specified image list.

GetItem

bool GetItem ( wxListItem &$info )

Gets information about the item.

GetItemBackgroundColour

wxColour GetItemBackgroundColour ( integer $item )

Returns the colour for this item.

GetItemCount

integer GetItemCount ( )

Returns the number of items in the list control.

GetItemFont

wxFont GetItemFont ( integer $item )

Returns the item's font.

GetItemPosition

bool GetItemPosition ( integer $item, wxPoint &$pos )

Returns the position of the item, in icon or small icon view.

GetItemRect

bool GetItemRect ( integer $item, wxRect &$rect, integer $code=wxLIST_RECT_BOUNDS )

Returns the rectangle representing the item's size and position, in physical coordinates.

GetItemSpacing

wxSize GetItemSpacing ( )

Retrieves the spacing between icons in pixels: horizontal spacing is returned as x component of the wxSize object and the vertical spacing as its y component.

GetItemState

integer GetItemState ( integer $item, integer $stateMask )

Gets the item state.

GetItemText

string GetItemText ( integer $item, integer $col )

Gets the item text for this item.

GetItemTextColour

wxColour GetItemTextColour ( integer $item )

Returns the colour for this item.

GetNextItem

integer GetNextItem ( integer $item, integer $geometry=wxLIST_NEXT_ALL, integer $state=wxLIST_STATE_DONTCARE )

Searches for an item with the given geometry or state, starting from item but excluding the item itself.

GetSelectedItemCount

integer GetSelectedItemCount ( )

Returns the number of selected items in the list control.

GetSubItemRect

bool GetSubItemRect ( integer $item, integer $subItem, wxRect &$rect, integer $code=wxLIST_RECT_BOUNDS )

Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e.

GetTextColour

wxColour GetTextColour ( )

Gets the text colour of the list control.

GetTopItem

integer GetTopItem ( )

Gets the index of the topmost visible item when in list or report view.

GetViewRect

wxRect GetViewRect ( )

Returns the rectangle taken by all items in the control.

InsertColumn

integer InsertColumn ( integer $col, wxListItem $info )

For report view mode (only), inserts a column.
integer InsertColumn ( integer $col, string $heading, integer $format=wxLIST_FORMAT_LEFT, integer $width=wxLIST_AUTOSIZE )

For report view mode (only), inserts a column.

InsertItem

integer InsertItem ( wxListItem &$info )

Inserts an item, returning the index of the new item if successful, -1 otherwise.
integer InsertItem ( integer $index, string $label )

Insert an string item.
integer InsertItem ( integer $index, integer $imageIndex )

Insert an image item.
integer InsertItem ( integer $index, string $label, integer $imageIndex )

Insert an image/string item.

OnGetItemAttr

wxListItemAttr& OnGetItemAttr ( integer $item )

This function may be overridden in the derived class for a control with wxLC_VIRTUAL style.

OnGetItemColumnImage

integer OnGetItemColumnImage ( integer $item, integer $column )

Override this function in the derived class for a control with wxLC_VIRTUAL and wxLC_REPORT styles in order to specify the image index for the given line and column.

OnGetItemImage

integer OnGetItemImage ( integer $item )

This function must be overridden in the derived class for a control with wxLC_VIRTUAL style having an "image list" (see SetImageList(); if the control doesn't have an image list, it is not necessary to override it).

OnGetItemText

string OnGetItemText ( integer $item, integer $column )

This function must be overridden in the derived class for a control with wxLC_VIRTUAL style.

RefreshItem

RefreshItem ( integer $item )

Redraws the given item.

RefreshItems

RefreshItems ( integer $itemFrom, integer $itemTo )

Redraws the items between itemFrom and itemTo.

ScrollList

bool ScrollList ( integer $dx, integer $dy )

Scrolls the list control.

SetBackgroundColour

bool SetBackgroundColour ( wxColour $col )

Sets the background colour.

SetColumn

bool SetColumn ( integer $col, wxListItem &$item )

Sets information about this column.

SetColumnWidth

bool SetColumnWidth ( integer $col, integer $width )

Sets the column width.

SetImageList

SetImageList ( wxImageList &$imageList, integer $which )

Sets the image list associated with the control.

SetItem

integer SetItem ( integer $index, integer $column, string $label, integer $imageId=-1 )

Sets an item string field at a particular column.
bool SetItem ( wxListItem &$info )

Sets the data of an item.

SetItemBackgroundColour

SetItemBackgroundColour ( integer $item, wxColour $col )

Sets the background colour for this item.

SetItemColumnImage

bool SetItemColumnImage ( integer $item, integer $column, integer $image )

Sets the image associated with the item.

SetItemCount

SetItemCount ( integer $count )

This method can only be used with virtual list controls.

SetItemData

bool SetItemData ( integer $item, integer $data )

Associates application-defined data with this item.

SetItemFont

SetItemFont ( integer $item, wxFont $font )

Sets the item's font.

SetItemPosition

bool SetItemPosition ( integer $item, wxPoint $pos )

Sets the position of the item, in icon or small icon view.

SetItemState

bool SetItemState ( integer $item, integer $state, integer $stateMask )

Sets the item state.

SetItemText

SetItemText ( integer $item, string $text )

Sets the item text for this item.

SetItemTextColour

SetItemTextColour ( integer $item, wxColour $col )

Sets the colour for this item.

SetSingleStyle

SetSingleStyle ( integer $style, bool $add=true )

Adds or removes a single window style.

SetTextColour

SetTextColour ( wxColour $col )

Sets the text colour of the list control.

SetWindowStyleFlag

SetWindowStyleFlag ( integer $style )

Sets the whole window style, deleting all items.