added comments to the makefile; added WX_CONFIG var to be able to use a different...

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

diff --git a/wxPython/demo/wxListCtrl.py b/wxPython/demo/wxListCtrl.py
index 6f10f7d7a9ccbe2f8e6efdffb19b1ad00bd02fb9..32b3a3f461730f7692ba950913e9daacdf087be4 100644 (file)
--- a/wxPython/demo/wxListCtrl.py
+++ b/wxPython/demo/wxListCtrl.py
@@ -1,4 +1,3 @@
-#!/bin/env python

 #----------------------------------------------------------------------------
 # Name:         ListCtrl.py
 # Purpose:      Testing lots of stuff, controls, window types, etc.
 #----------------------------------------------------------------------------
 # Name:         ListCtrl.py
 # Purpose:      Testing lots of stuff, controls, window types, etc.


@@ -12,6 +11,7 @@
 #----------------------------------------------------------------------------
 
 from wxPython.wx import *
 #----------------------------------------------------------------------------
 
 from wxPython.wx import *

+from wxPython.lib.mixins.listctrl import wxColumnSorterMixin, wxListCtrlAutoWidthMixin

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


@@ -55,11 +55,35 @@ musicdata = {
 37: ("Spyro Gyra", "Song for Lorraine", "Jazz"),
 38: ("Yes", "Owner Of A Lonely Heart", "Rock"),
 39: ("Yes", "Rhythm Of Love", "Rock"),
 37: ("Spyro Gyra", "Song for Lorraine", "Jazz"),
 38: ("Yes", "Owner Of A Lonely Heart", "Rock"),
 39: ("Yes", "Rhythm Of Love", "Rock"),

+40: ("Cusco", "Dream Catcher", "New Age"),
+41: ("Cusco", "Geronimos Laughter", "New Age"),
+42: ("Cusco", "Ghost Dance", "New Age"),
+43: ("Blue Man Group", "Drumbone", "New Age"),
+44: ("Blue Man Group", "Endless Column", "New Age"),
+45: ("Blue Man Group", "Klein Mandelbrot", "New Age"),
+46: ("Kenny G", "Silhouette", "Jazz"),
+47: ("Sade", "Smooth Operator", "Jazz"),
+48: ("David Arkenstone", "Papillon (On The Wings Of The Butterfly)", "New Age"),
+49: ("David Arkenstone", "Stepping Stars", "New Age"),
+50: ("David Arkenstone", "Carnation Lily Lily Rose", "New Age"),
+51: ("David Lanz", "Behind The Waterfall", "New Age"),
+52: ("David Lanz", "Cristofori's Dream", "New Age"),
+53: ("David Lanz", "Heartsounds", "New Age"),
+54: ("David Lanz", "Leaves on the Seine", "New Age"),

 }
 
 import images
 
 }
 
 import images
 

-class TestListCtrlPanel(wxPanel):
+
+class TestListCtrl(wxListCtrl, wxListCtrlAutoWidthMixin):
+    def __init__(self, parent, ID, pos=wxDefaultPosition,
+                 size=wxDefaultSize, style=0):
+        wxListCtrl.__init__(self, parent, ID, pos, size, style)
+        wxListCtrlAutoWidthMixin.__init__(self)
+
+
+
+class TestListCtrlPanel(wxPanel, wxColumnSorterMixin):

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


@@ -67,61 +91,114 @@ class TestListCtrlPanel(wxPanel):
         tID = wxNewId()
 
         self.il = wxImageList(16, 16)
         tID = wxNewId()
 
         self.il = wxImageList(16, 16)

-        bmp = images.getSmilesBitmap()
-        idx1 = self.il.AddWithColourMask(bmp, wxWHITE)

 
 

-        self.list = wxListCtrl(self, tID,
-                               style=wxLC_REPORT|wxSUNKEN_BORDER)
+        self.idx1 = self.il.Add(images.getSmilesBitmap())
+        self.sm_up = self.il.Add(images.getSmallUpArrowBitmap())
+        self.sm_dn = self.il.Add(images.getSmallDnArrowBitmap())
+
+        self.list = TestListCtrl(self, tID,
+                                 style=wxLC_REPORT | wxSUNKEN_BORDER
+                                 | wxLC_EDIT_LABELS
+                                 #| wxLC_NO_HEADER
+                                 #| wxLC_VRULES | wxLC_HRULES
+                                 )

         self.list.SetImageList(self.il, wxIMAGE_LIST_SMALL)
 
         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.PopulateList()
