[wxWidgets.git] / wxPython / demo / wxListCtrl.py

#!/bin/env python
#----------------------------------------------------------------------------
# Name:         ListCtrl.py
# Purpose:      Testing lots of stuff, controls, window types, etc.
#
# Author:       Robin Dunn & Gary Dumer
#
# Created:
# RCS-ID:       $Id$
# Copyright:    (c) 1998 by Total Control Software
# Licence:      wxWindows license
#----------------------------------------------------------------------------

from wxPython.wx import *

#---------------------------------------------------------------------------

musicdata = {
1 : ("Bad English", "The Price Of Love", "Rock"),
2 : ("DNA featuring Suzanne Vega", "Tom's Diner", "Rock"),
3 : ("George Michael", "Praying For Time", "Rock"),
4 : ("Gloria Estefan", "Here We Are", "Rock"),
5 : ("Linda Ronstadt", "Don't Know Much", "Rock"),
6 : ("Michael Bolton", "How Am I Supposed To Live Without You", "Blues"),
7 : ("Paul Young", "Oh Girl", "Rock"),
8 : ("Paula Abdul", "Opposites Attract", "Rock"),
9 : ("Richard Marx", "Should've Known Better", "Rock"),
10: ("Rod Stewart", "Forever Young", "Rock"),
11: ("Roxette", "Dangerous", "Rock"),
12: ("Sheena Easton", "The Lover In Me", "Rock"),
13: ("Sinead O'Connor", "Nothing Compares 2 U", "Rock"),
14: ("Stevie B.", "Because I Love You", "Rock"),
15: ("Taylor Dayne", "Love Will Lead You Back", "Rock"),
16: ("The Bangles", "Eternal Flame", "Rock"),
17: ("Wilson Phillips", "Release Me", "Rock"),
18: ("Billy Joel", "Blonde Over Blue", "Rock"),
19: ("Billy Joel", "Famous Last Words", "Rock"),
20: ("Billy Joel", "Lullabye (Goodnight, My Angel)", "Rock"),
21: ("Billy Joel", "The River Of Dreams", "Rock"),
22: ("Billy Joel", "Two Thousand Years", "Rock"),
23: ("Janet Jackson", "Alright", "Rock"),
24: ("Janet Jackson", "Black Cat", "Rock"),
25: ("Janet Jackson", "Come Back To Me", "Rock"),
26: ("Janet Jackson", "Escapade", "Rock"),
27: ("Janet Jackson", "Love Will Never Do (Without You)", "Rock"),
28: ("Janet Jackson", "Miss You Much", "Rock"),
29: ("Janet Jackson", "Rhythm Nation", "Rock"),
30: ("Janet Jackson", "State Of The World", "Rock"),
31: ("Janet Jackson", "The Knowledge", "Rock"),
32: ("Spyro Gyra", "End of Romanticism", "Jazz"),
33: ("Spyro Gyra", "Heliopolis", "Jazz"),
34: ("Spyro Gyra", "Jubilee", "Jazz"),
35: ("Spyro Gyra", "Little Linda", "Jazz"),
36: ("Spyro Gyra", "Morning Dance", "Jazz"),
37: ("Spyro Gyra", "Song for Lorraine", "Jazz"),
38: ("Yes", "Owner Of A Lonely Heart", "Rock"),
39: ("Yes", "Rhythm Of Love", "Rock"),
}


class TestListCtrlPanel(wxPanel):
    def __init__(self, parent, log):
        wxPanel.__init__(self, parent, -1, style=wxWANTS_CHARS)

        self.log = log
        tID = wxNewId()

        self.il = wxImageList(16, 16)
        bmp = wxBitmap('bitmaps/smiles.bmp', wxBITMAP_TYPE_BMP)
        idx1 = self.il.AddWithColourMask(bmp, wxWHITE)

        self.list = wxListCtrl(self, tID,
                               style=wxLC_REPORT|wxSUNKEN_BORDER)
        self.list.SetImageList(self.il, wxIMAGE_LIST_SMALL)

        #  Why doesn't this show up on MSW???
        self.list.SetToolTip(wxToolTip("This is a ToolTip!"))

        self.list.InsertColumn(0, "Artist")
        self.list.InsertColumn(1, "Title", wxLIST_FORMAT_RIGHT)
        self.list.InsertColumn(2, "Genre")
        items = musicdata.items()
        for x in range(len(items)):
            key, data = items[x]
            self.list.InsertImageStringItem(x, data[0], idx1)
            self.list.SetStringItem(x, 1, data[1])
            self.list.SetStringItem(x, 2, data[2])
            self.list.SetItemData(x, key)

        self.list.SetColumnWidth(0, wxLIST_AUTOSIZE)
        self.list.SetColumnWidth(1, wxLIST_AUTOSIZE)
        ##self.list.SetColumnWidth(2, wxLIST_AUTOSIZE)

        self.list.SetItemState(25, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)

        #self.list.SetItemState(25, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
        #self.list.EnsureVisible(25)

        # show how to change the colour of an item
        item = self.list.GetItem(1)
        item.SetTextColour(wxBLUE)
        self.list.SetItem(item)

        self.currentItem = 0
        EVT_SIZE(self, self.OnSize)
        EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
        EVT_LIST_ITEM_ACTIVATED(self, tID, self.OnItemActivated)
        EVT_LIST_DELETE_ITEM(self, tID, self.OnItemDelete)
        EVT_LIST_COL_CLICK(self, tID, self.OnColClick)
        EVT_LEFT_DCLICK(self.list, self.OnDoubleClick)
        EVT_RIGHT_DOWN(self.list, self.OnRightDown)

        # for wxMSW
        EVT_COMMAND_RIGHT_CLICK(self.list, tID, self.OnRightClick)

        # for wxGTK
        EVT_RIGHT_UP(self.list, self.OnRightClick)


    def OnRightDown(self, event):
        self.x = event.GetX()
        self.y = event.GetY()
        self.log.WriteText("x, y = %s\n" % str((self.x, self.y)))
        event.Skip()


    def getColumnText(self, index, col):
        item = self.list.GetItem(index, col)
        return item.GetText()


    def OnItemSelected(self, event):
        self.currentItem = event.m_itemIndex
        self.log.WriteText("OnItemSelected: %s, %s, %s\n" %
                           (self.list.GetItemText(self.currentItem),
                            self.getColumnText(self.currentItem, 1),
                            self.getColumnText(self.currentItem, 2)))


    def OnItemActivated(self, event):
        self.currentItem = event.m_itemIndex
        self.log.WriteText("OnItemActivated: %s\n" % self.list.GetItemText(self.currentItem))

    def OnItemDelete(self, event):
        self.log.WriteText("OnItemDelete\n")

    def OnColClick(self, event):
        self.log.WriteText("OnColClick: %d\n" % event.m_col)
        self.col = event.m_col
        self.list.SortItems(self.ColumnSorter)

    def ColumnSorter(self, key1, key2):
        item1 = musicdata[key1][self.col]
        item2 = musicdata[key2][self.col]
        if item1 == item2:  return 0
        elif item1 < item2: return -1
        else:               return 1


    def OnDoubleClick(self, event):
        self.log.WriteText("OnDoubleClick item %s\n" % self.list.GetItemText(self.currentItem))
        event.Skip()

    def OnRightClick(self, event):
        self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))
        menu = wxMenu()
        tPopupID1 = 0
        tPopupID2 = 1
        tPopupID3 = 2
        tPopupID4 = 3
        tPopupID5 = 5
        menu.Append(tPopupID1, "One")
        menu.Append(tPopupID2, "Two")
        menu.Append(tPopupID3, "Three")
        menu.Append(tPopupID4, "DeleteAllItems")
        menu.Append(tPopupID5, "GetItem")
        EVT_MENU(self, tPopupID1, self.OnPopupOne)
        EVT_MENU(self, tPopupID2, self.OnPopupTwo)
        EVT_MENU(self, tPopupID3, self.OnPopupThree)
        EVT_MENU(self, tPopupID4, self.OnPopupFour)
        EVT_MENU(self, tPopupID5, self.OnPopupFive)
        self.PopupMenu(menu, wxPoint(self.x, self.y))
        menu.Destroy()
        event.Skip()

    def OnPopupOne(self, event):
        self.log.WriteText("Popup one\n")

    def OnPopupTwo(self, event):
        self.log.WriteText("Popup two\n")

    def OnPopupThree(self, event):
        self.log.WriteText("Popup three\n")

    def OnPopupFour(self, event):
        self.list.DeleteAllItems()

    def OnPopupFive(self, event):
        item = self.list.GetItem(self.currentItem)
        print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)

    def OnSize(self, event):
        w,h = self.GetClientSizeTuple()
        self.list.SetDimensions(0, 0, w, h)


#---------------------------------------------------------------------------

def runTest(frame, nb, log):
    win = TestListCtrlPanel(nb, log)
    return win

#---------------------------------------------------------------------------


overview = """\
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.

wxListCtrl()
------------------------

Default constructor.

wxListCtrl(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listCtrl")

Constructor, creating and showing a list control.

Parameters
-------------------

parent = Parent window. Must not be NULL.

id = Window identifier. A value of -1 indicates a default value.

pos = Window position.

size = Window size. If the default size (-1, -1) is specified then the window is sized appropriately.

style = Window style. See wxListCtrl.

validator = Window validator.

name = Window name.
"""
Commit	Line	Data
cf694132 RD	1	#!/bin/env python
	2	#----------------------------------------------------------------------------
	3	# Name: ListCtrl.py
	4	# Purpose: Testing lots of stuff, controls, window types, etc.
	5	#
	6	# Author: Robin Dunn & Gary Dumer
	7	#
	8	# Created:
	9	# RCS-ID: $Id$
	10	# Copyright: (c) 1998 by Total Control Software
	11	# Licence: wxWindows license
	12	#----------------------------------------------------------------------------
	13
	14	from wxPython.wx import *
	15
	16	#---------------------------------------------------------------------------
	17
dcd38683 RD	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	}
	59
	60
cf694132 RD	61	class TestListCtrlPanel(wxPanel):
cf694132 RD	62	def __init__(self, parent, log):
c368d904	63	wxPanel.__init__(self, parent, -1, style=wxWANTS_CHARS)
cf694132 RD	64
cf694132 RD	65	self.log = log
f6bcfd97	66	tID = wxNewId()
cf694132 RD	67
cf694132 RD	68	self.il = wxImageList(16, 16)
185d7c3e RD	69	bmp = wxBitmap('bitmaps/smiles.bmp', wxBITMAP_TYPE_BMP)
185d7c3e RD	70	idx1 = self.il.AddWithColourMask(bmp, wxWHITE)
cf694132	71
c368d904 RD	72	self.list = wxListCtrl(self, tID,
c368d904 RD	73	style=wxLC_REPORT\|wxSUNKEN_BORDER)
cf694132 RD	74	self.list.SetImageList(self.il, wxIMAGE_LIST_SMALL)
cf694132 RD	75
185d7c3e	76	# Why doesn't this show up on MSW???
cf694132	77	self.list.SetToolTip(wxToolTip("This is a ToolTip!"))
cf694132	78
dcd38683	79	self.list.InsertColumn(0, "Artist")
c368d904	80	self.list.InsertColumn(1, "Title", wxLIST_FORMAT_RIGHT)
dcd38683 RD	81	self.list.InsertColumn(2, "Genre")
	82	items = musicdata.items()
	83	for x in range(len(items)):
	84	key, data = items[x]
	85	self.list.InsertImageStringItem(x, data[0], idx1)
	86	self.list.SetStringItem(x, 1, data[1])
	87	self.list.SetStringItem(x, 2, data[2])
	88	self.list.SetItemData(x, key)
cf694132 RD	89
	90	self.list.SetColumnWidth(0, wxLIST_AUTOSIZE)
	91	self.list.SetColumnWidth(1, wxLIST_AUTOSIZE)
dcd38683	92	##self.list.SetColumnWidth(2, wxLIST_AUTOSIZE)
cf694132	93
c368d904 RD	94	self.list.SetItemState(25, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
	95
	96	#self.list.SetItemState(25, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
	97	#self.list.EnsureVisible(25)
	98
	99	# show how to change the colour of an item
	100	item = self.list.GetItem(1)
	101	item.SetTextColour(wxBLUE)
	102	self.list.SetItem(item)
bb0054cd RD	103
bb0054cd RD	104	self.currentItem = 0
f6bcfd97	105	EVT_SIZE(self, self.OnSize)
bb0054cd	106	EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
c368d904	107	EVT_LIST_ITEM_ACTIVATED(self, tID, self.OnItemActivated)
8bf5d46e	108	EVT_LIST_DELETE_ITEM(self, tID, self.OnItemDelete)
dcd38683	109	EVT_LIST_COL_CLICK(self, tID, self.OnColClick)
bb0054cd	110	EVT_LEFT_DCLICK(self.list, self.OnDoubleClick)
a08cbc01 RD	111	EVT_RIGHT_DOWN(self.list, self.OnRightDown)
a08cbc01 RD	112
64be6958 RD	113	# for wxMSW
	114	EVT_COMMAND_RIGHT_CLICK(self.list, tID, self.OnRightClick)
	115
	116	# for wxGTK
	117	EVT_RIGHT_UP(self.list, self.OnRightClick)
	118
a08cbc01 RD	119
	120	def OnRightDown(self, event):
	121	self.x = event.GetX()
64be6958 RD	122	self.y = event.GetY()
64be6958 RD	123	self.log.WriteText("x, y = %s\n" % str((self.x, self.y)))
a08cbc01	124	event.Skip()
bb0054cd	125
185d7c3e RD	126
	127	def getColumnText(self, index, col):
	128	item = self.list.GetItem(index, col)
	129	return item.GetText()
	130
	131
bb0054cd RD	132	def OnItemSelected(self, event):
bb0054cd RD	133	self.currentItem = event.m_itemIndex
185d7c3e RD	134	self.log.WriteText("OnItemSelected: %s, %s, %s\n" %
	135	(self.list.GetItemText(self.currentItem),
	136	self.getColumnText(self.currentItem, 1),
	137	self.getColumnText(self.currentItem, 2)))
	138
bb0054cd	139
c368d904 RD	140	def OnItemActivated(self, event):
	141	self.currentItem = event.m_itemIndex
	142	self.log.WriteText("OnItemActivated: %s\n" % self.list.GetItemText(self.currentItem))
	143
8bf5d46e RD	144	def OnItemDelete(self, event):
	145	self.log.WriteText("OnItemDelete\n")
	146
dcd38683 RD	147	def OnColClick(self, event):
	148	self.log.WriteText("OnColClick: %d\n" % event.m_col)
	149	self.col = event.m_col
	150	self.list.SortItems(self.ColumnSorter)
	151
	152	def ColumnSorter(self, key1, key2):
	153	item1 = musicdata[key1][self.col]
	154	item2 = musicdata[key2][self.col]
	155	if item1 == item2: return 0
	156	elif item1 < item2: return -1
	157	else: return 1
	158
8bf5d46e	159
bb0054cd RD	160	def OnDoubleClick(self, event):
bb0054cd RD	161	self.log.WriteText("OnDoubleClick item %s\n" % self.list.GetItemText(self.currentItem))
185d7c3e	162	event.Skip()
a08cbc01	163
bb0054cd RD	164	def OnRightClick(self, event):
bb0054cd RD	165	self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))
e166644c	166	menu = wxMenu()
a08cbc01 RD	167	tPopupID1 = 0
	168	tPopupID2 = 1
	169	tPopupID3 = 2
8bf5d46e	170	tPopupID4 = 3
e166644c RD	171	tPopupID5 = 5
	172	menu.Append(tPopupID1, "One")
	173	menu.Append(tPopupID2, "Two")
	174	menu.Append(tPopupID3, "Three")
	175	menu.Append(tPopupID4, "DeleteAllItems")
	176	menu.Append(tPopupID5, "GetItem")
a08cbc01 RD	177	EVT_MENU(self, tPopupID1, self.OnPopupOne)
	178	EVT_MENU(self, tPopupID2, self.OnPopupTwo)
	179	EVT_MENU(self, tPopupID3, self.OnPopupThree)
8bf5d46e	180	EVT_MENU(self, tPopupID4, self.OnPopupFour)
e166644c RD	181	EVT_MENU(self, tPopupID5, self.OnPopupFive)
	182	self.PopupMenu(menu, wxPoint(self.x, self.y))
	183	menu.Destroy()
185d7c3e	184	event.Skip()
a08cbc01 RD	185
	186	def OnPopupOne(self, event):
	187	self.log.WriteText("Popup one\n")
	188
	189	def OnPopupTwo(self, event):
	190	self.log.WriteText("Popup two\n")
	191
	192	def OnPopupThree(self, event):
	193	self.log.WriteText("Popup three\n")
cf694132	194
8bf5d46e RD	195	def OnPopupFour(self, event):
	196	self.list.DeleteAllItems()
	197
e166644c RD	198	def OnPopupFive(self, event):
	199	item = self.list.GetItem(self.currentItem)
	200	print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)
	201
cf694132 RD	202	def OnSize(self, event):
	203	w,h = self.GetClientSizeTuple()
	204	self.list.SetDimensions(0, 0, w, h)
	205
	206
	207
	208
a08cbc01 RD	209
a08cbc01 RD	210
cf694132 RD	211	#---------------------------------------------------------------------------
	212
	213	def runTest(frame, nb, log):
	214	win = TestListCtrlPanel(nb, log)
	215	return win
	216
	217	#---------------------------------------------------------------------------
	218
	219
	220
	221
	222
	223
	224
	225
	226
	227
	228
	229
	230
	231
	232
	233
	234	overview = """\
	235	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.
	236
	237	wxListCtrl()
	238	------------------------
	239
	240	Default constructor.
	241
	242	wxListCtrl(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listCtrl")
	243
	244	Constructor, creating and showing a list control.
	245
	246	Parameters
	247	-------------------
	248
	249	parent = Parent window. Must not be NULL.
	250
	251	id = Window identifier. A value of -1 indicates a default value.
	252
	253	pos = Window position.
	254
	255	size = Window size. If the default size (-1, -1) is specified then the window is sized appropriately.
	256
	257	style = Window style. See wxListCtrl.
	258
	259	validator = Window validator.
	260
	261	name = Window name.
	262	"""