list.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import os
 
import wx
from wx import Colour
from wx.lib.mixins.listctrl import ListCtrlAutoWidthMixin
 
IS_WINDOWS = os.sep == '\\'
 
 
class VirtualList(wx.ListCtrl, ListCtrlAutoWidthMixin):
    
    _style = wx.LC_REPORT|wx.LC_SINGLE_SEL|wx.LC_HRULES|wx.LC_VIRTUAL
 
    def __init__(self, parent, headers, model):
        wx.ListCtrl.__init__(self, parent, style=self._style_style)
        ListCtrlAutoWidthMixin.__init__(self)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        self._model_model = model
        self._selection_listeners_selection_listeners = []
        self._create_headers_create_headers(headers)
        self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnListItemSelectedOnListItemSelected)
        if IS_WINDOWS:
            self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDownOnLeftDown)
        self.SetItemCount(model.count)
        self.SetImageList(model.images, wx.IMAGE_LIST_SMALL)
 
    def OnLeftDown(self, event):
        item, flags =  self.HitTest(event.Position)
        if flags | wx.LIST_HITTEST_ONITEM:
            wx.CallAfter(self._inform_listeners_inform_listeners, item)
        event.Skip()
 
    def _create_headers(self, headers):
        for idx, name in enumerate(headers):
            self.InsertColumn(idx, name)
        self.SetColumnWidth(0, 200)
        self.SetColumnWidth(1, 160)
 
    def refresh(self):
        self.SetItemCount(self._model_model.count)
        self.SetImageList(self._model_model.images, wx.IMAGE_LIST_SMALL)
 
    def add_selection_listener(self, listener):
        self._selection_listeners_selection_listeners.append(listener)
 
    def OnListItemSelected(self, event):
        self._inform_listeners_inform_listeners(event.Index)
 
    def _inform_listeners(self, selected_index):
        for listener in self._selection_listeners_selection_listeners:
            listener(selected_index)
 
    def OnGetItemText(self, row, col):
        return self._model_model.item_text(row, col)
 
    def OnGetItemImage(self, item):
        return self._model_model.image(item)
 
    def OnGetItemAttr(self, item):
        return self._model_model.item_attributes(item)
 
 
class ListModel():
 
    @property
    count = property
    
    def count(self):
        return 0
 
    @property
    images = property
    
    def images(self):
        return None
 
    def item_text(self, row, col):
        return ''
 
    def image(self, row):
        return -1
 
    def item_attributes(self, row):
        return None