PySide6.QtWidgets.QLabel

class QLabel

The QLabel widget provides a text or image display. More…

Inheritance diagram of PySide6.QtWidgets.QLabel

Synopsis

Properties

Methods

Slots

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

../../_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.

See also

QLineEdit QTextEdit QPixmapQMovie

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property alignmentᅟ: Combination of Qt.AlignmentFlag

This property holds the alignment of the label’s contents.

By default, the contents of the label are left-aligned and vertically-centered.

See also

text

Access functions:
property hasSelectedTextᅟ: bool

This property holds whether there is any text selected.

hasSelectedText() returns true if some or all of the text has been selected by the user; otherwise returns false.

By default, this property is false.

Note

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

See also

selectedText()

Access functions:
property indentᅟ: int

This property holds the label’s text indent in pixels.

If a label displays text, the indent applies to the left edge if alignment() is Qt::AlignLeft, to the right edge if alignment() is Qt::AlignRight, to the top edge if alignment() is Qt::AlignTop, and to the bottom edge if alignment() is Qt::AlignBottom.

If indent is negative, or if no indent has been set, the label computes the effective indent as follows: If frameWidth() is 0, the effective indent becomes 0. If frameWidth() is greater than 0, the effective indent becomes half the width of the “x” character of the widget’s current font() .

By default, the indent is -1, meaning that an effective indent is calculating in the manner described above.

See also

alignment margin frameWidth() font()

Access functions:
property marginᅟ: int

This property holds the width of the margin.

The margin is the distance between the innermost pixel of the frame and the outermost pixel of contents.

The default margin is 0.

See also

indent

Access functions:

Specifies whether QLabel should automatically open links using QDesktopServices::openUrl() instead of emitting the linkActivated() signal.

Note

The textInteractionFlags set on the label need to include either LinksAccessibleByMouse or LinksAccessibleByKeyboard.

The default value is false.

Access functions:
property pixmapᅟ: QPixmap

This property holds the label’s pixmap..

Setting the pixmap clears any previous content. The buddy shortcut, if any, is disabled.

Access functions:
property scaledContentsᅟ: bool

This property holds whether the label will scale its contents to fill all available space..

When enabled and the label shows a pixmap, it will scale the pixmap to fill the available space.

This property’s default is false.

Access functions:
property selectedTextᅟ: str

This property holds the selected text.

If there is no selected text this property’s value is an empty string.

By default, this property contains an empty string.

Note

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

See also

hasSelectedText()

Access functions:
property textᅟ: str

This property holds the label’s text.

If no text has been set this will return an empty string. Setting the text clears any previous content.

The text will be interpreted either as plain text or as rich text, depending on the text format setting; see setTextFormat() . The default setting is Qt::AutoText; i.e. QLabel will try to auto-detect the format of the text set. See Supported HTML Subset for the definition of rich text.

If a buddy has been set, the buddy mnemonic key is updated from the new text.

Note that QLabel is well-suited to display small rich text documents, such as small documents that get their document specific settings (font, text color, link color) from the label’s palette and font properties. For large documents, use QTextEdit in read-only mode instead. QTextEdit can also provide a scroll bar when necessary.

Note

This function enables mouse tracking if text contains rich text.

See also

setTextFormat() setBuddy() alignment

Access functions:
property textFormatᅟ: Qt.TextFormat

This property holds the label’s text format.

See the Qt::TextFormat enum for an explanation of the possible options.

The default format is Qt::AutoText.

See also

text()

Access functions:
property textInteractionFlagsᅟ: Combination of Qt.TextInteractionFlag

Specifies how the label should interact with user input if it displays text.

If the flags contain Qt::LinksAccessibleByKeyboard the focus policy is also automatically set to Qt::StrongFocus. If Qt::TextSelectableByKeyboard is set then the focus policy is set to Qt::ClickFocus.

The default value is Qt::LinksAccessibleByMouse.

