button

Module Contents

PushButton

Push button

PrimaryPushButton

Primary color push button

TransparentPushButton

Transparent push button

ToggleButton

Toggle push button

TransparentTogglePushButton

Transparent toggle push button

HyperlinkButton

Hyperlink button

RadioButton

Radio button

ToolButton

Tool button

TransparentToolButton

Transparent background tool button

PrimaryToolButton

Primary color tool button

ToggleToolButton

Toggle tool button

TransparentToggleToolButton

Transparent toggle tool button

DropDownButtonBase

Drop down button base class

DropDownPushButton

Drop down push button

TransparentDropDownPushButton

Transparent drop down push button

DropDownToolButton

Drop down tool button

TransparentDropDownToolButton

Transparent drop down tool button

PrimaryDropDownButtonBase

Primary color drop down button base class

PrimaryDropDownPushButton

Primary color drop down push button

PrimaryDropDownToolButton

Primary drop down tool button

SplitDropButton

Tool button

PrimarySplitDropButton

Primary color tool button

SplitWidgetBase

Split widget base class

SplitPushButton

Split push button

PrimarySplitPushButton

Primary split push button

SplitToolButton

Split tool button

PrimarySplitToolButton

Primary split push button

PillButtonBase

Pill button base class

PillPushButton

Pill push button

PillToolButton

Pill push button

TogglePushButton

class PushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PyQt5.QtWidgets.QPushButton

Push button

Constructors

  • PushButton(parent: QWidget = None)

  • PushButton(text: str, parent: QWidget = None, icon: QIcon | str | FluentIconBase = None)

  • PushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

isPressed = False
isHover = False
setIcon(icon: PyQt5.QtGui.QIcon | str | qfluentwidgets.common.icon.FluentIconBase)
icon()
setProperty(name: str, value) → bool
mousePressEvent(e)
mouseReleaseEvent(e)
enterEvent(e)
leaveEvent(e)
paintEvent(e)
class PrimaryPushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PushButton

Primary color push button

Constructors

  • PrimaryPushButton(parent: QWidget = None)

  • PrimaryPushButton(text: str, parent: QWidget = None, icon: QIcon | str | FluentIconBase = None)

  • PrimaryPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

class TransparentPushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PushButton

Transparent push button

Constructors

  • TransparentPushButton(parent: QWidget = None)

  • TransparentPushButton(text: str, parent: QWidget = None, icon: QIcon | str | FluentIconBase = None)

  • TransparentPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

class ToggleButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PushButton

Toggle push button

Constructors

  • ToggleButton(parent: QWidget = None)

  • ToggleButton(text: str, parent: QWidget = None, icon: QIcon | str | FluentIconBase = None)

  • ToggleButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

TogglePushButton
class TransparentTogglePushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: TogglePushButton

Transparent toggle push button

Constructors

  • TransparentTogglePushButton(parent: QWidget = None)

  • TransparentTogglePushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • TransparentTogglePushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

class HyperlinkButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PushButton

Hyperlink button

