X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d14a1e28567de23c586bc80017073d0c39f8d18f..ba9a486d430ea0a385984b9f0ea56a12a8d57a5a:/wxPython/wx/lib/mixins/listctrl.py diff --git a/wxPython/wx/lib/mixins/listctrl.py b/wxPython/wx/lib/mixins/listctrl.py index a2fe1e514b..3e5c73a802 100644 --- a/wxPython/wx/lib/mixins/listctrl.py +++ b/wxPython/wx/lib/mixins/listctrl.py @@ -9,22 +9,40 @@ # Copyright: (c) 2001 by Total Control Software # Licence: wxWindows license #---------------------------------------------------------------------------- +# 12/14/2003 - Jeff Grimmett (grimmtooth@softhome.net) +# +# o 2.5 compatability update. +# o ListCtrlSelectionManagerMix untested. +# +# 12/21/2003 - Jeff Grimmett (grimmtooth@softhome.net) +# +# o wxColumnSorterMixin -> ColumnSorterMixin +# o wxListCtrlAutoWidthMixin -> ListCtrlAutoWidthMixin +# ... +# 13/10/2004 - Pim Van Heuven (pim@think-wize.com) +# o wxTextEditMixin: Support Horizontal scrolling when TAB is pressed on long +# ListCtrls, support for WXK_DOWN, WXK_UP, performance improvements on +# very long ListCtrls, Support for virtual ListCtrls +# +# 15-Oct-2004 - Robin Dunn +# o wxTextEditMixin: Added Shift-TAB support +# -from wxPython.wx import * -import locale +import locale +import wx #---------------------------------------------------------------------------- -class wxColumnSorterMixin: +class ColumnSorterMixin: """ - A mixin class that handles sorting of a wxListCtrl in REPORT mode when + A mixin class that handles sorting of a wx.ListCtrl in REPORT mode when the column header is clicked on. There are a few requirments needed in order for this to work genericly: 1. The combined class must have a GetListCtrl method that - returns the wxListCtrl to be sorted, and the list control - must exist at the time the wxColumnSorterMixin.__init__ + returns the wx.ListCtrl to be sorted, and the list control + must exist at the time the wx.ColumnSorterMixin.__init__ method is called because it uses GetListCtrl. 2. Items in the list control must have a unique data value set @@ -43,8 +61,8 @@ class wxColumnSorterMixin: self.SetColumnCount(numColumns) list = self.GetListCtrl() if not list: - raise ValueError, "No wxListCtrl available" - EVT_LIST_COL_CLICK(list, list.GetId(), self.__OnColClick) + raise ValueError, "No wx.ListCtrl available" + self.Bind(wx.EVT_LIST_COL_CLICK, self.__OnColClick, list) def SetColumnCount(self, newNumColumns): @@ -139,29 +157,29 @@ class wxColumnSorterMixin: #---------------------------------------------------------------------------- #---------------------------------------------------------------------------- -class wxListCtrlAutoWidthMixin: +class ListCtrlAutoWidthMixin: """ A mix-in class that automatically resizes the last column to take up - the remaining width of the wxListCtrl. + the remaining width of the wx.ListCtrl. - This causes the wxListCtrl to automatically take up the full width of + This causes the wx.ListCtrl to automatically take up the full width of the list, without either a horizontal scroll bar (unless absolutely necessary) or empty space to the right of the last column. NOTE: This only works for report-style lists. - WARNING: If you override the EVT_SIZE event in your wxListCtrl, make + WARNING: If you override the EVT_SIZE event in your wx.ListCtrl, make sure you call event.Skip() to ensure that the mixin's _OnResize method is called. This mix-in class was written by Erik Westra -""" + """ def __init__(self): """ Standard initialiser. """ self._lastColMinWidth = None - EVT_SIZE(self, self._onResize) - EVT_LIST_COL_END_DRAG(self, self.GetId(), self._onResize) + self.Bind(wx.EVT_SIZE, self._onResize) + self.Bind(wx.EVT_LIST_COL_END_DRAG, self._onResize, self) def resizeLastColumn(self, minWidth): @@ -171,7 +189,7 @@ class wxListCtrlAutoWidthMixin: a horizontal scrollbar. Otherwise, we expand the right-most column to take up the remaining free space in the list. - This method is called automatically when the wxListCtrl is resized; + This method is called automatically when the wx.ListCtrl is resized; you can also call it yourself whenever you want the last column to be resized appropriately (eg, when adding, removing or resizing columns). @@ -186,11 +204,11 @@ class wxListCtrlAutoWidthMixin: # ===================== def _onResize(self, event): - """ Respond to the wxListCtrl being resized. + """ Respond to the wx.ListCtrl being resized. We automatically resize the last column in the list. """ - wxCallAfter(self._doResize) + wx.CallAfter(self._doResize) event.Skip() @@ -206,6 +224,10 @@ class wxListCtrlAutoWidthMixin: or calculated a minimum width. This ensure that repeated calls to _doResize() don't cause the last column to size itself too large. """ + + if not self: # avoid a PyDeadObject error + return + numCols = self.GetColumnCount() if numCols == 0: return # Nothing to resize. @@ -216,9 +238,9 @@ class wxListCtrlAutoWidthMixin: # NOTE: on GTK, the scrollbar is included in the client size, but on # Windows it is not included listWidth = self.GetClientSize().width - if wxPlatform != '__WXMSW__': + if wx.Platform != '__WXMSW__': if self.GetItemCount() > self.GetCountPerPage(): - scrollWidth = wxSystemSettings_GetMetric(wxSYS_VSCROLL_X) + scrollWidth = wx.SystemSettings_GetMetric(wx.SYS_VSCROLL_X) listWidth = listWidth - scrollWidth totColWidth = 0 # Width of all columns except last one. @@ -242,61 +264,70 @@ class wxListCtrlAutoWidthMixin: #---------------------------------------------------------------------------- -SEL_FOC = wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED +SEL_FOC = wx.LIST_STATE_SELECTED | wx.LIST_STATE_FOCUSED def selectBeforePopup(event): """Ensures the item the mouse is pointing at is selected before a popup. Works with both single-select and multi-select lists.""" ctrl = event.GetEventObject() - if isinstance(ctrl, wxListCtrl): + if isinstance(ctrl, wx.ListCtrl): n, flags = ctrl.HitTest(event.GetPosition()) if n >= 0: - if not ctrl.GetItemState(n, wxLIST_STATE_SELECTED): + if not ctrl.GetItemState(n, wx.LIST_STATE_SELECTED): for i in range(ctrl.GetItemCount()): ctrl.SetItemState(i, 0, SEL_FOC) #for i in getListCtrlSelection(ctrl, SEL_FOC): # ctrl.SetItemState(i, 0, SEL_FOC) ctrl.SetItemState(n, SEL_FOC, SEL_FOC) -def getListCtrlSelection(listctrl, state=wxLIST_STATE_SELECTED): + +def getListCtrlSelection(listctrl, state=wx.LIST_STATE_SELECTED): """ Returns list of item indexes of given state (selected by defaults) """ res = [] idx = -1 while 1: - idx = listctrl.GetNextItem(idx, wxLIST_NEXT_ALL, state) + idx = listctrl.GetNextItem(idx, wx.LIST_NEXT_ALL, state) if idx == -1: break res.append(idx) return res +wxEVT_DOPOPUPMENU = wx.NewEventType() +EVT_DOPOPUPMENU = wx.PyEventBinder(wxEVT_DOPOPUPMENU, 0) + + class ListCtrlSelectionManagerMix: """Mixin that defines a platform independent selection policy As selection single and multi-select list return the item index or a list of item indexes respectively. """ - wxEVT_DOPOPUPMENU = wxNewId() _menu = None def __init__(self): - EVT_RIGHT_DOWN(self, self.OnLCSMRightDown) - self.Connect(-1, -1, self.wxEVT_DOPOPUPMENU, self.OnLCSMDoPopup) + self.Bind(wx.EVT_RIGHT_DOWN, self.OnLCSMRightDown) + self.Bind(EVT_DOPOPUPMENU, self.OnLCSMDoPopup) +# self.Connect(-1, -1, self.wxEVT_DOPOPUPMENU, self.OnLCSMDoPopup) + def getPopupMenu(self): """ Override to implement dynamic menus (create) """ return self._menu + def setPopupMenu(self, menu): """ Must be set for default behaviour """ self._menu = menu + def afterPopupMenu(self, menu): """ Override to implement dynamic menus (destroy) """ pass + def getSelection(self): res = getListCtrlSelection(self) - if self.GetWindowStyleFlag() & wxLC_SINGLE_SEL: + if self.GetWindowStyleFlag() & wx.LC_SINGLE_SEL: if res: return res[0] else: @@ -304,19 +335,226 @@ class ListCtrlSelectionManagerMix: else: return res + def OnLCSMRightDown(self, event): selectBeforePopup(event) event.Skip() menu = self.getPopupMenu() if menu: - evt = wxPyEvent() - evt.SetEventType(self.wxEVT_DOPOPUPMENU) + evt = wx.PyEvent() + evt.SetEventType(wxEVT_DOPOPUPMENU) evt.menu = menu evt.pos = event.GetPosition() - wxPostEvent(self, evt) + wx.PostEvent(self, evt) + def OnLCSMDoPopup(self, event): self.PopupMenu(event.menu, event.pos) self.afterPopupMenu(event.menu) -#---------------------------------------------------------------------- + +#---------------------------------------------------------------------------- +from bisect import bisect + + +class TextEditMixin: + """ + A mixin class that handles enables any text in any column of a + multi-column listctrl to be edited by clicking on the given row + and column. You close the text editor by hitting the ENTER key or + clicking somewhere else on the listctrl. You switch to the next + column by hiting TAB. + + To use the mixin you have to include it in the class definition + and call the __init__ function:: + + class TestListCtrl(wx.ListCtrl, TextEdit): + def __init__(self, parent, ID, pos=wx.DefaultPosition, + size=wx.DefaultSize, style=0): + wx.ListCtrl.__init__(self, parent, ID, pos, size, style) + TextEdit.__init__(self) + + + Authors: Steve Zatz, Pim Van Heuven (pim@think-wize.com) + """ + + def __init__(self): + #editor = wx.TextCtrl(self, -1, pos=(-1,-1), size=(-1,-1), + # style=wx.TE_PROCESS_ENTER|wx.TE_PROCESS_TAB \ + # |wx.TE_RICH2) + + self.make_editor() + self.Bind(wx.EVT_TEXT_ENTER, self.CloseEditor) + self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown) + self.Bind(wx.EVT_LEFT_DCLICK, self.OnLeftDown) + self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnItemSelected) + + + def make_editor(self, col_style=wx.LIST_FORMAT_LEFT): + editor = wx.PreTextCtrl() + + style =wx.TE_PROCESS_ENTER|wx.TE_PROCESS_TAB|wx.TE_RICH2 + style |= {wx.LIST_FORMAT_LEFT: wx.TE_LEFT, wx.LIST_FORMAT_RIGHT: wx.TE_RIGHT, wx.LIST_FORMAT_CENTRE : wx.TE_CENTRE}[col_style] + + editor.Create(self, -1, style=style) + editor.SetBackgroundColour(wx.Colour(red=255,green=255,blue=175)) #Yellow + font = self.GetFont() + editor.SetFont(font) + + self.curRow = 0 + self.curCol = 0 + + editor.Hide() + self.editor = editor + + self.col_style = col_style + self.editor.Bind(wx.EVT_CHAR, self.OnChar) + self.editor.Bind(wx.EVT_KILL_FOCUS, self.CloseEditor) + + + def OnItemSelected(self, evt): + self.curRow = evt.GetIndex() + evt.Skip() + + + def OnChar(self, event): + ''' Catch the TAB, Shift-TAB, cursor DOWN/UP key code + so we can open the editor at the next column (if any).''' + + keycode = event.GetKeyCode() + if keycode == wx.WXK_TAB and event.ShiftDown(): + self.CloseEditor() + if self.curCol-1 >= 0: + self.OpenEditor(self.curCol-1, self.curRow) + + elif keycode == wx.WXK_TAB: + self.CloseEditor() + if self.curCol+1 < self.GetColumnCount(): + self.OpenEditor(self.curCol+1, self.curRow) + + elif keycode == wx.WXK_ESCAPE: + self.CloseEditor() + + elif keycode == wx.WXK_DOWN: + self.CloseEditor() + if self.curRow+1 < self.GetItemCount(): + self._SelectIndex(self.curRow+1) + self.OpenEditor(self.curCol, self.curRow) + + elif keycode == wx.WXK_UP: + self.CloseEditor() + if self.curRow > 0: + self._SelectIndex(self.curRow-1) + self.OpenEditor(self.curCol, self.curRow) + + else: + event.Skip() + + + def OnLeftDown(self, evt=None): + ''' Examine the click and double + click events to see if a row has been click on twice. If so, + determine the current row and columnn and open the editor.''' + + if self.editor.IsShown(): + self.CloseEditor() + + x,y = evt.GetPosition() + row,flags = self.HitTest((x,y)) + + if row != self.curRow: # self.curRow keeps track of the current row + evt.Skip() + return + + # the following should really be done in the mixin's init but + # the wx.ListCtrl demo creates the columns after creating the + # ListCtrl (generally not a good idea) on the other hand, + # doing this here handles adjustable column widths + + self.col_locs = [0] + loc = 0 + for n in range(self.GetColumnCount()): + loc = loc + self.GetColumnWidth(n) + self.col_locs.append(loc) + + + col = bisect(self.col_locs, x+self.GetScrollPos(wx.HORIZONTAL)) - 1 + self.OpenEditor(col, row) + + + def OpenEditor(self, col, row): + ''' Opens an editor at the current position. ''' + + if self.GetColumn(col).m_format != self.col_style: + self.make_editor(self.GetColumn(col).m_format) + + x0 = self.col_locs[col] + x1 = self.col_locs[col+1] - x0 + + scrolloffset = self.GetScrollPos(wx.HORIZONTAL) + + # scroll foreward + if x0+x1-scrolloffset > self.GetSize()[0]: + if wx.Platform == "__WXMSW__": + # don't start scrolling unless we really need to + offset = x0+x1-self.GetSize()[0]-scrolloffset + # scroll a bit more than what is minimum required + # so we don't have to scroll everytime the user presses TAB + # which is very tireing to the eye + addoffset = self.GetSize()[0]/4 + # but be careful at the end of the list + if addoffset + scrolloffset < self.GetSize()[0]: + offset += addoffset + + self.ScrollList(offset, 0) + scrolloffset = self.GetScrollPos(wx.HORIZONTAL) + else: + # Since we can not programmatically scroll the ListCtrl + # close the editor so the user can scroll and open the editor + # again + self.CloseEditor() + return + + y0 = self.GetItemRect(row)[1] + + editor = self.editor + editor.SetDimensions(x0-scrolloffset,y0, x1,-1) + + editor.SetValue(self.GetItem(row, col).GetText()) + editor.Show() + editor.Raise() + editor.SetSelection(-1,-1) + editor.SetFocus() + + self.curRow = row + self.curCol = col + + + def CloseEditor(self, evt=None): + ''' Close the editor and save the new value to the ListCtrl. ''' + text = self.editor.GetValue() + self.editor.Hide() + if self.IsVirtual(): + # replace by whather you use to populate the virtual ListCtrl + # data source + self.SetVirtualData(self.curRow, self.curCol, text) + else: + self.SetStringItem(self.curRow, self.curCol, text) + self.RefreshItem(self.curRow) + + def _SelectIndex(self, row): + listlen = self.GetItemCount() + if row < 0 and not listlen: + return + if row > (listlen-1): + row = listlen -1 + + self.SetItemState(self.curRow, ~wx.LIST_STATE_SELECTED, + wx.LIST_STATE_SELECTED) + self.EnsureVisible(row) + self.SetItemState(row, wx.LIST_STATE_SELECTED, + wx.LIST_STATE_SELECTED) + + + +#----------------------------------------------------------------------------