+
+        # Now that the list exists we can init the other base class,
+        # see wxPython/lib/mixins/listctrl.py
+        self.itemDataMap = musicdata
+        wxColumnSorterMixin.__init__(self, 3)
+        #self.SortListItems(0, True)
+
+        EVT_SIZE(self, self.OnSize)
+        EVT_LIST_ITEM_SELECTED(self, tID, self.OnItemSelected)
+        EVT_LIST_ITEM_DESELECTED(self, tID, self.OnItemDeselected)
+        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_LIST_COL_RIGHT_CLICK(self, tID, self.OnColRightClick)
+        EVT_LIST_COL_BEGIN_DRAG(self, tID, self.OnColBeginDrag)
+        EVT_LIST_COL_DRAGGING(self, tID, self.OnColDragging)
+        EVT_LIST_COL_END_DRAG(self, tID, self.OnColEndDrag)
+        EVT_LIST_BEGIN_LABEL_EDIT(self, tID, self.OnBeginEdit)
+
+        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 PopulateList(self):
+        if 0:
+            # for normal, simple columns, you can add them like this:
+            self.list.InsertColumn(0, "Artist")
+            self.list.InsertColumn(1, "Title", wxLIST_FORMAT_RIGHT)
+            self.list.InsertColumn(2, "Genre")
+        else:
+            # but since we want images on the column header we have to do it the hard way:
+            info = wxListItem()
+            info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_IMAGE | wxLIST_MASK_FORMAT
+            info.m_image = -1
+            info.m_format = 0
+            info.m_text = "Artist"
+            self.list.InsertColumnInfo(0, info)
+
+            info.m_format = wxLIST_FORMAT_RIGHT
+            info.m_text = "Title"
+            self.list.InsertColumnInfo(1, info)
+
+            info.m_format = 0
+            info.m_text = "Genre"
+            self.list.InsertColumnInfo(2, info)

 
 

-        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]
         items = musicdata.items()
         for x in range(len(items)):
             key, data = items[x]

-            self.list.InsertImageStringItem(x, data[0], idx1)
+            self.list.InsertImageStringItem(x, data[0], self.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.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.SetColumnWidth(2, 100)

 
 

-        self.list.SetItemState(25, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)
+        # show how to select an item
+        self.list.SetItemState(5, 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
+        # show how to change the colour of a couple items

         item = self.list.GetItem(1)
         item.SetTextColour(wxBLUE)
         self.list.SetItem(item)
         item = self.list.GetItem(1)
         item.SetTextColour(wxBLUE)
         self.list.SetItem(item)

+        item = self.list.GetItem(4)
+        item.SetTextColour(wxRED)
+        self.list.SetItem(item)

 
         self.currentItem = 0
 
         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)
+    # Used by the wxColumnSorterMixin, see wxPython/lib/mixins/listctrl.py
+    def GetListCtrl(self):
+        return self.list
+
+    # Used by the wxColumnSorterMixin, see wxPython/lib/mixins/listctrl.py
+    def GetSortImages(self):
+        return (self.sm_dn, self.sm_up)

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

+        item, flags = self.list.HitTest((self.x, self.y))
+        if flags & wxLIST_HITTEST_ONITEM:
+            self.list.Select(item)

         event.Skip()
 
 
         event.Skip()
 
 


@@ -131,32 +208,63 @@ class TestListCtrlPanel(wxPanel):
 
 
     def OnItemSelected(self, event):
 
 
     def OnItemSelected(self, event):

+        ##print event.GetItem().GetTextColour()

         self.currentItem = event.m_itemIndex
         self.currentItem = event.m_itemIndex

-        self.log.WriteText("OnItemSelected: %s, %s, %s\n" %
-                           (self.list.GetItemText(self.currentItem),
+        self.log.WriteText("OnItemSelected: %s, %s, %s, %s\n" %
+                           (self.currentItem,
+                            self.list.GetItemText(self.currentItem),

                             self.getColumnText(self.currentItem, 1),
                             self.getColumnText(self.currentItem, 2)))
                             self.getColumnText(self.currentItem, 1),
                             self.getColumnText(self.currentItem, 2)))

+        if self.currentItem == 10:
+            self.log.WriteText("OnItemSelected: Veto'd selection\n")
+            #event.Veto()  # doesn't work
+            # this does
+            self.list.SetItemState(10, 0, wxLIST_STATE_SELECTED)
+        event.Skip()
+
+
+    def OnItemDeselected(self, evt):
+        item = evt.GetItem()
+        self.log.WriteText("OnItemDeselected: %d" % evt.m_itemIndex)
+
+        # Show how to reselect something we don't want deselected
+        if evt.m_itemIndex == 11:
+            wxCallAfter(self.list.SetItemState, 11, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED)

 
 
     def OnItemActivated(self, event):
         self.currentItem = event.m_itemIndex
 
 
     def OnItemActivated(self, event):
         self.currentItem = event.m_itemIndex

-        self.log.WriteText("OnItemActivated: %s\n" % self.list.GetItemText(self.currentItem))
+        self.log.WriteText("OnItemActivated: %s\nTopItem: %s" %
+                           (self.list.GetItemText(self.currentItem), self.list.GetTopItem()))
+
+    def OnBeginEdit(self, event):
+        self.log.WriteText("OnBeginEdit")
+        event.Allow()

 
     def OnItemDelete(self, event):
         self.log.WriteText("OnItemDelete\n")
 
     def OnColClick(self, event):
 
     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)
