setting_card
============

.. py:module:: qfluentwidgets.components.settings.setting_card


Module Contents
---------------



.. autoapisummary::

   qfluentwidgets.components.settings.setting_card.SettingIconWidget
   qfluentwidgets.components.settings.setting_card.SettingCard
   qfluentwidgets.components.settings.setting_card.SwitchSettingCard
   qfluentwidgets.components.settings.setting_card.RangeSettingCard
   qfluentwidgets.components.settings.setting_card.PushSettingCard
   qfluentwidgets.components.settings.setting_card.PrimaryPushSettingCard
   qfluentwidgets.components.settings.setting_card.HyperlinkCard
   qfluentwidgets.components.settings.setting_card.ColorPickerButton
   qfluentwidgets.components.settings.setting_card.ColorSettingCard
   qfluentwidgets.components.settings.setting_card.ComboBoxSettingCard




.. py:class:: SettingIconWidget(parent=None)

   Bases: :py:obj:`qfluentwidgets.components.widgets.icon_widget.IconWidget`


   Icon widget

   Constructors
   ------------
   * IconWidget(`parent`: QWidget = None)
   * IconWidget(`icon`: QIcon | str | FluentIconBase, `parent`: QWidget = None)


   .. py:method:: paintEvent(e)


.. py:class:: SettingCard(icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title, content=None, parent=None)

   Bases: :py:obj:`PyQt5.QtWidgets.QFrame`


   Setting card 


   .. py:attribute:: iconLabel


   .. py:attribute:: titleLabel


   .. py:attribute:: contentLabel


   .. py:attribute:: hBoxLayout


   .. py:attribute:: vBoxLayout


   .. py:method:: setTitle(title: str)

      set the title of card 



   .. py:method:: setContent(content: str)

      set the content of card 



   .. py:method:: setValue(value)

      set the value of config item 



   .. py:method:: setIconSize(width: int, height: int)

      set the icon fixed size 



   .. py:method:: paintEvent(e)


.. py:class:: SwitchSettingCard(icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title, content=None, configItem: qfluentwidgets.common.config.ConfigItem = None, parent=None)

   Bases: :py:obj:`SettingCard`


   Setting card with switch button 


   .. py:attribute:: checkedChanged


   .. py:attribute:: configItem
      :value: None



   .. py:attribute:: switchButton


   .. py:method:: setValue(isChecked: bool)

      set the value of config item 



   .. py:method:: setChecked(isChecked: bool)


   .. py:method:: isChecked()


.. py:class:: RangeSettingCard(configItem, icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title, content=None, parent=None)

   Bases: :py:obj:`SettingCard`


   Setting card with a slider 


   .. py:attribute:: valueChanged


   .. py:attribute:: configItem


   .. py:attribute:: slider


   .. py:attribute:: valueLabel


   .. py:method:: setValue(value)

      set the value of config item 



.. py:class:: PushSettingCard(text, icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title, content=None, parent=None)

   Bases: :py:obj:`SettingCard`


   Setting card with a push button 


   .. py:attribute:: clicked


   .. py:attribute:: button


.. py:class:: PrimaryPushSettingCard(text, icon, title, content=None, parent=None)

   Bases: :py:obj:`PushSettingCard`


   Push setting card with primary color 


.. py:class:: HyperlinkCard(url, text, icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title, content=None, parent=None)

   Bases: :py:obj:`SettingCard`


   Hyperlink card 


   .. py:attribute:: linkButton


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

   Bases: :py:obj:`PyQt5.QtWidgets.QToolButton`


   Color picker button 


   .. py:attribute:: colorChanged


   .. py:attribute:: title


   .. py:attribute:: enableAlpha
      :value: False



   .. py:method:: setColor(color)

      set color 



   .. py:method:: paintEvent(e)


.. py:class:: ColorSettingCard(configItem, icon: Union[str, PyQt5.QtGui.QIcon, qfluentwidgets.common.icon.FluentIconBase], title: str, content: str = None, parent=None, enableAlpha=False)

   Bases: :py:obj:`SettingCard`


   Setting card with color picker 


   .. py:attribute:: colorChanged


   .. py:attribute:: configItem


   .. py:attribute:: colorPicker


   .. py:method:: setValue(color: PyQt5.QtGui.QColor)

      set the value of config item 



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

   Bases: :py:obj:`SettingCard`


   Setting card with a combo box 


   .. py:attribute:: configItem


   .. py:attribute:: comboBox


   .. py:attribute:: optionToText


   .. py:method:: setValue(value)

      set the value of config item