label
=====

.. py:module:: qfluentwidgets.components.widgets.label


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



.. autoapisummary::

   qfluentwidgets.components.widgets.label.PixmapLabel
   qfluentwidgets.components.widgets.label.FluentLabelBase
   qfluentwidgets.components.widgets.label.CaptionLabel
   qfluentwidgets.components.widgets.label.BodyLabel
   qfluentwidgets.components.widgets.label.StrongBodyLabel
   qfluentwidgets.components.widgets.label.SubtitleLabel
   qfluentwidgets.components.widgets.label.TitleLabel
   qfluentwidgets.components.widgets.label.LargeTitleLabel
   qfluentwidgets.components.widgets.label.DisplayLabel
   qfluentwidgets.components.widgets.label.ImageLabel
   qfluentwidgets.components.widgets.label.AvatarWidget
   qfluentwidgets.components.widgets.label.HyperlinkLabel




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

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


   Label for high dpi pixmap 


   .. py:method:: setPixmap(pixmap: PyQt5.QtGui.QPixmap)


   .. py:method:: pixmap()


   .. py:method:: paintEvent(e)


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

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


   Fluent label base class

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


   .. py:method:: getFont()
      :abstractmethod:



   .. py:method:: setTextColor(light=QColor(0, 0, 0), dark=QColor(255, 255, 255))

      set the text color of label

      Parameters
      ----------
      light, dark: QColor | Qt.GlobalColor | str
          text color in light/dark mode



   .. py:method:: lightColor()


   .. py:method:: darkColor()


   .. py:method:: pixelFontSize()


   .. py:method:: strikeOut()


   .. py:method:: underline()


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

   Bases: :py:obj:`FluentLabelBase`


   Caption text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Body text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Strong body text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Subtitle text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Sub title text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Large title text label

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


   .. py:method:: getFont()


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

   Bases: :py:obj:`FluentLabelBase`


   Display text label

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


   .. py:method:: getFont()


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

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


   Image label

   Constructors
   ------------
   * ImageLabel(`parent`: QWidget = None)
   * ImageLabel(`image`: str | QImage | QPixmap, `parent`: QWidget = None)


   .. py:attribute:: clicked


   .. py:attribute:: image


   .. py:method:: setBorderRadius(topLeft: int, topRight: int, bottomLeft: int, bottomRight: int)

      set the border radius of image 



   .. py:method:: setImage(image: Union[str, PyQt5.QtGui.QPixmap, PyQt5.QtGui.QImage] = None)

      set the image of label 



   .. py:method:: scaledToWidth(width: int)


   .. py:method:: scaledToHeight(height: int)


   .. py:method:: setScaledSize(size: PyQt5.QtCore.QSize)


   .. py:method:: isNull()


   .. py:method:: mouseReleaseEvent(e)


   .. py:method:: setPixmap(pixmap: PyQt5.QtGui.QPixmap)


   .. py:method:: pixmap() -> PyQt5.QtGui.QPixmap


   .. py:method:: setMovie(movie: PyQt5.QtGui.QMovie)


   .. py:method:: paintEvent(e)


   .. py:method:: topLeftRadius()


   .. py:method:: topRightRadius()


   .. py:method:: bottomLeftRadius()


   .. py:method:: bottomRightRadius()


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

   Bases: :py:obj:`ImageLabel`


   Avatar widget

   Constructors
   ------------
   * AvatarWidget(`parent`: QWidget = None)
   * AvatarWidget(`image`: str | QImage | QPixmap, `parent`: QWidget = None)


   .. py:method:: getRadius()


   .. py:method:: setRadius(radius: int)


   .. py:method:: setImage(image: Union[str, PyQt5.QtGui.QPixmap, PyQt5.QtGui.QImage] = None)

      set the image of label 



   .. py:method:: setBackgroundColor(light: PyQt5.QtGui.QColor, dark: PyQt5.QtGui.QColor)


   .. py:method:: paintEvent(e)


   .. py:attribute:: radius


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

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


   Hyperlink label

   Constructors
   ------------
   * HyperlinkLabel(`parent`: QWidget = None)
   * HyperlinkLabel(`text`: str, `parent`: QWidget = None)
   * HyperlinkLabel(`url`: QUrl, `parent`: QWidget = None)


   .. py:method:: getUrl() -> PyQt5.QtCore.QUrl


   .. py:method:: setUrl(url: Union[PyQt5.QtCore.QUrl, str])


   .. py:method:: isUnderlineVisible()


   .. py:method:: setUnderlineVisible(isVisible: bool)


   .. py:attribute:: url


   .. py:attribute:: underlineVisible