Access functions:
property wordWrapᅟ: bool

This property holds the label’s word-wrapping policy.

If this property is true then label text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all.

By default, word wrap is disabled.

See also

text

Access functions:
__init__([parent=None[, f=Qt.WindowFlags()]])
Parameters:

Constructs an empty label.

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

__init__(text[, parent=None[, f=Qt.WindowFlags()]])
Parameters:

Constructs a label that displays the text, text.

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

alignment()
Return type:

Combination of AlignmentFlag

See also

setAlignment()

Getter of property alignmentᅟ .

buddy()
Return type:

QWidget

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

See also

setBuddy()

clear()

Clears any label contents.

hasScaledContents()
Return type:

bool

Getter of property scaledContentsᅟ .

hasSelectedText()
Return type:

bool

Getter of property hasSelectedTextᅟ .

indent()
Return type:

int

See also

setIndent()

Getter of property indentᅟ .

linkActivated(link)
Parameters:

link – str

This signal is emitted when the user clicks a link. The URL referred to by the anchor is passed in link.

See also

linkHovered()

linkHovered(link)
Parameters:

link – str

This signal is emitted when the user hovers over a link. The URL referred to by the anchor is passed in link.

See also

linkActivated()

margin()
Return type:

int

See also

setMargin()

Getter of property marginᅟ .

movie()
Return type:

QMovie

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

See also

setMovie()

openExternalLinks()
Return type:

bool

See also

setOpenExternalLinks()

Getter of property openExternalLinksᅟ .

picture()
Return type:

QPicture

Returns the label’s picture.

See also

setPicture()

pixmap()
Return type:

QPixmap

Getter of property pixmapᅟ .

selectedText()
Return type:

str

Getter of property selectedTextᅟ .

selectionStart()
Return type:

int

selectionStart() 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()

setAlignment(arg__1)
Parameters:

arg__1 – Combination of AlignmentFlag

See also

alignment()

Setter of property alignmentᅟ .

setBuddy(arg__1)
Parameters:

arg__1 – QWidget

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 QKeySequence::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.

setIndent(arg__1)
Parameters:

arg__1 – int

See also

indent()

Setter of property indentᅟ .

setMargin(arg__1)
Parameters:

arg__1 – int

See also

margin()

Setter of property marginᅟ .

setMovie(movie)
Parameters:

movie – 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()

setNum(arg__1)
Parameters:

arg__1 – float

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.

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.

Parameters:

open – bool

See also

openExternalLinks()

Setter of property openExternalLinksᅟ .

setPicture(arg__1)
Parameters:

arg__1 – QPicture

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

The buddy shortcut, if any, is disabled.

setPixmap(arg__1)
Parameters:

arg__1 – QPixmap

See also

pixmap()

Setter of property pixmapᅟ .

setScaledContents(arg__1)
Parameters:

arg__1 – bool

See also

hasScaledContents()

Setter of property scaledContentsᅟ .

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()

setText(arg__1)
Parameters:

arg__1 – str

See also

text()

Setter of property textᅟ .

setTextFormat(arg__1)
Parameters:

arg__1 – TextFormat

See also

textFormat()

Setter of property textFormatᅟ .

setTextInteractionFlags(flags)
Parameters:

flags – Combination of TextInteractionFlag

See also

textInteractionFlags()

Setter of property textInteractionFlagsᅟ .

setWordWrap(on)
Parameters:

on – bool

See also

wordWrap()

Setter of property wordWrapᅟ .

text()
Return type:

str

See also

setText()

Getter of property textᅟ .

textFormat()
Return type:

TextFormat

See also

setTextFormat()

Getter of property textFormatᅟ .

textInteractionFlags()
Return type:

Combination of TextInteractionFlag

See also

setTextInteractionFlags()

Getter of property textInteractionFlagsᅟ .

wordWrap()
Return type:

bool

See also

setWordWrap()

Getter of property wordWrapᅟ .