tkflu.listbox · FluListBox 列表
列表组件。
FluListBox 是一个真正的列表控件:条目数据、单选/多选、键盘导航、
滚轮与可拖动的滚动条,全部由控件自己绘制,不依赖任何原生 Tk 列表控件。
.. code-block:: python
import tkflu
root = tkflu.FluWindow()
box = tkflu.FluListBox(root, width=260, height=180,
items=[f"第 {i} 行" for i in range(1, 31)])
box.pack(padx=12, pady=12)
box.dconfigure(command=lambda index, item: print("激活", index, item))
root.mainloop()
数据与选择
====================== ==========================================================
方法 说明
====================== ==========================================================
insert(index, item) 在 index 处插入条目("end" 表示追加)
append(item) 追加到末尾
delete_item(index) 删除一个条目;"all" 清空(remove 是同义别名)
clear() 清空全部条目
get(index) 取条目原始对象
index(item) 取条目下标;找不到返回 None
selection() 当前选中的下标元组(curselection() 是同义别名)
select(index) 选中;deselect 取消、select_all 全选
see(index) 把某一条滚进可视区
====================== ==========================================================
selectmode 支持三种,语义与 Windows 一致:
"single"—— 一次只能选一条(默认);"multiple"—— 点一条切换一条,互不影响;"extended"——Ctrl+点切换、Shift+点选择区间。
回调
command—— 激活时触发(双击、或选中后按Enter), 调用时会尽量带上(index, item);只写lambda: ...的老代码照样能用 (见 :func:tkflu.defs.call_command)。on_select—— 选中集合变化时触发,参数同样是(indices, items)。
.. note::
构造参数 text 是老占位实现的遗留:列表为空时它会作为居中提示文字
显示出来(空列表状态)。想放条目请用 items。
FluListBox
Bases: FluListBoxCanvas, DDrawWidget, FluToolTipBase
可滚动、可选择的列表控件。
:cvar ITEM_HEIGHT: 单行高度(像素) :cvar PADDING_X: 条目文字与左边缘的距离 :cvar ROW_RADIUS: 条目高亮的圆角半径
源代码位于: tkflu\listbox.py
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 | |
__init__(*args, items=None, text='', width=200, height=None, command=None, on_select=None, font=None, mode='light', style='standard', state='normal', selectmode='single', item_height=None, scrollbar=True, **kwargs)
构造列表。
:param args: 透传给 :class:tkinter.Canvas.__init__
:param items: 初始条目(任意对象,显示时取 str())
:param text: 空列表时显示的居中提示文字(老占位实现的遗留参数)
:param width: 控件宽度
:param height: 控件高度;None 时"只给 text 的旧写法"用 32,
其余情况用 160
:param command: 激活回调,尽量以 (index, item) 调用
:param on_select: 选中集合变化回调,尽量以 (indices, items) 调用
:param font: 条目字体
:param mode: "light" / "dark"
:param style: "standard" / "accent"
:param state: "normal" / "disabled"
:param selectmode: "single" / "multiple" / "extended"
:param item_height: 单行高度;None 时用类属性 ITEM_HEIGHT
:param scrollbar: 是否绘制并允许拖动滚动条
:param kwargs: 其余参数透传给 :class:tkinter.Canvas.__init__
:raises ValueError: selectmode 无法识别
源代码位于: tkflu\listbox.py
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 | |
__len__()
条目个数。
源代码位于: tkflu\listbox.py
366 367 368 | |
activate(index=None)
触发 command。
:param index: 要激活的条目;None 时用当前选中的第一条
源代码位于: tkflu\listbox.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 | |
append(item)
追加一个条目(:meth:insert 的便捷写法)。
源代码位于: tkflu\listbox.py
408 409 410 | |
clear()
清空全部条目与选择。
源代码位于: tkflu\listbox.py
448 449 450 451 452 453 454 455 | |
clear_selection(notify=True)
清空选择。
源代码位于: tkflu\listbox.py
514 515 516 517 518 519 520 | |
create_roundrect_highlight(x1, y1, x2, y2, color)
画一行的高亮底(单独抽出来是为了方便子类换图元)。
源代码位于: tkflu\listbox.py
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 | |
delete_item(index)
删除条目。
:param index: 下标;"all" 表示清空整个列表
.. warning::
这个方法不叫 delete。FluListBox 本身是一个
:class:tkinter.Canvas,而 Canvas.delete 是用来删除画布元素的
(_draw 开头就是 self.delete("all"))。一旦把条目删除也叫
delete,重绘时就会递归调用自己,直接 RecursionError。
要清空列表请用 :meth:clear 或 delete_item("all")。
源代码位于: tkflu\listbox.py
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | |
deselect(index, notify=True)
取消选中一条。
源代码位于: tkflu\listbox.py
497 498 499 500 501 502 | |
get(index)
取第 index 条的原始对象。
:raises IndexError: 下标越界
源代码位于: tkflu\listbox.py
374 375 376 377 378 379 | |
index(item)
取某个条目对象的下标;不存在时返回 None。
源代码位于: tkflu\listbox.py
381 382 383 384 385 386 | |
insert(index, item)
插入一个条目。
:param index: 插入位置;"end" 表示追加到末尾
:param item: 任意对象,显示时取 str()
源代码位于: tkflu\listbox.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | |
invoke()
activate 的历史别名。
源代码位于: tkflu\listbox.py
631 632 633 | |
is_selected(index)
某一条是否被选中。
源代码位于: tkflu\listbox.py
480 481 482 | |
items()
返回条目列表的一份拷贝。
源代码位于: tkflu\listbox.py
370 371 372 | |
scroll(rows)
滚动 rows 行(正数向下)。
源代码位于: tkflu\listbox.py
603 604 605 606 607 608 609 | |
see(index)
把第 index 条滚进可视区(不会画出界)。
源代码位于: tkflu\listbox.py
546 547 548 549 550 551 552 553 554 555 556 | |
select(index, notify=True)
选中一条("single" 模式下会先清空其它选择)。
源代码位于: tkflu\listbox.py
484 485 486 487 488 489 490 491 492 493 494 495 | |
select_all(notify=True)
全选("single" 模式下只选中第一条)。
源代码位于: tkflu\listbox.py
504 505 506 507 508 509 510 511 512 | |
selected_items()
当前选中的条目对象列表。
源代码位于: tkflu\listbox.py
476 477 478 | |
selection()
当前选中的下标(升序元组)。
源代码位于: tkflu\listbox.py
469 470 471 | |
set(index, item)
替换第 index 条的内容。
源代码位于: tkflu\listbox.py
412 413 414 415 | |
theme(mode=None, style=None)
切换主题(并可顺带改样式)。
:param mode: "light" / "dark"
:param style: "standard" / "accent";省略表示沿用构造时的样式
.. warning::
分支判断必须用 self.style,不能用这个参数:
一键换肤时 :class:~tkflu.thememanager.FluThemeManager 只会传
mode,参数 style 是 None,拿它去 .lower()
会直接抛 AttributeError。
源代码位于: tkflu\listbox.py
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 | |
yview(*args)
Tk 风格的滚动接口。
yview()→(首个可见行的比例, 末行之后的比例)yview(index)→ 把该条滚进可视区(返回(offset, offset+rows)之类的二元组)yview_moveto(fraction)/yview_scroll(n, what)
源代码位于: tkflu\listbox.py
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 | |
yview_moveto(fraction)
按比例滚动(0.0 顶部,1.0 底部)。
源代码位于: tkflu\listbox.py
586 587 588 589 590 591 592 593 | |
yview_scroll(number, what='units')
按行(units)或按页(pages)滚动。
源代码位于: tkflu\listbox.py
595 596 597 598 599 600 601 | |
FluListBoxCanvas
Bases: DCanvas
列表的画布。
源代码位于: tkflu\listbox.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
create_round_rectangle(x1, y1, x2, y2, r1, r2=None, temppath=None, fill='transparent', outline='black', outline2='black', width=1)
画列表的圆角背景。
:param r1: 圆角半径(x 方向) :param r2: 圆角半径(y 方向) :returns: 画布上的 item id
列表的描边是 0%→100% 的竖直渐变(button 是 0.9→1.0),
所以这里显式把两个 stop 传给
:meth:tkdeft.windows.canvas.DCanvas.draw_roundrect。
快速路径的判定与回退都在 tkdeft 里,组件层不再重复。
源代码位于: tkflu\listbox.py
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
FluListBoxDraw
Bases: DSvgDraw
列表的 SVG 绘制后端。
create_roundrect 里固定了渐变定义的 id(DListBox.Border),
其余图元都直接用 :class:tkdeft.windows.draw.DSvgDraw 的通用实现。
源代码位于: tkflu\listbox.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | |
create_roundrect(x1, y1, x2, y2, radius, radiusy=None, temppath=None, fill='transparent', outline='black', outline2='black', width=1, gradient_stop1=0.0, gradient_stop2=1.0, **extra)
列表背景的 SVG 图元。
:param gradient_stop1: 渐变描边起点(列表用 0%→100%,不同于 button 的 0.9→1.0)
:param gradient_stop2: 渐变描边终点
:param extra: 其余关键字透传给 svgwrite 的 rect()
:returns: 生成好的 SVG 文件路径
渐变的 id 固定为 DListBox.Border;几何由
:func:tkdeft.svg.add_roundrect 内缩半个线宽,四边描边才完整。
源代码位于: tkflu\listbox.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | |