label

Module Contents

PixmapLabel	Label for high dpi pixmap
FluentLabelBase	Fluent label base class
CaptionLabel	Caption text label
BodyLabel	Body text label
StrongBodyLabel	Strong body text label
SubtitleLabel	Subtitle text label
TitleLabel	Sub title text label
LargeTitleLabel	Large title text label
DisplayLabel	Display text label
ImageLabel	Image label
AvatarWidget	Avatar widget
HyperlinkLabel	Hyperlink label

class PixmapLabel(parent=None)

Bases: PyQt5.QtWidgets.QLabel

Label for high dpi pixmap

setPixmap(pixmap: PyQt5.QtGui.QPixmap)

pixmap()

paintEvent(e)

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

Bases: PyQt5.QtWidgets.QLabel

Fluent label base class

Constructors

• FluentLabelBase(parent: QWidget = None)

• FluentLabelBase(text: str, parent: QWidget = None)

abstract getFont()

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

lightColor()

darkColor()

pixelFontSize()

strikeOut()

underline()

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

Bases: FluentLabelBase

Caption text label

Constructors

• CaptionLabel(parent: QWidget = None)

• CaptionLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Body text label

Constructors

• BodyLabel(parent: QWidget = None)

• BodyLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Strong body text label

Constructors

• StrongBodyLabel(parent: QWidget = None)

• StrongBodyLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Subtitle text label

Constructors

• SubtitleLabel(parent: QWidget = None)

• SubtitleLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Sub title text label

Constructors

• TitleLabel(parent: QWidget = None)

• TitleLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Large title text label

Constructors

• LargeTitleLabel(parent: QWidget = None)

• LargeTitleLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: FluentLabelBase

Display text label

Constructors

• DisplayLabel(parent: QWidget = None)

• DisplayLabel(text: str, parent: QWidget = None)

getFont()

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

Bases: PyQt5.QtWidgets.QLabel

Image label

Constructors

• ImageLabel(parent: QWidget = None)

• ImageLabel(image: str | QImage | QPixmap, parent: QWidget = None)

clicked

setBorderRadius(topLeft: int, topRight: int, bottomLeft: int, bottomRight: int)

set the border radius of image

setImage(image: str | PyQt5.QtGui.QPixmap | PyQt5.QtGui.QImage = None)

set the image of label

scaledToWidth(width: int)

scaledToHeight(height: int)

isNull()

mouseReleaseEvent(e)

setPixmap(pixmap: PyQt5.QtGui.QPixmap)

pixmap() → PyQt5.QtGui.QPixmap

setMovie(movie: PyQt5.QtGui.QMovie)

paintEvent(e)

topLeftRadius()

topRightRadius()

bottomLeftRadius()

bottomRightRadius()

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

Bases: ImageLabel

Avatar widget

Constructors

• AvatarWidget(parent: QWidget = None)

• AvatarWidget(image: str | QImage | QPixmap, parent: QWidget = None)

radius

getRadius()

setRadius(radius: int)

paintEvent(e)

class HyperlinkLabel(parent=None)

Bases: PyQt5.QtWidgets.QPushButton

Hyperlink label

Constructors

• HyperlinkLabel(parent: QWidget = None)

• HyperlinkLabel(text: str, parent: QWidget = None)

• HyperlinkLabel(url: QUrl, parent: QWidget = None)

url

underlineVisible

getUrl() → PyQt5.QtCore.QUrl

setUrl(url: PyQt5.QtCore.QUrl | str)

isUnderlineVisible()

setUnderlineVisible(isVisible: bool)