QLabel

The QLabel widget provides a text or image display. More

Inheritance diagram of PySide6.QtWidgets.QLabel

Synopsis

Functions

Detailed Description

../../_images/windows-label.png

QLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of the label can be configured in various ways, and it can be used for specifying a focus mnemonic key for another widget.

A QLabel can contain any of the following content types:

Content

Setting

Plain text

Pass a QString to setText() .

Rich text

Pass a QString that contains rich text to setText() .

A pixmap

Pass a QPixmap to setPixmap() .

A movie

Pass a QMovie to setMovie() .

A number

Pass an int or a double to setNum() , which converts the number to plain text.

Nothing

The same as an empty plain text. This is the default. Set by clear() .

Warning

When passing a QString to the constructor or calling setText() , make sure to sanitize your input, as QLabel tries to guess whether it displays the text as plain text or as rich text, a subset of HTML 4 markup. You may want to call setTextFormat() explicitly, e.g. in case you expect the text to be in plain format but cannot control the text source (for instance when displaying data loaded from the Web).

When the content is changed using any of these functions, any previous content is cleared.

By default, labels display left-aligned, vertically-centered text and images, where any tabs in the text to be displayed are automatically expanded . However, the look of a QLabel can be adjusted and fine-tuned in several ways.

The positioning of the content within the QLabel widget area can be tuned with setAlignment() and setIndent() . Text content can also wrap lines along word boundaries with setWordWrap() . For example, this code sets up a sunken panel with a two-line text in the bottom right corner (both lines being flush with the right side of the label):

label = QLabel(self)
label.setFrameStyle(QFrame.Panel | QFrame.Sunken)
label.setText("first line\nsecond line")
label.setAlignment(Qt.AlignBottom | Qt.AlignRight)

The properties and functions QLabel inherits from QFrame can also be used to specify the widget frame to be used for any given label.

A QLabel is often used as a label for an interactive widget. For this use QLabel provides a useful mechanism for adding an mnemonic (see QKeySequence ) that will set the keyboard focus to the other widget (called the QLabel ‘s “buddy”). For example:

phoneEdit = QLineEdit(self)
phoneLabel = QLabel("Phone:", self)
phoneLabel.setBuddy(phoneEdit)

In this example, keyboard focus is transferred to the label’s buddy (the QLineEdit ) when the user presses Alt+P. If the buddy was a button (inheriting from QAbstractButton ), triggering the mnemonic would emulate a button click.

class PySide6.QtWidgets.QLabel([parent=None[, f=Qt.WindowFlags()]])

PySide6.QtWidgets.QLabel(text[, parent=None[, f=Qt.WindowFlags()]])

Parameters

Constructs an empty label.

The parent and widget flag f, arguments are passed to the QFrame constructor.

Constructs a label that displays the text, text.

The parent and widget flag f, arguments are passed to the QFrame constructor.

PySide6.QtWidgets.QLabel.alignment()
Return type

Alignment

See also

setAlignment()

PySide6.QtWidgets.QLabel.buddy()
Return type

PySide6.QtWidgets.QWidget

Returns this label’s buddy, or nullptr if no buddy is currently set.

See also

setBuddy()

PySide6.QtWidgets.QLabel.clear()

Clears any label contents.

PySide6.QtWidgets.QLabel.hasScaledContents()
Return type

bool

PySide6.QtWidgets.QLabel.hasSelectedText()
Return type

bool

PySide6.QtWidgets.QLabel.indent()
Return type

int

See also

setIndent()

PySide6.QtWidgets.QLabel.linkActivated(link)
Parameters

link – str

PySide6.QtWidgets.QLabel.linkHovered(link)
Parameters

link – str

PySide6.QtWidgets.QLabel.margin()
Return type

int

See also

setMargin()

PySide6.QtWidgets.QLabel.movie()
Return type

PySide6.QtGui.QMovie

Returns a pointer to the label’s movie, or nullptr if no movie has been set.

See also

setMovie()

Return type

bool

PySide6.QtWidgets.QLabel.picture()
Return type

PySide6.QtGui.QPicture

Returns the label’s picture.

PySide6.QtWidgets.QLabel.pixmap()
Return type

PySide6.QtGui.QPixmap

PySide6.QtWidgets.QLabel.selectedText()
Return type

str

PySide6.QtWidgets.QLabel.selectionStart()
Return type

int

returns the index of the first selected character in the label or -1 if no text is selected.

Note

