combo_box

Module Contents

ComboItem

下拉框项

ComboBoxBase

下拉框基类

ComboBox

下拉框

EditableComboBox

可编辑下拉框

ComboBoxMenu

下拉菜单

class ComboItem(text: str, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase = None, userData=None)

下拉框项

text
userData
property icon
class ComboBoxBase(parent=None, **kwargs)

Bases: PyQt5.QtCore.QObject

下拉框基类

currentIndexChanged
currentTextChanged
activated
textActivated
isHover = False
isPressed = False
items: List[ComboItem] = []
dropMenu = None
eventFilter(obj, e: PyQt5.QtCore.QEvent)
addItem(text: str, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase = None, userData=None)

添加选项

参数

text: str

选项的文本

icon: str | QIcon | FluentIconBase

addItems(texts: Iterable[str])

添加多个选项

参数

text: Iterable[str]

选项的文本

removeItem(index: int)

移除指定索引处的选项。如果当前项被移除,该操作会更新当前选中的选项

currentIndex()
setCurrentIndex(index: int)

设置当前索引

参数

index: int

返回当前索引

setText(text: str)
currentText()
currentData()
setCurrentText(text)

设置当前选项,text 需要在选项中

参数

text: str

当前选项

setItemText(index: int, text: str)

设置选项的文本

参数

index: int

选项的索引

text: str

选项的新文本

itemData(index: int)

返回指定索引处的数据

itemText(index: int)

返回指定索引处的文本

itemIcon(index: int)

返回指定索引处的图标

setItemData(index: int, value)

设置选项的数据

setItemIcon(index: int, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase)

设置选项的数据

findData(data)

返回含有该数据的选项索引,如果找不到匹配的选项就返回 -1

findText(text: str)

返回含有该文本的选项索引,如果找不到匹配的选项就返回 -1

clear()

Clears the combobox, removing all items.

count()

返回选项数量

insertItem(index: int, text: str, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase = None, userData=None)

在指定索引处插入选项

insertItems(index: int, texts: Iterable[str])

在指定索引处插入多个选项

setMaxVisibleItems(num: int)
maxVisibleItems()
class ComboBox(parent=None)

Bases: PyQt5.QtWidgets.QPushButton, ComboBoxBase

下拉框

currentIndexChanged
currentTextChanged
activated
textActivated
arrowAni
setPlaceholderText(text: str)
setCurrentIndex(index: int)

设置当前索引

参数

index: int

返回当前索引

mouseReleaseEvent(e)
paintEvent(e)
class EditableComboBox(parent=None)

Bases: qfluentwidgets.components.widgets.line_edit.LineEdit, ComboBoxBase

可编辑下拉框

currentIndexChanged
currentTextChanged
activated
textActivated
dropButton
setCompleterMenu(menu)

set completer menu

参数

menu: CompleterMenu

completer menu

currentText()
setCurrentIndex(index: int)

设置当前索引

参数

index: int

返回当前索引

clear()

Clears the combobox, removing all items.

setPlaceholderText(text: str)
class ComboBoxMenu(parent=None)

Bases: qfluentwidgets.components.widgets.menu.RoundMenu

下拉菜单

exec(pos, ani=True, aniType=MenuAnimationType.DROP_DOWN)

show menu

参数

pos: QPoint

pop-up position

ani: bool

Whether to show pop-up animation

aniType: MenuAnimationType

menu animation type