Constructors

  • HyperlinkButton(parent: QWidget = None)

  • HyperlinkButton(url: str, text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

getUrl()
setUrl(url: str | PyQt5.QtCore.QUrl)
url
class RadioButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PyQt5.QtWidgets.QRadioButton

Radio button

Constructors

  • RadioButton(parent: QWidget = None)

  • RadioButton(url: text, text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

class ToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PyQt5.QtWidgets.QToolButton

Tool button

Constructors

  • ToolButton(parent: QWidget = None)

  • ToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

isPressed = False
isHover = False
setIcon(icon: PyQt5.QtGui.QIcon | str | qfluentwidgets.common.icon.FluentIconBase)
icon()
setProperty(name: str, value) → bool
mousePressEvent(e)
mouseReleaseEvent(e)
enterEvent(e)
leaveEvent(e)
paintEvent(e)
class TransparentToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToolButton

Transparent background tool button

Constructors

  • TransparentToolButton(parent: QWidget = None)

  • TransparentToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class PrimaryToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToolButton

Primary color tool button

Constructors

  • PrimaryToolButton(parent: QWidget = None)

  • PrimaryToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class ToggleToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToolButton

Toggle tool button

Constructors

  • ToggleToolButton(parent: QWidget = None)

  • ToggleToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class TransparentToggleToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToggleToolButton

Transparent toggle tool button

Constructors

  • TransparentToggleToolButton(parent: QWidget = None)

  • TransparentToggleToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class DropDownButtonBase(*args, **kwargs)

Drop down button base class

arrowAni
setMenu(menu: qfluentwidgets.components.widgets.menu.RoundMenu)
menu() → qfluentwidgets.components.widgets.menu.RoundMenu
paintEvent(e)
class DropDownPushButton(*args, **kwargs)

Bases: DropDownButtonBase, PushButton

Drop down push button

Constructors

  • DropDownPushButton(parent: QWidget = None)

  • DropDownPushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • DropDownPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

mouseReleaseEvent(e)
paintEvent(e)
class TransparentDropDownPushButton(*args, **kwargs)

Bases: DropDownPushButton

Transparent drop down push button

Constructors

  • TransparentDropDownPushButton(parent: QWidget = None)

  • TransparentDropDownPushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • TransparentDropDownPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

class DropDownToolButton(*args, **kwargs)

Bases: DropDownButtonBase, ToolButton

Drop down tool button

Constructors

  • DropDownToolButton(parent: QWidget = None)

  • DropDownToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

mouseReleaseEvent(e)
paintEvent(e)
class TransparentDropDownToolButton(*args, **kwargs)

Bases: DropDownToolButton

Transparent drop down tool button

Constructors

  • TransparentDropDownToolButton(parent: QWidget = None)

  • TransparentDropDownToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class PrimaryDropDownButtonBase(*args, **kwargs)

Bases: DropDownButtonBase

Primary color drop down button base class

class PrimaryDropDownPushButton(*args, **kwargs)

Bases: PrimaryDropDownButtonBase, PrimaryPushButton

Primary color drop down push button

Constructors

  • PrimaryDropDownPushButton(parent: QWidget = None)

  • PrimaryDropDownPushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • PrimaryDropDownPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

mouseReleaseEvent(e)
paintEvent(e)
class PrimaryDropDownToolButton(*args, **kwargs)

Bases: PrimaryDropDownButtonBase, PrimaryToolButton

Primary drop down tool button

Constructors

  • PrimaryDropDownToolButton(parent: QWidget = None)

  • PrimaryDropDownToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

mouseReleaseEvent(e)
paintEvent(e)
class SplitDropButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToolButton

Tool button

Constructors

  • ToolButton(parent: QWidget = None)

  • ToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class PrimarySplitDropButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: PrimaryToolButton

Primary color tool button

Constructors

  • PrimaryToolButton(parent: QWidget = None)

  • PrimaryToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class SplitWidgetBase(parent=None)

Bases: PyQt5.QtWidgets.QWidget

Split widget base class

dropDownClicked
flyout: PyQt5.QtWidgets.QWidget = None
dropButton
hBoxLayout
setWidget(widget: PyQt5.QtWidgets.QWidget)

set the widget on left side

setDropButton(button)

set drop dow button

setDropIcon(icon: str | PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase)

set the icon of drop down button

setDropIconSize(size: PyQt5.QtCore.QSize)

set the icon size of drop down button

setFlyout(flyout)

set the widget pops up when drop down button is clicked

Parameters

flyout: QWidget

the widget pops up when drop down button is clicked. It should contain exec(pos: QPoint) method

showFlyout()

show flyout

class SplitPushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: SplitWidgetBase

Split push button

Constructors

  • SplitPushButton(parent: QWidget = None)

  • SplitPushButton(text: str, parent: QWidget = None, icon: QIcon | str | FluentIconBase = None)

clicked
button
text()
setText(text: str)
icon()
setIcon(icon: PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase | str)
setIconSize(size: PyQt5.QtCore.QSize)
text_
icon_
class PrimarySplitPushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: SplitPushButton

Primary split push button

Constructors

  • PrimarySplitPushButton(parent: QWidget = None)

  • PrimarySplitPushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • PrimarySplitPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

class SplitToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: SplitWidgetBase

Split tool button

Constructors

  • SplitToolButton(parent: QWidget = None)

  • SplitToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

clicked
button
icon()
setIcon(icon: PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase | str)
setIconSize(size: PyQt5.QtCore.QSize)
icon_
class PrimarySplitToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: SplitToolButton

Primary split push button

Constructors

  • PrimarySplitToolButton(parent: QWidget = None)

  • PrimarySplitToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

class PillButtonBase(*args, **kwargs)

Pill button base class

paintEvent(e)
class PillPushButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: TogglePushButton, PillButtonBase

Pill push button

Constructors

  • PillPushButton(parent: QWidget = None)

  • PillPushButton(text: str, parent: QWidget = None,

    icon: QIcon | str | FluentIconBase = None)

  • PillPushButton(icon: QIcon | FluentIcon, text: str, parent: QWidget = None)

paintEvent(e)
class PillToolButton(parent: PyQt5.QtWidgets.QWidget = None)

Bases: ToggleToolButton, PillButtonBase

Pill push button

Constructors

  • PillToolButton(parent: QWidget = None)

  • PillToolButton(icon: QIcon | str | FluentIconBase, parent: QWidget = None)

paintEvent(e)