check_box
=========

.. py:module:: qfluentwidgets.components.widgets.check_box


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



.. autoapisummary::

   qfluentwidgets.components.widgets.check_box.CheckBoxIcon
   qfluentwidgets.components.widgets.check_box.CheckBoxState
   qfluentwidgets.components.widgets.check_box.CheckBox




.. py:class:: CheckBoxIcon

   Bases: :py:obj:`qfluentwidgets.common.icon.FluentIconBase`, :py:obj:`enum.Enum`


   CheckBoxIcon 


   .. py:attribute:: ACCEPT
      :value: 'Accept'



   .. py:attribute:: PARTIAL_ACCEPT
      :value: 'PartialAccept'



   .. py:method:: path(theme=Theme.AUTO)

      get the path of icon

      Parameters
      ----------
      theme: Theme
          the theme of icon
          * `Theme.Light`: black icon
          * `Theme.DARK`: white icon
          * `Theme.AUTO`: icon color depends on `config.theme`



.. py:class:: CheckBoxState

   Bases: :py:obj:`enum.Enum`


   Check box state 


   .. py:attribute:: NORMAL
      :value: 0



   .. py:attribute:: HOVER
      :value: 1



   .. py:attribute:: PRESSED
      :value: 2



   .. py:attribute:: CHECKED
      :value: 3



   .. py:attribute:: CHECKED_HOVER
      :value: 4



   .. py:attribute:: CHECKED_PRESSED
      :value: 5



   .. py:attribute:: DISABLED
      :value: 6



   .. py:attribute:: CHECKED_DISABLED
      :value: 7



.. py:class:: CheckBox(parent: PyQt5.QtWidgets.QWidget = None)

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


   Check box

   Constructors
   ------------
   * CheckBox(`parent`: QWidget = None)
   * CheckBox(`text`: str, `parent`: QWidget = None)


   .. py:attribute:: isPressed
      :value: False



   .. py:attribute:: isHover
      :value: False



   .. py:method:: mousePressEvent(e)


   .. py:method:: mouseReleaseEvent(e)


   .. py:method:: enterEvent(e)


   .. py:method:: leaveEvent(e)


   .. py:method:: paintEvent(e)