wxPython/demo/wxListCtrl.py

   1 #----------------------------------------------------------------------------
   2 # Name:         ListCtrl.py
   3 # Purpose:      Testing lots of stuff, controls, window types, etc.
   4 #
   5 # Author:       Robin Dunn & Gary Dumer
   6 #
   7 # Created:
   8 # RCS-ID:       $Id$
   9 # Copyright:    (c) 1998 by Total Control Software
  10 # Licence:      wxWindows license
  11 #----------------------------------------------------------------------------
  12
  13 from wxPython.wx import *
  14 from wxPython.lib.mixins.listctrl import wxColumnSorterMixin, wxListCtrlAutoWidthMixin
  15
  16 #---------------------------------------------------------------------------
  17
  18 musicdata = {
  19 1 : ("Bad English", "The Price Of Love", "Rock"),
  20 2 : ("DNA featuring Suzanne Vega", "Tom's Diner", "Rock"),
  21 3 : ("George Michael", "Praying For Time", "Rock"),
  22 4 : ("Gloria Estefan", "Here We Are", "Rock"),
  23 5 : ("Linda Ronstadt", "Don't Know Much", "Rock"),
  24 6 : ("Michael Bolton", "How Am I Supposed To Live Without You", "Blues"),
  25 7 : ("Paul Young", "Oh Girl", "Rock"),
  26 8 : ("Paula Abdul", "Opposites Attract", "Rock"),
  27 9 : ("Richard Marx", "Should've Known Better", "Rock"),
  28 10: ("Rod Stewart", "Forever Young", "Rock"),
  29 11: ("Roxette", "Dangerous", "Rock"),
  30 12: ("Sheena Easton", "The Lover In Me", "Rock"),
  31 13: ("Sinead O'Connor", "Nothing Compares 2 U", "Rock"),
  32 14: ("Stevie B.", "Because I Love You", "Rock"),
  33 15: ("Taylor Dayne", "Love Will Lead You Back", "Rock"),
  34 16: ("The Bangles", "Eternal Flame", "Rock"),
  35 17: ("Wilson Phillips", "Release Me", "Rock"),
  36 18: ("Billy Joel", "Blonde Over Blue", "Rock"),
  37 19: ("Billy Joel", "Famous Last Words", "Rock"),
  38 20: ("Billy Joel", "Lullabye (Goodnight, My Angel)", "Rock"),
  39 21: ("Billy Joel", "The River Of Dreams", "Rock"),
  40 22: ("Billy Joel", "Two Thousand Years", "Rock"),
  41 23: ("Janet Jackson", "Alright", "Rock"),
  42 24: ("Janet Jackson", "Black Cat", "Rock"),
  43 25: ("Janet Jackson", "Come Back To Me", "Rock"),
  44 26: ("Janet Jackson", "Escapade", "Rock"),
  45 27: ("Janet Jackson", "Love Will Never Do (Without You)", "Rock"),
  46 28: ("Janet Jackson", "Miss You Much", "Rock"),
  47 29: ("Janet Jackson", "Rhythm Nation", "Rock"),
  48 30: ("Janet Jackson", "State Of The World", "Rock"),
  49 31: ("Janet Jackson", "The Knowledge", "Rock"),
  50 32: ("Spyro Gyra", "End of Romanticism", "Jazz"),
  51 33: ("Spyro Gyra", "Heliopolis", "Jazz"),
  52 34: ("Spyro Gyra", "Jubilee", "Jazz"),
  53 35: ("Spyro Gyra", "Little Linda", "Jazz"),
  54 36: ("Spyro Gyra", "Morning Dance", "Jazz"),
  55 37: ("Spyro Gyra", "Song for Lorraine", "Jazz"),
  56 38: ("Yes", "Owner Of A Lonely Heart", "Rock"),
  57 39: ("Yes", "Rhythm Of Love", "Rock"),
  58 40: ("Cusco", "Dream Catcher", "New Age"),
  59 41: ("Cusco", "Geronimos Laughter", "New Age"),
  60 42: ("Cusco", "Ghost Dance", "New Age"),
  61 43: ("Blue Man Group", "Drumbone", "New Age"),
  62 44: ("Blue Man Group", "Endless Column", "New Age"),
  63 45: ("Blue Man Group", "Klein Mandelbrot", "New Age"),
  64 46: ("Kenny G", "Silhouette", "Jazz"),
  65 47: ("Sade", "Smooth Operator", "Jazz"),
  66 48: ("David Arkenstone", "Papillon (On The Wings Of The Butterfly)", "New Age"),
  67 49: ("David Arkenstone", "Stepping Stars", "New Age"),
  68 50: ("David Arkenstone", "Carnation Lily Lily Rose", "New Age"),
  69 51: ("David Lanz", "Behind The Waterfall", "New Age"),
  70 52: ("David Lanz", "Cristofori's Dream", "New Age"),
  71 53: ("David Lanz", "Heartsounds", "New Age"),
  72 54: ("David Lanz", "Leaves on the Seine", "New Age"),
  73 }
  74
  75 import images
  76
  77
  78 class TestListCtrl(wxListCtrl, wxListCtrlAutoWidthMixin):
  79     def __init__(self, parent, ID, pos=wxDefaultPosition,
  80                  size=wxDefaultSize, style=0):
  81         wxListCtrl.__init__(self, parent, ID, pos, size, style)
  82         wxListCtrlAutoWidthMixin.__init__(self)
  83
  84
  85
  86 class TestListCtrlPanel(wxPanel, wxColumnSorterMixin):
  87     def __init__(self, parent, log):
  88         wxPanel.__init__(self, parent, -1, style=wxWANTS_CHARS)
  89
  90         self.log = log
  91         tID = wxNewId()
  92
  93         self.il = wxImageList(16, 16)
  94
  95         self.idx1 = self.il.Add(images.getSmilesBitmap())
  96         self.sm_up = self.il.Add(images.getSmallUpArrowBitmap())
  97         self.sm_dn = self.il.Add(images.getSmallDnArrowBitmap())
  98
  99         self.list = TestListCtrl(self, tID,
 100                                  style=wxLC_REPORT | wxSUNKEN_BORDER
 101                                  #| wxLC_NO_HEADER
 102                                  #| wxLC_VRULES | wxLC_HRULES
 103                                  )
 104         self.list.SetImageList(self.il, wxIMAGE_LIST_SMALL)
 105
 106         self.PopulateList()
 107
 108         # Now that the list exists we can init the other base class,
 109         # see wxPython/lib/mixins/listctrl.py
 110         self.itemDataMap = musicdata
 111         wxColumnSorterMixin.__init__(self, 3)
 112         #self.SortListItems(0, True)
 113
 114         EVT_SIZE(self, self.OnSize)
 115         EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
 116         EVT_LIST_ITEM_DESELECTED(self, tID, self.OnItemDeselected)
 117         EVT_LIST_ITEM_ACTIVATED(self, tID, self.OnItemActivated)
 118         EVT_LIST_DELETE_ITEM(self, tID, self.OnItemDelete)
 119         EVT_LIST_COL_CLICK(self, tID, self.OnColClick)
 120         EVT_LIST_COL_RIGHT_CLICK(self, tID, self.OnColRightClick)
 121         EVT_LIST_COL_BEGIN_DRAG(self, tID, self.OnColBeginDrag)
 122         EVT_LIST_COL_DRAGGING(self, tID, self.OnColDragging)
 123         EVT_LIST_COL_END_DRAG(self, tID, self.OnColEndDrag)
 124
 125         EVT_LEFT_DCLICK(self.list, self.OnDoubleClick)
 126         EVT_RIGHT_DOWN(self.list, self.OnRightDown)
 127
 128         # for wxMSW
 129         EVT_COMMAND_RIGHT_CLICK(self.list, tID, self.OnRightClick)
 130
 131         # for wxGTK
 132         EVT_RIGHT_UP(self.list, self.OnRightClick)
 133
 134
 135     def PopulateList(self):
 136         if 0:
 137             # for normal, simple columns, you can add them like this:
 138             self.list.InsertColumn(0, "Artist")
 139             self.list.InsertColumn(1, "Title", wxLIST_FORMAT_RIGHT)
 140             self.list.InsertColumn(2, "Genre")
 141         else:
 142             # but since we want images on the column header we have to do it the hard way:
 143             info = wxListItem()
 144             info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE | wxLIST_MASK_FORMAT
 145             info.m_image = -1
 146             info.m_format = 0
 147             info.m_text = "Artist"
 148             self.list.InsertColumnInfo(0, info)
 149
 150             info.m_format = wxLIST_FORMAT_RIGHT
 151             info.m_text = "Title"
 152             self.list.InsertColumnInfo(1, info)
 153
 154             info.m_format = 0
 155             info.m_text = "Genre"
 156             self.list.InsertColumnInfo(2, info)
 157
 158         items = musicdata.items()
 159         for x in range(len(items)):
 160             key, data = items[x]
 161             self.list.InsertImageStringItem(x, data[0], self.idx1)
 162             self.list.SetStringItem(x, 1, data[1])
 163             self.list.SetStringItem(x, 2, data[2])
 164             self.list.SetItemData(x, key)
 165
 166         self.list.SetColumnWidth(0, wxLIST_AUTOSIZE)
 167         self.list.SetColumnWidth(1, wxLIST_AUTOSIZE)
 168         self.list.SetColumnWidth(2, 100)
 169
 170         # show how to select an item
 171         self.list.SetItemState(5, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
 172
 173         # show how to change the colour of a couple items
 174         item = self.list.GetItem(1)
 175         item.SetTextColour(wxBLUE)
 176         self.list.SetItem(item)
 177         item = self.list.GetItem(4)
 178         item.SetTextColour(wxRED)
 179         self.list.SetItem(item)
 180
 181         self.currentItem = 0
 182
 183
 184     # Used by the wxColumnSorterMixin, see wxPython/lib/mixins/listctrl.py
 185     def GetListCtrl(self):
 186         return self.list
 187
 188     # Used by the wxColumnSorterMixin, see wxPython/lib/mixins/listctrl.py
 189     def GetSortImages(self):
 190         return (self.sm_dn, self.sm_up)
 191
 192
 193     def OnRightDown(self, event):
 194         self.x = event.GetX()
 195         self.y = event.GetY()
 196         self.log.WriteText("x, y = %s\n" % str((self.x, self.y)))
 197         item, flags = self.list.HitTest((self.x, self.y))
 198         if flags & wxLIST_HITTEST_ONITEM:
 199             self.list.Select(item)
 200         event.Skip()
 201
 202
 203     def getColumnText(self, index, col):
 204         item = self.list.GetItem(index, col)
 205         return item.GetText()
 206
 207
 208     def OnItemSelected(self, event):
 209         ##print event.GetItem().GetTextColour()
 210         self.currentItem = event.m_itemIndex
 211         self.log.WriteText("OnItemSelected: %s, %s, %s, %s\n" %
 212                            (self.currentItem,
 213                             self.list.GetItemText(self.currentItem),
 214                             self.getColumnText(self.currentItem, 1),
 215                             self.getColumnText(self.currentItem, 2)))
 216         if self.currentItem == 10:
 217             self.log.WriteText("OnItemSelected: Veto'd selection\n")
 218             #event.Veto()  # doesn't work
 219             # this does
 220             self.list.SetItemState(10, 0, wxLIST_STATE_SELECTED)
 221
 222     def OnItemDeselected(self, evt):
 223         item = evt.GetItem()
 224         self.log.WriteText("OnItemDeselected: %d" % evt.m_itemIndex)
 225
 226         # Show how to reselect something we don't want deselected
 227         if evt.m_itemIndex == 11:
 228             wxCallAfter(self.list.SetItemState, 11, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
 229
 230
 231     def OnItemActivated(self, event):
 232         self.currentItem = event.m_itemIndex
 233         self.log.WriteText("OnItemActivated: %s\nTopItem: %s" %
 234                            (self.list.GetItemText(self.currentItem), self.list.GetTopItem()))
 235
 236     def OnItemDelete(self, event):
 237         self.log.WriteText("OnItemDelete\n")
 238
 239     def OnColClick(self, event):
 240         self.log.WriteText("OnColClick: %d\n" % event.GetColumn())
 241
 242     def OnColRightClick(self, event):
 243         item = self.list.GetColumn(event.GetColumn())
 244         self.log.WriteText("OnColRightClick: %d %s\n" %
 245                            (event.GetColumn(), (item.GetText(), item.GetAlign(),
 246                                                 item.GetWidth(), item.GetImage())))
 247
 248     def OnColBeginDrag(self, event):
 249         self.log.WriteText("OnColBeginDrag\n")
 250         ## Show how to not allow a column to be resized
 251         #if event.GetColumn() == 0:
 252         #    event.Veto()
 253
 254
 255     def OnColDragging(self, event):
 256         self.log.WriteText("OnColDragging\n")
 257
 258     def OnColEndDrag(self, event):
 259         self.log.WriteText("OnColEndDrag\n")
 260
 261     def OnDoubleClick(self, event):
 262         self.log.WriteText("OnDoubleClick item %s\n" % self.list.GetItemText(self.currentItem))
 263         event.Skip()
 264
 265     def OnRightClick(self, event):
 266         self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))
 267
 268         # only do this part the first time
 269         if not hasattr(self, "popupID1"):
 270             self.popupID1 = wxNewId()
 271             self.popupID2 = wxNewId()
 272             self.popupID3 = wxNewId()
 273             self.popupID4 = wxNewId()
 274             self.popupID5 = wxNewId()
 275             EVT_MENU(self, self.popupID1, self.OnPopupOne)
 276             EVT_MENU(self, self.popupID2, self.OnPopupTwo)
 277             EVT_MENU(self, self.popupID3, self.OnPopupThree)
 278             EVT_MENU(self, self.popupID4, self.OnPopupFour)
 279             EVT_MENU(self, self.popupID5, self.OnPopupFive)
 280
 281         # make a menu
 282         menu = wxMenu()
 283         # Show how to put an icon in the menu
 284         item = wxMenuItem(menu, self.popupID1,"One")
 285         item.SetBitmap(images.getSmilesBitmap())
 286         menu.AppendItem(item)
 287         # add some other items
 288         menu.Append(self.popupID2, "Two")
 289         menu.Append(self.popupID3, "ClearAll and repopulate")
 290         menu.Append(self.popupID4, "DeleteAllItems")
 291         menu.Append(self.popupID5, "GetItem")
 292
 293         # Popup the menu.  If an item is selected then its handler
 294         # will be called before PopupMenu returns.
 295         self.PopupMenu(menu, wxPoint(self.x, self.y))
 296         menu.Destroy()
 297
 298
 299     def OnPopupOne(self, event):
 300         self.log.WriteText("Popup one\n")
 301         print "FindItem:", self.list.FindItem(-1, "Roxette")
 302         print "FindItemData:", self.list.FindItemData(-1, 11)
 303
 304     def OnPopupTwo(self, event):
 305         self.log.WriteText("Popup two\n")
 306
 307     def OnPopupThree(self, event):
 308         self.log.WriteText("Popup three\n")
 309         self.list.ClearAll()
 310         wxCallAfter(self.PopulateList)
 311         #wxYield()
 312         #self.PopulateList()
 313
 314     def OnPopupFour(self, event):
 315         self.list.DeleteAllItems()
 316
 317     def OnPopupFive(self, event):
 318         item = self.list.GetItem(self.currentItem)
 319         print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)
 320
 321     def OnSize(self, event):
 322         w,h = self.GetClientSizeTuple()
 323         self.list.SetDimensions(0, 0, w, h)
 324
 325
 326
 327
 328
 329
 330 #---------------------------------------------------------------------------
 331
 332 def runTest(frame, nb, log):
 333     win = TestListCtrlPanel(nb, log)
 334     return win
 335
 336 #---------------------------------------------------------------------------
 337
 338
 339
 340
 341 overview = """\
 342 A list control presents lists in a number of formats: list view, report view, icon view and small icon view. Elements are numbered from zero.
 343
 344 """
 345
 346
 347
 348
 349
 350 if __name__ == '__main__':
 351     import sys,os
 352     import run
 353     run.main(['', os.path.basename(sys.argv[0])])
 354