Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
The QPlainTextEdit class provides a widget that is used to edit and display plain text. More...
#include <qplaintextedit.h>
Public Types | |
enum | LineWrapMode { NoWrap , WidgetWidth } |
\value NoWrap \value WidgetWidth More... | |
Public Slots | |
void | setPlainText (const QString &text) |
Changes the text of the text edit to the string text. | |
void | cut () |
Copies the selected text to the clipboard and deletes it from the text edit. | |
void | copy () |
Copies any selected text to the clipboard. | |
void | paste () |
Pastes the text from the clipboard into the text edit at the current cursor position. | |
void | undo () |
Undoes the last operation. | |
void | redo () |
Redoes the last operation. | |
void | clear () |
Deletes all the text in the text edit. | |
void | selectAll () |
Selects all text. | |
void | insertPlainText (const QString &text) |
Convenience slot that inserts text at the current cursor position. | |
void | appendPlainText (const QString &text) |
Appends a new paragraph with text to the end of the text edit. | |
void | appendHtml (const QString &html) |
Appends a new paragraph with html to the end of the text edit. | |
void | centerCursor () |
Scrolls the document in order to center the cursor vertically. | |
void | zoomIn (int range=1) |
\reimp | |
void | zoomOut (int range=1) |
Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. | |
Signals | |
void | textChanged () |
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied. | |
void | undoAvailable (bool b) |
This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false). | |
void | redoAvailable (bool b) |
This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false). | |
void | copyAvailable (bool b) |
This signal is emitted when text is selected or de-selected in the text edit. | |
void | selectionChanged () |
This signal is emitted whenever the selection changes. | |
void | cursorPositionChanged () |
This signal is emitted whenever the position of the cursor changed. | |
void | updateRequest (const QRect &rect, int dy) |
This signal is emitted when the text document needs an update of the specified rect. | |
void | blockCountChanged (int newBlockCount) |
This signal is emitted whenever the block count changes. | |
void | modificationChanged (bool) |
This signal is emitted whenever the content of the document changes in a way that affects the modification state. | |
Public Member Functions | |
QPlainTextEdit (QWidget *parent=nullptr) | |
Constructs an empty QPlainTextEdit with parent parent. | |
QPlainTextEdit (const QString &text, QWidget *parent=nullptr) | |
Constructs a QPlainTextEdit with parent parent. | |
virtual | ~QPlainTextEdit () |
Destructor. | |
void | setDocument (QTextDocument *document) |
Makes document the new document of the text editor. | |
QTextDocument * | document () const |
Returns a pointer to the underlying document. | |
void | setPlaceholderText (const QString &placeholderText) |
QString | placeholderText () const |
void | setTextCursor (const QTextCursor &cursor) |
Sets the visible cursor. | |
QTextCursor | textCursor () const |
Returns a copy of the QTextCursor that represents the currently visible cursor. | |
bool | isReadOnly () const |
void | setReadOnly (bool ro) |
void | setTextInteractionFlags (Qt::TextInteractionFlags flags) |
Qt::TextInteractionFlags | textInteractionFlags () const |
void | mergeCurrentCharFormat (const QTextCharFormat &modifier) |
Merges the properties specified in modifier into the current character format by calling QTextCursor::mergeCharFormat on the editor's cursor. | |
void | setCurrentCharFormat (const QTextCharFormat &format) |
Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor. | |
QTextCharFormat | currentCharFormat () const |
Returns the char format that is used when inserting new text. | |
bool | tabChangesFocus () const |
void | setTabChangesFocus (bool b) |
void | setDocumentTitle (const QString &title) |
QString | documentTitle () const |
bool | isUndoRedoEnabled () const |
void | setUndoRedoEnabled (bool enable) |
void | setMaximumBlockCount (int maximum) |
int | maximumBlockCount () const |
LineWrapMode | lineWrapMode () const |
void | setLineWrapMode (LineWrapMode mode) |
QTextOption::WrapMode | wordWrapMode () const |
the mode QPlainTextEdit will use when wrapping text by words | |
void | setWordWrapMode (QTextOption::WrapMode policy) |
void | setBackgroundVisible (bool visible) |
bool | backgroundVisible () const |
void | setCenterOnScroll (bool enabled) |
bool | centerOnScroll () const |
bool | find (const QString &exp, QTextDocument::FindFlags options=QTextDocument::FindFlags()) |
Finds the next occurrence of the string, exp, using the given options. | |
QString | toPlainText () const |
Returns the text of the text edit as plain text. | |
void | ensureCursorVisible () |
Ensures that the cursor is visible by scrolling the text edit if necessary. | |
virtual QVariant | loadResource (int type, const QUrl &name) |
Loads the resource specified by the given type and name. | |
QMenu * | createStandardContextMenu () |
This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. | |
QMenu * | createStandardContextMenu (const QPoint &position) |
QTextCursor | cursorForPosition (const QPoint &pos) const |
returns a QTextCursor at position pos (in viewport coordinates). | |
QRect | cursorRect (const QTextCursor &cursor) const |
returns a rectangle (in viewport coordinates) that includes the cursor. | |
QRect | cursorRect () const |
returns a rectangle (in viewport coordinates) that includes the cursor of the text edit. | |
QString | anchorAt (const QPoint &pos) const |
Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point. | |
bool | overwriteMode () const |
void | setOverwriteMode (bool overwrite) |
qreal | tabStopDistance () const |
void | setTabStopDistance (qreal distance) |
int | cursorWidth () const |
void | setCursorWidth (int width) |
void | setExtraSelections (const QList< QTextEdit::ExtraSelection > &selections) |
This function allows temporarily marking certain regions in the document with a given color, specified as selections. | |
QList< QTextEdit::ExtraSelection > | extraSelections () const |
Returns previously set extra selections. | |
void | moveCursor (QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode=QTextCursor::MoveAnchor) |
Moves the cursor by performing the given operation. | |
bool | canPaste () const |
Returns whether text can be pasted from the clipboard into the textedit. | |
void | print (QPagedPaintDevice *printer) const |
Convenience function to print the text edit's document to the given printer. | |
int | blockCount () const |
QVariant | inputMethodQuery (Qt::InputMethodQuery property) const override |
\reimp | |
Q_INVOKABLE QVariant | inputMethodQuery (Qt::InputMethodQuery query, QVariant argument) const |
Protected Member Functions | |
virtual bool | event (QEvent *e) override |
virtual void | timerEvent (QTimerEvent *e) override |
virtual void | keyPressEvent (QKeyEvent *e) override |
\reimp | |
virtual void | keyReleaseEvent (QKeyEvent *e) override |
\reimp | |
virtual void | resizeEvent (QResizeEvent *e) override |
\reimp | |
virtual void | paintEvent (QPaintEvent *e) override |
\reimp | |
virtual void | mousePressEvent (QMouseEvent *e) override |
\reimp | |
virtual void | mouseMoveEvent (QMouseEvent *e) override |
\reimp | |
virtual void | mouseReleaseEvent (QMouseEvent *e) override |
\reimp | |
virtual void | mouseDoubleClickEvent (QMouseEvent *e) override |
\reimp | |
virtual bool | focusNextPrevChild (bool next) override |
\reimp | |
virtual void | contextMenuEvent (QContextMenuEvent *e) override |
Shows the standard context menu created with createStandardContextMenu(). | |
virtual void | focusInEvent (QFocusEvent *e) override |
\reimp | |
virtual void | focusOutEvent (QFocusEvent *e) override |
\reimp | |
virtual void | showEvent (QShowEvent *) override |
\reimp | |
virtual void | changeEvent (QEvent *e) override |
\reimp | |
virtual QMimeData * | createMimeDataFromSelection () const |
This function returns a new MIME data object to represent the contents of the text edit's current selection. | |
virtual bool | canInsertFromMimeData (const QMimeData *source) const |
This function returns true if the contents of the MIME data object, specified by source, can be decoded and inserted into the document. | |
virtual void | insertFromMimeData (const QMimeData *source) |
This function inserts the contents of the MIME data object, specified by source, into the text edit at the current cursor position. | |
virtual void | inputMethodEvent (QInputMethodEvent *) override |
\reimp | |
QPlainTextEdit (QPlainTextEditPrivate &dd, QWidget *parent) | |
virtual void | scrollContentsBy (int dx, int dy) override |
\reimp | |
virtual void | doSetTextCursor (const QTextCursor &cursor) |
QTextBlock | firstVisibleBlock () const |
Returns the first visible block. | |
QPointF | contentOffset () const |
Returns the content's origin in viewport coordinates. | |
QRectF | blockBoundingRect (const QTextBlock &block) const |
Returns the bounding rectangle of the text block in the block's own coordinates. | |
QRectF | blockBoundingGeometry (const QTextBlock &block) const |
Returns the bounding rectangle of the text block in content coordinates. | |
QAbstractTextDocumentLayout::PaintContext | getPaintContext () const |
Returns the paint context for the viewport(), useful only when reimplementing paintEvent(). | |
void | zoomInF (float range) |
Properties | |
bool | tabChangesFocus |
whether \uicontrol Tab changes focus or is accepted as input | |
QString | documentTitle |
the title of the document parsed from the text. | |
bool | undoRedoEnabled |
whether undo and redo are enabled | |
LineWrapMode | lineWrapMode |
the line wrap mode | |
bool | readOnly |
whether the text edit is read-only | |
QString | plainText |
This property gets and sets the plain text editor's contents. | |
bool | overwriteMode |
whether text entered by the user will overwrite existing text | |
qreal | tabStopDistance |
the tab stop distance in pixels | |
int | cursorWidth |
This property specifies the width of the cursor in pixels. | |
Qt::TextInteractionFlags | textInteractionFlags |
Specifies how the label should interact with user input if it displays text. | |
int | blockCount |
the number of text blocks in the document. | |
int | maximumBlockCount |
the limit for blocks in the document. | |
bool | backgroundVisible |
whether the palette background is visible outside the document area | |
bool | centerOnScroll |
whether the cursor should be centered on screen | |
QString | placeholderText |
the editor placeholder text | |
Friends | |
class | QPlainTextEditControl |
The QPlainTextEdit class provides a widget that is used to edit and display plain text.
\inmodule QtWidgets
Definition at line 29 of file qplaintextedit.h.
\value NoWrap \value WidgetWidth
Enumerator | |
---|---|
NoWrap | |
WidgetWidth |
Definition at line 51 of file qplaintextedit.h.
Constructs an empty QPlainTextEdit with parent parent.
Definition at line 1225 of file qplaintextedit.cpp.
References d.
Constructs a QPlainTextEdit with parent parent.
The text edit will display the plain text text.
Definition at line 1246 of file qplaintextedit.cpp.
|
virtual |
|
protected |
Definition at line 1235 of file qplaintextedit.cpp.
References d.
Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point.
Definition at line 1379 of file qplaintextedit.cpp.
References QTextCharFormat::anchorHref(), QTextFormatCollection::charFormat(), d, document(), Qt::ExactHit, QTextDocumentPrivate::find(), fmt, QTextDocumentPrivate::formatCollection(), QTextDocumentPrivate::get(), it, and pos.
Referenced by QPlainTextEditControl::anchorAt().
Appends a new paragraph with html to the end of the text edit.
Definition at line 3071 of file qplaintextedit.cpp.
References d, and Qt::RichText.
Appends a new paragraph with text to the end of the text edit.
Definition at line 3059 of file qplaintextedit.cpp.
References d, Qt::PlainText, and text.
bool QPlainTextEdit::backgroundVisible | ( | ) | const |
Definition at line 2833 of file qplaintextedit.cpp.
References d.
|
protected |
Returns the bounding rectangle of the text block in content coordinates.
Translate the rectangle with the contentOffset() to get visual coordinates on the viewport.
Definition at line 3153 of file qplaintextedit.cpp.
References d.
|
protected |
Returns the bounding rectangle of the text block in the block's own coordinates.
Definition at line 3164 of file qplaintextedit.cpp.
References QPlainTextDocumentLayout::blockBoundingRect(), document(), and Q_ASSERT.
Referenced by paintEvent().
int QPlainTextEdit::blockCount | ( | ) | const |
Definition at line 3177 of file qplaintextedit.cpp.
References QTextDocument::blockCount, and document().
|
signal |
This signal is emitted whenever the block count changes.
The new block count is passed in newBlockCount.
Referenced by QPlainTextEditPrivate::init().
|
protectedvirtual |
This function returns true
if the contents of the MIME data object, specified by source, can be decoded and inserted into the document.
It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag.
Definition at line 2574 of file qplaintextedit.cpp.
References d.
bool QPlainTextEdit::canPaste | ( | ) | const |
Returns whether text can be pasted from the clipboard into the textedit.
Definition at line 2718 of file qplaintextedit.cpp.
References d.
|
slot |
Scrolls the document in order to center the cursor vertically.
Definition at line 3110 of file qplaintextedit.cpp.
References d, position(), and textCursor().
bool QPlainTextEdit::centerOnScroll | ( | ) | const |
Definition at line 2865 of file qplaintextedit.cpp.
References d.
\reimp
Definition at line 2294 of file qplaintextedit.cpp.
References QEvent::ActivationChange, QEvent::ApplicationFontChange, d, QEvent::EnabledChange, font, QEvent::FontChange, QEvent::LayoutDirectionChange, palette, QEvent::PaletteChange, QEvent::setAccepted(), and QEvent::type().
|
slot |
Deletes all the text in the text edit.
Notes: \list
Definition at line 1486 of file qplaintextedit.cpp.
References d.
Referenced by keyPressEvent(), and timerEvent().
|
protected |
Returns the content's origin in viewport coordinates.
The origin of the content of a plain text edit is always the top left corner of the first visible text block. The content offset is different from (0,0) when the text has been scrolled horizontally, or when the first visible block has been scrolled partially off the screen, i.e. the visible text does not start with the first line of the first visible block, or when the first visible block is the very first block and the editor displays a margin.
Definition at line 3140 of file qplaintextedit.cpp.
References d.
Referenced by inputMethodQuery(), and paintEvent().
|
overrideprotectedvirtual |
Shows the standard context menu created with createStandardContextMenu().
If you do not want the text edit to have a context menu, you can set its \l contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this function. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.
Information about the event is passed in the event object.
Definition at line 2122 of file qplaintextedit.cpp.
References d.
|
slot |
Copies any selected text to the clipboard.
Definition at line 1447 of file qplaintextedit.cpp.
References d.
|
signal |
This signal is emitted when text is selected or de-selected in the text edit.
When text is selected this signal will be emitted with yes set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with yes set to false.
If yes is true then copy() can be used to copy the selection to the clipboard. If yes is false then copy() does nothing.
Referenced by QPlainTextEditPrivate::init().
|
protectedvirtual |
This function returns a new MIME data object to represent the contents of the text edit's current selection.
It is called when the selection needs to be encapsulated into a new QMimeData object; for example, when a drag and drop operation is started, or when data is copied to the clipboard.
If you reimplement this function, note that the ownership of the returned QMimeData object is passed to the caller. The selection can be retrieved by using the textCursor() function.
Definition at line 2562 of file qplaintextedit.cpp.
References d.
QMenu * QPlainTextEdit::createStandardContextMenu | ( | ) |
This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button.
It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.
We recommend that you use the createStandardContextMenu(QPoint) version instead which will enable the actions that are sensitive to where the user clicked.
Definition at line 2391 of file qplaintextedit.cpp.
References d.
Definition at line 2407 of file qplaintextedit.cpp.
References d, and position().
QTextCharFormat QPlainTextEdit::currentCharFormat | ( | ) | const |
Returns the char format that is used when inserting new text.
Definition at line 2677 of file qplaintextedit.cpp.
References d.
QTextCursor QPlainTextEdit::cursorForPosition | ( | const QPoint & | pos | ) | const |
returns a QTextCursor at position pos (in viewport coordinates).
Definition at line 2417 of file qplaintextedit.cpp.
|
signal |
This signal is emitted whenever the position of the cursor changed.
QRect QPlainTextEdit::cursorRect | ( | ) | const |
returns a rectangle (in viewport coordinates) that includes the cursor of the text edit.
Definition at line 2442 of file qplaintextedit.cpp.
References d, and QRect::translate().
Referenced by event().
QRect QPlainTextEdit::cursorRect | ( | const QTextCursor & | cursor | ) | const |
returns a rectangle (in viewport coordinates) that includes the cursor.
Definition at line 2427 of file qplaintextedit.cpp.
References cursor, d, and QRect::translate().
int QPlainTextEdit::cursorWidth | ( | ) | const |
Definition at line 2513 of file qplaintextedit.cpp.
References d.
|
slot |
Copies the selected text to the clipboard and deletes it from the text edit.
If there is no selected text nothing happens.
Definition at line 1435 of file qplaintextedit.cpp.
References d.
QTextDocument * QPlainTextEdit::document | ( | ) | const |
Returns a pointer to the underlying document.
Definition at line 1308 of file qplaintextedit.cpp.
References d.
Referenced by anchorAt(), blockBoundingRect(), blockCount(), event(), keyPressEvent(), paintEvent(), and setDocument().
|
inline |
Definition at line 85 of file qplaintextedit.h.
References QTextDocument::DocumentTitle.
|
protectedvirtual |
This provides a hook for subclasses to intercept cursor changes.
Definition at line 1356 of file qplaintextedit.cpp.
Referenced by setTextCursor().
void QPlainTextEdit::ensureCursorVisible | ( | ) |
Ensures that the cursor is visible by scrolling the text edit if necessary.
Definition at line 3099 of file qplaintextedit.cpp.
References d.
Referenced by QPlainTextEditControl::ensureCursorVisible(), event(), inputMethodEvent(), setLineWrapMode(), and showEvent().
|
overrideprotectedvirtual |
Definition at line 1508 of file qplaintextedit.cpp.
References QRect::center(), QEvent::ContextMenu, cursorRect(), d, document(), ensureCursorVisible(), QEvent::Gesture, Qt::GestureStarted, QEvent::isAccepted(), QGuiApplication::isRightToLeft(), QContextMenuEvent::Keyboard, palette, Qt::PanGesture, QPointF::rx(), QEvent::setAccepted(), QEvent::ShortcutOverride, QEvent::ToolTip, QEvent::type(), QEvent::WindowActivate, and QEvent::WindowDeactivate.
QList< QTextEdit::ExtraSelection > QPlainTextEdit::extraSelections | ( | ) | const |
Returns previously set extra selections.
Definition at line 2546 of file qplaintextedit.cpp.
References d.
bool QPlainTextEdit::find | ( | const QString & | exp, |
QTextDocument::FindFlags | options = QTextDocument::FindFlags() ) |
Finds the next occurrence of the string, exp, using the given options.
Returns true
if exp was found and changes the cursor to select the match; otherwise returns false
.
Finds the next occurrence, matching the regular expression, exp, using the given options.
Returns true
if a match was found and changes the cursor to select the match; otherwise returns false
.
Definition at line 2887 of file qplaintextedit.cpp.
References d.
|
protected |
Returns the first visible block.
Definition at line 3121 of file qplaintextedit.cpp.
References d.
Referenced by paintEvent().
|
overrideprotectedvirtual |
\reimp
Definition at line 2261 of file qplaintextedit.cpp.
References d, Qt::MouseFocusReason, and QFocusEvent::reason().
|
overrideprotectedvirtual |
\reimp
Definition at line 2098 of file qplaintextedit.cpp.
References d, next, and Qt::TextEditable.
|
overrideprotectedvirtual |
|
protected |
Returns the paint context for the viewport(), useful only when reimplementing paintEvent().
Definition at line 3185 of file qplaintextedit.cpp.
References d.
Referenced by paintEvent().
|
overrideprotectedvirtual |
\reimp
Definition at line 2174 of file qplaintextedit.cpp.
References QInputMethodEvent::attributes(), QInputMethodEvent::commitString(), d, ensureCursorVisible(), QString::isEmpty(), QInputMethodEvent::preeditString(), selectAll(), and Qt::TextEditable.
|
override |
\reimp
Definition at line 2203 of file qplaintextedit.cpp.
References inputMethodQuery(), and property.
Referenced by inputMethodQuery().
QVariant QPlainTextEdit::inputMethodQuery | ( | Qt::InputMethodQuery | query, |
QVariant | argument ) const |
Definition at line 2210 of file qplaintextedit.cpp.
References argument, contentOffset(), d, Qt::ImEnabled, Qt::ImHints, Qt::ImInputItemClipRectangle, Qt::ImReadOnly, QWidget::inputMethodQuery(), isReadOnly(), QVariant::toRectF(), and QRectF::translated().
This function inserts the contents of the MIME data object, specified by source, into the text edit at the current cursor position.
It is called whenever text is inserted as the result of a clipboard paste operation, or when the text edit accepts data from a drag and drop operation.
Definition at line 2587 of file qplaintextedit.cpp.
References d.
Convenience slot that inserts text at the current cursor position.
It is equivalent to
Definition at line 2693 of file qplaintextedit.cpp.
bool QPlainTextEdit::isReadOnly | ( | ) | const |
Definition at line 2603 of file qplaintextedit.cpp.
References d, and Qt::TextEditable.
Referenced by inputMethodQuery(), keyReleaseEvent(), mouseReleaseEvent(), paintEvent(), and shouldEnableInputMethod().
|
inline |
Definition at line 88 of file qplaintextedit.h.
\reimp
Definition at line 1649 of file qplaintextedit.cpp.
References QEvent::accept(), clear(), Qt::ControlModifier, cursor, d, document(), QTextCursor::Down, QEvent::ignore(), QEvent::isAccepted(), QKeyEvent::isAutoRepeat(), QTextCursor::KeepAnchor, QKeyEvent::key(), Qt::Key_Back, Qt::Key_Down, Qt::Key_End, Qt::Key_Home, Qt::Key_Left, Qt::Key_No, Qt::Key_Right, Qt::Key_Select, Qt::Key_Space, Qt::Key_Up, Qt::LinksAccessibleByKeyboard, QKeyEvent::modifiers(), QTextCursor::MoveAnchor, QKeySequence::MoveToNextPage, QKeySequence::MoveToPreviousPage, Qt::NavigationModeKeypadDirectional, Qt::NoModifier, QKeySequence::SelectNextPage, QKeySequence::SelectPreviousPage, Qt::ShiftModifier, QAbstractSlider::SliderPageStepAdd, QAbstractSlider::SliderPageStepSub, QAbstractSlider::SliderToMaximum, QAbstractSlider::SliderToMinimum, QKeyEvent::text(), Qt::TextEditable, Qt::TextSelectableByKeyboard, and QTextCursor::Up.
\reimp
Definition at line 1797 of file qplaintextedit.cpp.
References cursor, d, QKeyEvent::isAutoRepeat(), isReadOnly(), QKeyEvent::key(), Qt::Key_Back, QWidget::keyReleaseEvent(), list, QList< T >::remove(), and setTextCursor().
QPlainTextEdit::LineWrapMode QPlainTextEdit::lineWrapMode | ( | ) | const |
Definition at line 2777 of file qplaintextedit.cpp.
References d.
Loads the resource specified by the given type and name.
This function is an extension of QTextDocument::loadResource().
Definition at line 1835 of file qplaintextedit.cpp.
References Q_UNUSED.
Referenced by QPlainTextEditControl::loadResource().
|
inline |
Definition at line 95 of file qplaintextedit.h.
void QPlainTextEdit::mergeCurrentCharFormat | ( | const QTextCharFormat & | modifier | ) |
Merges the properties specified in modifier into the current character format by calling QTextCursor::mergeCharFormat on the editor's cursor.
If the editor has a selection then the properties of modifier are directly applied to the selection.
Definition at line 2656 of file qplaintextedit.cpp.
References d.
|
signal |
This signal is emitted whenever the content of the document changes in a way that affects the modification state.
If changed is true, the document has been modified; otherwise it is false.
For example, calling setModified(false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.
Referenced by QPlainTextEditPrivate::init().
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
\reimp
Definition at line 2055 of file qplaintextedit.cpp.
References QSinglePointEvent::buttons(), QRect::contains(), d, Qt::LeftButton, Qt::MouseEventNotSynthesized, pos, QSinglePointEvent::position(), QMouseEvent::source(), and QPointF::toPoint().
Referenced by timerEvent().
|
overrideprotectedvirtual |
|
overrideprotectedvirtual |
\reimp
Definition at line 2074 of file qplaintextedit.cpp.
References QSinglePointEvent::button(), contains(), d, isReadOnly(), Qt::MouseEventNotSynthesized, QSinglePointEvent::position(), rect, QMouseEvent::source(), and QPointF::toPoint().
void QPlainTextEdit::moveCursor | ( | QTextCursor::MoveOperation | operation, |
QTextCursor::MoveMode | mode = QTextCursor::MoveAnchor ) |
Moves the cursor by performing the given operation.
If mode is QTextCursor::KeepAnchor, the cursor selects the text it moves over. This is the same effect that the user achieves when they hold down the Shift key and move the cursor with the cursor keys.
Definition at line 2709 of file qplaintextedit.cpp.
References d.
bool QPlainTextEdit::overwriteMode | ( | ) | const |
Definition at line 2465 of file qplaintextedit.cpp.
References d.
|
overrideprotectedvirtual |
\reimp
Definition at line 1890 of file qplaintextedit.cpp.
References QRect::adjusted(), Qt::AlignTop, QTextFormat::background(), backgroundVisible, base, blockBoundingRect(), QTextBlock::blockFormat(), centerOnScroll, QTextBlock::contains(), contentOffset(), context, cursorWidth, d, document(), QTextDocument::documentLayout(), QTextDocument::documentMargin, QAbstractTextDocumentLayout::documentSize(), QPainter::drawText(), fillBackground(), QPainter::fillRect(), firstVisibleBlock(), QTextFormat::FullWidthSelection, getPaintContext(), QRect::height(), i, QLayout::isEmpty(), isReadOnly(), QTextBlock::isValid(), QTextBlock::isVisible(), layout, QTextBlock::layout(), QTextBlock::length(), QTextBlock::next(), Qt::NoBrush, o, overwriteMode, painter, palette, placeholderText, QTextBlock::position(), Q_ASSERT, qMax(), qMin(), QPaintEvent::rect(), QPainter::setBrushOrigin(), QPainter::setClipRect(), QPainter::setPen(), QRectF::setWidth(), text, textInteractionFlags, QTextLine::textLength(), textRect, Qt::TextSelectableByKeyboard, QTextLine::textStart(), Qt::TextWordWrap, QRectF::translated(), viewport(), and QRect::width().
|
slot |
Pastes the text from the clipboard into the text edit at the current cursor position.
If there is no text in the clipboard nothing happens.
To change the behavior of this function, i.e. to modify what QPlainTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() functions.
Definition at line 1467 of file qplaintextedit.cpp.
References d.
QString QPlainTextEdit::placeholderText | ( | ) | const |
Definition at line 1336 of file qplaintextedit.cpp.
References d.
void QPlainTextEdit::print | ( | QPagedPaintDevice * | printer | ) | const |
Convenience function to print the text edit's document to the given printer.
This is equivalent to calling the print method on the document directly except that this function also supports QPrinter::Selection as print range.
Definition at line 2732 of file qplaintextedit.cpp.
References d.
|
slot |
Redoes the last operation.
If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens.
Definition at line 1408 of file qplaintextedit.cpp.
References d.
|
signal |
This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).
Referenced by QPlainTextEditPrivate::init().
|
overrideprotectedvirtual |
\reimp
Definition at line 1844 of file qplaintextedit.cpp.
References d, QResizeEvent::oldSize(), QResizeEvent::size(), and QSize::width().
|
overrideprotectedvirtual |
|
slot |
Selects all text.
Definition at line 1500 of file qplaintextedit.cpp.
References d.
Referenced by inputMethodEvent().
|
signal |
This signal is emitted whenever the selection changes.
Referenced by QPlainTextEditPrivate::init().
void QPlainTextEdit::setBackgroundVisible | ( | bool | visible | ) |
Definition at line 2839 of file qplaintextedit.cpp.
References d.
void QPlainTextEdit::setCenterOnScroll | ( | bool | enabled | ) |
Definition at line 2871 of file qplaintextedit.cpp.
void QPlainTextEdit::setCurrentCharFormat | ( | const QTextCharFormat & | format | ) |
Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor.
If the editor has a selection then the char format is directly applied to the selection.
Definition at line 2668 of file qplaintextedit.cpp.
References d.
void QPlainTextEdit::setCursorWidth | ( | int | width | ) |
Definition at line 2519 of file qplaintextedit.cpp.
References d.
void QPlainTextEdit::setDocument | ( | QTextDocument * | document | ) |
Makes document the new document of the text editor.
The parent QObject of the provided document remains the owner of the object. If the current document is a child of the text editor, then it is deleted.
The document must have a document layout that inherits QPlainTextDocumentLayout (see QTextDocument::setDocumentLayout()).
Definition at line 1278 of file qplaintextedit.cpp.
References d, document(), QTextDocument::documentLayout(), QPlainTextEditPrivate::documentLayoutPtr, QPlainTextDocumentLayoutPrivate::mainViewPrivate, Q_UNLIKELY, qWarning, and QTextDocument::setDocumentLayout().
Definition at line 83 of file qplaintextedit.h.
References QTextDocument::DocumentTitle, and title.
void QPlainTextEdit::setExtraSelections | ( | const QList< QTextEdit::ExtraSelection > & | selections | ) |
This function allows temporarily marking certain regions in the document with a given color, specified as selections.
This can be useful for example in a programming editor to mark a whole line of text with a given background color to indicate the existence of a breakpoint.
Definition at line 2535 of file qplaintextedit.cpp.
References d.
void QPlainTextEdit::setLineWrapMode | ( | LineWrapMode | mode | ) |
Definition at line 2783 of file qplaintextedit.cpp.
References d, ensureCursorVisible(), and wrap().
Referenced by QInputDialogPrivate::ensurePlainTextEdit().
|
inline |
Definition at line 93 of file qplaintextedit.h.
void QPlainTextEdit::setOverwriteMode | ( | bool | overwrite | ) |
Definition at line 2471 of file qplaintextedit.cpp.
References d.
Definition at line 1327 of file qplaintextedit.cpp.
References d, and placeholderText.
Changes the text of the text edit to the string text.
Any previous text is removed.
text is interpreted as plain text.
Notes: \list
Definition at line 1633 of file qplaintextedit.cpp.
Referenced by QInputDialogPrivate::setInputWidget().
void QPlainTextEdit::setReadOnly | ( | bool | ro | ) |
Definition at line 2609 of file qplaintextedit.cpp.
References d, Qt::NoTextInteraction, QEvent::ReadOnlyChange, QCoreApplication::sendEvent(), setAttribute(), shouldEnableInputMethod(), Qt::TextEditorInteraction, Qt::TextSelectableByMouse, and Qt::WA_InputMethodEnabled.
void QPlainTextEdit::setTabChangesFocus | ( | bool | b | ) |
Definition at line 2754 of file qplaintextedit.cpp.
References d.
Definition at line 2497 of file qplaintextedit.cpp.
void QPlainTextEdit::setTextCursor | ( | const QTextCursor & | cursor | ) |
Sets the visible cursor.
Definition at line 1345 of file qplaintextedit.cpp.
References cursor, and doSetTextCursor().
Referenced by keyReleaseEvent().
void QPlainTextEdit::setTextInteractionFlags | ( | Qt::TextInteractionFlags | flags | ) |
Definition at line 2636 of file qplaintextedit.cpp.
References d.
|
inline |
Definition at line 90 of file qplaintextedit.h.
void QPlainTextEdit::setWordWrapMode | ( | QTextOption::WrapMode | policy | ) |
Definition at line 2810 of file qplaintextedit.cpp.
References d.
|
overrideprotectedvirtual |
\reimp
Definition at line 2282 of file qplaintextedit.cpp.
References d, and ensureCursorVisible().
bool QPlainTextEdit::tabChangesFocus | ( | ) | const |
Definition at line 2748 of file qplaintextedit.cpp.
References d.
qreal QPlainTextEdit::tabStopDistance | ( | ) | const |
Definition at line 2491 of file qplaintextedit.cpp.
References d.
|
signal |
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.
Referenced by QInputDialogPrivate::ensurePlainTextEdit(), and QPlainTextEditPrivate::init().
QTextCursor QPlainTextEdit::textCursor | ( | ) | const |
Returns a copy of the QTextCursor that represents the currently visible cursor.
Note that changes on the returned cursor do not affect QPlainTextEdit's cursor; use setTextCursor() to update the visible cursor.
Definition at line 1367 of file qplaintextedit.cpp.
References d.
Referenced by centerCursor().
Qt::TextInteractionFlags QPlainTextEdit::textInteractionFlags | ( | ) | const |
Definition at line 2642 of file qplaintextedit.cpp.
References d.
|
overrideprotectedvirtual |
Definition at line 1573 of file qplaintextedit.cpp.
References QRect::adjust(), QRect::bottom(), QRect::center(), clear(), d, QRect::height(), QGuiApplication::keyboardModifiers(), QRect::left(), Qt::LeftButton, QEvent::MouseMove, mouseMoveEvent(), pos, QCursor::pos(), qMax(), qMin(), QRect::right(), QAbstractSlider::SliderSingleStepAdd, QAbstractSlider::SliderSingleStepSub, QTimerEvent::timerId(), QRect::top(), and QRect::width().
|
inline |
Returns the text of the text edit as plain text.
Definition at line 116 of file qplaintextedit.h.
Referenced by QInputDialogPrivate::plainTextEditTextChanged().
|
slot |
Undoes the last operation.
If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens.
Definition at line 1402 of file qplaintextedit.cpp.
References d.
|
signal |
This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).
Referenced by QPlainTextEditPrivate::init().
This signal is emitted when the text document needs an update of the specified rect.
If the text is scrolled, rect will cover the entire viewport area. If the text is scrolled vertically, dy carries the amount of pixels the viewport was scrolled.
The purpose of the signal is to support extra widgets in plain text edit subclasses that e.g. show line numbers, breakpoints, or other extra information.
QTextOption::WrapMode QPlainTextEdit::wordWrapMode | ( | ) | const |
the mode QPlainTextEdit will use when wrapping text by words
By default, this property is set to QTextOption::WrapAtWordBoundaryOrAnywhere.
Definition at line 2804 of file qplaintextedit.cpp.
References d.
|
slot |
\reimp
Zooms in on the text by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.
Definition at line 2349 of file qplaintextedit.cpp.
References zoomInF().
|
protected |
Definition at line 2369 of file qplaintextedit.cpp.
References font.
Referenced by zoomIn(), and zoomOut().
|
slot |
Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size.
This does not change the size of any images.
Definition at line 2361 of file qplaintextedit.cpp.
References zoomInF().
|
friend |
Definition at line 244 of file qplaintextedit.h.
|
readwrite |
whether the palette background is visible outside the document area
If set to true, the plain text edit paints the palette background on the viewport area not covered by the text document. Otherwise, if set to false, it won't. The feature makes it possible for the user to visually distinguish between the area of the document, painted with the base color of the palette, and the empty area not covered by any document.
The default is false.
Definition at line 47 of file qplaintextedit.h.
Referenced by paintEvent().
|
read |
the number of text blocks in the document.
By default, in an empty document, this property contains a value of 1.
Definition at line 45 of file qplaintextedit.h.
|
readwrite |
whether the cursor should be centered on screen
If set to true, the plain text edit scrolls the document vertically to make the cursor visible at the center of the viewport. This also allows the text edit to scroll below the end of the document. Otherwise, if set to false, the plain text edit scrolls the smallest amount possible to ensure the cursor is visible. The same algorithm is applied to any new line appended through appendPlainText().
The default is false.
Definition at line 48 of file qplaintextedit.h.
Referenced by paintEvent().
|
readwrite |
This property specifies the width of the cursor in pixels.
The default value is 1.
Definition at line 42 of file qplaintextedit.h.
Referenced by paintEvent().
|
readwrite |
the title of the document parsed from the text.
By default, this property contains an empty string.
Definition at line 34 of file qplaintextedit.h.
|
readwrite |
the line wrap mode
The default mode is WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words use setWordWrapMode().
Definition at line 36 of file qplaintextedit.h.
|
readwrite |
the limit for blocks in the document.
Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.
A negative or zero value specifies that the document may contain an unlimited amount of blocks.
The default value is 0.
Note that setting this property will apply the limit immediately to the document contents. Setting this property also disables the undo redo history.
Definition at line 46 of file qplaintextedit.h.
|
readwrite |
whether text entered by the user will overwrite existing text
As with many text editors, the plain text editor widget can be configured to insert or overwrite existing text with new text entered by the user.
If this property is true
, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text.
By default, this property is false
(new text does not overwrite existing text).
Definition at line 40 of file qplaintextedit.h.
Referenced by paintEvent().
|
readwrite |
the editor placeholder text
Setting this property makes the editor display a grayed-out placeholder text as long as the document() is empty.
By default, this property contains an empty string.
Definition at line 49 of file qplaintextedit.h.
Referenced by paintEvent(), and setPlaceholderText().
|
readwrite |
This property gets and sets the plain text editor's contents.
The previous contents are removed and undo/redo history is reset when this property is set. currentCharFormat() is also reset, unless textCursor() is already at the beginning of the document.
By default, for an editor with no contents, this property contains an empty string.
Definition at line 39 of file qplaintextedit.h.
|
readwrite |
whether the text edit is read-only
In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible.
This property's default is false.
Definition at line 38 of file qplaintextedit.h.
|
readwrite |
whether \uicontrol Tab changes focus or is accepted as input
In some occasions text edits should not allow the user to input tabulators or change indentation using the \uicontrol Tab key, as this breaks the focus chain. The default is false.
Definition at line 33 of file qplaintextedit.h.
|
readwrite |
the tab stop distance in pixels
By default, this property contains a value of 80 pixels.
Do not set a value less than the \l {QFontMetrics::}{horizontalAdvance()} of the QChar::VisualTabCharacter character, otherwise the tab-character will be drawn incompletely.
Definition at line 41 of file qplaintextedit.h.
|
readwrite |
Specifies how the label should interact with user input if it displays text.
If the flags contain either Qt::LinksAccessibleByKeyboard or Qt::TextSelectableByKeyboard then the focus policy is also automatically set to Qt::ClickFocus.
The default value depends on whether the QPlainTextEdit is read-only or editable.
Definition at line 43 of file qplaintextedit.h.
Referenced by paintEvent(), and shouldEnableInputMethod().
|
readwrite |
whether undo and redo are enabled
Users are only able to undo or redo actions if this property is true, and if there is an action that can be undone (or redone).
By default, this property is true
.
Definition at line 35 of file qplaintextedit.h.