QtBase
v6.3.1
|
The QLabel widget provides a text or image display. More...
#include <qlabel.h>
Public Slots | |
void | setText (const QString &) |
void | setPixmap (const QPixmap &) |
void | setPicture (const QPicture &) |
void | setNum (int) |
void | setNum (double) |
void | clear () |
Public Slots inherited from QWidget | |
void | setEnabled (bool) |
void | setDisabled (bool) |
void | setWindowModified (bool) |
void | setWindowTitle (const QString &) |
void | setStyleSheet (const QString &styleSheet) |
void | setFocus () |
void | update () |
void | repaint () |
virtual void | setVisible (bool visible) |
void | setHidden (bool hidden) |
void | show () |
void | hide () |
void | showMinimized () |
void | showMaximized () |
void | showFullScreen () |
void | showNormal () |
bool | close () |
void | raise () |
void | lower () |
Public Slots inherited from QObject | |
void | deleteLater () |
Signals | |
void | linkActivated (const QString &link) |
void | linkHovered (const QString &link) |
Signals inherited from QWidget | |
void | windowTitleChanged (const QString &title) |
void | windowIconChanged (const QIcon &icon) |
void | windowIconTextChanged (const QString &iconText) |
void | customContextMenuRequested (const QPoint &pos) |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
Properties | |
QString | text |
the label's text More... | |
Qt::TextFormat | textFormat |
the label's text format More... | |
QPixmap | pixmap |
the label's pixmap. More... | |
bool | scaledContents |
whether the label will scale its contents to fill all available space. More... | |
Qt::Alignment | alignment |
the alignment of the label's contents More... | |
bool | wordWrap |
the label's word-wrapping policy More... | |
int | margin |
the width of the margin More... | |
int | indent |
the label's text indent in pixels More... | |
bool | openExternalLinks |
Qt::TextInteractionFlags | textInteractionFlags |
bool | hasSelectedText |
whether there is any text selected More... | |
QString | selectedText |
the selected text More... | |
Properties inherited from QFrame | |
Shape | frameShape |
the frame shape value from the frame style More... | |
Shadow | frameShadow |
the frame shadow value from the frame style More... | |
int | lineWidth |
the line width More... | |
int | midLineWidth |
the width of the mid-line More... | |
int | frameWidth |
the width of the frame that is drawn. More... | |
QRect | frameRect |
the frame's rectangle More... | |
Properties inherited from QWidget | |
bool | modal |
whether the widget is a modal widget More... | |
Qt::WindowModality | windowModality |
which windows are blocked by the modal widget More... | |
bool | enabled |
whether the widget is enabled More... | |
QRect | geometry |
the geometry of the widget relative to its parent and excluding the window frame More... | |
QRect | frameGeometry |
geometry of the widget relative to its parent including any window frame More... | |
QRect | normalGeometry |
the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More... | |
int | x |
the x coordinate of the widget relative to its parent including any window frame More... | |
int | y |
the y coordinate of the widget relative to its parent and including any window frame More... | |
QPoint | pos |
the position of the widget within its parent widget More... | |
QSize | frameSize |
the size of the widget including any window frame More... | |
QSize | size |
the size of the widget excluding any window frame More... | |
int | width |
the width of the widget excluding any window frame More... | |
int | height |
the height of the widget excluding any window frame More... | |
QRect | rect |
the internal geometry of the widget excluding any window frame More... | |
QRect | childrenRect |
the bounding rectangle of the widget's children More... | |
QRegion | childrenRegion |
the combined region occupied by the widget's children More... | |
QSizePolicy | sizePolicy |
the default layout behavior of the widget More... | |
QSize | minimumSize |
the widget's minimum size More... | |
QSize | maximumSize |
the widget's maximum size in pixels More... | |
int | minimumWidth |
the widget's minimum width in pixels More... | |
int | minimumHeight |
the widget's minimum height in pixels More... | |
int | maximumWidth |
the widget's maximum width in pixels More... | |
int | maximumHeight |
the widget's maximum height in pixels More... | |
QSize | sizeIncrement |
the size increment of the widget More... | |
QSize | baseSize |
the base size of the widget More... | |
QPalette | palette |
the widget's palette More... | |
QFont | font |
the font currently set for the widget More... | |
QCursor | cursor |
the cursor shape for this widget More... | |
bool | mouseTracking |
whether mouse tracking is enabled for the widget More... | |
bool | tabletTracking |
whether tablet tracking is enabled for the widget More... | |
bool | isActiveWindow |
whether this widget's window is the active window More... | |
Qt::FocusPolicy | focusPolicy |
the way the widget accepts keyboard focus More... | |
bool | focus |
whether this widget (or its focus proxy) has the keyboard input focus More... | |
Qt::ContextMenuPolicy | contextMenuPolicy |
how the widget shows a context menu More... | |
bool | updatesEnabled |
whether updates are enabled More... | |
bool | visible |
whether the widget is visible More... | |
bool | minimized |
whether this widget is minimized (iconified) More... | |
bool | maximized |
whether this widget is maximized More... | |
bool | fullScreen |
whether the widget is shown in full screen mode More... | |
QSize | sizeHint |
the recommended size for the widget More... | |
QSize | minimumSizeHint |
the recommended minimum size for the widget More... | |
bool | acceptDrops |
whether drop events are enabled for this widget More... | |
QString | windowTitle |
the window title (caption) More... | |
QIcon | windowIcon |
the widget's icon More... | |
QString | windowIconText |
the text to be displayed on the icon of a minimized window More... | |
double | windowOpacity |
The level of opacity for the window. More... | |
bool | windowModified |
whether the document shown in the window has unsaved changes More... | |
QString | accessibleName |
the widget's name as seen by assistive technologies More... | |
QString | accessibleDescription |
the widget's description as seen by assistive technologies More... | |
Qt::LayoutDirection | layoutDirection |
the layout direction for this widget. More... | |
bool | autoFillBackground |
whether the widget background is filled automatically More... | |
QString | styleSheet |
the widget's style sheet More... | |
QLocale | locale |
the widget's locale More... | |
QString | windowFilePath |
the file path associated with a widget More... | |
Qt::InputMethodHints | inputMethodHints |
What input method specific hints the widget has. More... | |
Properties inherited from QObject | |
QString | objectName |
the name of this object More... | |
Friends | |
class | QMessageBoxPrivate |
class | QBalloonTip |
The QLabel widget provides a text or image display.
\inmodule QtWidgets
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:
\table \header
When the content is changed using any of these functions, any previous content is cleared.
By default, labels display \l{alignment}{left-aligned, vertically-centered} text and images, where any tabs in the text to be displayed are \l{Qt::TextExpandTabs}{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):
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:
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.
Constructs an empty label.
The parent and widget flag f, arguments are passed to the QFrame constructor.
Definition at line 225 of file qlabel.cpp.
|
explicit |
Constructs a label that displays the text, text.
The parent and widget flag f, arguments are passed to the QFrame constructor.
Definition at line 240 of file qlabel.cpp.
QLabel::~QLabel | ( | ) |
Destroys the label.
Definition at line 252 of file qlabel.cpp.
Qt::Alignment QLabel::alignment | ( | ) | const |
Definition at line 488 of file qlabel.cpp.
QWidget * QLabel::buddy | ( | ) | const |
Returns this label's buddy, or nullptr if no buddy is currently set.
Definition at line 1231 of file qlabel.cpp.
\reimp
Reimplemented from QFrame.
Definition at line 1452 of file qlabel.cpp.
|
slot |
Clears any label contents.
Definition at line 359 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Reimplemented in ContextMenuWidget.
Definition at line 918 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QFrame.
Reimplemented in ContextMenuWidget.
Definition at line 990 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Definition at line 939 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Definition at line 972 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Definition at line 952 of file qlabel.cpp.
bool QLabel::hasScaledContents | ( | ) | const |
Definition at line 1479 of file qlabel.cpp.
bool QLabel::hasSelectedText | ( | ) | const |
Definition at line 801 of file qlabel.cpp.
|
overridevirtual |
\reimp
Reimplemented from QWidget.
Definition at line 684 of file qlabel.cpp.
int QLabel::indent | ( | ) | const |
Definition at line 551 of file qlabel.cpp.
This signal is emitted when the user clicks a link. The URL referred to by the anchor is passed in link.
This signal is emitted when the user hovers over a link. The URL referred to by the anchor is passed in link.
int QLabel::margin | ( | ) | const |
Definition at line 569 of file qlabel.cpp.
|
overridevirtual |
\reimp
Reimplemented from QWidget.
Definition at line 865 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Reimplemented in MouseMonitor.
Definition at line 901 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QWidget.
Reimplemented in DraggableLabel, MouseMonitor, and ClickableLabel.
Definition at line 893 of file qlabel.cpp.
|
overrideprotectedvirtual |
bool QLabel::openExternalLinks | ( | ) | const |
Definition at line 707 of file qlabel.cpp.
|
overrideprotectedvirtual |
\reimp
Reimplemented from QFrame.
Definition at line 1035 of file qlabel.cpp.
QPicture QLabel::picture | ( | ) | const |
Returns the label's picture.
Previously, Qt provided a version of picture()
which returned the picture by-pointer. That version is now removed. This overload allowed to explicitly differentiate between the by-pointer function and the by-value.
Returns the label's picture.
Definition at line 207 of file qlabel.cpp.
QPixmap QLabel::pixmap | ( | ) | const |
Definition at line 384 of file qlabel.cpp.
QTextDocument::ResourceProvider QLabel::resourceProvider | ( | ) | const |
Returns the resource provider for rich text of this label.
Definition at line 1428 of file qlabel.cpp.
QString QLabel::selectedText | ( | ) | const |
Definition at line 825 of file qlabel.cpp.
int QLabel::selectionStart | ( | ) | const |
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.
Definition at line 844 of file qlabel.cpp.
void QLabel::setAlignment | ( | Qt::Alignment | alignment | ) |
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 \l 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:
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.
Definition at line 1201 of file qlabel.cpp.
void QLabel::setIndent | ( | int | indent | ) |
void QLabel::setMargin | ( | int | margin | ) |
|
slot |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
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.
Definition at line 460 of file qlabel.cpp.
|
slot |
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.
Definition at line 440 of file qlabel.cpp.
void QLabel::setOpenExternalLinks | ( | bool | open | ) |
Sets the label contents to picture. Any previous content is cleared.
The buddy shortcut, if any, is disabled.
Definition at line 419 of file qlabel.cpp.
Definition at line 373 of file qlabel.cpp.
void QLabel::setResourceProvider | ( | const QTextDocument::ResourceProvider & | provider | ) |
Sets the provider of resources for rich text of this label.
Definition at line 1441 of file qlabel.cpp.
void QLabel::setScaledContents | ( | bool | enable | ) |
Definition at line 1485 of file qlabel.cpp.
void QLabel::setSelection | ( | int | start, |
int | length | ||
) |
Selects text from position start and for length characters.
{Note:} The textInteractionFlags set on the label need to include either TextSelectableByMouse or TextSelectableByKeyboard.
Definition at line 773 of file qlabel.cpp.
Definition at line 297 of file qlabel.cpp.
void QLabel::setTextFormat | ( | Qt::TextFormat | format | ) |
Definition at line 1410 of file qlabel.cpp.
void QLabel::setTextInteractionFlags | ( | Qt::TextInteractionFlags | flags | ) |
Definition at line 733 of file qlabel.cpp.
void QLabel::setWordWrap | ( | bool | on | ) |
|
overridevirtual |
\reimp
Reimplemented from QFrame.
Definition at line 854 of file qlabel.cpp.
QString QLabel::text | ( | ) | const |
Qt::TextFormat QLabel::textFormat | ( | ) | const |
Definition at line 1404 of file qlabel.cpp.
Qt::TextInteractionFlags QLabel::textInteractionFlags | ( | ) | const |
Definition at line 757 of file qlabel.cpp.
bool QLabel::wordWrap | ( | ) | const |
Definition at line 517 of file qlabel.cpp.
|
friend |
|
friend |
|
readwrite |
|
read |
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.
|
readwrite |
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.
|
readwrite |
|
readwrite |
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.
|
readwrite |
|
readwrite |
|
read |
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.
|
readwrite |
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 \l {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.
|
readwrite |
the label's text format
See the Qt::TextFormat enum for an explanation of the possible options.
The default format is Qt::AutoText.
|
readwrite |
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.
|
readwrite |