button¶
Module Contents¶
Push button |
|
Primary color push button |
|
Transparent push button |
|
Toggle push button |
|
Transparent toggle push button |
|
Hyperlink button |
|
Radio button |
|
Tool button |
|
Transparent background tool button |
|
Primary color tool button |
|
Toggle tool button |
|
Transparent toggle tool button |
|
Drop down button base class |
|
Drop down push button |
|
Transparent drop down push button |
|
Drop down tool button |
|
Transparent drop down tool button |
|
Primary color drop down button base class |
|
Primary color drop down push button |
|
Primary drop down tool button |
|
Tool button |
|
Primary color tool button |
|
Split widget base class |
|
Split push button |
|
Primary split push button |
|
Split tool button |
|
Primary split push button |
|
Pill button base class |
|
Pill push button |
|
Pill push button |
- 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)
- 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)
- url¶
- getUrl()¶
- setUrl(url: str | PyQt5.QtCore.QUrl)¶
- 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)
- 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
- setMenu(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¶
- 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¶
- text_¶
- icon_¶
- text()¶
- setText(text: str)¶
- icon()¶
- setIcon(icon: PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase | str)¶
- setIconSize(size: PyQt5.QtCore.QSize)¶
- 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¶
- icon_¶
- icon()¶
- setIcon(icon: PyQt5.QtGui.QIcon | qfluentwidgets.common.icon.FluentIconBase | str)¶
- setIconSize(size: PyQt5.QtCore.QSize)¶
- 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 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)¶