button ====== .. py:module:: qfluentwidgets.components.widgets.button Module Contents --------------- .. autoapisummary:: qfluentwidgets.components.widgets.button.PushButton qfluentwidgets.components.widgets.button.PrimaryPushButton qfluentwidgets.components.widgets.button.TransparentPushButton qfluentwidgets.components.widgets.button.ToggleButton qfluentwidgets.components.widgets.button.TransparentTogglePushButton qfluentwidgets.components.widgets.button.HyperlinkButton qfluentwidgets.components.widgets.button.RadioButton qfluentwidgets.components.widgets.button.ToolButton qfluentwidgets.components.widgets.button.TransparentToolButton qfluentwidgets.components.widgets.button.PrimaryToolButton qfluentwidgets.components.widgets.button.ToggleToolButton qfluentwidgets.components.widgets.button.TransparentToggleToolButton qfluentwidgets.components.widgets.button.DropDownButtonBase qfluentwidgets.components.widgets.button.DropDownPushButton qfluentwidgets.components.widgets.button.TransparentDropDownPushButton qfluentwidgets.components.widgets.button.DropDownToolButton qfluentwidgets.components.widgets.button.TransparentDropDownToolButton qfluentwidgets.components.widgets.button.PrimaryDropDownButtonBase qfluentwidgets.components.widgets.button.PrimaryDropDownPushButton qfluentwidgets.components.widgets.button.PrimaryDropDownToolButton qfluentwidgets.components.widgets.button.SplitDropButton qfluentwidgets.components.widgets.button.PrimarySplitDropButton qfluentwidgets.components.widgets.button.SplitWidgetBase qfluentwidgets.components.widgets.button.SplitPushButton qfluentwidgets.components.widgets.button.PrimarySplitPushButton qfluentwidgets.components.widgets.button.SplitToolButton qfluentwidgets.components.widgets.button.PrimarySplitToolButton qfluentwidgets.components.widgets.button.PillButtonBase qfluentwidgets.components.widgets.button.PillPushButton qfluentwidgets.components.widgets.button.PillToolButton .. autoapisummary:: qfluentwidgets.components.widgets.button.TogglePushButton .. py:class:: PushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:attribute:: isPressed :value: False .. py:attribute:: isHover :value: False .. py:method:: setIcon(icon: Union[PyQt5.QtGui.QIcon, str, qfluentwidgets.common.icon.FluentIconBase]) .. py:method:: icon() .. py:method:: setProperty(name: str, value) -> bool .. py:method:: mousePressEvent(e) .. py:method:: mouseReleaseEvent(e) .. py:method:: enterEvent(e) .. py:method:: leaveEvent(e) .. py:method:: paintEvent(e) .. py:class:: PrimaryPushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:class:: TransparentPushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:class:: ToggleButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:data:: TogglePushButton .. py:class:: TransparentTogglePushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:class:: HyperlinkButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`PushButton` Hyperlink button Constructors ------------ * HyperlinkButton(`parent`: QWidget = None) * HyperlinkButton(`url`: str, `text`: str, `parent`: QWidget = None, `icon`: QIcon | str | FluentIconBase = None) .. py:method:: getUrl() .. py:method:: setUrl(url: Union[str, PyQt5.QtCore.QUrl]) .. py:attribute:: url .. py:class:: RadioButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`PyQt5.QtWidgets.QRadioButton` Radio button Constructors ------------ * RadioButton(`parent`: QWidget = None) * RadioButton(`url`: text, `text`: str, `parent`: QWidget = None, `icon`: QIcon | str | FluentIconBase = None) .. py:class:: ToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`PyQt5.QtWidgets.QToolButton` Tool button Constructors ------------ * ToolButton(`parent`: QWidget = None) * ToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:attribute:: isPressed :value: False .. py:attribute:: isHover :value: False .. py:method:: setIcon(icon: Union[PyQt5.QtGui.QIcon, str, qfluentwidgets.common.icon.FluentIconBase]) .. py:method:: icon() .. py:method:: setProperty(name: str, value) -> bool .. py:method:: mousePressEvent(e) .. py:method:: mouseReleaseEvent(e) .. py:method:: enterEvent(e) .. py:method:: leaveEvent(e) .. py:method:: paintEvent(e) .. py:class:: TransparentToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToolButton` Transparent background tool button Constructors ------------ * TransparentToolButton(`parent`: QWidget = None) * TransparentToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: PrimaryToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToolButton` Primary color tool button Constructors ------------ * PrimaryToolButton(`parent`: QWidget = None) * PrimaryToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: ToggleToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToolButton` Toggle tool button Constructors ------------ * ToggleToolButton(`parent`: QWidget = None) * ToggleToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: TransparentToggleToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToggleToolButton` Transparent toggle tool button Constructors ------------ * TransparentToggleToolButton(`parent`: QWidget = None) * TransparentToggleToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: DropDownButtonBase(*args, **kwargs) Drop down button base class .. py:attribute:: arrowAni .. py:method:: setMenu(menu: qfluentwidgets.components.widgets.menu.RoundMenu) .. py:method:: menu() -> qfluentwidgets.components.widgets.menu.RoundMenu .. py:method:: paintEvent(e) .. py:class:: DropDownPushButton(*args, **kwargs) Bases: :py:obj:`DropDownButtonBase`, :py:obj:`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) .. py:method:: mouseReleaseEvent(e) .. py:method:: paintEvent(e) .. py:class:: TransparentDropDownPushButton(*args, **kwargs) Bases: :py:obj:`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) .. py:class:: DropDownToolButton(*args, **kwargs) Bases: :py:obj:`DropDownButtonBase`, :py:obj:`ToolButton` Drop down tool button Constructors ------------ * DropDownToolButton(`parent`: QWidget = None) * DropDownToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:method:: mouseReleaseEvent(e) .. py:method:: paintEvent(e) .. py:class:: TransparentDropDownToolButton(*args, **kwargs) Bases: :py:obj:`DropDownToolButton` Transparent drop down tool button Constructors ------------ * TransparentDropDownToolButton(`parent`: QWidget = None) * TransparentDropDownToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: PrimaryDropDownButtonBase(*args, **kwargs) Bases: :py:obj:`DropDownButtonBase` Primary color drop down button base class .. py:class:: PrimaryDropDownPushButton(*args, **kwargs) Bases: :py:obj:`PrimaryDropDownButtonBase`, :py:obj:`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) .. py:method:: mouseReleaseEvent(e) .. py:method:: paintEvent(e) .. py:class:: PrimaryDropDownToolButton(*args, **kwargs) Bases: :py:obj:`PrimaryDropDownButtonBase`, :py:obj:`PrimaryToolButton` Primary drop down tool button Constructors ------------ * PrimaryDropDownToolButton(`parent`: QWidget = None) * PrimaryDropDownToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:method:: mouseReleaseEvent(e) .. py:method:: paintEvent(e) .. py:class:: SplitDropButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToolButton` Tool button Constructors ------------ * ToolButton(`parent`: QWidget = None) * ToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: PrimarySplitDropButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`PrimaryToolButton` Primary color tool button Constructors ------------ * PrimaryToolButton(`parent`: QWidget = None) * PrimaryToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: SplitWidgetBase(parent=None) Bases: :py:obj:`PyQt5.QtWidgets.QWidget` Split widget base class .. py:attribute:: dropDownClicked .. py:attribute:: flyout :type: PyQt5.QtWidgets.QWidget :value: None .. py:attribute:: dropButton .. py:attribute:: hBoxLayout .. py:method:: setWidget(widget: PyQt5.QtWidgets.QWidget) set the widget on left side .. py:method:: setDropButton(button) set drop dow button .. py:method:: setDropIcon(icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase]) set the icon of drop down button .. py:method:: setDropIconSize(size: PyQt5.QtCore.QSize) set the icon size of drop down button .. py:method:: 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 .. py:method:: showFlyout() show flyout .. py:class:: SplitPushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`SplitWidgetBase` Split push button Constructors ------------ * SplitPushButton(`parent`: QWidget = None) * SplitPushButton(`text`: str, `parent`: QWidget = None, `icon`: QIcon | str | FluentIconBase = None) .. py:attribute:: clicked .. py:attribute:: button .. py:method:: text() .. py:method:: setText(text: str) .. py:method:: icon() .. py:method:: setIcon(icon: Union[PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase, str]) .. py:method:: setIconSize(size: PyQt5.QtCore.QSize) .. py:attribute:: text_ .. py:attribute:: icon_ .. py:class:: PrimarySplitPushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`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) .. py:class:: SplitToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`SplitWidgetBase` Split tool button Constructors ------------ * SplitToolButton(`parent`: QWidget = None) * SplitToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:attribute:: clicked .. py:attribute:: button .. py:method:: icon() .. py:method:: setIcon(icon: Union[PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase, str]) .. py:method:: setIconSize(size: PyQt5.QtCore.QSize) .. py:attribute:: icon_ .. py:class:: PrimarySplitToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`SplitToolButton` Primary split push button Constructors ------------ * PrimarySplitToolButton(`parent`: QWidget = None) * PrimarySplitToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:class:: PillButtonBase(*args, **kwargs) Pill button base class .. py:method:: paintEvent(e) .. py:class:: PillPushButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`TogglePushButton`, :py:obj:`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) .. py:method:: paintEvent(e) .. py:class:: PillToolButton(parent: PyQt5.QtWidgets.QWidget = None) Bases: :py:obj:`ToggleToolButton`, :py:obj:`PillButtonBase` Pill push button Constructors ------------ * PillToolButton(`parent`: QWidget = None) * PillToolButton(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None) .. py:method:: paintEvent(e)