+        self.log.WriteText("OnColClick: %d\n" % event.GetColumn())
+
+    def OnColRightClick(self, event):
+        item = self.list.GetColumn(event.GetColumn())
+        self.log.WriteText("OnColRightClick: %d %s\n" %
+                           (event.GetColumn(), (item.GetText(), item.GetAlign(),
+                                                item.GetWidth(), item.GetImage())))
+
+    def OnColBeginDrag(self, event):
+        self.log.WriteText("OnColBeginDrag\n")
+        ## Show how to not allow a column to be resized
+        #if event.GetColumn() == 0:
+        #    event.Veto()

 
 

-    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 OnColDragging(self, event):
+        self.log.WriteText("OnColDragging\n")
+
+    def OnColEndDrag(self, event):
+        self.log.WriteText("OnColEndDrag\n")

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


@@ -164,34 +272,55 @@ class TestListCtrlPanel(wxPanel):
 
     def OnRightClick(self, event):
         self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))
 
     def OnRightClick(self, event):
         self.log.WriteText("OnRightClick %s\n" % self.list.GetItemText(self.currentItem))

+
+        # only do this part the first time so the events are only bound once
+        if not hasattr(self, "popupID1"):
+            self.popupID1 = wxNewId()
+            self.popupID2 = wxNewId()
+            self.popupID3 = wxNewId()
+            self.popupID4 = wxNewId()
+            self.popupID5 = wxNewId()
+            self.popupID6 = wxNewId()
+            EVT_MENU(self, self.popupID1, self.OnPopupOne)
+            EVT_MENU(self, self.popupID2, self.OnPopupTwo)
+            EVT_MENU(self, self.popupID3, self.OnPopupThree)
+            EVT_MENU(self, self.popupID4, self.OnPopupFour)
+            EVT_MENU(self, self.popupID5, self.OnPopupFive)
+            EVT_MENU(self, self.popupID6, self.OnPopupSix)
+
+        # make a menu

         menu = wxMenu()
         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)
+        # add some items
+        menu.Append(self.popupID1, "FindItem tests")
+        menu.Append(self.popupID2, "Iterate Selected")
+        menu.Append(self.popupID3, "ClearAll and repopulate")
+        menu.Append(self.popupID4, "DeleteAllItems")
+        menu.Append(self.popupID5, "GetItem")
+        menu.Append(self.popupID6, "Edit")
+
+        # Popup the menu.  If an item is selected then its handler
+        # will be called before PopupMenu returns.

         self.PopupMenu(menu, wxPoint(self.x, self.y))
         menu.Destroy()
         self.PopupMenu(menu, wxPoint(self.x, self.y))
         menu.Destroy()

-        event.Skip()
+

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

+        print "FindItem:", self.list.FindItem(-1, "Roxette")
+        print "FindItemData:", self.list.FindItemData(-1, 11)

 
     def OnPopupTwo(self, event):
 
     def OnPopupTwo(self, event):

-        self.log.WriteText("Popup two\n")
+        self.log.WriteText("Selected items:\n")
+        index = self.list.GetFirstSelected()
+        while index != -1:
+            self.log.WriteText("      %s: %s\n" % (self.list.GetItemText(index), self.getColumnText(index, 1)))
+            index = self.list.GetNextSelected(index)
+

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

+        self.list.ClearAll()
+        wxCallAfter(self.PopulateList)

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


@@ -200,6 +329,10 @@ class TestListCtrlPanel(wxPanel):
         item = self.list.GetItem(self.currentItem)
         print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)
 
         item = self.list.GetItem(self.currentItem)
         print item.m_text, item.m_itemId, self.list.GetItemData(self.currentItem)
 

+    def OnPopupSix(self, event):
+        self.list.EditLabel(self.currentItem)
+
+

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


@@ -220,44 +353,17 @@ def runTest(frame, nb, log):
 
 
 
 
 
 

-
-
-
-
-
-
-
-
-
-
-
-

 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.
 
 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.
+if __name__ == '__main__':
+    import sys,os
+    import run
+    run.main(['', os.path.basename(sys.argv[0])])

 
 

-name = Window name.
-"""