wxListCtrl - Functions for wxListCtrl class
Please see following description for synopsis
wxListCtrl(3) Erlang Module Definition wxListCtrl(3)
NAME
wxListCtrl - Functions for wxListCtrl class
DESCRIPTION
A list control presents lists in a number of formats: list view, report
view, icon view and small icon view. In any case, elements are numbered
from zero. For all these modes, the items are stored in the control and
must be added to it using insertItem/4 method.
A special case of report view quite different from the other modes of
the list control is a virtual control in which the items data (includ-
ing text, images and attributes) is managed by the main program and is
requested by the control itself only when needed which allows having
controls with millions of items without consuming much memory. To use
virtual list control you must use setItemCount/2 first and override at
least wxListCtrl::OnGetItemText (not implemented in wx) (and optionally
wxListCtrl::OnGetItemImage (not implemented in wx) or wxListC-
trl::OnGetItemColumnImage (not implemented in wx) and wxListC-
trl::OnGetItemAttr (not implemented in wx)) to return the information
about the items when the control requests it.
Virtual list control can be used as a normal one except that no opera-
tions which can take time proportional to the number of items in the
control happen - this is required to allow having a practically infi-
nite number of items. For example, in a multiple selection virtual list
control, the selections won't be sent when many items are selected at
once because this could mean iterating over all the items.
Using many of wxListCtrl features is shown in the corresponding sample.
To intercept events from a list control, use the event table macros
described in wxListEvent.
wxMac Note: Starting with wxWidgets 2.8, wxListCtrl uses a native
implementation for report mode, and uses a generic implementation for
other modes. You can use the generic implementation for report mode as
well by setting the mac.listctrl.always_use_generic system option (see
wxSystemOptions) to 1.
Styles
This class supports the following styles:
Note: Under wxMSW this control uses wxSystemThemedControl (not imple-
mented in wx) for an explorer style appearance by default since wxWid-
gets 3.1.0. If this is not desired, you can call wxSystemThemedCon-
trol::EnableSystemTheme (not implemented in wx) with false argument to
disable this.
See: Overview listctrl, wxListView, wxListBox, wxTreeCtrl, wxImageList,
wxListEvent, wxListItem, wxEditableListBox (not implemented in wx)
This class is derived (and can use functions) from: wxControl wxWindow
wxEvtHandler
wxWidgets docs: wxListCtrl
EVENTS
Event types emitted from this class: command_list_begin_drag, com-
mand_list_begin_rdrag, command_list_begin_label_edit, com-
mand_list_end_label_edit, command_list_delete_item, com-
mand_list_delete_all_items, command_list_item_selected, com-
mand_list_item_deselected, command_list_item_activated, com-
mand_list_item_focused, command_list_item_middle_click, com-
mand_list_item_right_click, command_list_key_down, com-
mand_list_insert_item, command_list_col_click, com-
mand_list_col_right_click, command_list_col_begin_drag, com-
mand_list_col_dragging, command_list_col_end_drag, com-
mand_list_cache_hint
DATA TYPES
wxListCtrl() = wx:wx_object()
EXPORTS
new() -> wxListCtrl()
Default constructor.
new(Parent, Options :: [Option]) -> wxListCtrl()
Types:
Parent = wxWindow:wxWindow()
Option =
{winid, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{style, integer()} |
{validator, wx:wx_object()} |
{onGetItemText, function()} |
{onGetItemAttr, function()} |
{onGetItemColumnImage, function()}
Constructor, creating and showing a list control.
See: create/3, wxValidator (not implemented in wx)
destroy(This :: wxListCtrl()) -> ok
Destructor, destroying the list control.
arrange(This) -> boolean()
Types:
This = wxListCtrl()
arrange(This, Options :: [Option]) -> boolean()
Types:
This = wxListCtrl()
Option = {flag, integer()}
Arranges the items in icon or small icon view.
This only has effect on Win32. flag is one of:
assignImageList(This, ImageList, Which) -> ok
Types:
This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()
Sets the image list associated with the control and takes owner-
ship of it (i.e.
the control will, unlike when using setImageList/3, delete the
list when destroyed). which is one of wxIMAGE_LIST_NORMAL, wxIM-
AGE_LIST_SMALL, wxIMAGE_LIST_STATE (the last is unimplemented).
See: setImageList/3
clearAll(This) -> ok
Types:
This = wxListCtrl()
Deletes all items and all columns.
Note: This sends an event of type wxEVT_LIST_DELETE_ALL_ITEMS
under all platforms.
create(This, Parent, Options :: [Option]) -> boolean()
Types:
This = Parent = wxWindow:wxWindow()
Option =
{winid, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{size, {W :: integer(), H :: integer()}} |
{style, integer()} |
{validator, wx:wx_object()} |
{onGetItemText, function()} |
{onGetItemAttr, function()} |
{onGetItemColumnImage, function()}
Creates the list control.
See new/2 for further details.
deleteAllItems(This) -> boolean()
Types:
This = wxListCtrl()
Deletes all items in the list control.
This function does not send the wxEVT_LIST_DELETE_ITEM event
because deleting many items from the control would be too slow
then (unlike deleteItem/2) but it does send the special
wxEVT_LIST_DELETE_ALL_ITEMS event if the control was not empty.
If it was already empty, nothing is done and no event is sent.
Return: true if the items were successfully deleted or if the
control was already empty, false if an error occurred while
deleting the items.
deleteColumn(This, Col) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
Deletes a column.
deleteItem(This, Item) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Deletes the specified item.
This function sends the wxEVT_LIST_DELETE_ITEM event for the
item being deleted.
See: deleteAllItems/1
editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()
Types:
This = wxListCtrl()
Item = integer()
Starts editing the label of the given item.
This function generates a EVT_LIST_BEGIN_LABEL_EDIT event which
can be vetoed so that no text control will appear for in-place
editing.
If the user changed the label (i.e. s/he does not press ESC or
leave the text control without changes, a
EVT_LIST_END_LABEL_EDIT event will be sent which can be vetoed
as well.
ensureVisible(This, Item) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Ensures this item is visible.
findItem(This, Start, Str) -> integer()
Types:
This = wxListCtrl()
Start = integer()
Str = unicode:chardata()
findItem(This, Start, Str, Options :: [Option]) -> integer()
findItem(This, Start, Pt, Direction) -> integer()
Types:
This = wxListCtrl()
Start = integer()
Pt = {X :: integer(), Y :: integer()}
Direction = integer()
Find an item nearest this position in the specified direction,
starting from start or the beginning if start is -1.
Return: The next matching item if any or -1 (wxNOT_FOUND) other-
wise.
getColumn(This, Col, Item) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()
Gets information about this column.
See setItem/5 for more information.
getColumnCount(This) -> integer()
Types:
This = wxListCtrl()
Returns the number of columns.
getColumnWidth(This, Col) -> integer()
Types:
This = wxListCtrl()
Col = integer()
Gets the column width (report view only).
getCountPerPage(This) -> integer()
Types:
This = wxListCtrl()
Gets the number of items that can fit vertically in the visible
area of the list control (list or report view) or the total num-
ber of items in the list control (icon or small icon view).
getEditControl(This) -> wxTextCtrl:wxTextCtrl()
Types:
This = wxListCtrl()
Returns the edit control being currently used to edit a label.
Returns NULL if no label is being edited.
Note: It is currently only implemented for wxMSW and the generic
version, not for the native macOS version.
getImageList(This, Which) -> wxImageList:wxImageList()
Types:
This = wxListCtrl()
Which = integer()
Returns the specified image list.
which may be one of:
getItem(This, Info) -> boolean()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
Gets information about the item.
See setItem/5 for more information.
You must call info.SetId() to set the ID of item you're inter-
ested in before calling this method, and info.SetMask() with the
flags indicating what fields you need to retrieve from info.
getItemBackgroundColour(This, Item) -> wx:wx_colour4()
Types:
This = wxListCtrl()
Item = integer()
Returns the colour for this item.
If the item has no specific colour, returns an invalid colour
(and not the default background control of the control itself).
See: getItemTextColour/2
getItemCount(This) -> integer()
Types:
This = wxListCtrl()
Returns the number of items in the list control.
getItemData(This, Item) -> integer()
Types:
This = wxListCtrl()
Item = integer()
Gets the application-defined data associated with this item.
getItemFont(This, Item) -> wxFont:wxFont()
Types:
This = wxListCtrl()
Item = integer()
Returns the item's font.
getItemPosition(This, Item) -> Result
Types:
Result =
{Res :: boolean(), Pos :: {X :: integer(), Y :: inte-
ger()}}
This = wxListCtrl()
Item = integer()
Returns the position of the item, in icon or small icon view.
getItemRect(This, Item) -> Result
Types:
Result =
{Res :: boolean(),
Rect ::
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}}
This = wxListCtrl()
Item = integer()
getItemRect(This, Item, Options :: [Option]) -> Result
Types:
Result =
{Res :: boolean(),
Rect ::
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}}
This = wxListCtrl()
Item = integer()
Option = {code, integer()}
Returns the rectangle representing the item's size and position,
in physical coordinates.
code is one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON,
wxLIST_RECT_LABEL.
getItemSpacing(This) -> {W :: integer(), H :: integer()}
Types:
This = wxListCtrl()
Retrieves the spacing between icons in pixels: horizontal spac-
ing is returned as x component of the {Width,Height} object and
the vertical spacing as its y component.
getItemState(This, Item, StateMask) -> integer()
Types:
This = wxListCtrl()
Item = StateMask = integer()
Gets the item state.
For a list of state flags, see setItem/5. The stateMask indi-
cates which state flags are of interest.
getItemText(This, Item) -> unicode:charlist()
Types:
This = wxListCtrl()
Item = integer()
getItemText(This, Item, Options :: [Option]) -> unicode:charlist()
Types:
This = wxListCtrl()
Item = integer()
Option = {col, integer()}
Gets the item text for this item.
getItemTextColour(This, Item) -> wx:wx_colour4()
Types:
This = wxListCtrl()
Item = integer()
Returns the colour for this item.
If the item has no specific colour, returns an invalid colour
(and not the default foreground control of the control itself as
this wouldn't allow distinguishing between items having the same
colour as the current control foreground and items with default
colour which, hence, have always the same colour as the con-
trol).
getNextItem(This, Item) -> integer()
Types:
This = wxListCtrl()
Item = integer()
getNextItem(This, Item, Options :: [Option]) -> integer()
Types:
This = wxListCtrl()
Item = integer()
Option = {geometry, integer()} | {state, integer()}
Searches for an item with the given geometry or state, starting
from item but excluding the item itself.
If item is -1, the first item that matches the specified flags
will be returned. Returns the first item with given state fol-
lowing item or -1 if no such item found. This function may be
used to find all selected items in the control like this:
geometry can be one of:
Note: this parameter is only supported by wxMSW currently and
ignored on other platforms.
state can be a bitlist of the following:
getSelectedItemCount(This) -> integer()
Types:
This = wxListCtrl()
Returns the number of selected items in the list control.
getTextColour(This) -> wx:wx_colour4()
Types:
This = wxListCtrl()
Gets the text colour of the list control.
getTopItem(This) -> integer()
Types:
This = wxListCtrl()
Gets the index of the topmost visible item when in list or
report view.
getViewRect(This) ->
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}
Types:
This = wxListCtrl()
Returns the rectangle taken by all items in the control.
In other words, if the controls client size were equal to the
size of this rectangle, no scrollbars would be needed and no
free space would be left.
Note that this function only works in the icon and small icon
views, not in list or report views (this is a limitation of the
native Win32 control).
hitTest(This, Point) -> Result
Types:
Result =
{Res :: integer(),
Flags :: integer(),
PtrSubItem :: integer()}
This = wxListCtrl()
Point = {X :: integer(), Y :: integer()}
Determines which item (if any) is at the specified point, giving
details in flags.
Returns index of the item or wxNOT_FOUND if no item is at the
specified point.
flags will be a combination of the following flags:
If ptrSubItem is not NULL and the wxListCtrl is in the report
mode the subitem (or column) number will also be provided. This
feature is only available in version 2.7.0 or higher and is cur-
rently only implemented under wxMSW and requires at least com-
ctl32.dll of version 4.70 on the host system or the value stored
in ptrSubItem will be always -1. To compile this feature into
wxWidgets library you need to have access to commctrl.h of ver-
sion 4.70 that is provided by Microsoft.
insertColumn(This, Col, Heading) -> integer()
insertColumn(This, Col, Info) -> integer()
Types:
This = wxListCtrl()
Col = integer()
Info = wxListItem:wxListItem()
For report view mode (only), inserts a column.
For more details, see setItem/5. Also see insertColumn/4 over-
load for a usually more convenient alternative to this method
and the description of how the item width is interpreted by this
method.
insertColumn(This, Col, Heading, Options :: [Option]) -> integer()
Types:
This = wxListCtrl()
Col = integer()
Heading = unicode:chardata()
Option = {format, integer()} | {width, integer()}
For report view mode (only), inserts a column.
Insert a new column in the list control in report view mode at
the given position specifying its most common attributes.
Notice that to set the image for the column you need to use
insertColumn/4 overload and specify ?wxLIST_MASK_IMAGE in the
item mask.
Return: The index of the inserted column or -1 if adding it
failed.
insertItem(This, Info) -> integer()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
Inserts an item, returning the index of the new item if success-
ful, -1 otherwise.
insertItem(This, Index, ImageIndex) -> integer()
insertItem(This, Index, Label) -> integer()
Types:
This = wxListCtrl()
Index = integer()
Label = unicode:chardata()
Insert a string item.
insertItem(This, Index, Label, ImageIndex) -> integer()
Types:
This = wxListCtrl()
Index = integer()
Label = unicode:chardata()
ImageIndex = integer()
Insert an image/string item.
refreshItem(This, Item) -> ok
Types:
This = wxListCtrl()
Item = integer()
Redraws the given item.
This is only useful for the virtual list controls as without
calling this function the displayed value of the item doesn't
change even when the underlying data does change.
See: refreshItems/3
refreshItems(This, ItemFrom, ItemTo) -> ok
Types:
This = wxListCtrl()
ItemFrom = ItemTo = integer()
Redraws the items between itemFrom and itemTo.
The starting item must be less than or equal to the ending one.
Just as refreshItem/2 this is only useful for virtual list con-
trols.
scrollList(This, Dx, Dy) -> boolean()
Types:
This = wxListCtrl()
Dx = Dy = integer()
Scrolls the list control.
If in icon, small icon or report view mode, dx specifies the
number of pixels to scroll. If in list view mode, dx specifies
the number of columns to scroll. dy always specifies the number
of pixels to scroll vertically.
Note: This method is currently only implemented in the Windows
version.
setBackgroundColour(This, Col) -> boolean()
Types:
This = wxListCtrl()
Col = wx:wx_colour()
Sets the background colour.
Note that the wxWindow:getBackgroundColour/1 function of wxWin-
dow base class can be used to retrieve the current background
colour.
setColumn(This, Col, Item) -> boolean()
Types:
This = wxListCtrl()
Col = integer()
Item = wxListItem:wxListItem()
Sets information about this column.
See setItem/5 for more information.
setColumnWidth(This, Col, Width) -> boolean()
Types:
This = wxListCtrl()
Col = Width = integer()
Sets the column width.
width can be a width in pixels or wxLIST_AUTOSIZE (-1) or
wxLIST_AUTOSIZE_USEHEADER (-2).
wxLIST_AUTOSIZE will resize the column to the length of its
longest item.
wxLIST_AUTOSIZE_USEHEADER will resize the column to the length
of the header (Win32) or 80 pixels (other platforms).
In small or normal icon view, col must be -1, and the column
width is set for all columns.
setImageList(This, ImageList, Which) -> ok
Types:
This = wxListCtrl()
ImageList = wxImageList:wxImageList()
Which = integer()
Sets the image list associated with the control.
which is one of wxIMAGE_LIST_NORMAL, wxIMAGE_LIST_SMALL, wxIM-
AGE_LIST_STATE (the last is unimplemented).
This method does not take ownership of the image list, you have
to delete it yourself.
See: assignImageList/3
setItem(This, Info) -> boolean()
Types:
This = wxListCtrl()
Info = wxListItem:wxListItem()
Sets the data of an item.
Using the wxListItem's mask and state mask, you can change only
selected attributes of a wxListCtrl item.
Return: true if the item was successfully updated or false if
the update failed for some reason (e.g. an invalid item index).
setItem(This, Index, Column, Label) -> boolean()
Types:
This = wxListCtrl()
Index = Column = integer()
Label = unicode:chardata()
setItem(This, Index, Column, Label, Options :: [Option]) ->
boolean()
Types:
This = wxListCtrl()
Index = Column = integer()
Label = unicode:chardata()
Option = {imageId, integer()}
Sets an item string field at a particular column.
Return: true if the item was successfully updated or false if
the update failed for some reason (e.g. an invalid item index).
setItemBackgroundColour(This, Item, Col) -> ok
Types:
This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()
Sets the background colour for this item.
This function only works in report view mode. The colour can be
retrieved using getItemBackgroundColour/2.
setItemCount(This, Count) -> ok
Types:
This = wxListCtrl()
Count = integer()
This method can only be used with virtual list controls.
It is used to indicate to the control the number of items it
contains. After calling it, the main program should be ready to
handle calls to various item callbacks (such as wxListC-
trl::OnGetItemText (not implemented in wx)) for all items in the
range from 0 to count.
Notice that the control is not necessarily redrawn after this
call as it may be undesirable if an item which is not visible on
the screen anyhow was added to or removed from a control dis-
playing many items, if you do need to refresh the display you
can just call wxWindow:refresh/2 manually.
setItemData(This, Item, Data) -> boolean()
Types:
This = wxListCtrl()
Item = Data = integer()
Associates application-defined data with this item.
Notice that this function cannot be used to associate pointers
with the control items, use SetItemPtrData() (not implemented in
wx) instead.
setItemFont(This, Item, Font) -> ok
Types:
This = wxListCtrl()
Item = integer()
Font = wxFont:wxFont()
Sets the item's font.
setItemImage(This, Item, Image) -> boolean()
Types:
This = wxListCtrl()
Item = Image = integer()
setItemImage(This, Item, Image, Options :: [Option]) -> boolean()
Types:
This = wxListCtrl()
Item = Image = integer()
Option = {selImage, integer()}
Sets the unselected and selected images associated with the
item.
The images are indices into the image list associated with the
list control.
setItemColumnImage(This, Item, Column, Image) -> boolean()
Types:
This = wxListCtrl()
Item = Column = Image = integer()
Sets the image associated with the item.
In report view, you can specify the column. The image is an
index into the image list associated with the list control.
setItemPosition(This, Item, Pos) -> boolean()
Types:
This = wxListCtrl()
Item = integer()
Pos = {X :: integer(), Y :: integer()}
Sets the position of the item, in icon or small icon view.
Windows only.
setItemState(This, Item, State, StateMask) -> boolean()
Types:
This = wxListCtrl()
Item = State = StateMask = integer()
Sets the item state.
The stateMask is a combination of wxLIST_STATE_XXX constants
described in wxListItem documentation. For each of the bits
specified in stateMask, the corresponding state is set or
cleared depending on whether state argument contains the same
bit or not.
So to select an item you can use while to deselect it you should
use
Consider using wxListView if possible to avoid dealing with this
error-prone and confusing method.
Also notice that contrary to the usual rule that only user
actions generate events, this method does generate
wxEVT_LIST_ITEM_SELECTED event when it is used to select an
item.
setItemText(This, Item, Text) -> ok
Types:
This = wxListCtrl()
Item = integer()
Text = unicode:chardata()
Sets the item text for this item.
setItemTextColour(This, Item, Col) -> ok
Types:
This = wxListCtrl()
Item = integer()
Col = wx:wx_colour()
Sets the colour for this item.
This function only works in report view. The colour can be
retrieved using getItemTextColour/2.
setSingleStyle(This, Style) -> ok
Types:
This = wxListCtrl()
Style = integer()
setSingleStyle(This, Style, Options :: [Option]) -> ok
Types:
This = wxListCtrl()
Style = integer()
Option = {add, boolean()}
Adds or removes a single window style.
setTextColour(This, Col) -> ok
Types:
This = wxListCtrl()
Col = wx:wx_colour()
Sets the text colour of the list control.
setWindowStyleFlag(This, Style) -> ok
Types:
This = wxListCtrl()
Style = integer()
Sets the whole window style, deleting all items.
sortItems(This :: wxListCtrl(), SortCallBack) -> boolean()
Types:
SortCallBack = fun((integer(), integer()) -> integer())
Sort the items in the list control.
Sorts the items with supplied SortCallBack fun.
SortCallBack receives the client data associated with two items
to compare (NOT the the index), and should return 0 if the items
are equal, a negative value if the first item is less than the
second one and a positive value if the first item is greater
than the second one.
Remark: Notice that the control may only be sorted on client
data associated with the items, so you must use SetItemData if
you want to be able to sort the items in the control.
The callback may not call other (wx) processes.
wxWidgets team. wx 2.1.1 wxListCtrl(3)