Qt 4.8
Public Types | Public Slots | Signals | Public Functions | Protected Functions | Properties | Friends | List of all members
QPlainTextEdit Class Reference

The QPlainTextEdit class provides a widget that is used to edit and display plain text. More...

#include <qplaintextedit.h>

Inheritance diagram for QPlainTextEdit:
QAbstractScrollArea QFrame QWidget QObject QPaintDevice QScriptEdit

Public Types

enum  LineWrapMode { NoWrap, WidgetWidth }
 
- Public Types inherited from QFrame
enum  Shadow { Plain = 0x0010, Raised = 0x0020, Sunken = 0x0030 }
 This enum type defines the types of shadow that are used to give a 3D effect to frames. More...
 
enum  Shape {
  NoFrame = 0, Box = 0x0001, Panel = 0x0002, WinPanel = 0x0003,
  HLine = 0x0004, VLine = 0x0005, StyledPanel = 0x0006
}
 This enum type defines the shapes of frame available. More...
 
enum  StyleMask { Shadow_Mask = 0x00f0, Shape_Mask = 0x000f }
 This enum defines two constants that can be used to extract the two components of frameStyle(): More...
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1, DrawChildren = 0x2, IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1, PdmHeight, PdmWidthMM, PdmHeightMM,
  PdmNumColors, PdmDepth, PdmDpiX, PdmDpiY,
  PdmPhysicalDpiX, PdmPhysicalDpiY
}
 

Public Slots

void appendHtml (const QString &html)
 Appends a new paragraph with html to the end of the text edit. More...
 
void appendPlainText (const QString &text)
 Appends a new paragraph with text to the end of the text edit. More...
 
void centerCursor ()
 Scrolls the document in order to center the cursor vertically. More...
 
void clear ()
 Deletes all the text in the text edit. More...
 
void copy ()
 Copies any selected text to the clipboard. More...
 
void cut ()
 Copies the selected text to the clipboard and deletes it from the text edit. More...
 
void insertPlainText (const QString &text)
 Convenience slot that inserts text at the current cursor position. More...
 
void paste ()
 Pastes the text from the clipboard into the text edit at the current cursor position. More...
 
void redo ()
 Redoes the last operation. More...
 
void selectAll ()
 Selects all text. More...
 
void setPlainText (const QString &text)
 Changes the text of the text edit to the string text. More...
 
void undo ()
 Undoes the last operation. More...
 
- Public Slots inherited from QWidget
bool close ()
 Closes this widget. More...
 
void hide ()
 Hides the widget. More...
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack. More...
 
void raise ()
 Raises this widget to the top of the parent widget's stack. More...
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. More...
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events. More...
 
void setEnabled (bool)
 
void setFocus ()
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More...
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden). More...
 
QT_MOC_COMPAT void setShown (bool shown)
 Use setVisible(shown) instead. More...
 
void setStyleSheet (const QString &styleSheet)
 
virtual void setVisible (bool visible)
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void show ()
 Shows the widget and its child widgets. More...
 
void showFullScreen ()
 Shows the widget in full-screen mode. More...
 
void showMaximized ()
 Shows the widget maximized. More...
 
void showMinimized ()
 Shows the widget minimized, as an icon. More...
 
void showNormal ()
 Restores the widget after it has been maximized or minimized. More...
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 

Signals

void blockCountChanged (int newBlockCount)
 This signal is emitted whenever the block count changes. More...
 
void copyAvailable (bool b)
 This signal is emitted when text is selected or de-selected in the text edit. More...
 
void cursorPositionChanged ()
 This signal is emitted whenever the position of the cursor changed. More...
 
void modificationChanged (bool)
 This signal is emitted whenever the content of the document changes in a way that affects the modification state. More...
 
void redoAvailable (bool b)
 This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false). More...
 
void selectionChanged ()
 This signal is emitted whenever the selection changes. More...
 
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. More...
 
void undoAvailable (bool b)
 This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false). More...
 
void updateRequest (const QRect &rect, int dy)
 This signal is emitted when the text document needs an update of the specified rect. More...
 
- Signals inherited from QWidget
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

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. More...
 
bool backgroundVisible () const
 
int blockCount () const
 
bool canPaste () const
 Returns whether text can be pasted from the clipboard into the textedit. More...
 
bool centerOnScroll () const
 
QMenucreateStandardContextMenu ()
 This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. More...
 
QTextCharFormat currentCharFormat () const
 Returns the char format that is used when inserting new text. More...
 
QTextCursor cursorForPosition (const QPoint &pos) const
 returns a QTextCursor at position pos (in viewport coordinates). More...
 
QRect cursorRect (const QTextCursor &cursor) const
 returns a rectangle (in viewport coordinates) that includes the cursor. More...
 
QRect cursorRect () const
 returns a rectangle (in viewport coordinates) that includes the cursor of the text edit. More...
 
int cursorWidth () const
 
QTextDocumentdocument () const
 Returns a pointer to the underlying document. More...
 
QString documentTitle () const
 
void ensureCursorVisible ()
 Ensures that the cursor is visible by scrolling the text edit if necessary. More...
 
QList< QTextEdit::ExtraSelectionextraSelections () const
 Returns previously set extra selections. More...
 
bool find (const QString &exp, QTextDocument::FindFlags options=0)
 Finds the next occurrence of the string, exp, using the given options. More...
 
bool isReadOnly () const
 
bool isUndoRedoEnabled () const
 
LineWrapMode lineWrapMode () const
 
virtual QVariant loadResource (int type, const QUrl &name)
 Loads the resource specified by the given type and name. More...
 
int maximumBlockCount () 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. More...
 
void moveCursor (QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode=QTextCursor::MoveAnchor)
 Moves the cursor by performing the given operation. More...
 
bool overwriteMode () const
 
void print (QPrinter *printer) const
 Convenience function to print the text edit's document to the given printer. More...
 
 QPlainTextEdit (QWidget *parent=0)
 Constructs an empty QPlainTextEdit with parent parent. More...
 
 QPlainTextEdit (const QString &text, QWidget *parent=0)
 Constructs a QPlainTextEdit with parent parent. More...
 
void setBackgroundVisible (bool visible)
 
void setCenterOnScroll (bool enabled)
 
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. More...
 
void setCursorWidth (int width)
 
void setDocument (QTextDocument *document)
 Makes document the new document of the text editor. More...
 
void setDocumentTitle (const QString &title)
 
void setExtraSelections (const QList< QTextEdit::ExtraSelection > &selections)
 This function allows temporarily marking certain regions in the document with a given color, specified as selections. More...
 
void setLineWrapMode (LineWrapMode mode)
 
void setMaximumBlockCount (int maximum)
 
void setOverwriteMode (bool overwrite)
 
void setReadOnly (bool ro)
 
void setTabChangesFocus (bool b)
 
void setTabStopWidth (int width)
 
void setTextCursor (const QTextCursor &cursor)
 Sets the visible cursor. More...
 
void setTextInteractionFlags (Qt::TextInteractionFlags flags)
 
void setUndoRedoEnabled (bool enable)
 
void setWordWrapMode (QTextOption::WrapMode policy)
 
bool tabChangesFocus () const
 
int tabStopWidth () const
 
QTextCursor textCursor () const
 Returns a copy of the QTextCursor that represents the currently visible cursor. More...
 
Qt::TextInteractionFlags textInteractionFlags () const
 
QString toPlainText () const
 Returns the text of the text edit as plain text. More...
 
QTextOption::WrapMode wordWrapMode () const
 the mode QPlainTextEdit will use when wrapping text by words More...
 
virtual ~QPlainTextEdit ()
 Destructor. More...
 
- Public Functions inherited from QAbstractScrollArea
void addScrollBarWidget (QWidget *widget, Qt::Alignment alignment)
 Adds widget as a scroll bar widget in the location specified by alignment. More...
 
QWidgetcornerWidget () const
 Returns the widget in the corner between the two scroll bars. More...
 
QScrollBarhorizontalScrollBar () const
 Returns the horizontal scroll bar. More...
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const
 
QSize maximumViewportSize () const
 Returns the size of the viewport as if the scroll bars had no valid scrolling range. More...
 
QSize minimumSizeHint () const
 Reimplemented Function More...
 
 QAbstractScrollArea (QWidget *parent=0)
 Constructs a viewport. More...
 
QWidgetList scrollBarWidgets (Qt::Alignment alignment)
 Returns a list of the currently set scroll bar widgets. More...
 
void setCornerWidget (QWidget *widget)
 Sets the widget in the corner between the two scroll bars to be widget. More...
 
void setHorizontalScrollBar (QScrollBar *scrollbar)
 Replaces the existing horizontal scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. More...
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setVerticalScrollBar (QScrollBar *scrollbar)
 Replaces the existing vertical scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. More...
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 Sets the viewport to be the given widget. More...
 
QSize sizeHint () const
 Reimplemented Function More...
 
QScrollBarverticalScrollBar () const
 Returns the vertical scroll bar. More...
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const
 
QWidgetviewport () const
 Returns the viewport widget. More...
 
 ~QAbstractScrollArea ()
 Destroys the viewport. More...
 
- Public Functions inherited from QFrame
QRect frameRect () const
 
Shadow frameShadow () const
 
Shape frameShape () const
 
int frameStyle () const
 Returns the frame style. More...
 
int frameWidth () const
 
int lineWidth () const
 
