[wxWidgets.git] / utils / 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)

        self.log = log
        tID = NewId()

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

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

        self.list.SetToolTip(wxToolTip("This is a ToolTip!"))
        wxToolTip_Enable(true)

        self.list.InsertColumn(0, "Artist")
        self.list.InsertColumn(1, "Title")
        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(5, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)

        self.currentItem = 0
        EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
        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 OnItemSelected(self, event):
        self.currentItem = event.m_itemIndex
        self.log.WriteText("OnItemSelected: %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))


    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()

    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):
	62	def __init__(self, parent, log):
	63	wxPanel.__init__(self, parent, -1)
	64
	65	self.log = log
	66	tID = NewId()
	67
	68	self.il = wxImageList(16, 16)
694759cf	69	idx1 = self.il.Add(wxBitmap('bitmaps/smiles.bmp', wxBITMAP_TYPE_BMP))
cf694132 RD	70
	71	self.list = wxListCtrl(self, tID, wxDefaultPosition, wxDefaultSize,
	72	wxLC_REPORT\|wxSUNKEN_BORDER)
	73	self.list.SetImageList(self.il, wxIMAGE_LIST_SMALL)
	74
	75	self.list.SetToolTip(wxToolTip("This is a ToolTip!"))
	76	wxToolTip_Enable(true)
	77
dcd38683 RD	78	self.list.InsertColumn(0, "Artist")
	79	self.list.InsertColumn(1, "Title")
	80	self.list.InsertColumn(2, "Genre")
	81	items = musicdata.items()
	82	for x in range(len(items)):
	83	key, data = items[x]
	84	self.list.InsertImageStringItem(x, data[0], idx1)
	85	self.list.SetStringItem(x, 1, data[1])
	86	self.list.SetStringItem(x, 2, data[2])
	87	self.list.SetItemData(x, key)
cf694132 RD	88
	89	self.list.SetColumnWidth(0, wxLIST_AUTOSIZE)
	90	self.list.SetColumnWidth(1, wxLIST_AUTOSIZE)
dcd38683	91	##self.list.SetColumnWidth(2, wxLIST_AUTOSIZE)
cf694132	92
bb0054cd RD	93	self.list.SetItemState(5, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
	94
	95	self.currentItem = 0
	96	EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
8bf5d46e	97	EVT_LIST_DELETE_ITEM(self, tID, self.OnItemDelete)
dcd38683	98	EVT_LIST_COL_CLICK(self, tID, self.OnColClick)
bb0054cd	99	EVT_LEFT_DCLICK(self.list, self.OnDoubleClick)
a08cbc01 RD	100	EVT_RIGHT_DOWN(self.list, self.OnRightDown)
a08cbc01 RD	101
64be6958 RD	102	# for wxMSW
	103	EVT_COMMAND_RIGHT_CLICK(self.list, tID, self.OnRightClick)
	104
	105	# for wxGTK
	106	EVT_RIGHT_UP(self.list, self.OnRightClick)
	107
a08cbc01 RD	108
	109	def OnRightDown(self, event):
	110	self.x = event.GetX()
64be6958 RD	111	self.y = event.GetY()
64be6958 RD	112	self.log.WriteText("x, y = %s\n" % str((self.x, self.y)))
a08cbc01	113	event.Skip()
bb0054cd RD	114
	115	def OnItemSelected(self, event):
	116	self.currentItem = event.m_itemIndex
	117	self.log.WriteText("OnItemSelected: %s\n" % self.list.GetItemText(self.currentItem))
	118
8bf5d46e RD	119	def OnItemDelete(self, event):
	120	self.log.WriteText("OnItemDelete\n")
	121
dcd38683 RD	122	def OnColClick(self, event):
	123	self.log.WriteText("OnColClick: %d\n" % event.m_col)
	124	self.col = event.m_col
	125	self.list.SortItems(self.ColumnSorter)
	126
	127	def ColumnSorter(self, key1, key2):
	128	item1 = musicdata[key1][self.col]
	129	item2 = musicdata[key2][self.col]
	130	if item1 == item2: return 0
	131	elif item1 < item2: return -1
	132	else: return 1
	133
8bf5d46e	134
bb0054cd RD	135	def OnDoubleClick(self, event):
	136	self.log.WriteText("OnDoubleClick item %s\n" % self.list.GetItemText(self.currentItem))
	137
a08cbc01	138
bb0054cd RD	139	def OnRightClick(self, event):
bb0054cd RD	140	self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))
e166644c	141	menu = wxMenu()
a08cbc01 RD	142	tPopupID1 = 0
	143	tPopupID2 = 1
	144	tPopupID3 = 2
8bf5d46e	145	tPopupID4 = 3
e166644c RD	146	tPopupID5 = 5
	147	menu.Append(tPopupID1, "One")
	148	menu.Append(tPopupID2, "Two")
	149	menu.Append(tPopupID3, "Three")
	150	menu.Append(tPopupID4, "DeleteAllItems")
	151	menu.Append(tPopupID5, "GetItem")
a08cbc01 RD	152	EVT_MENU(self, tPopupID1, self.OnPopupOne)
	153	EVT_MENU(self, tPopupID2, self.OnPopupTwo)
	154	EVT_MENU(self, tPopupID3, self.OnPopupThree)
8bf5d46e	155	EVT_MENU(self, tPopupID4, self.OnPopupFour)
e166644c RD	156	EVT_MENU(self, tPopupID5, self.OnPopupFive)
	157	self.PopupMenu(menu, wxPoint(self.x, self.y))
	158	menu.Destroy()
a08cbc01 RD	159
	160	def OnPopupOne(self, event):
	161	self.log.WriteText("Popup one\n")
	162
	163	def OnPopupTwo(self, event):
	164	self.log.WriteText("Popup two\n")
	165
	166	def OnPopupThree(self, event):
	167	self.log.WriteText("Popup three\n")
cf694132	168
8bf5d46e RD	169	def OnPopupFour(self, event):
	170	self.list.DeleteAllItems()
	171
e166644c RD	172	def OnPopupFive(self, event):
	173	item = self.list.GetItem(self.currentItem)
	174	print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)
	175
cf694132 RD	176	def OnSize(self, event):
	177	w,h = self.GetClientSizeTuple()
	178	self.list.SetDimensions(0, 0, w, h)
	179
	180
	181
	182
a08cbc01 RD	183
a08cbc01 RD	184
cf694132 RD	185	#---------------------------------------------------------------------------
	186
	187	def runTest(frame, nb, log):
	188	win = TestListCtrlPanel(nb, log)
	189	return win
	190
	191	#---------------------------------------------------------------------------
	192
	193
	194
	195
	196
	197
	198
	199
	200
	201
	202
	203
	204
	205
	206
	207
	208	overview = """\
	209	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.
	210
	211	wxListCtrl()
	212	------------------------
	213
	214	Default constructor.
	215
	216	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")
	217
	218	Constructor, creating and showing a list control.
	219
	220	Parameters
	221	-------------------
	222
	223	parent = Parent window. Must not be NULL.
	224
	225	id = Window identifier. A value of -1 indicates a default value.
	226
	227	pos = Window position.
	228
	229	size = Window size. If the default size (-1, -1) is specified then the window is sized appropriately.
	230
	231	style = Window style. See wxListCtrl.
	232
	233	validator = Window validator.
	234
	235	name = Window name.
	236	"""