settings¶

Package Contents¶

`SettingCard`	Setting card
`SwitchSettingCard`	Setting card with switch button
`RangeSettingCard`	Setting card with a slider
`PushSettingCard`	Setting card with a push button
`ColorSettingCard`	Setting card with color picker
`HyperlinkCard`	Hyperlink card
`PrimaryPushSettingCard`	Push setting card with primary color
`ColorPickerButton`	Color picker button
`ComboBoxSettingCard`	Setting card with a combo box
`ExpandSettingCard`	Expandable setting card
`ExpandGroupSettingCard`	Expand group setting card
`FolderListSettingCard`	Folder list setting card
`OptionsSettingCard`	setting card with a group of options
`CustomColorSettingCard`	Custom color setting card
`SettingCardGroup`	Setting card group

class SettingCard(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, parent=None)¶

Bases: PyQt5.QtWidgets.QFrame

Setting card

setTitle(title: str)¶: set the title of card

setContent(content: str)¶: set the content of card

setValue(value)¶: set the value of config item

setIconSize(width: int, height: int)¶: set the icon fixed size

paintEvent(e)¶

class SwitchSettingCard(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, configItem: qfluentwidgets.common.config.ConfigItem = None, parent=None)¶

Bases: SettingCard

Setting card with switch button

checkedChanged¶

setValue(isChecked: bool)¶: set the value of config item

setChecked(isChecked: bool)¶

isChecked()¶

class RangeSettingCard(configItem, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, parent=None)¶

Bases: SettingCard

Setting card with a slider

valueChanged¶

setValue(value)¶: set the value of config item

class PushSettingCard(text, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, parent=None)¶

Bases: SettingCard

Setting card with a push button

clicked¶

class ColorSettingCard(configItem, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title: str, content: str = None, parent=None, enableAlpha=False)¶

Bases: SettingCard

Setting card with color picker

colorChanged¶

setValue(color: PyQt5.QtGui.QColor)¶: set the value of config item

class HyperlinkCard(url, text, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, parent=None)¶

Bases: SettingCard

Hyperlink card

class PrimaryPushSettingCard(text, icon, title, content=None, parent=None)¶

Bases: PushSettingCard

Push setting card with primary color

class ColorPickerButton(color: PyQt5.QtGui.QColor, title: str, parent=None, enableAlpha=False)¶

Bases: PyQt5.QtWidgets.QToolButton

Color picker button

colorChanged¶

setColor(color)¶: set color

paintEvent(e)¶

class ComboBoxSettingCard(configItem: qfluentwidgets.common.config.OptionsConfigItem, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, texts=None, parent=None)¶

Bases: SettingCard

Setting card with a combo box

setValue(value)¶: set the value of config item

class ExpandSettingCard(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, title: str, content: str = None, parent=None)¶

Bases: PyQt5.QtWidgets.QScrollArea

Expandable setting card

addWidget(widget: PyQt5.QtWidgets.QWidget)¶: add widget to tail

wheelEvent(e)¶

setExpand(isExpand: bool)¶: set the expand status of card

toggleExpand()¶: toggle expand status

resizeEvent(e)¶

setValue(value)¶: set the value of config item

class ExpandGroupSettingCard(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, title: str, content: str = None, parent=None)¶

Bases: ExpandSettingCard

Expand group setting card

addGroupWidget(widget: PyQt5.QtWidgets.QWidget)¶: add widget to group

class FolderListSettingCard(configItem: qfluentwidgets.common.config.ConfigItem, title: str, content: str = None, directory='./', parent=None)¶

Bases: qfluentwidgets.components.settings.expand_setting_card.ExpandSettingCard

Folder list setting card

folderChanged¶

class OptionsSettingCard(configItem, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title, content=None, texts=None, parent=None)¶

Bases: qfluentwidgets.components.settings.expand_setting_card.ExpandSettingCard

setting card with a group of options

optionChanged¶

setValue(value)¶: select button according to the value

class CustomColorSettingCard(configItem: qfluentwidgets.common.config.ColorConfigItem, icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase, title: str, content=None, parent=None, enableAlpha=False)¶

Bases: qfluentwidgets.components.settings.expand_setting_card.ExpandGroupSettingCard

Custom color setting card

colorChanged¶

class SettingCardGroup(title: str, parent=None)¶

Bases: PyQt5.QtWidgets.QWidget

Setting card group

addSettingCard(card: PyQt5.QtWidgets.QWidget)¶: add setting card to group

addSettingCards(cards: List[PyQt5.QtWidgets.QWidget])¶: add setting cards to group

adjustSize()¶