The textInteractionFlags set on the label need to include either TextSelectableByMouse or TextSelectableByKeyboard.

See also

selectedText()

PySide6.QtWidgets.QLabel.setAlignment(arg__1)
Parameters

arg__1Alignment

See also

alignment()

PySide6.QtWidgets.QLabel.setBuddy(arg__1)
Parameters

arg__1PySide6.QtWidgets.QWidget

Sets this label’s buddy to buddy.

When the user presses the shortcut key indicated by this label, the keyboard focus is transferred to the label’s buddy widget.

The buddy mechanism is only available for QLabels that contain text in which one character is prefixed with an ampersand, ‘&’. This character is set as the shortcut key. See the mnemonic() documentation for details (to display an actual ampersand, use ‘&&’).

In a dialog, you might create two data entry widgets and a label for each, and set up the geometry layout so each label is just to the left of its data entry widget (its “buddy”), for example:

nameEdit = QLineEdit(self)
QLabel nameLabel = QLabel("Name:", self)
nameLabel.setBuddy(nameEdit)
phoneEdit = QLineEdit(self)
QLabel phoneLabel = QLabel("Phone:", self)
phoneLabel.setBuddy(phoneEdit)
# (layout setup not shown)

With the code above, the focus jumps to the Name field when the user presses Alt+N, and to the Phone field when the user presses Alt+P.

To unset a previously set buddy, call this function with buddy set to nullptr.

See also

buddy() setText() QShortcut setAlignment()

PySide6.QtWidgets.QLabel.setIndent(arg__1)
Parameters

arg__1 – int

See also

indent()

PySide6.QtWidgets.QLabel.setMargin(arg__1)
Parameters

arg__1 – int

See also

margin()

PySide6.QtWidgets.QLabel.setMovie(movie)
Parameters

moviePySide6.QtGui.QMovie

Sets the label contents to movie. Any previous content is cleared. The label does NOT take ownership of the movie.

The buddy shortcut, if any, is disabled.

See also

movie() setBuddy()

PySide6.QtWidgets.QLabel.setNum(arg__1)
Parameters

arg__1double

This is an overloaded function.

Sets the label contents to plain text containing the textual representation of double num. Any previous content is cleared. Does nothing if the double’s string representation is the same as the current contents of the label.

The buddy shortcut, if any, is disabled.

See also

setText() setNum() setBuddy()

PySide6.QtWidgets.QLabel.setNum(arg__1)
Parameters

arg__1 – int

Sets the label contents to plain text containing the textual representation of integer num. Any previous content is cleared. Does nothing if the integer’s string representation is the same as the current contents of the label.

The buddy shortcut, if any, is disabled.

See also

setText() setNum() setBuddy()

Parameters

open – bool

PySide6.QtWidgets.QLabel.setPicture(arg__1)
Parameters

arg__1PySide6.QtGui.QPicture

Sets the label contents to picture. Any previous content is cleared.

The buddy shortcut, if any, is disabled.

PySide6.QtWidgets.QLabel.setPixmap(arg__1)
Parameters

arg__1PySide6.QtGui.QPixmap

See also

pixmap()

PySide6.QtWidgets.QLabel.setScaledContents(arg__1)
Parameters

arg__1 – bool

PySide6.QtWidgets.QLabel.setSelection(arg__1, arg__2)
Parameters
  • arg__1 – int

  • arg__2 – int

Selects text from position start and for length characters.

Note

The textInteractionFlags set on the label need to include either TextSelectableByMouse or TextSelectableByKeyboard.

See also

selectedText()

PySide6.QtWidgets.QLabel.setText(arg__1)
Parameters

arg__1 – str

See also

text()

PySide6.QtWidgets.QLabel.setTextFormat(arg__1)
Parameters

arg__1TextFormat

See also

textFormat()

PySide6.QtWidgets.QLabel.setTextInteractionFlags(flags)
Parameters

flagsTextInteractionFlags

PySide6.QtWidgets.QLabel.setWordWrap(on)
Parameters

on – bool

See also

wordWrap()

PySide6.QtWidgets.QLabel.text()
Return type

str

See also

setText()

PySide6.QtWidgets.QLabel.textFormat()
Return type

TextFormat

See also

setTextFormat()

PySide6.QtWidgets.QLabel.textInteractionFlags()
Return type

TextInteractionFlags

PySide6.QtWidgets.QLabel.wordWrap()
Return type

bool

See also

setWordWrap()