PySide6.QtWidgets.QGraphicsTextItem

class QGraphicsTextItem

The QGraphicsTextItem class provides a text item that you can add to a QGraphicsScene to display formatted text. More…

Synopsis

Methods

• def __init__()

• def adjustSize()

• def defaultTextColor()

• def document()

• def font()

• def openExternalLinks()

• def setDefaultTextColor()

• def setDocument()

• def setFont()

• def setHtml()

• def setOpenExternalLinks()

• def setPlainText()

• def setTabChangesFocus()

• def setTextCursor()

• def setTextInteractionFlags()

• def setTextWidth()

• def tabChangesFocus()

• def textCursor()

• def textInteractionFlags()

• def textWidth()

• def toHtml()

• def toPlainText()

Virtual methods

• def setExtension()

• def supportsExtension()

Signals

• def linkActivated()

• def linkHovered()

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

If you only need to show plain text in an item, consider using QGraphicsSimpleTextItem instead.

To set the item’s text, pass a QString to QGraphicsTextItem ‘s constructor, or call setHtml() / setPlainText() .

QGraphicsTextItem uses the text’s formatted size and the associated font to provide a reasonable implementation of boundingRect() , shape() , and contains() . You can set the font by calling setFont() .

It is possible to make the item editable by setting the Qt::TextEditorInteraction flag using setTextInteractionFlags() .

The item’s preferred text width can be set using setTextWidth() and obtained using textWidth() .

Note

In order to align HTML text in the center, the item’s text width must be set. Otherwise, you can call adjustSize() after setting the item’s text.

Note

QGraphicsTextItem accepts hover events by default. You can change this with setAcceptHoverEvents() .

See also

QGraphicsSimpleTextItem QGraphicsPathItem QGraphicsRectItem QGraphicsEllipseItem QGraphicsPixmapItem QGraphicsPolygonItem QGraphicsLineItem Graphics View Framework

__init__([parent=None])

Parameters:

parent – QGraphicsItem

Constructs a QGraphicsTextItem . parent is passed to QGraphicsItem ‘s constructor.

See also

addItem()

__init__(text[, parent=None])

Parameters:

• text – str

• parent – QGraphicsItem

Constructs a QGraphicsTextItem , using text as the default plain text. parent is passed to QGraphicsItem ‘s constructor.

See also

addItem()

adjustSize()

Adjusts the text item to a reasonable size.

defaultTextColor()

Return type:

QColor

Returns the default text color that is used for unformatted text.

See also

setDefaultTextColor()

document()

Return type:

QTextDocument

Returns the item’s text document.

See also

setDocument()

font()

Return type:

QFont

Returns the item’s font, which is used to render the text.

See also

setFont()

linkActivated(link)

Parameters:

link – str

This signal is emitted when the user clicks on a link on a text item that enables Qt::LinksAccessibleByMouse or Qt::LinksAccessibleByKeyboard. link is the link that was clicked.

See also

setTextInteractionFlags()

linkHovered(link)

Parameters:

link – str

This signal is emitted when the user hovers over a link on a text item that enables Qt::LinksAccessibleByMouse. link is the link that was hovered over.

See also

setTextInteractionFlags()

openExternalLinks()

Return type:

bool

See also

setOpenExternalLinks()

setDefaultTextColor(c)

Parameters:

c – QColor

Sets the color for unformatted text to col.

See also

defaultTextColor()

setDocument(document)

Parameters:

document – QTextDocument

Sets the text document document on the item.

See also

document()

setExtension(extension, variant)

Parameters:

• extension – Extension

• variant – object

setFont(font)

Parameters:

font – QFont

Sets the font used to render the text item to font.

See also

font()

setHtml(html)

Parameters:

html – str

Sets the item’s text to text, assuming that text is HTML formatted. If the item has keyboard input focus, this function will also call ensureVisible() to ensure that the text is visible in all viewports.

See also

toHtml() hasFocus() QGraphicsSimpleTextItem

setOpenExternalLinks(open)

Parameters:

open – bool

See also

openExternalLinks()

setPlainText(text)

Parameters:

text – str

Sets the item’s text to text. If the item has keyboard input focus, this function will also call ensureVisible() to ensure that the text is visible in all viewports.

See also

toHtml() hasFocus()

setTabChangesFocus(b)

Parameters:

b – bool

If b is true, the Tab key will cause the widget to change focus; otherwise, the tab key will insert a tab into the document.

In some occasions text edits should not allow the user to input tabulators or change indentation using the Tab key, as this breaks the focus chain. The default is false.

See also

tabChangesFocus() ItemIsFocusable textInteractionFlags()

setTextCursor(cursor)

Parameters:

cursor – QTextCursor

See also

textCursor()

setTextInteractionFlags(flags)

Parameters:

flags – Combination of TextInteractionFlag

Sets the flags flags to specify how the text item should react to user input.

The default for a QGraphicsTextItem is Qt::NoTextInteraction. This function also affects the ItemIsFocusable QGraphicsItem flag by setting it if flags is different from Qt::NoTextInteraction and clearing it otherwise.

By default, the text is read-only. To transform the item into an editor, set the Qt::TextEditable flag.

See also

textInteractionFlags()

setTextWidth(width)

Parameters:

width – float

Sets the preferred width for the item’s text. If the actual text is wider than the specified width then it will be broken into multiple lines.

If width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Note that QGraphicsTextItem keeps a QTextDocument internally, which is used to calculate the text width.

See also

textWidth() setTextWidth()

supportsExtension(extension)

Parameters:

extension – Extension

Return type:

bool

tabChangesFocus()

Return type:

bool

Returns true if the Tab key will cause the widget to change focus; otherwise, false is returned.

By default, this behavior is disabled, and this function will return false.

See also

setTabChangesFocus()

textCursor()

Return type:

QTextCursor

See also

setTextCursor()

textInteractionFlags()

Return type:

Combination of TextInteractionFlag

Returns the current text interaction flags.

See also

setTextInteractionFlags()

textWidth()

Return type:

float

Returns the text width.

The width is calculated with the QTextDocument that QGraphicsTextItem keeps internally.

See also

setTextWidth() textWidth()

toHtml()

Return type:

str

Returns the item’s text converted to HTML, or an empty QString if no text has been set.

See also

setHtml()

toPlainText()

Return type:

str

Returns the item’s text converted to plain text, or an empty QString if no text has been set.

See also

setPlainText()