Qt 4.8: QGraphicsTextItem Class Reference

Qt Reference Documentation

# QGraphicsTextItem Class Reference

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

     #include <QGraphicsTextItem>

Inherits: QGraphicsObject.

This class was introduced in Qt 4.2.

- List of all members, including inherited members

## Properties

- openExternalLinks : bool
- textCursor : QTextCursor

- 12 properties inherited from QGraphicsObject
- 1 property inherited from QObject

## Public Functions

| QGraphicsTextItem ( QGraphicsItem * parent = 0 )
| QGraphicsTextItem ( const QString & text, QGraphicsItem * parent = 0 )
| ~QGraphicsTextItem ()
void | adjustSize ()
QColor | defaultTextColor () const
QTextDocument * | document () const
QFont | font () const
bool | openExternalLinks () const
void | setDefaultTextColor ( const QColor & col )
void | setDocument ( QTextDocument * document )
void | setFont ( const QFont & font )
void | setHtml ( const QString & text )
void | setOpenExternalLinks ( bool open )
void | setPlainText ( const QString & text )
void | setTabChangesFocus ( bool b )
void | setTextCursor ( const QTextCursor & cursor )
void | setTextInteractionFlags ( Qt::TextInteractionFlags flags )
void | setTextWidth ( qreal width )
bool | tabChangesFocus () const
QTextCursor | textCursor () const
Qt::TextInteractionFlags | textInteractionFlags () const
qreal | textWidth () const
QString | toHtml () const
QString | toPlainText () const

## Reimplemented Public Functions

virtual QRectF | boundingRect () const
virtual bool | contains ( const QPointF & point ) const
virtual bool | isObscuredBy ( const QGraphicsItem * item ) const
virtual QPainterPath | opaqueArea () const
virtual void | paint ( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget )
virtual QPainterPath | shape () const
virtual int | type () const

- 2 public functions inherited from QGraphicsObject
- 29 public functions inherited from QObject
- 177 public functions inherited from QGraphicsItem

## Signals

void | linkActivated ( const QString & link )
void | linkHovered ( const QString & link )

- 9 signals inherited from QGraphicsObject
- 1 signal inherited from QObject

## Reimplemented Protected Functions

virtual void | contextMenuEvent ( QGraphicsSceneContextMenuEvent * event )
virtual void | dragEnterEvent ( QGraphicsSceneDragDropEvent * event )
virtual void | dragLeaveEvent ( QGraphicsSceneDragDropEvent * event )
virtual void | dragMoveEvent ( QGraphicsSceneDragDropEvent * event )
virtual void | dropEvent ( QGraphicsSceneDragDropEvent * event )
virtual void | focusInEvent ( QFocusEvent * event )
virtual void | focusOutEvent ( QFocusEvent * event )
virtual void | hoverEnterEvent ( QGraphicsSceneHoverEvent * event )
virtual void | hoverLeaveEvent ( QGraphicsSceneHoverEvent * event )
virtual void | hoverMoveEvent ( QGraphicsSceneHoverEvent * event )
virtual void | inputMethodEvent ( QInputMethodEvent * event )
virtual QVariant | inputMethodQuery ( Qt::InputMethodQuery query ) const
virtual void | keyPressEvent ( QKeyEvent * event )
virtual void | keyReleaseEvent ( QKeyEvent * event )
virtual void | mouseDoubleClickEvent ( QGraphicsSceneMouseEvent * event )
virtual void | mouseMoveEvent ( QGraphicsSceneMouseEvent * event )
virtual void | mousePressEvent ( QGraphicsSceneMouseEvent * event )
virtual void | mouseReleaseEvent ( QGraphicsSceneMouseEvent * event )
virtual bool | sceneEvent ( QEvent * event )

- 8 protected functions inherited from QObject
- 24 protected functions inherited from QGraphicsItem

### Additional Inherited Members

- 1 public slot inherited from QObject
- 7 static public members inherited from QObject
- 2 static public members inherited from QGraphicsItem
- 8 protected functions inherited from QObject
- 24 protected functions inherited from QGraphicsItem
- 1 protected slot inherited from QGraphicsObject

## Detailed Description

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

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.

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

See also QGraphicsSimpleTextItem, QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem, QGraphicsPixmapItem, QGraphicsPolygonItem, QGraphicsLineItem, and Graphics View Framework.

## Property Documentation

### openExternalLinks : bool

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

The default value is false.

Access functions:

bool | openExternalLinks () const
void | setOpenExternalLinks ( bool open )

### textCursor : QTextCursor

This property represents the visible text cursor in an editable text item.

By default, if the item's text has not been set, this property contains a null text cursor; otherwise it contains a text cursor placed at the start of the item's document.

Access functions:

QTextCursor | textCursor () const
void | setTextCursor ( const QTextCursor & cursor )

## Member Function Documentation

### QGraphicsTextItem::QGraphicsTextItem ( QGraphicsItem * parent = 0 )

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

See also QGraphicsScene::addItem().

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

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

See also QGraphicsScene::addItem().

### QGraphicsTextItem::~QGraphicsTextItem ()

Destroys the QGraphicsTextItem.

### void QGraphicsTextItem::adjustSize ()

Adjusts the text item to a reasonable size.

### QRectF QGraphicsTextItem::boundingRect () const`[virtual]`

Reimplemented from QGraphicsItem::boundingRect().

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

Reimplemented from QGraphicsItem::contains().

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

Reimplemented from QGraphicsItem::contextMenuEvent().

### QColor QGraphicsTextItem::defaultTextColor () const

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

See also setDefaultTextColor().

### QTextDocument * QGraphicsTextItem::document () const

Returns the item's text document.

See also setDocument().

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

Reimplemented from QGraphicsItem::dragEnterEvent().

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

Reimplemented from QGraphicsItem::dragLeaveEvent().

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

Reimplemented from QGraphicsItem::dragMoveEvent().

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

Reimplemented from QGraphicsItem::dropEvent().

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

Reimplemented from QGraphicsItem::focusInEvent().

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

Reimplemented from QGraphicsItem::focusOutEvent().

### QFont QGraphicsTextItem::font () const

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

See also setFont().

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

Reimplemented from QGraphicsItem::hoverEnterEvent().

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

Reimplemented from QGraphicsItem::hoverLeaveEvent().

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

Reimplemented from QGraphicsItem::hoverMoveEvent().

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

Reimplemented from QGraphicsItem::inputMethodEvent().

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

Reimplemented from QGraphicsItem::inputMethodQuery().

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

Reimplemented from QGraphicsItem::isObscuredBy().

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

Reimplemented from QGraphicsItem::keyPressEvent().

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

Reimplemented from QGraphicsItem::keyReleaseEvent().

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

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

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

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

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

Reimplemented from QGraphicsItem::mouseDoubleClickEvent().

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

Reimplemented from QGraphicsItem::mouseMoveEvent().

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

Reimplemented from QGraphicsItem::mousePressEvent().

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

Reimplemented from QGraphicsItem::mouseReleaseEvent().

### QPainterPath QGraphicsTextItem::opaqueArea () const`[virtual]`

Reimplemented from QGraphicsItem::opaqueArea().

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

Reimplemented from QGraphicsItem::paint().

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

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

### QPainterPath QGraphicsTextItem::shape () const`[virtual]`

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

### int QGraphicsTextItem::type () const`[virtual]`

Reimplemented from QGraphicsItem::type().