settings

• custom_color_setting_card
• expand_setting_card
• folder_list_setting_card
• options_setting_card
• setting_card
• setting_card_group

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
SimpleExpandGroupSettingCard	Simple 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

iconLabel

titleLabel

contentLabel

hBoxLayout

vBoxLayout

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

configItem = None

switchButton

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

configItem

slider

valueLabel

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

button

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

configItem

colorPicker

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

linkButton

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

title

enableAlpha = False

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

configItem

comboBox

optionToText

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

isExpand = False

scrollWidget

view

card

scrollLayout

viewLayout

spaceWidget

borderWidget

expandAni

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

widgets: List[PyQt5.QtWidgets.QWidget] = []

addGroupWidget(widget: PyQt5.QtWidgets.QWidget)

add widget to group

addGroup(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIcon, title: str, content: str, widget: PyQt5.QtWidgets.QWidget, stretch=0) → GroupWidget

add group

Parameters

icon: str | QIcon | FluentIconBase

the icon of group

title: str

the title of group

content: str

the description of group

widget: str

the widget of group

stretch: int

the stretch of widget

removeGroupWidget(widget: PyQt5.QtWidgets.QWidget)

remove a group from card

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

Bases: ExpandGroupSettingCard

Simple expand group setting card

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

configItem

addFolderButton

folders: List[str]

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

texts = []

configItem

configName

choiceLabel

buttonGroup

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

enableAlpha = False

configItem

defaultColor

customColor

choiceLabel

radioWidget

radioLayout

defaultRadioButton

customRadioButton

buttonGroup

customColorWidget

customColorLayout

customLabel

chooseColorButton

class SettingCardGroup(title: str, parent=None)

Bases: PyQt5.QtWidgets.QWidget

Setting card group

titleLabel

vBoxLayout

cardLayout

addSettingCard(card: PyQt5.QtWidgets.QWidget)

add setting card to group

addSettingCards(cards: List[PyQt5.QtWidgets.QWidget])

add setting cards to group

adjustSize()