QGraphicsTextItem Class

Member Function Documentation

QGraphicsTextItem::QGraphicsTextItem(QGraphicsItem *parent = nullptr)

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

See also QGraphicsScene::addItem().

QGraphicsTextItem::QGraphicsTextItem(const QString &text, QGraphicsItem *parent = nullptr)

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

See also QGraphicsScene::addItem().

[virtual] QGraphicsTextItem::~QGraphicsTextItem()

Destroys the QGraphicsTextItem.

void QGraphicsTextItem::adjustSize()

Adjusts the text item to a reasonable size.

[override virtual] QRectF QGraphicsTextItem::boundingRect() const

Reimplemented from QGraphicsItem::boundingRect().

[override virtual] bool QGraphicsTextItem::contains(const QPointF &point) const

Reimplemented from QGraphicsItem::contains().

[override virtual protected] void QGraphicsTextItem::contextMenuEvent(QGraphicsSceneContextMenuEvent *event)

Reimplemented from QGraphicsItem::contextMenuEvent().

QColor QGraphicsTextItem::defaultTextColor() const

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

See also setDefaultTextColor().

QTextDocument *QGraphicsTextItem::document() const

Returns the item's text document.

See also setDocument().

[override virtual protected] void QGraphicsTextItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)

Reimplemented from QGraphicsItem::dragEnterEvent().

[override virtual protected] void QGraphicsTextItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)

Reimplemented from QGraphicsItem::dragLeaveEvent().

[override virtual protected] void QGraphicsTextItem::dragMoveEvent(QGraphicsSceneDragDropEvent *event)

Reimplemented from QGraphicsItem::dragMoveEvent().

[override virtual protected] void QGraphicsTextItem::dropEvent(QGraphicsSceneDragDropEvent *event)

Reimplemented from QGraphicsItem::dropEvent().

[override virtual protected] void QGraphicsTextItem::focusInEvent(QFocusEvent *event)

Reimplemented from QGraphicsItem::focusInEvent().

[override virtual protected] void QGraphicsTextItem::focusOutEvent(QFocusEvent *event)

Reimplemented from QGraphicsItem::focusOutEvent().

QFont QGraphicsTextItem::font() const

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

See also setFont().

[override virtual protected] void QGraphicsTextItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event)

Reimplemented from QGraphicsItem::hoverEnterEvent().

[override virtual protected] void QGraphicsTextItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event)

Reimplemented from QGraphicsItem::hoverLeaveEvent().

[override virtual protected] void QGraphicsTextItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event)

Reimplemented from QGraphicsItem::hoverMoveEvent().

[override virtual protected] void QGraphicsTextItem::inputMethodEvent(QInputMethodEvent *event)

Reimplemented from QGraphicsItem::inputMethodEvent().

[override virtual protected] QVariant QGraphicsTextItem::inputMethodQuery(Qt::InputMethodQuery query) const

Reimplemented from QGraphicsItem::inputMethodQuery().

[override virtual] bool QGraphicsTextItem::isObscuredBy(const QGraphicsItem *item) const

Reimplemented from QGraphicsItem::isObscuredBy().

[override virtual protected] void QGraphicsTextItem::keyPressEvent(QKeyEvent *event)

Reimplemented from QGraphicsItem::keyPressEvent().

[override virtual protected] void QGraphicsTextItem::keyReleaseEvent(QKeyEvent *event)

Reimplemented from QGraphicsItem::keyReleaseEvent().

[signal] void QGraphicsTextItem::linkActivated(const QString &link)

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

[signal] void QGraphicsTextItem::linkHovered(const QString &link)

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

[override virtual protected] void QGraphicsTextItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)

Reimplemented from QGraphicsItem::mouseDoubleClickEvent().

[override virtual protected] void QGraphicsTextItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event)

Reimplemented from QGraphicsItem::mouseMoveEvent().

[override virtual protected] void QGraphicsTextItem::mousePressEvent(QGraphicsSceneMouseEvent *event)

Reimplemented from QGraphicsItem::mousePressEvent().

[override virtual protected] void QGraphicsTextItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)

Reimplemented from QGraphicsItem::mouseReleaseEvent().

[override virtual] QPainterPath QGraphicsTextItem::opaqueArea() const

Reimplemented from QGraphicsItem::opaqueArea().

[override virtual] void QGraphicsTextItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)

Reimplemented from QGraphicsItem::paint().

[override virtual protected] bool QGraphicsTextItem::sceneEvent(QEvent *event)

Reimplemented from QGraphicsItem::sceneEvent().

void QGraphicsTextItem::setDefaultTextColor(const QColor &col)

Sets the color for unformatted text to col.

See also defaultTextColor().

void QGraphicsTextItem::setDocument(QTextDocument *document)

Sets the text document document on the item.

See also document().

void QGraphicsTextItem::setFont(const QFont &font)

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

See also font().

void QGraphicsTextItem::setHtml(const QString &text)

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(), and QGraphicsSimpleTextItem.

void QGraphicsTextItem::setPlainText(const QString &text)

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() and hasFocus().

void QGraphicsTextItem::setTabChangesFocus(bool b)

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.

This function was introduced in Qt 4.5.

See also tabChangesFocus(), ItemIsFocusable, and textInteractionFlags().

void QGraphicsTextItem::setTextInteractionFlags(Qt::TextInteractionFlags flags)

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

void QGraphicsTextItem::setTextWidth(qreal width)

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() and QTextDocument::setTextWidth().

[override virtual] QPainterPath QGraphicsTextItem::shape() const

Reimplemented from QGraphicsItem::shape().

bool QGraphicsTextItem::tabChangesFocus() const

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.

This function was introduced in Qt 4.5.

See also setTabChangesFocus().

Qt::TextInteractionFlags QGraphicsTextItem::textInteractionFlags() const

Returns the current text interaction flags.

See also setTextInteractionFlags().

qreal QGraphicsTextItem::textWidth() const

Returns the text width.

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

See also setTextWidth() and QTextDocument::textWidth().

QString QGraphicsTextItem::toHtml() const

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

See also setHtml().

QString QGraphicsTextItem::toPlainText() const

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

See also setPlainText().

[override virtual] int QGraphicsTextItem::type() const

Reimplemented from QGraphicsItem::type().