wxPython高级控件之列表控件ListCtrl
实战wxPython系列-040
wx.ListCtrl是项列表的图形表示。一个wx.ListBox只能有一列。 wx.ListCtrl可以有多个列。wx.ListCtrl是一个非常常见和有用的控件。例如，文件管理器使用wxListCtrl来显示文件系统上的目录和文件。
一、wx.ListCtrl列表控件
wx.ListCtrl可以以三种不同的格式使用。列表视图、报表视图、图标视图和小图标视图。这些格式由wx.ListCtrl窗口样式wx.LC_REPORT, wx.LC_LIST,wx.LC_ICON和wx.LC_SMALL_ICON控制。
在任何情况下，元素都是从0开始编号的。对于所有这些模式，项都存储在控件中，必须使用wx.ListCtrl.InsertItem方法将项添加到控件中。
报表视图的一个特殊情况与列表控件的其他模式非常不同，它是一个虚拟控件，其中的项数据(包括文本、图像和属性)由主程序管理，只有在需要时才由控件本身请求，这允许拥有数百万项的控件而不消耗太多内存。要使用虚拟列表控件，必须首先使用wx.ListCtrl.SetItemCount，并至少重写wx.ListCtrl.OnGetItemText(以及可选的wx.ListCtrl.OnGetItemImage或wx.ListCtrl.OnGetItemColumnImage和wx.ListCtrl.OnGetItemAttr)，以便在控件请求时返回有关项的信息。
虚拟列表控件可以像普通控件一样使用，除了没有需要与控件中项目数量成比例的时间的操作发生-这是允许拥有实际上无限数量的项目所必需的。例如，在多个选择虚拟列表控件中，当一次选择了许多项时，选择不会被发送，因为这可能意味着遍历所有项。
wx.ListCtrl支持的窗口样式：wx.LC_LIST：使用可选的小图标进行多列显示。列数是自动计算的，不需要设置像wx.LC_REPORT那样设置列数。换句话说，这只是一个自动换行的排列。wx.LC_REPORT：单列或者多列报告方式,并且可以设置可选的标题。wx.LC_VIRTUAL：指定显示的文本由应用程序动态提供; 只能用于wxLC_REPORT方式。wx.LC_ICON：大图标方式显示，可选显示文本标签。wx.LC_SMALL_ICON：小图标方式显示，可选显示文本标签。 wx.LC_ALIGN_TOP：图标顶端对齐(仅适用于Windows)。 wx.LC_ALIGN_LEFT：图标左对齐。 wx.LC_AUTOARRANGE：图标自动排列(仅适用于Windows)。 wx.LC_EDIT_LABELS：标签可编辑；当编辑动作开始时应用程序将收到通知。wx.LC_NO_HEADER：在报告模式下不显示标题。 wx.LC_SINGLE_SEL：指定单选模式(默认为多选模式)。 wx.LC_SORT_ASCENDING：从小到大排序。应用程序需要在SortItems中提供自己的排序函数。wx.LC_SORT_DESCENDING：从大到小排序。 应用程序需要在SortItems中提供自己的排序函数。wx.LC_HRULES：在报告模式中显示每行之间的标尺。wx.LC_VRULES：在报告模式中显示每列之间的标尺。
wx.ListCtrl发出的信息：EVT_LIST_BEGIN_DRAG：用鼠标左键拖动时产生。EVT_LIST_BEGIN_RDRAG：鼠标右键拖动时产生。EVT_LIST_BEGIN_LABEL_EDIT：开始编辑标签时产生。可以通过调用Veto()来阻止编辑。EVT_LIST_END_LABEL_EDIT：完成标签的编辑时产生。可以通过调用Veto()来阻止编辑。EVT_LIST_DELETE_ITEM：删除了一个子项时产生。EVT_LIST_DELETE_ALL_ITEMS：删除所有子项时产生。EVT_LIST_ITEM_SELECTED：已完成选择时产生。EVT_LIST_ITEM_DESELECTED：子项被取消选中时产生。EVT_LIST_ITEM_ACTIVATED：子项被激活(输入或双击)时产生。EVT_LIST_ITEM_FOCUSED：当前焦点项已更改时产生。EVT_LIST_ITEM_MIDDLE_CLICK：在子项上单击了鼠标中间按钮时产生(只有泛型控件支持这一点)。EVT_LIST_ITEM_RIGHT_CLICK：在子项上单击鼠标右键时产生。EVT_LIST_KEY_DOWN：在有针对列表控件的按键事件的时产生 。EVT_LIST_INSERT_ITEM：新的子项插入的时产生 。EVT_LIST_COL_CLICK：某一列被鼠标左键单击的时产生。 EVT_LIST_COL_RIGHT_CLICK：某一列被鼠标右键单击的时产生。 EVT_LIST_COL_BEGIN_DRAG：用户开始调整列的大小时产生。可以通过调用Veto()来阻止。EVT_LIST_COL_DRAGGING：列之间的分隔符正在被拖动时产生。EVT_LIST_COL_END_DRAG：用户调整了列的大小之后产生。EVT_LIST_CACHE_HINT：为虚拟列表控件准备缓存时产生。EVT_LIST_ITEM_CHECKED：项已选择后产生。EVT_LIST_ITEM_UNCHECKED：子 项取消选择后产生。
wx.ListCtrl常用方法：Append ( self , entry )：向列表控件添加一个 子 项。 AppendColumn ( self , heading , format=LIST_FORMAT_LEFT , width=-1 )：在报表视图模式向列表控件添加新列。 ClearAll ( self )：删除所有项和所有列。 DeleteAllColumns ( self )：删除列表控件中的所有列。 DeleteAllItems ( self )：删除列表控件中的所有子项。 DeleteColumn ( self , col )：删除指定列。 DeleteItem ( self , item )：删除指定子项。 EditLabel ( self , item )：开始编辑给定项的标签。 GetColumn ( self , col )：获取指定列的信息。 GetColumnCount ( self )：返回列数。 GetColumnWidth ( self , col )：获取列宽度(仅限报表视图)。 GetItem ( self , itemIdx , col=0 )：获取指定项的信息。 GetItemCount ( self )：返回列表控件中的项数。 GetItemData ( self , item )：获取与指定关联的应用程序定义的数据。 InsertColumn (self, col, info)：插入一列(仅适用报表视图)。 InsertItem (self, info)：插入一个项，如果成功则返回新项的索引，否则返回-1。 IsEmpty ( self )：如果控件当前不包含任何项，则返回True。 Select ( self , idx , on=1 )：选择/取消选择一个项。 SetColumn ( self , col , item )：设置指定列的信息。 SetItem (self, info)：设置一个项的数据。 SetItemCount ( self , count )：此方法只能用于虚拟列表控件。它用于向控件指示其包含的项的数量。 SetItemData ( self , item , data )：将应用程序定义的数据与此项关联。
图1：wx.ListCtrl类继承关系
二、wx.ListCtrl演示 #列表控件(wx.ListCtrl) import wx data = [ (＂鲁迅＂, ＂浙江＂, ＂1881＂), (＂艾青＂, ＂浙江＂, ＂1910＂), (＂沈从文＂, ＂湖南＂, ＂1902＂), (＂郁达夫＂, ＂浙江＂, ＂1896＂), (＂巴金＂, ＂四川＂, ＂1904＂), (＂莫言＂, ＂山东＂, ＂1955＂) ] class SampleListCtrl(wx.Frame): def __init__(self, *args, **kw): super(SampleListCtrl, self).__init__(*args, **kw) self.InitUi() def InitUi(self): #设置标题 self.SetTitle(＂实战wxPython: ListCtrl演示＂) #设置窗口尺寸 self.SetSize(400, 240) panel = wx.Panel(self) hbox = wx.BoxSizer(wx.HORIZONTAL) self.list = wx.ListCtrl(panel, wx.ID_ANY, style = wx.LC_REPORT) self.list.InsertColumn(0, ＂名字＂, width = 140) self.list.InsertColumn(1, ＂出生地＂, width = 130) self.list.InsertColumn(2, ＂出生年份＂, wx.LIST_FORMAT_RIGHT, 90) idx = 0 for i in data: index = self.list.InsertItem(idx, i[0]) self.list.SetItem(index, 1, i[1]) self.list.SetItem(index, 2, i[2]) idx += 1 hbox.Add(self.list, 1, wx.EXPAND) panel.SetSizer(hbox) self.Centre() def main(): app = wx.App() sample = SampleListCtrl(None) sample.Show() app.MainLoop()
上面的代码演示如何使用wx.ListCtrl控件来显示有关文学家的一些信息。self.list = wx.ListCtrl(panel, wx.ID_ANY, style = wx.LC_REPORT)
使用wx.LC_REPORT窗口模式创建一个wx.ListCtrlk控件。self.list.InsertColumn(0, ＂名字＂, width = 140) self.list.InsertColumn(1, ＂出生地＂, width = 130) self.list.InsertColumn(2, ＂出生年份＂, wx.LIST_FORMAT_RIGHT, 90)
插入三列。可以指定列的宽度和列的格式。默认格式为wx.LIST_FORMAT_LEFT。idx = 0 for i in data: index = self.list.InsertItem(idx, i[0]) self.list.SetItem(index, 1, i[1]) self.list.SetItem(index, 2, i[2]) idx += 1
使用两个方法将数据插入wx.ListCtrl。每行以InsertItem()方法开始。该方法的第一个参数指定行号。该方法返回行索引。SetItem()方法将数据添加到当前行的连续列中。
图2：wx.ListCtrl演示
三、 wx.ListView控件
wx.ListView继承自wx.ListCtrl，它提供一个更容易使用的接口，在一般情况下，使用wx.ListView比直接使用wx.ListCtrl更好。wx.ListView和wx.ListCtrl使用相同的事件、相同的窗口样式。
图3：wx.ListView类继承关系
四、本文知识点 wx.ListCtrl和wx.ListBox的区别。了解和使用wx.ListCtrl。了解wx.ListView。
前一篇：wxPython -高级控件之列表框ListBox
请关注，评论，收藏，点赞，和转发。