如何在Kivy Python中创建ListBox？Kivy文件管理器添加ListBox及绑定双击函数

Hey there! Let's walk through how to build a list component (similar to a ListBox) in Kivy, bind double-click actions, and integrate it into your file manager.

First, a quick heads-up: Kivy doesn't have a native ListBox widget. Instead, we use RecycleView—it's efficient for large datasets (perfect for file managers!) and flexible enough to mimic a ListBox's behavior. Let's dive in.

1. 创建RecycleView（模拟ListBox） #

RecycleView works by pairing a data source with a reusable view template. Here's a minimal implementation to get you started:

Python 核心代码 #

from kivy.app import App
from kivy.uix.recycleview import RecycleView
from kivy.uix.recycleview.views import RecycleDataViewBehavior
from kivy.uix.label import Label
from kivy.properties import BooleanProperty
from kivy.uix.boxlayout import BoxLayout
import os

# 自定义可选中的列表项
class SelectableLabel(RecycleDataViewBehavior, Label):
    index = None
    selected = BooleanProperty(False)
    selectable = BooleanProperty(True)

    def refresh_view_attrs(self, rv, index, data):
        self.index = index
        return super().refresh_view_attrs(rv, index, data)

    def on_touch_down(self, touch):
        if super().on_touch_down(touch):
            return True
        if self.collide_point(*touch.pos) and self.selectable:
            return self.parent.select_with_touch(self.index, touch)

# RecycleView 主组件，加载目录文件
class FileListRV(RecycleView):
    def __init__(self, **kwargs):
        super(FileListRV, self).__init__(**kwargs)
        # 加载当前工作目录的文件作为示例数据
        self.refresh_file_list()

    def refresh_file_list(self):
        self.data = [{'text': filename} for filename in os.listdir(os.getcwd())]

# 主应用布局
class FileManagerLayout(BoxLayout):
    pass

class FileManagerApp(App):
    def build(self):
        return FileManagerLayout()

if __name__ == '__main__':
    FileManagerApp().run()

KV 布局代码（命名为filemanager.kv或内嵌加载） #

<SelectableLabel>:
    # 选中时的高亮样式
    canvas.before:
        Color:
            rgba: (0.3, 0.6, 0.9, 1) if self.selected else (0, 0, 0, 0)
        Rectangle:
            pos: self.pos
            size: self.size

<FileListRV>:
    viewclass: 'SelectableLabel'
    RecycleBoxLayout:
        default_size: None, dp(56)
        default_size_hint: 1, None
        size_hint_y: None
        height: self.minimum_height
        orientation: 'vertical'

<FileManagerLayout>:
    orientation: 'vertical'
    FileListRV:
        id: file_list

This sets up a scrollable list that displays files in your current directory, with a highlight effect when items are selected.

2. 绑定双击触发的函数 #

To add double-click functionality, we'll extend the SelectableLabel to handle the on_double_tap event. Here's how to update the code:

更新 SelectableLabel 类 #

Add this method inside the SelectableLabel class to define your double-tap action:

def on_double_tap(self, touch):
    if self.collide_point(*touch.pos):
        # 替换成你需要的操作，比如打开文件、显示文件详情
        full_path = os.path.join(os.getcwd(), self.text)
        print(f"Double clicked on: {full_path}")
        # 取消注释下面的代码可实际打开文件
        # if os.path.isfile(full_path):
        #     if os.name == 'nt':
        #         os.startfile(full_path)
        #     else:
        #         import subprocess
        #         subprocess.run(['open' if os.uname().sysname == 'Darwin' else 'xdg-open', full_path])

Then, modify the on_touch_down method to detect double taps:

def on_touch_down(self, touch):
    if super().on_touch_down(touch):
        return True
    if self.collide_point(*touch.pos) and self.selectable:
        # 检测双击事件
        if touch.is_double_tap:
            self.on_double_tap(touch)
        return self.parent.select_with_touch(self.index, touch)

Alternatively, you can bind the double tap directly in the KV file if you prefer:

<SelectableLabel>:
    on_double_tap: root.on_double_tap(args[1])
    # ... 保留原有的样式代码

3. 完整可运行示例 #

Putting it all together, here's a fully functional mini file manager with double-click support:

from kivy.app import App
from kivy.uix.recycleview import RecycleView
from kivy.uix.recycleview.views import RecycleDataViewBehavior
from kivy.uix.label import Label
from kivy.properties import BooleanProperty
from kivy.uix.boxlayout import BoxLayout
from kivy.lang import Builder
import os

# 内嵌加载KV代码
Builder.load_string('''
<SelectableLabel>:
    canvas.before:
        Color:
            rgba: (0.3, 0.6, 0.9, 1) if self.selected else (0, 0, 0, 0)
        Rectangle:
            pos: self.pos
            size: self.size
    on_double_tap: root.on_double_tap(args[1])

<FileListRV>:
    viewclass: 'SelectableLabel'
    RecycleBoxLayout:
        default_size: None, dp(56)
        default_size_hint: 1, None
        size_hint_y: None
        height: self.minimum_height
        orientation: 'vertical'

<FileManagerLayout>:
    orientation: 'vertical'
    FileListRV:
        id: file_list
''')

class SelectableLabel(RecycleDataViewBehavior, Label):
    index = None
    selected = BooleanProperty(False)
    selectable = BooleanProperty(True)

    def refresh_view_attrs(self, rv, index, data):
        self.index = index
        return super().refresh_view_attrs(rv, index, data)

    def on_double_tap(self, touch):
        if self.collide_point(*touch.pos):
            full_path = os.path.join(os.getcwd(), self.text)
            print(f"Opening file/folder: {full_path}")
            # 实际打开文件的逻辑（按需启用）
            # if os.path.exists(full_path):
            #     if os.name == 'nt':
            #         os.startfile(full_path)
            #     else:
            #         import subprocess
            #         opener = 'open' if os.uname().sysname == 'Darwin' else 'xdg-open'
            #         subprocess.run([opener, full_path])

class FileListRV(RecycleView):
    def __init__(self, **kwargs):
        super(FileListRV, self).__init__(**kwargs)
        self.refresh_file_list()

    def refresh_file_list(self):
        self.data = [{'text': f} for f in os.listdir(os.getcwd())]

class FileManagerLayout(BoxLayout):
    pass

class FileManagerApp(App):
    def build(self):
        return FileManagerLayout()

if __name__ == '__main__':
    FileManagerApp().run()

关键提示 #

• RecycleView 优势: 相比旧的ListView，RecycleView复用视图组件，处理大量文件时性能更优，是Kivy官方推荐的列表组件。
• 双击检测: Kivy的Touch对象自带is_double_tap属性，无需手动计时判断双击。
• 自定义扩展: 你可以把SelectableLabel换成BoxLayout，添加文件图标、大小等信息，让列表项更贴合文件管理器的需求。

内容的提问来源于stack exchange，提问作者USERNAME GOES HERE