int midLineWidth () const
 
 QFrame (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a frame widget with frame style NoFrame and a 1-pixel frame width. More...
 
void setFrameRect (const QRect &)
 em>Reimplemented Function More...
 
void setFrameShadow (Shadow)
 
void setFrameShape (Shape)
 
void setFrameStyle (int)
 Sets the frame style to style. More...
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
QSize sizeHint () const
 em>Reimplemented Function More...
 
 ~QFrame ()
 Destroys the frame. More...
 
- Public Functions inherited from QWidget
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions. More...
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window. More...
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions. More...
 
void addActions (QList< QAction *> actions)
 Appends the actions actions to this widget's list of actions. More...
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents. More...
 
bool autoFillBackground () const
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget. More...
 
QSize baseSize () const
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. More...
 
QWidgetchildAt (const QPoint &p) const
 Returns the visible child widget at point p in the widget's own coordinate system. More...
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 Takes keyboard input focus from the widget. More...
 
void clearMask ()
 Removes any mask set by setMask(). More...
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins. More...
 
QRect contentsRect () const
 Returns the area inside the widget's margins. More...
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void createWinId ()
 
QCursor cursor () const
 
int devType () const
 
WId effectiveWinId () const
 Returns the effective window system identifier of the widget, i. More...
 
void ensurePolished () const
 Ensures that the widget has been polished by QStyle (i.e., has a proper font and palette). More...
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 Returns the focus proxy, or 0 if there is no focus proxy. More...
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on. More...
 
const QFontfont () const
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font. More...
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font. More...
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role. More...
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 Returns the widget's contents margins for left, top, right, and bottom. More...
 
HDC getDC () const
 Returns the window system handle of the widget, for low-level access. More...
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags. More...
 
void grabKeyboard ()
 Grabs the keyboard input. More...
 
void grabMouse ()
 Grabs the mouse input. More...
 
void grabMouse (const QCursor &)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. More...
 
QGraphicsEffectgraphicsEffect () const
 The graphicsEffect function returns a pointer to the widget's graphics effect. More...
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0. More...
 
bool hasFocus () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w. More...
 
QInputContextinputContext ()
 This function returns the QInputContext for this widget. More...
 
Qt::InputMethodHints inputMethodHints () const
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before. More...
 
void insertActions (QAction *before, QList< QAction *> actions)
 Inserts the actions actions to this widget's list of actions, before the action before. More...
 
WId internalWinId () const
 Returns the window system identifier of the widget, or 0 if the widget is not created yet. More...
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false. More...
 
bool isEnabled () const
 
bool isEnabledTo (QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false. More...
 
bool isEnabledToTLW () const
 This function is deprecated. More...
 
bool isFullScreen () const
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false. More...
 
bool isLeftToRight () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isRightToLeft () const
 
bool isTopLevel () const
 Use isWindow() instead. More...
 
bool isVisible () const
 
bool isVisibleTo (QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false. More...
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false. More...
 
bool isWindowModified () const
 
QLayoutlayout () const
 Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed. More...
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
Qt::HANDLE macCGHandle () const
 Returns the CoreGraphics handle of the widget. More...
 
Qt::HANDLE macQDHandle () const
 Returns the QuickDraw handle of the widget. More...
 
QPoint mapFrom (QWidget *, const QPoint &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. More...
 
QPoint mapFromGlobal (const QPoint &) const
 Translates the global screen coordinate pos to widget coordinates. More...
 
QPoint mapFromParent (const QPoint &) const
 Translates the parent widget coordinate pos to widget coordinates. More...
 
QPoint mapTo (QWidget *, const QPoint &) const
 Translates the widget coordinate pos to the coordinate system of parent. More...
 
QPoint mapToGlobal (const QPoint &) const
 Translates the widget coordinate pos to global screen coordinates. More...
 
QPoint mapToParent (const QPoint &) const
 Translates the widget coordinate pos to a coordinate in the parent widget. More...
 
QRegion mask () const
 Returns the mask currently set on a widget. More...
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (int x, int y)
 This corresponds to move(QPoint(x, y)). More...
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 Returns the native parent for this widget, i. More...
 
QWidgetnextInFocusChain () const
 Returns the next widget in this widget's focus chain. More...
 
QRect normalGeometry () const
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system. More...
 
void overrideWindowState (Qt::WindowStates state)
 
QPaintEnginepaintEngine () const
 Returns the widget's paint engine. More...
 
const QPalettepalette () const
 
QWidgetparentWidget () const
 Returns the parent of this widget, or 0 if it does not have any parent widget. More...
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain. More...
 
 QWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a widget which is a child of parent, with widget flags set to f. More...
 
QRect rect () const
 
void releaseDC (HDC) const
 Releases the HDC hdc acquired by a previous call to getDC(). More...
 
void releaseKeyboard ()
 Releases the keyboard grab. More...
 
void releaseMouse ()
 Releases the mouse grab. More...
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system. More...
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions. More...
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. More...
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 Renders the widget into the painter's QPainter::device(). More...
 
void repaint (int x, int y, int w, int h)
 This version repaints a rectangle (x, y, w, h) inside the widget. More...
 
void repaint (const QRect &)
 This version repaints a rectangle rect inside the widget. More...
 
void repaint (const QRegion &)
 This version repaints a region rgn inside the widget. More...
 
void resize (int w, int h)
 This corresponds to resize(QSize(w, h)). More...
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 Restores the geometry and state top-level widgets stored in the byte array geometry. More...
 
QByteArray saveGeometry () const
 Saves the current geometry and state for top-level widgets. More...
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward. More...
 
void scroll (int dx, int dy, const QRect &)
 This version only scrolls r and does not move the children of the widget. More...
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. More...
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role. More...
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This corresponds to setBaseSize(QSize(basew, baseh)). More...
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. More...
 
void setContentsMargins (const QMargins &margins)
 The setContentsMargins function sets the margins around the widget's contents. More...
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths. More...
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. More...
 
void setFixedSize (int w, int h)
 Sets the width of the widget to w and the height to h. More...
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights. More...
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More...
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w. More...
 
void setFont (const QFont &)
 Use the single-argument overload instead. More...
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role. More...
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)). More...
 
void setGeometry (const QRect &)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 The setGraphicsEffect function is for setting the widget's graphics effect. More...
 
void setInputContext (QInputContext *)
 This function sets the input context context on this widget. More...
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout. More...
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. More...
 
void setMask (const QRegion &)
 Causes only the parts of the widget which overlap region to be visible. More...
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This function corresponds to setMaximumSize(QSize(maxw, maxh)). More...
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This function corresponds to setMinimumSize(QSize(minw, minh)). More...
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 Use the single-argument overload instead. More...
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags. More...
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This function also takes widget flags, f as an argument. More...
 
void setShortcutAutoRepeat (int id, bool enable=true)
 If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled. More...
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. More...
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 Sets the x (width) size increment to w and the y (height) size increment to h. More...
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. More...
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style. More...
 
void setToolTip (const QString &)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 Sets up the user interface for the specified widget. More...
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &)
 Sets the window's role to role. More...
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState. More...
 
void setWindowSurface (QWindowSurface *surface)
 Sets the window surface to be the surface specified. More...
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack. More...
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false. More...
 
QString toolTip () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false. More...
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type. More...
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 This version updates a rectangle (x, y, w, h) inside the widget. More...
 
void update (const QRect &)
 This version updates a rectangle rect inside the widget. More...
 
void update (const QRegion &)
 This version repaints a region rgn inside the widget. More...
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry. More...
 
bool updatesEnabled () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur. More...
 
QString whatsThis () const
 
int width () const
 
QWidgetwindow () const
 Returns the window for this widget, i.e. More...
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e. More...
 
QIcon windowIcon () const
 
QString windowIconText () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 Returns the window's role, or an empty string. More...
 
Qt::WindowStates windowState () const
 Returns the current window state. More...
 
QWindowSurfacewindowSurface () const
 Returns the QWindowSurface this widget will be drawn into. More...
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 Returns the window type of this widget. More...
 
WId winId () const
 Returns the window system identifier of the widget. More...
 
int x () const
 
const QX11Infox11Info () const
 Returns information about the configuration of the X display used to display the widget. More...
 
Qt::HANDLE x11PictureHandle () const
 Returns the X11 Picture handle of the widget for XRender support. More...
 
int y () const
 
 ~QWidget ()
 Destroys the widget. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 
- Public Functions inherited from QPaintDevice
int colorCount () const
 
int depth () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
QT_DEPRECATED int numColors () const
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 
virtual ~QPaintDevice ()
 

Protected Functions

QRectF blockBoundingGeometry (const QTextBlock &block) const
 Returns the bounding rectangle of the text block in content coordinates. More...
 
QRectF blockBoundingRect (const QTextBlock &block) const
 Returns the bounding rectangle of the text block in the block's own coordinates. More...
 
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. More...
 
virtual void changeEvent (QEvent *e)
 Reimplemented Function More...
 
QPointF contentOffset () const
 Returns the content's origin in viewport coordinates. More...
 
virtual void contextMenuEvent (QContextMenuEvent *e)
 Shows the standard context menu created with createStandardContextMenu(). More...
 
virtual QMimeDatacreateMimeDataFromSelection () const
 This function returns a new MIME data object to represent the contents of the text edit's current selection. More...
 
virtual void dragEnterEvent (QDragEnterEvent *e)
 Reimplemented Function More...
 
virtual void dragLeaveEvent (QDragLeaveEvent *e)
 Reimplemented Function More...
 
virtual void dragMoveEvent (QDragMoveEvent *e)
 Reimplemented Function More...
 
virtual void dropEvent (QDropEvent *e)
 Reimplemented Function More...
 
virtual bool event (QEvent *e)
 
QTextBlock firstVisibleBlock () const
 Returns the first visible block. More...
 
virtual void focusInEvent (QFocusEvent *e)
 Reimplemented Function More...
 
virtual bool focusNextPrevChild (bool next)
 Reimplemented Function More...
 
virtual void focusOutEvent (QFocusEvent *e)
 Reimplemented Function More...
 
QAbstractTextDocumentLayout::PaintContext getPaintContext () const
 Returns the paint context for the viewport(), useful only when reimplementing paintEvent(). More...
 
virtual void inputMethodEvent (QInputMethodEvent *)
 Reimplemented Function More...
 
QVariant inputMethodQuery (Qt::InputMethodQuery property) const
 This method is only relevant for input widgets. More...
 
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. More...
 
virtual void keyPressEvent (QKeyEvent *e)
 Reimplemented Function More...
 
virtual void keyReleaseEvent (QKeyEvent *e)
 Reimplemented Function More...
 
virtual void mouseDoubleClickEvent (QMouseEvent *e)
 Reimplemented Function More...
 
virtual void mouseMoveEvent (QMouseEvent *e)
 Reimplemented Function More...
 
virtual void mousePressEvent (QMouseEvent *e)
 Reimplemented Function More...
 
virtual void mouseReleaseEvent (QMouseEvent *e)
 Reimplemented Function More...
 
virtual void paintEvent (QPaintEvent *e)
 Reimplemented Function More...
 
 QPlainTextEdit (QPlainTextEditPrivate &dd, QWidget *parent)
 
virtual void resizeEvent (QResizeEvent *e)
 Reimplemented Function More...
 
virtual void scrollContentsBy (int dx, int dy)
 em>Reimplemented Function More...
 
virtual void showEvent (QShowEvent *)
 Reimplemented Function More...
 
virtual void timerEvent (QTimerEvent *e)
 
virtual void wheelEvent (QWheelEvent *e)
 Reimplemented Function More...
 
- Protected Functions inherited from QAbstractScrollArea
 QAbstractScrollArea (QAbstractScrollAreaPrivate &dd, QWidget *parent=0)
 Creates a new QAbstractScrollAreaPrivate, dd with the given parent. More...
 
void setViewportMargins (int left, int top, int right, int bottom)
 Sets the margins around the scrolling area to left, top, right and bottom. More...
 
void setViewportMargins (const QMargins &margins)
 Sets margins around the scrolling area. More...
 
virtual bool viewportEvent (QEvent *)
 The main event handler for the scrolling area (the viewport() widget). More...
 
- Protected Functions inherited from QFrame
void drawFrame (QPainter *)
 em>Reimplemented Function More...
 
 QFrame (QFramePrivate &dd, QWidget *parent=0, Qt::WindowFlags f=0)
 
- Protected Functions inherited from QWidget
virtual void actionEvent (QActionEvent *)
 This event handler is called with the given event whenever the widget's actions are changed. More...
 
virtual void closeEvent (QCloseEvent *)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system. More...
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window if window is 0, otherwise sets the widget's window to window. More...
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources. More...
 
virtual void enabledChange (bool)
 
virtual void enterEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. More...
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for Tab, and returns true if it can find a new widget, or false if it can't. More...
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for Shift+Tab, and returns true if it can find a new widget, or false if it can't. More...
 
virtual void fontChange (const QFont &)
 
virtual void hideEvent (QHideEvent *)
 This event handler can be reimplemented in a subclass to receive widget hide events. More...
 
virtual void languageChange ()
 
virtual void leaveEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. More...
 
virtual bool macEvent (EventHandlerCallRef, EventRef)
 This special event handler can be reimplemented in a subclass to receive native Macintosh events. More...
 
int metric (PaintDeviceMetric) const
 Internal implementation of the virtual QPaintDevice::metric() function. More...
 
virtual void moveEvent (QMoveEvent *)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. More...
 
virtual void paletteChange (const QPalette &)
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
virtual bool qwsEvent (QWSEvent *)
 This special event handler can be reimplemented in a subclass to receive native Qt for Embedded Linux events which are passed in the event parameter. More...
 
void resetInputContext ()
 This function can be called on the widget that currently has focus to reset the input method operating on it. More...
 
virtual void styleChange (QStyle &)
 
virtual void tabletEvent (QTabletEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive tablet events for the widget. More...
 
virtual void windowActivationChange (bool)
 
virtual bool winEvent (MSG *message, long *result)
 This special event handler can be reimplemented in a subclass to receive native Windows events which are passed in the message parameter. More...
 
virtual bool x11Event (XEvent *)
 This special event handler can be reimplemented in a subclass to receive native X11 events passed in the event parameter. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
- Protected Functions inherited from QPaintDevice
 QPaintDevice ()
 

Properties

bool backgroundVisible
 whether the palette background is visible outside the document area More...
 
int blockCount
 the number of text blocks in the document. More...
 
bool centerOnScroll
 whether the cursor should be centered on screen More...
 
int cursorWidth
 This property specifies the width of the cursor in pixels. More...
 
QString documentTitle
 the title of the document parsed from the text. More...
 
LineWrapMode lineWrapMode
 the line wrap mode More...
 
int maximumBlockCount
 the limit for blocks in the document. More...
 
bool overwriteMode
 whether text entered by the user will overwrite existing text More...
 
QString plainText
 This property gets and sets the plain text editor's contents. More...
 
bool readOnly
 whether the text edit is read-only More...
 
bool tabChangesFocus
 whether Tab changes focus or is accepted as input More...
 
int tabStopWidth
 the tab stop width in pixels More...
 
Qt::TextInteractionFlags textInteractionFlags
 Specifies how the label should interact with user input if it displays text. More...
 
bool undoRedoEnabled
 whether undo and redo are enabled More...
 

Friends

class QPlainTextEditControl
 

Additional Inherited Members

- Static Public Functions inherited from QWidget
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifer/handle id. More...
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input. More...
 
static QWidgetmouseGrabber ()
 Returns the widget that is currently grabbing the mouse input. More...
 
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Functions inherited from QPaintDevice
static QWSDisplayqwsDisplay ()
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Slots inherited from QAbstractScrollArea
void setupViewport (QWidget *viewport)
 This slot is called by QAbstractScrollArea after setViewport(viewport) has been called. More...
 
- Protected Slots inherited from QWidget
void updateMicroFocus ()
 Updates the widget's micro focus. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Variables inherited from QPaintDevice
ushort painters
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QPlainTextEdit class provides a widget that is used to edit and display plain text.

Since
4.4

Introduction and Concepts

QPlainTextEdit is an advanced viewer/editor supporting plain text. It is optimized to handle large documents and to respond quickly to user input.

QPlainText uses very much the same technology and concepts as QTextEdit, but is optimized for plain text handling.

QPlainTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signifies a paragraph. A document consists of zero or more paragraphs. Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.

The shape of the mouse cursor on a QPlainTextEdit is Qt::IBeamCursor by default. It can be changed through the viewport()'s cursor property.

Using QPlainTextEdit as a Display Widget

The text is set or replaced using setPlainText() which deletes the existing text and replaces it with the text passed to setPlainText().

Text can be inserted using the QTextCursor class or using the convenience functions insertPlainText(), appendPlainText() or paste().

By default, the text edit wraps words at whitespace to fit within the text edit widget. The setLineWrapMode() function is used to specify the kind of line wrap you want, WidgetWidth or NoWrap if you don't want any wrapping. If you use word wrap to the widget's width WidgetWidth , you can specify whether to break on whitespace or anywhere with setWordWrapMode().

The find() function can be used to find and select a given string within the text.

If you want to limit the total number of paragraphs in a QPlainTextEdit, as it is for example useful in a log viewer, then you can use the maximumBlockCount property. The combination of setMaximumBlockCount() and appendPlainText() turns QPlainTextEdit into an efficient viewer for log text. The scrolling can be reduced with the centerOnScroll() property, making the log viewer even faster. Text can be formatted in a limited way, either using a syntax highlighter (see below), or by appending html-formatted text with appendHtml(). While QPlainTextEdit does not support complex rich text rendering with tables and floats, it does support limited paragraph-based formatting that you may need in a log viewer.

Read-only Key Bindings

When QPlainTextEdit is used read-only the key bindings are limited to navigation, and text may only be selected with the mouse:

Keypresses Action
Qt::UpArrow Moves one line up.
Qt::DownArrow Moves one line down.
Qt::LeftArrow Moves one character to the left.
Qt::RightArrow Moves one character to the right.
PageUp Moves one (viewport) page up.
PageDown Moves one (viewport) page down.
Home Moves to the beginning of the text.
End Moves to the end of the text.
Alt+Wheel Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel Zooms the text.
Ctrl+A Selects all text.

Using QPlainTextEdit as an Editor

All the information about using QPlainTextEdit as a display widget also applies here.

Selection of text is handled by the QTextCursor class, which provides functionality for creating selections, retrieving the text contents or deleting selections. You can retrieve the object that corresponds with the user-visible cursor using the textCursor() method. If you want to set a selection in QPlainTextEdit just create one on a QTextCursor object and then make that cursor the visible cursor using setCursor(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). The entire text can be selected using selectAll().

QPlainTextEdit holds a QTextDocument object which can be retrieved using the document() method. You can also set your own document object using setDocument(). QTextDocument emits a textChanged() signal if the text changes and it also provides a isModified() function which will return true if the text has been modified since it was either loaded or since the last call to setModified with false as argument. In addition it provides methods for undo and redo.

Syntax Highlighting

Just like QTextEdit, QPlainTextEdit works together with QSyntaxHighlighter.

Editing Key Bindings

The list of key bindings which are implemented for editing:

Keypresses Action
Backspace Deletes the character to the left of the cursor.
Delete Deletes the character to the right of the cursor.
Ctrl+C Copy the selected text to the clipboard.
Ctrl+Insert Copy the selected text to the clipboard.
Ctrl+K Deletes to the end of the line.
Ctrl+V Pastes the clipboard text into text edit.
Shift+Insert Pastes the clipboard text into text edit.
Ctrl+X Deletes the selected text and copies it to the clipboard.
Shift+Delete Deletes the selected text and copies it to the clipboard.
Ctrl+Z Undoes the last operation.
Ctrl+Y Redoes the last operation.
LeftArrow Moves the cursor one character to the left.
Ctrl+LeftArrow Moves the cursor one word to the left.
RightArrow Moves the cursor one character to the right.
Ctrl+RightArrow Moves the cursor one word to the right.
UpArrow Moves the cursor one line up.
Ctrl+UpArrow Moves the cursor one word up.
DownArrow Moves the cursor one line down.
Ctrl+Down Arrow Moves the cursor one word down.
PageUp Moves the cursor one page up.
PageDown Moves the cursor one page down.
Home Moves the cursor to the beginning of the line.
Ctrl+Home Moves the cursor to the beginning of the text.
End Moves the cursor to the end of the line.
Ctrl+End Moves the cursor to the end of the text.
Alt+Wheel Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel Zooms the text.

To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, Shift+Right Arrow will select the character to the right, and Shift+Ctrl+Right Arrow will select the word to the right, etc.

Differences to QTextEdit

QPlainTextEdit is a thin class, implemented by using most of the technology that is behind QTextEdit and QTextDocument. Its performance benefits over QTextEdit stem mostly from using a different and simplified text layout called QPlainTextDocumentLayout on the text document (see QTextDocument::setDocumentLayout()). The plain text document layout does not support tables nor embedded frames, and replaces a pixel-exact height calculation with a line-by-line respectively paragraph-by-paragraph scrolling approach. This makes it possible to handle significantly larger documents, and still resize the editor with line wrap enabled in real time. It also makes for a fast log viewer (see setMaximumBlockCount()).

See also
QTextDocument, QTextCursor, {Application Example}, {Code Editor Example}, {Syntax Highlighter Example}, {Rich Text Processing}

Definition at line 69 of file qplaintextedit.h.

Enumerations

◆ LineWrapMode

  • NoWrap
  • WidgetWidth
Enumerator
NoWrap 
WidgetWidth 

Definition at line 90 of file qplaintextedit.h.

Constructors and Destructors

◆ QPlainTextEdit() [1/3]

QPlainTextEdit::QPlainTextEdit ( QWidget parent = 0)
explicit

Constructs an empty QPlainTextEdit with parent parent.

Definition at line 1244 of file qplaintextedit.cpp.

1246 {
1248  d->init();
1249 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QAbstractScrollArea(QWidget *parent=0)
Constructs a viewport.

◆ QPlainTextEdit() [2/3]

QPlainTextEdit::QPlainTextEdit ( const QString text,
QWidget parent = 0 
)
explicit

Constructs a QPlainTextEdit with parent parent.

The text edit will display the plain text text.

Definition at line 1265 of file qplaintextedit.cpp.

1267 {
1269  d->init(text);
1270 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QAbstractScrollArea(QWidget *parent=0)
Constructs a viewport.

◆ ~QPlainTextEdit()

QPlainTextEdit::~QPlainTextEdit ( )
virtual

Destructor.

Definition at line 1276 of file qplaintextedit.cpp.

1277 {
1279  if (d->documentLayoutPtr) {
1280  if (d->documentLayoutPtr->priv()->mainViewPrivate == d)
1281  d->documentLayoutPtr->priv()->mainViewPrivate = 0;
1282  }
1283 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ QPlainTextEdit() [3/3]

QPlainTextEdit::QPlainTextEdit ( QPlainTextEditPrivate dd,
QWidget parent 
)
protected
Warning
This function is not part of the public interface.

Definition at line 1254 of file qplaintextedit.cpp.

1255  : QAbstractScrollArea(dd, parent)
1256 {
1258  d->init();
1259 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QAbstractScrollArea(QWidget *parent=0)
Constructs a viewport.

Functions

◆ anchorAt()

QString QPlainTextEdit::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.

Since
4.7

Definition at line 1359 of file qplaintextedit.cpp.

1360 {
1361  Q_D(const QPlainTextEdit);
1362  int cursorPos = d->control->hitTest(pos + QPointF(d->horizontalOffset(),
1363  d->verticalOffset()),
1364  Qt::ExactHit);
1365  if (cursorPos < 0)
1366  return QString();
1367 
1368  QTextDocumentPrivate *pieceTable = document()->docHandle();
1369  QTextDocumentPrivate::FragmentIterator it = pieceTable->find(cursorPos);
1370  QTextCharFormat fmt = pieceTable->formatCollection()->charFormat(it->format);
1371  return fmt.anchorHref();
1372 }
double d
Definition: qnumeric_p.h:62
QTextCharFormat charFormat(int index) const
Definition: qtextformat_p.h:85
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
#define it(className, varName)
QTextDocument * document() const
Returns a pointer to the underlying document.
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
QString anchorHref() const
Returns the text format&#39;s hypertext link, or an empty string if none has been set.
Definition: qtextformat.h:506
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_D(Class)
Definition: qglobal.h:2482
FragmentMap::ConstIterator FragmentIterator
FragmentIterator find(int pos) const
QTextDocumentPrivate * docHandle() const
So that not all classes have to be friends of each other.
QTextFormatCollection * formatCollection()
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ appendHtml

void QPlainTextEdit::appendHtml ( const QString html)
slot

Appends a new paragraph with html to the end of the text edit.

appendPlainText()

Definition at line 2914 of file qplaintextedit.cpp.

2915 {
2917  d->append(html, Qt::RichText);
2918 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ appendPlainText

void QPlainTextEdit::appendPlainText ( const QString text)
slot

Appends a new paragraph with text to the end of the text edit.

See also
appendHtml()

Definition at line 2902 of file qplaintextedit.cpp.

2903 {
2905  d->append(text, Qt::PlainText);
2906 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ backgroundVisible()

bool QPlainTextEdit::backgroundVisible ( ) const

Referenced by paintEvent(), and setWordWrapMode().

◆ blockBoundingGeometry()

QRectF QPlainTextEdit::blockBoundingGeometry ( const QTextBlock block) const
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.

See also
firstVisibleBlock(), blockBoundingRect()

Definition at line 2996 of file qplaintextedit.cpp.

Referenced by QScriptEdit::extraAreaPaintEvent().

2997 {
2998  Q_D(const QPlainTextEdit);
2999  return d->control->blockBoundingRect(block);
3000 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ blockBoundingRect()

QRectF QPlainTextEdit::blockBoundingRect ( const QTextBlock block) const
protected

Returns the bounding rectangle of the text block in the block's own coordinates.

See also
blockBoundingGeometry()

Definition at line 3007 of file qplaintextedit.cpp.

Referenced by QScriptEdit::extraAreaPaintEvent(), and paintEvent().

3008 {
3010  Q_ASSERT(documentLayout);
3011  return documentLayout->blockBoundingRect(block);
3012 }
The QPlainTextDocumentLayout class implements a plain text layout for QTextDocument.
QTextDocument * document() const
Returns a pointer to the underlying document.
T * qobject_cast(QObject *object)
Definition: qobject.h:375
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
QAbstractTextDocumentLayout * documentLayout() const
Returns the document layout for this document.
QRectF blockBoundingRect(const QTextBlock &block) const
Reimplemented Function

◆ blockCount()

int QPlainTextEdit::blockCount ( ) const

◆ blockCountChanged

void QPlainTextEdit::blockCountChanged ( int  newBlockCount)
signal

This signal is emitted whenever the block count changes.

The new block count is passed in newBlockCount.

Referenced by QScriptEdit::QScriptEdit().

◆ canInsertFromMimeData()

bool QPlainTextEdit::canInsertFromMimeData ( const QMimeData source) const
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 2407 of file qplaintextedit.cpp.

Referenced by QPlainTextEditControl::canInsertFromMimeData().

2408 {
2409  Q_D(const QPlainTextEdit);
2410  return d->control->QTextControl::canInsertFromMimeData(source);
2411 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ canPaste()

bool QPlainTextEdit::canPaste ( ) const

Returns whether text can be pasted from the clipboard into the textedit.

Definition at line 2555 of file qplaintextedit.cpp.

2556 {
2557  Q_D(const QPlainTextEdit);
2558  return d->control->canPaste();
2559 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ centerCursor

void QPlainTextEdit::centerCursor ( )
slot

Scrolls the document in order to center the cursor vertically.

See also
ensureCursorVisible(), centerOnScroll

Definition at line 2953 of file qplaintextedit.cpp.

Referenced by QScriptEdit::gotoLine().

2954 {
2956  d->ensureVisible(textCursor().position(), true, true);
2957 }
double d
Definition: qnumeric_p.h:62
static qreal position(QGraphicsObject *item, QDeclarativeAnchorLine::AnchorLine anchorLine)
QTextCursor textCursor() const
Returns a copy of the QTextCursor that represents the currently visible cursor.
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ centerOnScroll()

bool QPlainTextEdit::centerOnScroll ( ) const

◆ changeEvent()

void QPlainTextEdit::changeEvent ( QEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QFrame.

Definition at line 2202 of file qplaintextedit.cpp.

2203 {
2207  || e->type() == QEvent::FontChange) {
2208  d->control->document()->setDefaultFont(font());
2209  } else if(e->type() == QEvent::ActivationChange) {
2210  if (!isActiveWindow())
2211  d->autoScrollTimer.stop();
2212  } else if (e->type() == QEvent::EnabledChange) {
2213  e->setAccepted(isEnabled());
2214  d->sendControlEvent(e);
2215  } else if (e->type() == QEvent::PaletteChange) {
2216  d->control->setPalette(palette());
2217  } else if (e->type() == QEvent::LayoutDirectionChange) {
2218  d->sendControlEvent(e);
2219  }
2220 }
double d
Definition: qnumeric_p.h:62
void setAccepted(bool accepted)
Definition: qcoreevent.h:306
bool isActiveWindow() const
#define Q_D(Class)
Definition: qglobal.h:2482
void changeEvent(QEvent *)
This event handler can be reimplemented to handle state changes.
Definition: qframe.cpp:574
const QPalette & palette() const
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
bool isEnabled() const
Definition: qwidget.h:948
const QFont & font() const
Type type() const
Returns the event type.
Definition: qcoreevent.h:303

◆ clear

void QPlainTextEdit::clear ( )
slot

Deletes all the text in the text edit.

Note that the undo/redo history is cleared by this function.

See also
cut() setPlainText()

Definition at line 1464 of file qplaintextedit.cpp.

Referenced by keyPressEvent(), and timerEvent().

1465 {
1467  // clears and sets empty content
1468  d->control->topBlock = d->topLine = d->topLineFracture = 0;
1469  d->control->clear();
1470 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ contentOffset()

QPointF QPlainTextEdit::contentOffset ( ) const
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.

See also
firstVisibleBlock(), horizontalScrollBar(), verticalScrollBar()

Definition at line 2983 of file qplaintextedit.cpp.

Referenced by QScriptEdit::extraAreaPaintEvent(), and paintEvent().

2984 {
2985  Q_D(const QPlainTextEdit);
2986  return QPointF(-d->horizontalOffset(), -d->verticalOffset());
2987 }
double d
Definition: qnumeric_p.h:62
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ contextMenuEvent()

void QPlainTextEdit::contextMenuEvent ( QContextMenuEvent event)
protectedvirtual

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

void MyQPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)
{
menu->addAction(tr("My Menu Item"));
//...
menu->exec(event->globalPos());
delete menu;
}

Reimplemented from QAbstractScrollArea.

Definition at line 2075 of file qplaintextedit.cpp.

2076 {
2078  d->sendControlEvent(e);
2079 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ copy

void QPlainTextEdit::copy ( )
slot

Copies any selected text to the clipboard.

See also
copyAvailable()

Definition at line 1430 of file qplaintextedit.cpp.

1431 {
1433  d->control->copy();
1434 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ copyAvailable

void QPlainTextEdit::copyAvailable ( bool  yes)
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.

See also
selectionChanged()

◆ createMimeDataFromSelection()

QMimeData * QPlainTextEdit::createMimeDataFromSelection ( ) const
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 2395 of file qplaintextedit.cpp.

Referenced by QPlainTextEditControl::createMimeDataFromSelection().

2396 {
2397  Q_D(const QPlainTextEdit);
2398  return d->control->QTextControl::createMimeDataFromSelection();
2399 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ createStandardContextMenu()

QMenu * QPlainTextEdit::createStandardContextMenu ( )

This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button.

It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

Definition at line 2239 of file qplaintextedit.cpp.

2240 {
2242  return d->control->createStandardContextMenu(QPointF(), this);
2243 }
double d
Definition: qnumeric_p.h:62
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ currentCharFormat()

QTextCharFormat QPlainTextEdit::currentCharFormat ( ) const

Returns the char format that is used when inserting new text.

Definition at line 2514 of file qplaintextedit.cpp.

2515 {
2516  Q_D(const QPlainTextEdit);
2517  return d->control->currentCharFormat();
2518 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ cursorForPosition()

QTextCursor QPlainTextEdit::cursorForPosition ( const QPoint pos) const

returns a QTextCursor at position pos (in viewport coordinates).

Definition at line 2249 of file qplaintextedit.cpp.

Referenced by QScriptEdit::extraAreaMouseEvent().

2250 {
2251  Q_D(const QPlainTextEdit);
2252  return d->control->cursorForPosition(d->mapToContents(pos));
2253 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ cursorPositionChanged

void QPlainTextEdit::cursorPositionChanged ( )
signal

This signal is emitted whenever the position of the cursor changed.

Referenced by QScriptEdit::QScriptEdit().

◆ cursorRect() [1/2]

QRect QPlainTextEdit::cursorRect ( const QTextCursor cursor) const

returns a rectangle (in viewport coordinates) that includes the cursor.

Definition at line 2259 of file qplaintextedit.cpp.

2260 {
2261  Q_D(const QPlainTextEdit);
2262  if (cursor.isNull())
2263  return QRect();
2264 
2265  QRect r = d->control->cursorRect(cursor).toRect();
2266  r.translate(-d->horizontalOffset(),-(int)d->verticalOffset());
2267  return r;
2268 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
bool isNull() const
Returns true if the cursor is null; otherwise returns false.
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
void translate(int dx, int dy)
Moves the rectangle dx along the x axis and dy along the y axis, relative to the current position...
Definition: qrect.h:312

◆ cursorRect() [2/2]

QRect QPlainTextEdit::cursorRect ( ) const

returns a rectangle (in viewport coordinates) that includes the cursor of the text edit.

Definition at line 2274 of file qplaintextedit.cpp.

Referenced by event().

2275 {
2276  Q_D(const QPlainTextEdit);
2277  QRect r = d->control->cursorRect().toRect();
2278  r.translate(-d->horizontalOffset(),-(int)d->verticalOffset());
2279  return r;
2280 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
void translate(int dx, int dy)
Moves the rectangle dx along the x axis and dy along the y axis, relative to the current position...
Definition: qrect.h:312

◆ cursorWidth()

int QPlainTextEdit::cursorWidth ( ) const

Referenced by paintEvent(), and setTabStopWidth().

◆ cut

void QPlainTextEdit::cut ( )
slot

Copies the selected text to the clipboard and deletes it from the text edit.

If there is no selected text nothing happens.

See also
copy() paste()

Definition at line 1418 of file qplaintextedit.cpp.

1419 {
1421  d->control->cut();
1422 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ document()

QTextDocument * QPlainTextEdit::document ( ) const

Returns a pointer to the underlying document.

See also
setDocument()

Definition at line 1327 of file qplaintextedit.cpp.

Referenced by anchorAt(), QPlainTextEditPrivate::append(), blockBoundingRect(), event(), QScriptEdit::gotoLine(), keyPressEvent(), paintEvent(), QAccessiblePlainTextEdit::textDocument(), and QScriptEdit::updateExtraSelections().

1328 {
1329  Q_D(const QPlainTextEdit);
1330  return d->control->document();
1331 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ documentTitle()

QString QPlainTextEdit::documentTitle ( ) const
inline

Definition at line 120 of file qplaintextedit.h.

QTextDocument * document() const
Returns a pointer to the underlying document.
QString metaInformation(MetaInformation info) const
Returns meta information about the document of the type specified by info.

◆ dragEnterEvent()

void QPlainTextEdit::dragEnterEvent ( QDragEnterEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2085 of file qplaintextedit.cpp.

2086 {
2088  d->inDrag = true;
2089  d->sendControlEvent(e);
2090 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ dragLeaveEvent()

void QPlainTextEdit::dragLeaveEvent ( QDragLeaveEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2094 of file qplaintextedit.cpp.

2095 {
2097  d->inDrag = false;
2098  d->autoScrollTimer.stop();
2099  d->sendControlEvent(e);
2100 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ dragMoveEvent()

void QPlainTextEdit::dragMoveEvent ( QDragMoveEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2104 of file qplaintextedit.cpp.

2105 {
2107  d->autoScrollDragPos = e->pos();
2108  if (!d->autoScrollTimer.isActive())
2109  d->autoScrollTimer.start(100, this);
2110  d->sendControlEvent(e);
2111 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
const QPoint & pos() const
Returns the position where the drop was made.
Definition: qevent.h:486

◆ dropEvent()

void QPlainTextEdit::dropEvent ( QDropEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2115 of file qplaintextedit.cpp.

2116 {
2118  d->inDrag = false;
2119  d->autoScrollTimer.stop();
2120  d->sendControlEvent(e);
2121 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ ensureCursorVisible()

void QPlainTextEdit::ensureCursorVisible ( )

Ensures that the cursor is visible by scrolling the text edit if necessary.

See also
centerCursor(), centerOnScroll

Definition at line 2942 of file qplaintextedit.cpp.

Referenced by QPlainTextEditControl::ensureCursorVisible(), event(), inputMethodEvent(), setLineWrapMode(), and showEvent().

2943 {
2945  d->ensureCursorVisible(d->centerOnScroll);
2946 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ event()

bool QPlainTextEdit::event ( QEvent e)
protectedvirtual
Warning
This function is not part of the public interface.

Reimplemented from QAbstractScrollArea.

Definition at line 1486 of file qplaintextedit.cpp.

1487 {
1489 
1490 #ifndef QT_NO_CONTEXTMENU
1491  if (e->type() == QEvent::ContextMenu
1492  && static_cast<QContextMenuEvent *>(e)->reason() == QContextMenuEvent::Keyboard) {
1494  const QPoint cursorPos = cursorRect().center();
1495  QContextMenuEvent ce(QContextMenuEvent::Keyboard, cursorPos, d->viewport->mapToGlobal(cursorPos));
1496  ce.setAccepted(e->isAccepted());
1497  const bool result = QAbstractScrollArea::event(&ce);
1498  e->setAccepted(ce.isAccepted());
1499  return result;
1500  }
1501 #endif // QT_NO_CONTEXTMENU
1502  if (e->type() == QEvent::ShortcutOverride
1503  || e->type() == QEvent::ToolTip) {
1504  d->sendControlEvent(e);
1505  }
1506 #ifdef QT_KEYPAD_NAVIGATION
1507  else if (e->type() == QEvent::EnterEditFocus || e->type() == QEvent::LeaveEditFocus) {
1508  if (QApplication::keypadNavigationEnabled())
1509  d->sendControlEvent(e);
1510  }
1511 #endif
1512 #ifndef QT_NO_GESTURES
1513  else if (e->type() == QEvent::Gesture) {
1514  QGestureEvent *ge = static_cast<QGestureEvent *>(e);
1515  QPanGesture *g = static_cast<QPanGesture *>(ge->gesture(Qt::PanGesture));
1516  if (g) {
1517  QScrollBar *hBar = horizontalScrollBar();
1518  QScrollBar *vBar = verticalScrollBar();
1519  if (g->state() == Qt::GestureStarted)
1520  d->originalOffsetY = vBar->value();
1521  QPointF offset = g->offset();
1522  if (!offset.isNull()) {
1524  offset.rx() *= -1;
1525  // QPlainTextEdit scrolls by lines only in vertical direction
1526  QFontMetrics fm(document()->defaultFont());
1527  int lineHeight = fm.height();
1528  int newX = hBar->value() - g->delta().x();
1529  int newY = d->originalOffsetY - offset.y()/lineHeight;
1530  hBar->setValue(newX);
1531  vBar->setValue(newY);
1532  }
1533  }
1534  return true;
1535  }
1536 #endif // QT_NO_GESTURES
1537  return QAbstractScrollArea::event(e);
1538 }
double d
Definition: qnumeric_p.h:62
void ensureCursorVisible()
Ensures that the cursor is visible by scrolling the text edit if necessary.
The QPanGesture class describes a panning gesture made by the user.
Definition: qgesture.h:107
The QFontMetrics class provides font metrics information.
Definition: qfontmetrics.h:65
The QContextMenuEvent class contains parameters that describe a context menu event.
Definition: qevent.h:396
QTextDocument * document() const
Returns a pointer to the underlying document.
void setAccepted(bool accepted)
Definition: qcoreevent.h:306
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
QScrollBar * verticalScrollBar() const
Returns the vertical scroll bar.
QPointF delta
the offset from the previous input position to the current input
Definition: qgesture.h:114
#define Q_D(Class)
Definition: qglobal.h:2482
QRect cursorRect() const
returns a rectangle (in viewport coordinates) that includes the cursor of the text edit...
qreal x() const
Returns the x-coordinate of this point.
Definition: qpoint.h:282
QPointF offset
the total offset from the first input position to the current input position
Definition: qgesture.h:113
The QScrollBar widget provides a vertical or horizontal scroll bar.
Definition: qscrollbar.h:59
int value() const
qreal & rx()
Returns a reference to the x coordinate of this point.
Definition: qpoint.h:302
The QGestureEvent class provides the description of triggered gestures.
Definition: qevent.h:841
bool isAccepted() const
Definition: qcoreevent.h:307
Qt::GestureState state() const
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QPoint center() const
Returns the center point of the rectangle.
Definition: qrect.h:300
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
QScrollBar * horizontalScrollBar() const
Returns the horizontal scroll bar.
bool isNull() const
Returns true if both the x and y coordinates are set to +0.
Definition: qpoint.h:277
qreal y() const
Returns the y-coordinate of this point.
Definition: qpoint.h:287
bool event(QEvent *)
Reimplemented Function
QGesture * gesture(Qt::GestureType type) const
Returns a gesture object by type.
Definition: qevent.cpp:4881
Type type() const
Returns the event type.
Definition: qcoreevent.h:303
static bool isRightToLeft()
Returns true if the application&#39;s layout direction is Qt::RightToLeft; otherwise returns false...
Definition: qapplication.h:233

◆ extraSelections()

QList< QTextEdit::ExtraSelection > QPlainTextEdit::extraSelections ( ) const

Returns previously set extra selections.

See also
setExtraSelections()

Definition at line 2379 of file qplaintextedit.cpp.

Referenced by QScriptEdit::updateExtraSelections().

2380 {
2381  Q_D(const QPlainTextEdit);
2382  return d->control->extraSelections();
2383 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ find()

bool QPlainTextEdit::find ( const QString exp,
QTextDocument::FindFlags  options = 0 
)

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.

Definition at line 2741 of file qplaintextedit.cpp.

Referenced by QScriptDebuggerCodeView::find().

2742 {
2744  return d->control->find(exp, options);
2745 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ firstVisibleBlock()

QTextBlock QPlainTextEdit::firstVisibleBlock ( ) const
protected

Returns the first visible block.

See also
blockBoundingRect()

Definition at line 2964 of file qplaintextedit.cpp.

Referenced by QScriptEdit::extraAreaPaintEvent(), and paintEvent().

2965 {
2966  Q_D(const QPlainTextEdit);
2967  return d->control->firstVisibleBlock();
2968 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ focusInEvent()

void QPlainTextEdit::focusInEvent ( QFocusEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QWidget.

Definition at line 2170 of file qplaintextedit.cpp.

2171 {
2173  if (e->reason() == Qt::MouseFocusReason) {
2174  d->clickCausedFocus = 1;
2175  }
2177  d->sendControlEvent(e);
2178 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
Qt::FocusReason reason()
Definition: qevent.cpp:1197
virtual void focusInEvent(QFocusEvent *)
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus receive...
Definition: qwidget.cpp:9431

◆ focusNextPrevChild()

bool QPlainTextEdit::focusNextPrevChild ( bool  next)
protectedvirtual

Reimplemented Function

Reimplemented from QWidget.

Definition at line 2051 of file qplaintextedit.cpp.

2052 {
2053  Q_D(const QPlainTextEdit);
2054  if (!d->tabChangesFocus && d->control->textInteractionFlags() & Qt::TextEditable)
2055  return false;
2057 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
virtual bool focusNextPrevChild(bool next)
Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can&#39;t.
Definition: qwidget.cpp:6836

◆ focusOutEvent()

void QPlainTextEdit::focusOutEvent ( QFocusEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QWidget.

Definition at line 2182 of file qplaintextedit.cpp.

2183 {
2186  d->sendControlEvent(e);
2187 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
virtual void focusOutEvent(QFocusEvent *)
This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) f...
Definition: qwidget.cpp:9457
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ getPaintContext()

QAbstractTextDocumentLayout::PaintContext QPlainTextEdit::getPaintContext ( ) const
protected

Returns the paint context for the viewport(), useful only when reimplementing paintEvent().

Definition at line 3031 of file qplaintextedit.cpp.

Referenced by paintEvent().

3032 {
3033  Q_D(const QPlainTextEdit);
3034  return d->control->getPaintContext(d->viewport);
3035 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ inputMethodEvent()

void QPlainTextEdit::inputMethodEvent ( QInputMethodEvent e)
protectedvirtual

Reimplemented Function

em>Reimplemented Function

Reimplemented from QWidget.

Definition at line 2127 of file qplaintextedit.cpp.

◆ inputMethodQuery()

QVariant QPlainTextEdit::inputMethodQuery ( Qt::InputMethodQuery  query) const
protectedvirtual

This method is only relevant for input widgets.

It is used by the input method to query a set of properties of the widget to be able to support complex input method operations as support for surrounding text and reconversions.

query specifies which property is queried.

See also
inputMethodEvent(), QInputMethodEvent, QInputContext, inputMethodHints

Reimplemented from QWidget.

Definition at line 2152 of file qplaintextedit.cpp.

2153 {
2154  Q_D(const QPlainTextEdit);
2155  QVariant v = d->control->inputMethodQuery(property);
2156  const QPoint offset(-d->horizontalOffset(), -0);
2157  if (v.type() == QVariant::RectF)
2158  v = v.toRectF().toRect().translated(offset);
2159  else if (v.type() == QVariant::PointF)
2160  v = v.toPointF().toPoint() + offset;
2161  else if (v.type() == QVariant::Rect)
2162  v = v.toRect().translated(offset);
2163  else if (v.type() == QVariant::Point)
2164  v = v.toPoint() + offset;
2165  return v;
2166 }
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
double d
Definition: qnumeric_p.h:62
QPointF toPointF() const
Returns the variant as a QPointF if the variant has type() Point or PointF ; otherwise returns a null...
Definition: qvariant.cpp:2509
QRect translated(int dx, int dy) const
Returns a copy of the rectangle that is translated dx along the x axis and dy along the y axis...
Definition: qrect.h:328
QRectF toRectF() const
Returns the variant as a QRectF if the variant has type() Rect or RectF ; otherwise returns an invali...
Definition: qvariant.cpp:2463
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QRect toRect() const
Returns a QRect based on the values of this rectangle.
Definition: qrect.h:845
QRect toRect() const
Returns the variant as a QRect if the variant has type() Rect ; otherwise returns an invalid QRect...
Definition: qvariant.cpp:2416
QPoint toPoint() const
Rounds the coordinates of this point to the nearest integer, and returns a QPoint object with the rou...
Definition: qpoint.h:376
Type type() const
Returns the storage type of the value stored in the variant.
Definition: qvariant.cpp:1901
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
QVariant property(const char *name) const
Returns the value of the object&#39;s name property.
Definition: qobject.cpp:3807
QPoint toPoint() const
Returns the variant as a QPoint if the variant has type() Point or PointF ; otherwise returns a null ...
Definition: qvariant.cpp:2400

◆ insertFromMimeData()

void QPlainTextEdit::insertFromMimeData ( const QMimeData source)
protectedvirtual

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 2420 of file qplaintextedit.cpp.

Referenced by QPlainTextEditControl::insertFromMimeData().

2421 {
2423  d->control->QTextControl::insertFromMimeData(source);
2424 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ insertPlainText

void QPlainTextEdit::insertPlainText ( const QString text)
slot

Convenience slot that inserts text at the current cursor position.

It is equivalent to

edit->textCursor().insertText(text);

Definition at line 2530 of file qplaintextedit.cpp.

2531 {
2533  d->control->insertPlainText(text);
2534 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ isReadOnly()

bool QPlainTextEdit::isReadOnly ( ) const

Definition at line 2439 of file qplaintextedit.cpp.

Referenced by mouseReleaseEvent(), paintEvent(), and shouldEnableInputMethod().

2440 {
2441  Q_D(const QPlainTextEdit);
2442  return !(d->control->textInteractionFlags() & Qt::TextEditable);
2443 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ isUndoRedoEnabled()

bool QPlainTextEdit::isUndoRedoEnabled ( ) const
inline

Definition at line 123 of file qplaintextedit.h.

124  { return document()->isUndoRedoEnabled(); }
QTextDocument * document() const
Returns a pointer to the underlying document.
bool isUndoRedoEnabled() const

◆ keyPressEvent()

void QPlainTextEdit::keyPressEvent ( QKeyEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 1616 of file qplaintextedit.cpp.

1617 {
1619 
1620 #ifdef QT_KEYPAD_NAVIGATION
1621  switch (e->key()) {
1622  case Qt::Key_Select:
1623  if (QApplication::keypadNavigationEnabled()) {
1624  if (!(d->control->textInteractionFlags() & Qt::LinksAccessibleByKeyboard))
1625  setEditFocus(!hasEditFocus());
1626  else {
1627  if (!hasEditFocus())
1628  setEditFocus(true);
1629  else {
1630  QTextCursor cursor = d->control->textCursor();
1631  QTextCharFormat charFmt = cursor.charFormat();
1632  if (!cursor.hasSelection() || charFmt.anchorHref().isEmpty()) {
1633  setEditFocus(false);
1634  }
1635  }
1636  }
1637  }
1638  break;
1639  case Qt::Key_Back:
1640  case Qt::Key_No:
1641  if (!QApplication::keypadNavigationEnabled()
1642  || (QApplication::keypadNavigationEnabled() && !hasEditFocus())) {
1643  e->ignore();
1644  return;
1645  }
1646  break;
1647  default:
1648  if (QApplication::keypadNavigationEnabled()) {
1649  if (!hasEditFocus() && !(e->modifiers() & Qt::ControlModifier)) {
1650  if (e->text()[0].isPrint()) {
1651  setEditFocus(true);
1652  clear();
1653  } else {
1654  e->ignore();
1655  return;
1656  }
1657  }
1658  }
1659  break;
1660  }
1661 #endif
1662 
1663 #ifndef QT_NO_SHORTCUT
1664 
1665  Qt::TextInteractionFlags tif = d->control->textInteractionFlags();
1666 
1667  if (tif & Qt::TextSelectableByKeyboard){
1669  e->accept();
1671  return;
1672  } else if (e ==QKeySequence::SelectNextPage) {
1673  e->accept();
1675  return;
1676  }
1677  }
1678  if (tif & (Qt::TextSelectableByKeyboard | Qt::TextEditable)) {
1680  e->accept();
1682  return;
1683  } else if (e == QKeySequence::MoveToNextPage) {
1684  e->accept();
1686  return;
1687  }
1688  }
1689 
1690  if (!(tif & Qt::TextEditable)) {
1691  switch (e->key()) {
1692  case Qt::Key_Space:
1693  e->accept();
1694  if (e->modifiers() & Qt::ShiftModifier)
1695  d->vbar->triggerAction(QAbstractSlider::SliderPageStepSub);
1696  else
1697  d->vbar->triggerAction(QAbstractSlider::SliderPageStepAdd);
1698  break;
1699  default:
1700  d->sendControlEvent(e);
1701  if (!e->isAccepted() && e->modifiers() == Qt::NoModifier) {
1702  if (e->key() == Qt::Key_Home) {
1703  d->vbar->triggerAction(QAbstractSlider::SliderToMinimum);
1704  e->accept();
1705  } else if (e->key() == Qt::Key_End) {
1706  d->vbar->triggerAction(QAbstractSlider::SliderToMaximum);
1707  e->accept();
1708  }
1709  }
1710  if (!e->isAccepted()) {
1712  }
1713  }
1714  return;
1715  }
1716 #endif // QT_NO_SHORTCUT
1717 
1718  d->sendControlEvent(e);
1719 #ifdef QT_KEYPAD_NAVIGATION
1720  if (!e->isAccepted()) {
1721  switch (e->key()) {
1722  case Qt::Key_Up:
1723  case Qt::Key_Down:
1724  if (QApplication::keypadNavigationEnabled()) {
1725  // Cursor position didn't change, so we want to leave
1726  // these keys to change focus.
1727  e->ignore();
1728  return;
1729  }
1730  break;
1731  case Qt::Key_Left:
1732  case Qt::Key_Right:
1733  if (QApplication::keypadNavigationEnabled()
1734  && QApplication::navigationMode() == Qt::NavigationModeKeypadDirectional) {
1735  // Same as for Key_Up and Key_Down.
1736  e->ignore();
1737  return;
1738  }
1739  break;
1740  case Qt::Key_Back:
1741  if (!e->isAutoRepeat()) {
1742  if (QApplication::keypadNavigationEnabled()) {
1743  if (document()->isEmpty()) {
1744  setEditFocus(false);
1745  e->accept();
1746  } else if (!d->deleteAllTimer.isActive()) {
1747  e->accept();
1748  d->deleteAllTimer.start(750, this);
1749  }
1750  } else {
1751  e->ignore();
1752  return;
1753  }
1754  }
1755  break;
1756  default: break;
1757  }
1758  }
1759 #endif
1760 }
double d
Definition: qnumeric_p.h:62
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
QTextCharFormat charFormat() const
Returns the format of the character immediately before the cursor position().
QCursor cursor() const
bool isEmpty() const
Returns true if the document is empty; otherwise returns false.
QTextDocument * document() const
Returns a pointer to the underlying document.
QString anchorHref() const
Returns the text format&#39;s hypertext link, or an empty string if none has been set.
Definition: qtextformat.h:506
#define Q_D(Class)
Definition: qglobal.h:2482
Qt::KeyboardModifiers modifiers() const
Returns the keyboard modifier flags that existed immediately after the event occurred.
Definition: qevent.cpp:999
int key() const
Returns the code of the key that was pressed or released.
Definition: qevent.h:231
bool isAccepted() const
Definition: qcoreevent.h:307
bool hasSelection() const
Returns true if the cursor contains a selection; otherwise returns false.
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
void clear()
Deletes all the text in the text edit.
QString text() const
Returns the Unicode text that this key generated.
Definition: qevent.h:236
bool isAutoRepeat() const
Returns true if this event comes from an auto-repeating key; returns false if it comes from an initia...
Definition: qevent.h:237
void ignore()
Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
Definition: qcoreevent.h:310
void accept()
Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
Definition: qcoreevent.h:309
void keyPressEvent(QKeyEvent *)
This function is called with key event e when key presses occur.

◆ keyReleaseEvent()

void QPlainTextEdit::keyReleaseEvent ( QKeyEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QWidget.

Definition at line 1764 of file qplaintextedit.cpp.

1765 {
1766 #ifdef QT_KEYPAD_NAVIGATION
1768  if (QApplication::keypadNavigationEnabled()) {
1769  if (!e->isAutoRepeat() && e->key() == Qt::Key_Back
1770  && d->deleteAllTimer.isActive()) {
1771  d->deleteAllTimer.stop();
1772  QTextCursor cursor = d->control->textCursor();
1773  QTextBlockFormat blockFmt = cursor.blockFormat();
1774 
1775  QTextList *list = cursor.currentList();
1776  if (list && cursor.atBlockStart()) {
1777  list->remove(cursor.block());
1778  } else if (cursor.atBlockStart() && blockFmt.indent() > 0) {
1779  blockFmt.setIndent(blockFmt.indent() - 1);
1780  cursor.setBlockFormat(blockFmt);
1781  } else {
1782  cursor.deletePreviousChar();
1783  }
1784  setTextCursor(cursor);
1785  }
1786  }
1787 #else
1788  Q_UNUSED(e);
1789 #endif
1790 }
double d
Definition: qnumeric_p.h:62
QCursor cursor() const
QTextBlockFormat blockFormat() const
Returns the block format of the block the cursor is in.
bool atBlockStart() const
Returns true if the cursor is at the start of a block; otherwise returns false.
int indent() const
Returns the paragraph&#39;s indent.
Definition: qtextformat.h:590
#define Q_D(Class)
Definition: qglobal.h:2482
int key() const
Returns the code of the key that was pressed or released.
Definition: qevent.h:231
void setBlockFormat(const QTextBlockFormat &format)
Sets the block format of the current block (or all blocks that are contained in the selection) to for...
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QTextList * currentList() const
Returns the current list if the cursor position() is inside a block that is part of a list; otherwise...
QTextBlock block() const
Returns the block that contains the cursor.
void remove(const QTextBlock &)
Removes the given block from the list.
Definition: qtextlist.cpp:319
void deletePreviousChar()
If there is no selected text, deletes the character before the current cursor position; otherwise del...
The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument...
Definition: qtextformat.h:545
bool isAutoRepeat() const
Returns true if this event comes from an auto-repeating key; returns false if it comes from an initia...
Definition: qevent.h:237
void setIndent(int indent)
Sets the paragraph&#39;s indentation.
Definition: qtextformat.h:622
void setTextCursor(const QTextCursor &cursor)
Sets the visible cursor.
The QTextList class provides a decorated list of items in a QTextDocument.
Definition: qtextlist.h:57
#define Q_UNUSED(x)
Indicates to the compiler that the parameter with the specified name is not used in the body of a fun...
Definition: qglobal.h:1729

◆ lineWrapMode()

LineWrapMode QPlainTextEdit::lineWrapMode ( ) const

Referenced by setTabChangesFocus().

◆ loadResource()

QVariant QPlainTextEdit::loadResource ( int  type,
const QUrl name 
)
virtual

Loads the resource specified by the given type and name.

This function is an extension of QTextDocument::loadResource().

See also
QTextDocument::loadResource()

Definition at line 1799 of file qplaintextedit.cpp.

Referenced by QPlainTextEditControl::loadResource().

1800 {
1801  Q_UNUSED(type);
1802  Q_UNUSED(name);
1803  return QVariant();
1804 }
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
int type
Definition: qmetatype.cpp:239
#define Q_UNUSED(x)
Indicates to the compiler that the parameter with the specified name is not used in the body of a fun...
Definition: qglobal.h:1729

◆ maximumBlockCount()

int QPlainTextEdit::maximumBlockCount ( ) const
inline

Definition at line 130 of file qplaintextedit.h.

Referenced by QPlainTextEditPrivate::append().

131  { return document()->maximumBlockCount(); }
int maximumBlockCount
Specifies the limit for blocks in the document.
QTextDocument * document() const
Returns a pointer to the underlying document.

◆ mergeCurrentCharFormat()

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.

See also
QTextCursor::mergeCharFormat()

Definition at line 2493 of file qplaintextedit.cpp.

2494 {
2496  d->control->mergeCurrentCharFormat(modifier);
2497 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ modificationChanged

void QPlainTextEdit::modificationChanged ( bool  changed)
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.

◆ mouseDoubleClickEvent()

void QPlainTextEdit::mouseDoubleClickEvent ( QMouseEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2043 of file qplaintextedit.cpp.

2044 {
2046  d->sendControlEvent(e);
2047 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ mouseMoveEvent()

void QPlainTextEdit::mouseMoveEvent ( QMouseEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2010 of file qplaintextedit.cpp.

Referenced by timerEvent().

2011 {
2013  d->inDrag = false; // paranoia
2014  const QPoint pos = e->pos();
2015  d->sendControlEvent(e);
2016  if (!(e->buttons() & Qt::LeftButton))
2017  return;
2018  QRect visible = d->viewport->rect();
2019  if (visible.contains(pos))
2020  d->autoScrollTimer.stop();
2021  else if (!d->autoScrollTimer.isActive())
2022  d->autoScrollTimer.start(100, this);
2023 }
QPoint pos() const
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
const QPoint & pos() const
Returns the position of the mouse cursor, relative to the widget that received the event...
Definition: qevent.h:95
bool visible
whether the widget is visible
Definition: qwidget.h:191
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
bool contains(const QPoint &p, bool proper=false) const
Returns true if the given point is inside or on the edge of the rectangle, otherwise returns false...
Definition: qrect.cpp:1101
Qt::MouseButtons buttons() const
Returns the button state when the event was generated.
Definition: qevent.h:102
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58

◆ mousePressEvent()

void QPlainTextEdit::mousePressEvent ( QMouseEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 1998 of file qplaintextedit.cpp.

1999 {
2001 #ifdef QT_KEYPAD_NAVIGATION
2002  if (QApplication::keypadNavigationEnabled() && !hasEditFocus())
2003  setEditFocus(true);
2004 #endif
2005  d->sendControlEvent(e);
2006 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ mouseReleaseEvent()

void QPlainTextEdit::mouseReleaseEvent ( QMouseEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2027 of file qplaintextedit.cpp.

2028 {
2030  d->sendControlEvent(e);
2031  if (d->autoScrollTimer.isActive()) {
2032  d->autoScrollTimer.stop();
2033  d->ensureCursorVisible();
2034  }
2035 
2036  if (!isReadOnly() && rect().contains(e->pos()))
2037  d->handleSoftwareInputPanel(e->button(), d->clickCausedFocus);
2038  d->clickCausedFocus = 0;
2039 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
const QPoint & pos() const
Returns the position of the mouse cursor, relative to the widget that received the event...
Definition: qevent.h:95
bool isReadOnly() const
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
Qt::MouseButton button() const
Returns the button that caused the event.
Definition: qevent.h:101
QRect rect() const

◆ moveCursor()

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.

See also
QTextCursor::movePosition()

Definition at line 2546 of file qplaintextedit.cpp.

2547 {
2549  d->control->moveCursor(operation, mode);
2550 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ overwriteMode()

bool QPlainTextEdit::overwriteMode ( ) const

Referenced by cursorRect(), and paintEvent().

◆ paintEvent()

void QPlainTextEdit::paintEvent ( QPaintEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Reimplemented in QScriptEdit.

Definition at line 1854 of file qplaintextedit.cpp.

Referenced by QScriptEdit::paintEvent().

1855 {
1856  QPainter painter(viewport());
1857  Q_ASSERT(qobject_cast<QPlainTextDocumentLayout*>(document()->documentLayout()));
1858 
1859  QPointF offset(contentOffset());
1860 
1861  QRect er = e->rect();
1862  QRect viewportRect = viewport()->rect();
1863 
1864  bool editable = !isReadOnly();
1865 
1866  QTextBlock block = firstVisibleBlock();
1868 
1869  // Set a brush origin so that the WaveUnderline knows where the wave started
1870  painter.setBrushOrigin(offset);
1871 
1872  // keep right margin clean from full-width selection
1873  int maxX = offset.x() + qMax((qreal)viewportRect.width(), maximumWidth)
1874  - document()->documentMargin();
1875  er.setRight(qMin(er.right(), maxX));
1876  painter.setClipRect(er);
1877 
1878 
1880 
1881  while (block.isValid()) {
1882 
1883  QRectF r = blockBoundingRect(block).translated(offset);
1884  QTextLayout *layout = block.layout();
1885 
1886  if (!block.isVisible()) {
1887  offset.ry() += r.height();
1888  block = block.next();
1889  continue;
1890  }
1891 
1892  if (r.bottom() >= er.top() && r.top() <= er.bottom()) {
1893 
1894  QTextBlockFormat blockFormat = block.blockFormat();
1895 
1896  QBrush bg = blockFormat.background();
1897  if (bg != Qt::NoBrush) {
1898  QRectF contentsRect = r;
1899  contentsRect.setWidth(qMax(r.width(), maximumWidth));
1900  fillBackground(&painter, contentsRect, bg);
1901  }
1902 
1903 
1905  int blpos = block.position();
1906  int bllen = block.length();
1907  for (int i = 0; i < context.selections.size(); ++i) {
1908  const QAbstractTextDocumentLayout::Selection &range = context.selections.at(i);
1909  const int selStart = range.cursor.selectionStart() - blpos;
1910  const int selEnd = range.cursor.selectionEnd() - blpos;
1911  if (selStart < bllen && selEnd > 0
1912  && selEnd > selStart) {
1914  o.start = selStart;
1915  o.length = selEnd - selStart;
1916  o.format = range.format;
1917  selections.append(o);
1919  && block.contains(range.cursor.position())) {
1920  // for full width selections we don't require an actual selection, just
1921  // a position to specify the line. that's more convenience in usage.
1923  QTextLine l = layout->lineForTextPosition(range.cursor.position() - blpos);
1924  o.start = l.textStart();
1925  o.length = l.textLength();
1926  if (o.start + o.length == bllen - 1)
1927  ++o.length; // include newline
1928  o.format = range.format;
1929  selections.append(o);
1930  }
1931  }
1932 
1933  bool drawCursor = ((editable || (textInteractionFlags() & Qt::TextSelectableByKeyboard))
1934  && context.cursorPosition >= blpos
1935  && context.cursorPosition < blpos + bllen);
1936 
1937  bool drawCursorAsBlock = drawCursor && overwriteMode() ;
1938 
1939  if (drawCursorAsBlock) {
1940  if (context.cursorPosition == blpos + bllen - 1) {
1941  drawCursorAsBlock = false;
1942  } else {
1944  o.start = context.cursorPosition - blpos;
1945  o.length = 1;
1948  selections.append(o);
1949  }
1950  }
1951 
1952 
1953  layout->draw(&painter, offset, selections, er);
1954  if ((drawCursor && !drawCursorAsBlock)
1955  || (editable && context.cursorPosition < -1
1956  && !layout->preeditAreaText().isEmpty())) {
1957  int cpos = context.cursorPosition;
1958  if (cpos < -1)
1959  cpos = layout->preeditAreaPosition() - (cpos + 2);
1960  else
1961  cpos -= blpos;
1962  layout->drawCursor(&painter, offset, cpos, cursorWidth());
1963  }
1964  }
1965 
1966  offset.ry() += r.height();
1967  if (offset.y() > viewportRect.height())
1968  break;
1969  block = block.next();
1970  }
1971 
1972  if (backgroundVisible() && !block.isValid() && offset.y() <= er.bottom()
1974  painter.fillRect(QRect(QPoint((int)er.left(), (int)offset.y()), er.bottomRight()), palette().background());
1975  }
1976 }
The QPainter class performs low-level painting on widgets and other paint devices.
Definition: qpainter.h:86
The QTextLayout::FormatRange structure is used to apply extra formatting information for a specified ...
Definition: qtextlayout.h:128
double qreal
Definition: qglobal.h:1193
Q_DECL_CONSTEXPR const T & qMin(const T &a, const T &b)
Definition: qglobal.h:1215
QTextCharFormat format
the format of the selection
QRect contentsRect() const
Returns the area inside the widget&#39;s margins.
Definition: qwidget.cpp:7544
int minimum() const
const QBrush & background() const
Use window() instead.
Definition: qpalette.h:134
qreal width() const
Returns the width.
Definition: qsize.h:284
int selectionEnd() const
Returns the end of the selection or position() if the cursor doesn&#39;t have a selection.
QTextDocument * document() const
Returns a pointer to the underlying document.
bool overwriteMode() const
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:214
The QTextLine class represents a line of text inside a QTextLayout.
Definition: qtextlayout.h:197
int textLength() const
Returns the length of the text in the line.
void drawCursor(QPainter *p, const QPointF &pos, int cursorPosition) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
int left() const
Returns the x-coordinate of the rectangle&#39;s left edge.
Definition: qrect.h:240
int width() const
Returns the width of the rectangle.
Definition: qrect.h:303
QScrollBar * verticalScrollBar() const
Returns the vertical scroll bar.
QTextCursor cursor
the selection&#39;s cursor
Qt::TextInteractionFlags textInteractionFlags() const
int start
Specifies the beginning of the format range within the text layout&#39;s text.
Definition: qtextlayout.h:129
void setBackground(const QBrush &brush)
Sets the brush use to paint the document&#39;s background to the brush specified.
Definition: qtextformat.h:343
int height() const
Returns the height of the rectangle.
Definition: qrect.h:306
int bottom() const
Returns the y-coordinate of the rectangle&#39;s bottom edge.
Definition: qrect.h:249
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
The QVector class is a template class that provides a dynamic array.
Definition: qdatastream.h:64
QAbstractTextDocumentLayout::PaintContext getPaintContext() const
Returns the paint context for the viewport(), useful only when reimplementing paintEvent().
int cursorPosition
the position within the document, where the cursor line should be drawn.
static const uint base
Definition: qurl.cpp:268
Q_DECL_CONSTEXPR const T & qMax(const T &a, const T &b)
Definition: qglobal.h:1217
QTextBlock next() const
Returns the text block in the document after this block, or an empty text block if this is the last o...
QTextLine lineForTextPosition(int pos) const
Returns the line that contains the cursor position specified by pos.
int position() const
Returns the index of the block&#39;s first character within the document.
QWidget * viewport() const
Returns the viewport widget.
The QAbstractTextDocumentLayout::Selection class is a convenience class defining the parameters of a ...
bool hasProperty(int propertyId) const
Returns true if the text format has a property with the given propertyId; otherwise returns false...
bool isVisible() const
Returns true if the block is visible; otherwise returns false.
The QRectF class defines a rectangle in the plane using floating point precision. ...
Definition: qrect.h:511
QPoint bottomRight() const
Returns the position of the rectangle&#39;s bottom-right corner.
Definition: qrect.h:291
bool hasSelection() const
Returns true if the cursor contains a selection; otherwise returns false.
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
bool isReadOnly() const
virtual QSizeF documentSize() const =0
Returns the total size of the document&#39;s layout.
qreal height() const
Returns the height of the rectangle.
Definition: qrect.h:710
void setRight(int pos)
Sets the right edge of the rectangle to the given x coordinate.
Definition: qrect.h:264
const QPalette & palette() const
void append(const T &t)
Inserts value at the end of the vector.
Definition: qvector.h:573
bool contains(int position) const
Returns true if the given position is located within the text block; otherwise returns false...
QRectF blockBoundingRect(const QTextBlock &block) const
Returns the bounding rectangle of the text block in the block&#39;s own coordinates.
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
qreal width() const
Returns the width of the rectangle.
Definition: qrect.h:707
bool backgroundVisible() const
void draw(QPainter *p, const QPointF &pos, const QVector< FormatRange > &selections=QVector< FormatRange >(), const QRectF &clip=QRectF()) const
Draws the whole layout on the painter p at the position specified by pos.
int position() const
Returns the absolute position of the cursor within the document.
int length() const
Returns the length of the block in characters.
QBrush background() const
Returns the brush used to paint the document&#39;s background.
Definition: qtextformat.h:345
int preeditAreaPosition() const
Returns the position of the area in the text layout that will be processed before editing occurs...
The QBrush class defines the fill pattern of shapes drawn by QPainter.
Definition: qbrush.h:76
bool centerOnScroll() const
QPointF contentOffset() const
Returns the content&#39;s origin in viewport coordinates.
QString preeditAreaText() const
Returns the text that is inserted in the layout before editing occurs.
int top() const
Returns the y-coordinate of the rectangle&#39;s top edge.
Definition: qrect.h:243
The QTextLayout class is used to lay out and render text.
Definition: qtextlayout.h:105
int right() const
Returns the x-coordinate of the rectangle&#39;s right edge.
Definition: qrect.h:246
QRect rect
the internal geometry of the widget excluding any window frame
Definition: qwidget.h:168
int cursorWidth() const
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
QAbstractTextDocumentLayout * documentLayout() const
Returns the document layout for this document.
static void fillBackground(QPainter *p, const QRectF &rect, QBrush brush, QRectF gradientRect=QRectF())
The QAbstractTextDocumentLayout::PaintContext class is a convenience class defining the parameters us...
The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument...
Definition: qtextformat.h:545
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
QFactoryLoader * l
qreal documentMargin
The margin around the document.
bool isValid() const
Returns true if this text block is valid; otherwise returns false.
Definition: qtextobject.h:208
qreal top() const
Returns the y-coordinate of the rectangle&#39;s top edge.
Definition: qrect.h:526
int length
Specifies the numer of characters the format range spans.
Definition: qtextlayout.h:130
QTextCharFormat format
Specifies the format to apply.
Definition: qtextlayout.h:131
void setForeground(const QBrush &brush)
Sets the foreground brush to the specified brush.
Definition: qtextformat.h:350
QLayout * layout() const
Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed...
Definition: qwidget.cpp:10073
void setWidth(qreal w)
Sets the width of the rectangle to the given width.
Definition: qrect.h:784
qreal bottom() const
Returns the y-coordinate of the rectangle&#39;s bottom edge.
Definition: qrect.h:528
QVector< Selection > selections
the collection of selections that will be rendered when passing this paint context to QAbstractTextDo...
QRectF translated(qreal dx, qreal dy) const
Returns a copy of the rectangle that is translated dx along the x axis and dy along the y axis...
Definition: qrect.h:740
const QRect & rect() const
Returns the rectangle that needs to be updated.
Definition: qevent.h:305
int maximum() const
QTextBlockFormat blockFormat() const
Returns the QTextBlockFormat that describes block-specific properties.
int selectionStart() const
Returns the start of the selection or position() if the cursor doesn&#39;t have a selection.
int textStart() const
Returns the start of the line from the beginning of the string passed to the QTextLayout.
#define text
Definition: qobjectdefs.h:80
QTextBlock firstVisibleBlock() const
Returns the first visible block.
int maximumWidth() const
QTextLayout * layout() const
Returns the QTextLayout that is used to lay out and display the block&#39;s contents. ...

◆ paste

void QPlainTextEdit::paste ( )
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.

See also
cut() copy()

Definition at line 1450 of file qplaintextedit.cpp.

1451 {
1453  d->control->paste();
1454 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ print()

void QPlainTextEdit::print ( QPrinter 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.

See also
QTextDocument::print()

Definition at line 2569 of file qplaintextedit.cpp.

2570 {
2571  Q_D(const QPlainTextEdit);
2572  d->control->print(printer);
2573 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ redo

void QPlainTextEdit::redo ( )
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.

See also
undo()

Definition at line 1388 of file qplaintextedit.cpp.

1389 {
1391  d->control->redo();
1392 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ redoAvailable

void QPlainTextEdit::redoAvailable ( bool  b)
signal

This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).

◆ resizeEvent()

void QPlainTextEdit::resizeEvent ( QResizeEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Reimplemented in QScriptEdit.

Definition at line 1808 of file qplaintextedit.cpp.

Referenced by QScriptEdit::resizeEvent().

1809 {
1811  if (e->oldSize().width() != e->size().width())
1812  d->relayoutDocument();
1813  d->_q_adjustScrollbars();
1814 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
int width() const
Returns the width.
Definition: qsize.h:126
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
const QSize & oldSize() const
Returns the old size of the widget.
Definition: qevent.h:356
const QSize & size() const
Returns the new size of the widget.
Definition: qevent.h:355

◆ scrollContentsBy()

void QPlainTextEdit::scrollContentsBy ( int  dx,
int  dy 
)
protectedvirtual

em>Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2144 of file qplaintextedit.cpp.

◆ selectAll

void QPlainTextEdit::selectAll ( )
slot

Selects all text.

See also
copy() cut() textCursor()

Definition at line 1478 of file qplaintextedit.cpp.

Referenced by inputMethodEvent().

1479 {
1481  d->control->selectAll();
1482 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ selectionChanged

void QPlainTextEdit::selectionChanged ( )
signal

This signal is emitted whenever the selection changes.

See also
copyAvailable()

◆ setBackgroundVisible()

void QPlainTextEdit::setBackgroundVisible ( bool  visible)

Definition at line 2691 of file qplaintextedit.cpp.

2692 {
2694  if (visible == d->backgroundVisible)
2695  return;
2696  d->backgroundVisible = visible;
2697  d->updateViewport();
2698 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
bool visible
whether the widget is visible
Definition: qwidget.h:191
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setCenterOnScroll()

void QPlainTextEdit::setCenterOnScroll ( bool  enabled)

Definition at line 2726 of file qplaintextedit.cpp.

2727 {
2729  if (enabled == d->centerOnScroll)
2730  return;
2731  d->centerOnScroll = enabled;
2732 }
double d
Definition: qnumeric_p.h:62
bool enabled
whether the widget is enabled
Definition: qwidget.h:157
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setCurrentCharFormat()

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 2505 of file qplaintextedit.cpp.

2506 {
2508  d->control->setCurrentCharFormat(format);
2509 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setCursorWidth()

void QPlainTextEdit::setCursorWidth ( int  width)

Definition at line 2352 of file qplaintextedit.cpp.

2353 {
2355  d->control->setCursorWidth(width);
2356 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
int width() const
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setDocument()

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

See also
document()

Definition at line 1297 of file qplaintextedit.cpp.

1298 {
1300  QPlainTextDocumentLayout *documentLayout = 0;
1301 
1302  if (!document) {
1303  document = new QTextDocument(d->control);
1304  documentLayout = new QPlainTextDocumentLayout(document);
1305  document->setDocumentLayout(documentLayout);
1306  } else {
1307  documentLayout = qobject_cast<QPlainTextDocumentLayout*>(document->documentLayout());
1308  if (!documentLayout) {
1309  qWarning("QPlainTextEdit::setDocument: Document set does not support QPlainTextDocumentLayout");
1310  return;
1311  }
1312  }
1313  d->control->setDocument(document);
1314  if (!documentLayout->priv()->mainViewPrivate)
1315  documentLayout->priv()->mainViewPrivate = d;
1316  d->documentLayoutPtr = documentLayout;
1317  d->updateDefaultTextOption();
1318  d->relayoutDocument();
1319  d->_q_adjustScrollbars();
1320 }
double d
Definition: qnumeric_p.h:62
The QPlainTextDocumentLayout class implements a plain text layout for QTextDocument.
T * qobject_cast(QObject *object)
Definition: qobject.h:375
#define Q_D(Class)
Definition: qglobal.h:2482
Q_CORE_EXPORT void qWarning(const char *,...)
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
QPlainTextEditPrivate * mainViewPrivate
QAbstractTextDocumentLayout * documentLayout() const
Returns the document layout for this document.
QPlainTextDocumentLayoutPrivate * priv() const
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit...
void setDocumentLayout(QAbstractTextDocumentLayout *layout)
Sets the document to use the given layout.

◆ setDocumentTitle()

void QPlainTextEdit::setDocumentTitle ( const QString title)
inline

Definition at line 118 of file qplaintextedit.h.

QTextDocument * document() const
Returns a pointer to the underlying document.
void setMetaInformation(MetaInformation info, const QString &)
Sets the document&#39;s meta information of the type specified by info to the given string.

◆ setExtraSelections()

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.

See also
QTextEdit::ExtraSelection, extraSelections()

Definition at line 2368 of file qplaintextedit.cpp.

Referenced by QScriptEdit::updateExtraSelections().

2369 {
2371  d->control->setExtraSelections(selections);
2372 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setLineWrapMode()

void QPlainTextEdit::setLineWrapMode ( LineWrapMode  mode)

Definition at line 2629 of file qplaintextedit.cpp.

2630 {
2632  if (d->lineWrap == wrap)
2633  return;
2634  d->lineWrap = wrap;
2635  d->updateDefaultTextOption();
2636  d->relayoutDocument();
2637  d->_q_adjustScrollbars();
2639 }
double d
Definition: qnumeric_p.h:62
void ensureCursorVisible()
Ensures that the cursor is visible by scrolling the text edit if necessary.
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setMaximumBlockCount()

void QPlainTextEdit::setMaximumBlockCount ( int  maximum)
inline

Definition at line 128 of file qplaintextedit.h.

129  { document()->setMaximumBlockCount(maximum); }
QTextDocument * document() const
Returns a pointer to the underlying document.
void setMaximumBlockCount(int maximum)

◆ setOverwriteMode()

void QPlainTextEdit::setOverwriteMode ( bool  overwrite)

Definition at line 2306 of file qplaintextedit.cpp.

2307 {
2309  d->control->setOverwriteMode(overwrite);
2310 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setPlainText

void QPlainTextEdit::setPlainText ( const QString text)
slot

Changes the text of the text edit to the string text.

Any previous text is removed.

text is interpreted as plain text.

Note that the undo/redo history is cleared by this function.

See also
toText()

Definition at line 1597 of file qplaintextedit.cpp.

1598 {
1600  d->control->setPlainText(text);
1601 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setReadOnly()

void QPlainTextEdit::setReadOnly ( bool  ro)

Definition at line 2445 of file qplaintextedit.cpp.

2446 {
2448  Qt::TextInteractionFlags flags = Qt::NoTextInteraction;
2449  if (ro) {
2450  flags = Qt::TextSelectableByMouse;
2451  } else {
2452  flags = Qt::TextEditorInteraction;
2453  }
2455  d->control->setTextInteractionFlags(flags);
2456 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
void setAttribute(Qt::WidgetAttribute, bool on=true)
Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
Definition: qwidget.cpp:11087
static bool shouldEnableInputMethod(QPlainTextEdit *plaintextedit)

◆ setTabChangesFocus()

void QPlainTextEdit::setTabChangesFocus ( bool  b)

Definition at line 2594 of file qplaintextedit.cpp.

2595 {
2597  d->tabChangesFocus = b;
2598 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setTabStopWidth()

void QPlainTextEdit::setTabStopWidth ( int  width)

Definition at line 2328 of file qplaintextedit.cpp.

2329 {
2331  QTextOption opt = d->control->document()->defaultTextOption();
2332  if (opt.tabStop() == width || width < 0)
2333  return;
2334  opt.setTabStop(width);
2335  d->control->document()->setDefaultTextOption(opt);
2336 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
qreal tabStop() const
Returns the distance in device units between tab stops.
Definition: qtextoption.h:124
int width() const
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
The QTextOption class provides a description of general rich text properties.
Definition: qtextoption.h:59
void setTabStop(qreal tabStop)
Sets the default distance in device units between tab stops to the value specified by tabStop...
Definition: qtextoption.h:154

◆ setTextCursor()

void QPlainTextEdit::setTextCursor ( const QTextCursor cursor)

Sets the visible cursor.

Definition at line 1336 of file qplaintextedit.cpp.

Referenced by QScriptDebuggerCodeView::find(), QScriptEdit::gotoLine(), keyReleaseEvent(), and QAccessiblePlainTextEdit::setTextCursor().

1337 {
1339  d->control->setTextCursor(cursor);
1340 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setTextInteractionFlags()

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

Definition at line 2473 of file qplaintextedit.cpp.

2474 {
2476  d->control->setTextInteractionFlags(flags);
2477 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ setUndoRedoEnabled()

void QPlainTextEdit::setUndoRedoEnabled ( bool  enable)
inline

Definition at line 125 of file qplaintextedit.h.

126  { document()->setUndoRedoEnabled(enable); }
QTextDocument * document() const
Returns a pointer to the underlying document.
void setUndoRedoEnabled(bool enable)

◆ setWordWrapMode()

void QPlainTextEdit::setWordWrapMode ( QTextOption::WrapMode  policy)

Definition at line 2659 of file qplaintextedit.cpp.

2660 {
2662  if (mode == d->wordWrap)
2663  return;
2664  d->wordWrap = mode;
2665  d->updateDefaultTextOption();
2666 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ showEvent()

void QPlainTextEdit::showEvent ( QShowEvent )
protectedvirtual

Reimplemented Function

Reimplemented from QWidget.

Definition at line 2191 of file qplaintextedit.cpp.

2192 {
2194  if (d->showCursorOnInitialShow) {
2195  d->showCursorOnInitialShow = false;
2197  }
2198 }
double d
Definition: qnumeric_p.h:62
void ensureCursorVisible()
Ensures that the cursor is visible by scrolling the text edit if necessary.
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ tabChangesFocus()

bool QPlainTextEdit::tabChangesFocus ( ) const

Referenced by print().

◆ tabStopWidth()

int QPlainTextEdit::tabStopWidth ( ) const

Referenced by setOverwriteMode().

◆ textChanged

void QPlainTextEdit::textChanged ( )
signal

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

◆ textCursor()

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 1347 of file qplaintextedit.cpp.

Referenced by centerCursor(), QScriptEdit::currentLineNumber(), QScriptDebuggerCodeView::find(), QAccessiblePlainTextEdit::textCursor(), and QScriptEdit::updateExtraSelections().

1348 {
1349  Q_D(const QPlainTextEdit);
1350  return d->control->textCursor();
1351 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ textInteractionFlags()

Qt::TextInteractionFlags QPlainTextEdit::textInteractionFlags ( ) const

◆ timerEvent()

void QPlainTextEdit::timerEvent ( QTimerEvent e)
protectedvirtual
Warning
This function is not part of the public interface.

Reimplemented from QObject.

Definition at line 1543 of file qplaintextedit.cpp.

1544 {
1546  if (e->timerId() == d->autoScrollTimer.timerId()) {
1547  QRect visible = d->viewport->rect();
1548  QPoint pos;
1549  if (d->inDrag) {
1550  pos = d->autoScrollDragPos;
1551  visible.adjust(qMin(visible.width()/3,20), qMin(visible.height()/3,20),
1552  -qMin(visible.width()/3,20), -qMin(visible.height()/3,20));
1553  } else {
1554  const QPoint globalPos = QCursor::pos();
1555  pos = d->viewport->mapFromGlobal(globalPos);
1557  mouseMoveEvent(&ev);
1558  }
1559  int deltaY = qMax(pos.y() - visible.top(), visible.bottom() - pos.y()) - visible.height();
1560  int deltaX = qMax(pos.x() - visible.left(), visible.right() - pos.x()) - visible.width();
1561  int delta = qMax(deltaX, deltaY);
1562  if (delta >= 0) {
1563  if (delta < 7)
1564  delta = 7;
1565  int timeout = 4900 / (delta * delta);
1566  d->autoScrollTimer.start(timeout, this);
1567 
1568  if (deltaY > 0)
1569  d->vbar->triggerAction(pos.y() < visible.center().y() ?
1572  if (deltaX > 0)
1573  d->hbar->triggerAction(pos.x() < visible.center().x() ?
1576  }
1577  }
1578 #ifdef QT_KEYPAD_NAVIGATION
1579  else if (e->timerId() == d->deleteAllTimer.timerId()) {
1580  d->deleteAllTimer.stop();
1581  clear();
1582  }
1583 #endif
1584 }
QPoint pos() const
double d
Definition: qnumeric_p.h:62
Q_DECL_CONSTEXPR const T & qMin(const T &a, const T &b)
Definition: qglobal.h:1215
int left() const
Returns the x-coordinate of the rectangle&#39;s left edge.
Definition: qrect.h:240
int width() const
Returns the width of the rectangle.
Definition: qrect.h:303
int height() const
Returns the height of the rectangle.
Definition: qrect.h:306
int bottom() const
Returns the y-coordinate of the rectangle&#39;s bottom edge.
Definition: qrect.h:249
#define Q_D(Class)
Definition: qglobal.h:2482
Q_DECL_CONSTEXPR const T & qMax(const T &a, const T &b)
Definition: qglobal.h:1217
virtual void mouseMoveEvent(QMouseEvent *e)
Reimplemented Function
bool visible
whether the widget is visible
Definition: qwidget.h:191
void adjust(int x1, int y1, int x2, int y2)
Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle.
Definition: qrect.h:434
int timerId() const
Returns the unique timer identifier, which is the same identifier as returned from QObject::startTime...
Definition: qcoreevent.h:346
The QPlainTextEdit class provides a widget that is used to edit and display plain text...
The QMouseEvent class contains parameters that describe a mouse event.
Definition: qevent.h:85
QPoint center() const
Returns the center point of the rectangle.
Definition: qrect.h:300
int top() const
Returns the y-coordinate of the rectangle&#39;s top edge.
Definition: qrect.h:243
int right() const
Returns the x-coordinate of the rectangle&#39;s right edge.
Definition: qrect.h:246
void clear()
Deletes all the text in the text edit.
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
int y() const
Returns the y coordinate of this point.
Definition: qpoint.h:131
int x() const
Returns the x coordinate of this point.
Definition: qpoint.h:128
static QPoint pos()
Returns the position of the cursor (hot spot) in global screen coordinates.
Definition: qcursor_mac.mm:310

◆ toPlainText()

QString QPlainTextEdit::toPlainText ( ) const
inline

Returns the text of the text edit as plain text.

See also
QPlainTextEdit::setPlainText()

Definition at line 148 of file qplaintextedit.h.

149  { return document()->toPlainText(); }
QTextDocument * document() const
Returns a pointer to the underlying document.
QString toPlainText() const
Returns the plain text contained in the document.

◆ undo

void QPlainTextEdit::undo ( )
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.

See also
redo()

Definition at line 1382 of file qplaintextedit.cpp.

1383 {
1385  d->control->undo();
1386 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

◆ undoAvailable

void QPlainTextEdit::undoAvailable ( bool  b)
signal

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

◆ updateRequest

void QPlainTextEdit::updateRequest ( const QRect rect,
int  dy 
)
signal

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.

Referenced by QScriptEdit::QScriptEdit().

◆ wheelEvent()

void QPlainTextEdit::wheelEvent ( QWheelEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QAbstractScrollArea.

Definition at line 2225 of file qplaintextedit.cpp.

2226 {
2228  updateMicroFocus();
2229 }
void wheelEvent(QWheelEvent *)
This event handler can be reimplemented in a subclass to receive wheel events for the viewport() widg...
void updateMicroFocus()
Updates the widget&#39;s micro focus.
Definition: qwidget.cpp:11820

◆ wordWrapMode()

QTextOption::WrapMode QPlainTextEdit::wordWrapMode ( ) const

the mode QPlainTextEdit will use when wrapping text by words

By default, this property is set to QTextOption::WrapAtWordBoundaryOrAnywhere.

See also
QTextOption::WrapMode

Definition at line 2653 of file qplaintextedit.cpp.

2654 {
2655  Q_D(const QPlainTextEdit);
2656  return d->wordWrap;
2657 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QPlainTextEdit class provides a widget that is used to edit and display plain text...

Friends and Related Functions

◆ QPlainTextEditControl

Definition at line 275 of file qplaintextedit.h.

Properties

◆ backgroundVisible

bool QPlainTextEdit::backgroundVisible
private

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 87 of file qplaintextedit.h.

◆ blockCount

int QPlainTextEdit::blockCount
private

the number of text blocks in the document.

By default, in an empty document, this property contains a value of 1.

Definition at line 85 of file qplaintextedit.h.

◆ centerOnScroll

bool QPlainTextEdit::centerOnScroll
private

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.

See also
centerCursor(), ensureCursorVisible()

Definition at line 88 of file qplaintextedit.h.

◆ cursorWidth

int QPlainTextEdit::cursorWidth
private

This property specifies the width of the cursor in pixels.

The default value is 1.

Definition at line 83 of file qplaintextedit.h.

◆ documentTitle

QPlainTextEdit::documentTitle
private

the title of the document parsed from the text.

By default, this property contains an empty string.

Definition at line 75 of file qplaintextedit.h.

◆ lineWrapMode

QPlainTextEdit::LineWrapMode QPlainTextEdit::lineWrapMode
private

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 77 of file qplaintextedit.h.

◆ maximumBlockCount

QPlainTextEdit::maximumBlockCount
private

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 86 of file qplaintextedit.h.

◆ overwriteMode

bool QPlainTextEdit::overwriteMode
private

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 81 of file qplaintextedit.h.

◆ plainText

QPlainTextEdit::plainText
private

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.

By default, for an editor with no contents, this property contains an empty string.

Definition at line 80 of file qplaintextedit.h.

◆ readOnly

QPlainTextEdit::readOnly
private

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 79 of file qplaintextedit.h.

◆ tabChangesFocus

bool QPlainTextEdit::tabChangesFocus
private

whether 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 Tab key, as this breaks the focus chain. The default is false.

Definition at line 74 of file qplaintextedit.h.

◆ tabStopWidth

int QPlainTextEdit::tabStopWidth
private

the tab stop width in pixels

By default, this property contains a value of 80.

Definition at line 82 of file qplaintextedit.h.

◆ textInteractionFlags

Qt::TextInteractionFlags QPlainTextEdit::textInteractionFlags
private

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 84 of file qplaintextedit.h.

◆ undoRedoEnabled

QPlainTextEdit::undoRedoEnabled
private

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 76 of file qplaintextedit.h.


The documentation for this class was generated from the following files: