CopperSpice API  1.7.2
QPlainTextEdit Class Reference

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

Inheritance diagram for QPlainTextEdit:
QAbstractScrollArea QFrame QWidget QObject QPaintDevice

Public Types

enum  LineWrapMode
 
- Public Types inherited from QFrame
enum  Shadow
 
enum  Shape
 
enum  StyleMask
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

Public Signals

void blockCountChanged (int newBlockCount)
 
void copyAvailable (bool status)
 
void cursorPositionChanged ()
 
void modificationChanged (bool changed)
 
void redoAvailable (bool status)
 
void selectionChanged ()
 
void textChanged ()
 
void undoAvailable (bool status)
 
void updateRequest (const QRect &rect, int dy)
 
- Public Signals inherited from QWidget
void customContextMenuRequested (const QPoint &pos)
 
void windowIconChanged (const QIcon &icon)
 
void windowIconTextChanged (const QString &iconText)
 
void windowTitleChanged (const QString &title)
 
- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 

Public Slots

void appendHtml (const QString &html)
 
void appendPlainText (const QString &text)
 
void centerCursor ()
 
void clear ()
 
void copy ()
 
void cut ()
 
void insertPlainText (const QString &text)
 
void paste ()
 
void redo ()
 
void selectAll ()
 
void setPlainText (const QString &text)
 
void undo ()
 
void zoomIn (int range=1)
 
void zoomOut (int range=1)
 
- Public Slots inherited from QWidget
bool close ()
 
void hide ()
 
void lower ()
 
void raise ()
 
void repaint ()
 
void setDisabled (bool disable)
 
void setEnabled (bool enable)
 
void setFocus ()
 
void setHidden (bool hidden)
 
void setStyleSheet (const QString &styleSheet)
 
virtual void setVisible (bool visible)
 
void setWindowModified (bool modified)
 
void setWindowTitle (const QString &title)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
void update ()
 
- Public Slots inherited from QObject
void deleteLater ()
 

Public Methods

 QPlainTextEdit (const QString &text, QWidget *parent=nullptr)
 
 QPlainTextEdit (QWidget *parent=nullptr)
 
virtual ~QPlainTextEdit ()
 
QString anchorAt (const QPoint &pos) const
 
bool backgroundVisible () const
 
int blockCount () const
 
bool canPaste () const
 
bool centerOnScroll () const
 
QMenucreateStandardContextMenu ()
 
QMenucreateStandardContextMenu (const QPoint &position)
 
QTextCharFormat currentCharFormat () const
 
QTextCursor cursorForPosition (const QPoint &pos) const
 
QRect cursorRect () const
 
QRect cursorRect (const QTextCursor &cursor) const
 
int cursorWidth () const
 
QTextDocumentdocument () const
 
QString documentTitle () const
 
void ensureCursorVisible ()
 
QList< QTextEdit::ExtraSelectionextraSelections () const
 
bool find (const QRegularExpression &exp, QTextDocument::FindFlags options=QTextDocument::FindFlags ())
 
bool find (const QString &exp, QTextDocument::FindFlags options=QTextDocument::FindFlags ())
 
QVariant inputMethodQuery (Qt::InputMethodQuery property) const override
 
QVariant inputMethodQuery (Qt::InputMethodQuery query, QVariant argument) const
 
bool isReadOnly () const
 
bool isUndoRedoEnabled () const
 
LineWrapMode lineWrapMode () const
 
virtual QVariant loadResource (int type, const QUrl &name)
 
int maximumBlockCount () const
 
void mergeCurrentCharFormat (const QTextCharFormat &modifier)
 
void moveCursor (QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode=QTextCursor::MoveAnchor)
 
bool overwriteMode () const
 
QString placeholderText () const
 
void print (QPagedPaintDevice *printer) const
 
void setBackgroundVisible (bool visible)
 
void setCenterOnScroll (bool enabled)
 
void setCurrentCharFormat (const QTextCharFormat &format)
 
void setCursorWidth (int width)
 
void setDocument (QTextDocument *document)
 
void setDocumentTitle (const QString &title)
 
void setExtraSelections (const QList< QTextEdit::ExtraSelection > &selections)
 
void setLineWrapMode (LineWrapMode mode)
 
void setMaximumBlockCount (int maximum)
 
void setOverwriteMode (bool overwrite)
 
void setPlaceholderText (const QString &placeholderText)
 
void setReadOnly (bool ro)
 
void setTabChangesFocus (bool b)
 
void setTabStopWidth (int width)
 
void setTextCursor (const QTextCursor &cursor)
 
void setTextInteractionFlags (Qt::TextInteractionFlags flags)
 
void setUndoRedoEnabled (bool enable)
 
void setWordWrapMode (QTextOption::WrapMode policy)
 
bool tabChangesFocus () const
 
int tabStopWidth () const
 
QTextCursor textCursor () const
 
Qt::TextInteractionFlags textInteractionFlags () const
 
QString toPlainText () const
 
QTextOption::WrapMode wordWrapMode () const
 
- Public Methods inherited from QAbstractScrollArea
 QAbstractScrollArea (QWidget *parent=nullptr)
 
 ~QAbstractScrollArea ()
 
void addScrollBarWidget (QWidget *widget, Qt::Alignment alignment)
 
QWidgetcornerWidget () const
 
QScrollBarhorizontalScrollBar () const
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const
 
QSize maximumViewportSize () const
 
QSize minimumSizeHint () const override
 
QWidgetList scrollBarWidgets (Qt::Alignment alignment)
 
void setCornerWidget (QWidget *widget)
 
void setHorizontalScrollBar (QScrollBar *scrollBar)
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setSizeAdjustPolicy (SizeAdjustPolicy policy)
 
virtual void setupViewport (QWidget *viewport)
 
void setVerticalScrollBar (QScrollBar *scrollBar)
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 
SizeAdjustPolicy sizeAdjustPolicy () const
 
QSize sizeHint () const override
 
QScrollBarverticalScrollBar () const
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const
 
QWidgetviewport () const
 
- Public Methods inherited from QFrame
 QFrame (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 
 ~QFrame ()
 
QRect frameRect () const
 
Shadow frameShadow () const
 
Shape frameShape () const
 
int frameStyle () const
 
int frameWidth () const
 
int lineWidth () const
 
int midLineWidth () const
 
void setFrameRect (const QRect &)
 
void setFrameShadow (Shadow)
 
void setFrameShape (Shape)
 
void setFrameStyle (int style)
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
QSize sizeHint () const override
 
- Public Methods inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 
 ~QWidget ()
 
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (const QList< QAction * > &actions)
 
void adjustSize ()
 
bool autoFillBackground () const
 
QPalette::ColorRole backgroundRole () const
 
QBackingStorebackingStore () const
 
QSize baseSize () const
 
QWidget * childAt (const QPoint &position) const
 
QWidget * childAt (int x, int y) const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 
void clearMask ()
 
QMargins contentsMargins () const
 
QRect contentsRect () const
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
QCursor cursor () const
 
WId effectiveWinId () const
 
void ensurePolished () const
 
Qt::FocusPolicy focusPolicy () const
 
QWidget * focusProxy () const
 
QWidget * focusWidget () const
 
const QFontfont () const
 
QFontInfo fontInfo () const
 
QFontMetrics fontMetrics () const
 
QPalette::ColorRole foregroundRole () const
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
QPixmap grab (const QRect &rectangle=QRect (QPoint (0, 0), QSize (-1,-1)))
 
void grabGesture (Qt::GestureType gestureType, Qt::GestureFlags flags=Qt::GestureFlags ())
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 
bool hasEditFocus () const
 
bool hasFocus () const
 
virtual bool hasHeightForWidth () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int width) const
 
Qt::InputMethodHints inputMethodHints () const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *parent) const
 
bool isEnabledToTLW () const
 
bool isFullScreen () const
 
bool isHidden () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isTopLevel () const
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *parent) const
 
bool isWindow () const
 
bool isWindowModified () const
 
QLayoutlayout () const
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const
 
QPoint mapFromGlobal (const QPoint &pos) const
 
QPoint mapFromParent (const QPoint &pos) const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const
 
QPoint mapToGlobal (const QPoint &pos) const
 
QPoint mapToParent (const QPoint &pos) const
 
QRegion mask () const
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (const QPoint &point)
 
void move (int x, int y)
 
QWidget * nativeParentWidget () const
 
QWidget * nextInFocusChain () const
 
QRect normalGeometry () const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
QPaintEnginepaintEngine () const override
 
const QPalettepalette () const
 
QWidget * parentWidget () const
 
QPoint pos () const
 
QWidget * previousInFocusChain () const
 
QRect rect () const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground|DrawChildren))
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint (), const QRegion &sourceRegion=QRegion (), RenderFlags renderFlags=RenderFlags (DrawWindowBackground|DrawChildren))
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &region)
 
void repaint (int x, int y, int w, int h)
 
void resize (const QSize &size)
 
void resize (int w, int h)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &rect)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool enable=true)
 
void setAutoFillBackground (bool enable)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &size)
 
void setBaseSize (int basew, int baseh)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &cursor)
 
void setEditFocus (bool enable)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &size)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *widget)
 
void setFont (const QFont &font)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &rect)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &size)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &size)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &palette)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags flags)
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
void setShortcutEnabled (int id, bool enable=true)
 
void setSizeIncrement (const QSize &size)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy policy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &data)
 
void setStyle (QStyle *style)
 
void setToolTip (const QString &data)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setWhatsThis (const QString &str)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (Qt::WindowFlags flags)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *widget)
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute attribute) const
 
QString toolTip () const
 
int toolTipDuration () const
 
QWidget * topLevelWidget () const
 
bool underMouse () const
 
void ungrabGesture (Qt::GestureType gestureType)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (const QRect &rect)
 
void update (const QRegion &region)
 
void update (int x, int y, int w, int h)
 
void updateGeometry ()
 
bool updatesEnabled () const
 
QRegion visibleRegion () const
 
QString whatsThis () const
 
int width () const
 
QWidget * window () const
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 
QWindowwindowHandle () const
 
QIcon windowIcon () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 
Qt::WindowStates windowState () const
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 
WId winId () const
 
int x () const
 
int y () const
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 
- Public Methods inherited from QPaintDevice
virtual ~QPaintDevice ()
 
int colorCount () const
 
int depth () const
 
int devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 

Protected Methods

QRectF blockBoundingGeometry (const QTextBlock &block) const
 
QRectF blockBoundingRect (const QTextBlock &block) const
 
bool canInsertFromMimeData (const QMimeData *source) const
 
void changeEvent (QEvent *event) override
 
QPointF contentOffset () const
 
void contextMenuEvent (QContextMenuEvent *event) override
 
QMimeDatacreateMimeDataFromSelection () const
 
virtual void doSetTextCursor (const QTextCursor &cursor)
 
void dragEnterEvent (QDragEnterEvent *event) override
 
void dragLeaveEvent (QDragLeaveEvent *event) override
 
void dragMoveEvent (QDragMoveEvent *event) override
 
void dropEvent (QDropEvent *event) override
 
QTextBlock firstVisibleBlock () const
 
void focusInEvent (QFocusEvent *event) override
 
bool focusNextPrevChild (bool next) override
 
void focusOutEvent (QFocusEvent *event) override
 
QAbstractTextDocumentLayout::PaintContext getPaintContext () const
 
void inputMethodEvent (QInputMethodEvent *event) override
 
void insertFromMimeData (const QMimeData *source)
 
void keyPressEvent (QKeyEvent *event) override
 
void keyReleaseEvent (QKeyEvent *event) override
 
void mouseDoubleClickEvent (QMouseEvent *event) override
 
void mouseMoveEvent (QMouseEvent *event) override
 
void mousePressEvent (QMouseEvent *event) override
 
void mouseReleaseEvent (QMouseEvent *event) override
 
void paintEvent (QPaintEvent *event) override
 
void resizeEvent (QResizeEvent *event) override
 
void scrollContentsBy (int dx, int dy) override
 
void showEvent (QShowEvent *event) override
 
void wheelEvent (QWheelEvent *event) override
 
void zoomInF (float range)
 
- Protected Methods inherited from QAbstractScrollArea
bool event (QEvent *event) override
 
void setViewportMargins (const QMargins &margins)
 
void setViewportMargins (int left, int top, int right, int bottom)
 
virtual bool viewportEvent (QEvent *event)
 
QMargins viewportMargins () const
 
virtual QSize viewportSizeHint () const
 
- Protected Methods inherited from QFrame
void drawFrame (QPainter *)
 
bool event (QEvent *event) override
 
void initStyleOption (QStyleOptionFrame *option) const
 
- Protected Methods inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
void create (WId window=0, bool initializeWindow=true, bool destroyOldWindow=true)
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 
virtual void enterEvent (QEvent *event)
 
bool event (QEvent *event) override
 
bool focusNextChild ()
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
void initPainter (QPainter *painter) const override
 
virtual void leaveEvent (QEvent *event)
 
int metric (PaintDeviceMetric metric) const override
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void tabletEvent (QTabletEvent *event)
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Methods inherited from QPaintDevice
 QPaintDevice ()
 

Properties

 backgroundVisible
 
 blockCount
 
 centerOnScroll
 
 cursorWidth
 
 documentTitle
 
 lineWrapMode
 
 maximumBlockCount
 
 overwriteMode
 
 placeholderText
 
 plainText
 
 readOnly
 
 tabChangesFocus
 
 tabStopWidth
 
 textInteractionFlags
 
 undoRedoEnabled
 
 wordWrapMode
 
- Properties inherited from QAbstractScrollArea
 horizontalScrollBarPolicy
 
 verticalScrollBarPolicy
 
- Properties inherited from QFrame
 frameRect
 
 frameShadow
 
 frameShape
 
 frameWidth
 
 lineWidth
 
 midLineWidth
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 toolTip
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Methods inherited from QWidget
static QWidget * createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::EmptyFlag)
 
static QWidget * find (WId id)
 
static QWidget * keyboardGrabber ()
 
static QWidget * mouseGrabber ()
 
static void setTabOrder (QWidget *firstWidget, QWidget *secondWidget)
 
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 
- Protected Slots inherited from QWidget
void updateMicroFocus ()
 

Detailed Description

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

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 similar concepts similar to QTextEdit, however it 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, 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 plaintiveness(). 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() method 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:

KeypressesAction
Qt::UpArrowMoves one line up.
Qt::DownArrowMoves one line down.
Qt::LeftArrowMoves one character to the left.
Qt::RightArrowMoves one character to the right.
PageUpMoves one (viewport) page up.
PageDownMoves one (viewport) page down.
HomeMoves to the beginning of the text.
EndMoves to the end of the text.
Alt+WheelScrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+WheelZooms the text.
Ctrl+ASelects 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 the isModified() method 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:

KeypressesAction
BackspaceDeletes the character to the left of the cursor.
DeleteDeletes the character to the right of the cursor.
Ctrl+CCopy the selected text to the clipboard.
Ctrl+InsertCopy the selected text to the clipboard.
Ctrl+KDeletes to the end of the line.
Ctrl+VPastes the clipboard text into text edit.
Shift+InsertPastes the clipboard text into text edit.
Ctrl+XDeletes the selected text and copies it to the clipboard.
Shift+DeleteDeletes the selected text and copies it to the clipboard.
Ctrl+ZUndoes the last operation.
Ctrl+YRedoes the last operation.
LeftArrowMoves the cursor one character to the left.
Ctrl+LeftArrowMoves the cursor one word to the left.
RightArrowMoves the cursor one character to the right.
Ctrl+RightArrowMoves the cursor one word to the right.
UpArrowMoves the cursor one line up.
Ctrl+UpArrowMoves the cursor one word up.
DownArrowMoves the cursor one line down.
Ctrl+Down ArrowMoves the cursor one word down.
PageUpMoves the cursor one page up.
PageDownMoves the cursor one page down.
HomeMoves the cursor to the beginning of the line.
Ctrl+HomeMoves the cursor to the beginning of the text.
EndMoves the cursor to the end of the line.
Ctrl+EndMoves the cursor to the end of the text.
Alt+WheelScrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+WheelZooms 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 (refer to 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 (refer to setMaximumBlockCount()).

See also
QTextDocument, QTextCursor, Rich Text Processing

Member Enumeration Documentation

ConstantValue
QPlainTextEdit::NoWrap0
QPlainTextEdit::WidgetWidth1

Constructor & Destructor Documentation

QPlainTextEdit::QPlainTextEdit ( QWidget parent = nullptr)
explicit

Constructs an empty QPlainTextEdit with parent parent.

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

Constructs a QPlainTextEdit with parent parent. The text edit will display the plain text text.

QPlainTextEdit::~QPlainTextEdit ( )
virtual

Destroys the current QPlainTextEdit object.

Method Documentation

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.

void QPlainTextEdit::appendHtml ( const QString html)
slot

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

See also
appendPlainText()
void QPlainTextEdit::appendPlainText ( const QString text)
slot

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

See also
appendHtml()
bool QPlainTextEdit::backgroundVisible ( ) const

Documentation pending.

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()
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()
int QPlainTextEdit::blockCount ( ) const

Documentation pending.

void QPlainTextEdit::blockCountChanged ( int  newBlockCount)
signal

This signal is emitted whenever the block count changes. The new block count is passed in newBlockCount.

bool QPlainTextEdit::canInsertFromMimeData ( const QMimeData source) const
protected

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.

bool QPlainTextEdit::canPaste ( ) const

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

void QPlainTextEdit::centerCursor ( )
slot

Scrolls the document in order to center the cursor vertically.

See also
ensureCursorVisible(), centerOnScroll
bool QPlainTextEdit::centerOnScroll ( ) const

Documentation pending.

void QPlainTextEdit::changeEvent ( QEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::changeEvent().

Reimplemented from QFrame.

void QPlainTextEdit::clear ( )
slot

Deletes all the text in the text edit. The undo/redo history is cleared by this method.

See also
cut(), setPlainText()
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()
void QPlainTextEdit::contextMenuEvent ( QContextMenuEvent event)
overrideprotectedvirtual

Shows the standard context menu created with createStandardContextMenu().

If you do not want the text edit to have a context menu, you can set its contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this method. 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.

void QPlainTextEdit::copy ( )
slot

Copies any selected text to the clipboard.

See also
copyAvailable()
void QPlainTextEdit::copyAvailable ( bool  status)
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 status set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with status set to false. If true then copy() can be used to copy the selection to the clipboard. If it is false then copy() does nothing.

See also
selectionChanged()
QMimeData * QPlainTextEdit::createMimeDataFromSelection ( ) const
protected

This method 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 method, be aware the ownership of the returned QMimeData object is passed to the caller. The selection can be retrieved by using the textCursor() function.

QMenu * QPlainTextEdit::createStandardContextMenu ( )

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

QMenu * QPlainTextEdit::createStandardContextMenu ( const QPoint position)

Documentation pending.

QTextCharFormat QPlainTextEdit::currentCharFormat ( ) const

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

See also
setCurrentCharFormat()
QTextCursor QPlainTextEdit::cursorForPosition ( const QPoint pos) const

Returns a QTextCursor at position pos in viewport coordinates.

void QPlainTextEdit::cursorPositionChanged ( )
signal

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

QRect QPlainTextEdit::cursorRect ( ) const

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

QRect QPlainTextEdit::cursorRect ( const QTextCursor cursor) const

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

int QPlainTextEdit::cursorWidth ( ) const

Documentation pending.

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()
QTextDocument * QPlainTextEdit::document ( ) const

Returns a pointer to the underlying document.

See also
setDocument()
QString QPlainTextEdit::documentTitle ( ) const
inline

Documentation pending.

void QPlainTextEdit::doSetTextCursor ( const QTextCursor cursor)
protectedvirtual

Documentation pending.

void QPlainTextEdit::dragEnterEvent ( QDragEnterEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::dragEnterEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::dragLeaveEvent ( QDragLeaveEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::dragLeaveEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::dragMoveEvent ( QDragMoveEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::dragMoveEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::dropEvent ( QDropEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::dropEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::ensureCursorVisible ( )

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

See also
centerCursor(), centerOnScroll
QList< QTextEdit::ExtraSelection > QPlainTextEdit::extraSelections ( ) const

Returns previously set extra selections.

See also
setExtraSelections()
bool QPlainTextEdit::find ( const QRegularExpression exp,
QTextDocument::FindFlags  options = QTextDocument::FindFlags() 
)

Documentation pending.

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

Finds the next occurrence of the string, exp, using the given options. Returns true if exp was found and changes the cursor to select the match, otherwise returns false.

QTextBlock QPlainTextEdit::firstVisibleBlock ( ) const
protected

Returns the first visible block.

See also
blockBoundingRect()
void QPlainTextEdit::focusInEvent ( QFocusEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::focusInEvent().

Reimplemented from QWidget.

bool QPlainTextEdit::focusNextPrevChild ( bool  next)
overrideprotectedvirtual

Reimplemented from QWidget::focusNextPrevChild().

Reimplemented from QWidget.

void QPlainTextEdit::focusOutEvent ( QFocusEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::focusOutEvent().

Reimplemented from QWidget.

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

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

void QPlainTextEdit::inputMethodEvent ( QInputMethodEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::inputMethodEvent().

Reimplemented from QWidget.

QVariant QPlainTextEdit::inputMethodQuery ( Qt::InputMethodQuery  property) const
overridevirtual

Reimplemented from QWidget::inputMethodQuery().

Reimplemented from QWidget.

QVariant QPlainTextEdit::inputMethodQuery ( Qt::InputMethodQuery  query,
QVariant  argument 
) const

Documentation pending.

void QPlainTextEdit::insertFromMimeData ( const QMimeData source)
protected

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.

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);
bool QPlainTextEdit::isReadOnly ( ) const

Documentation pending.

bool QPlainTextEdit::isUndoRedoEnabled ( ) const
inline

Documentation pending.

void QPlainTextEdit::keyPressEvent ( QKeyEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::keyPressEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::keyReleaseEvent ( QKeyEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::keyReleaseEvent().

Reimplemented from QWidget.

LineWrapMode QPlainTextEdit::lineWrapMode ( ) const

Documentation pending.

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

Loads the resource specified by the given type and name. This method is an extension of QTextDocument::loadResource().

See also
QTextDocument::loadResource()
int QPlainTextEdit::maximumBlockCount ( ) const
inline

Documentation pending.

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

void QPlainTextEdit::mouseDoubleClickEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseDoubleClickEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::mouseMoveEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseMoveEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::mousePressEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mousePressEvent().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::mouseReleaseEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseReleaseEvent().

Reimplemented from QAbstractScrollArea.

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()
bool QPlainTextEdit::overwriteMode ( ) const

Documentation pending.

void QPlainTextEdit::paintEvent ( QPaintEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::paintEvent().

Reimplemented from QAbstractScrollArea.

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 method, which will modify what QPlainTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() methods.

See also
cut(), copy()
QString QPlainTextEdit::placeholderText ( ) const

Documentation pending.

void QPlainTextEdit::print ( QPagedPaintDevice printer) const

Convenience method 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()
void QPlainTextEdit::redo ( )
slot

The last operation is redone. If there is no operation to redo, then there is no redo step in the undo/redo history and nothing happens.

See also
undo()
void QPlainTextEdit::redoAvailable ( bool  status)
signal

This signal is emitted when the redo operations become available. If redo operation is possible then status will be true, otherwise it will be false.

void QPlainTextEdit::resizeEvent ( QResizeEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::resizeEvent()

Reimplemented from QAbstractScrollArea.

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

Reimplemented from QAbstractScrollArea::scrollContentsBy().

Reimplemented from QAbstractScrollArea.

void QPlainTextEdit::selectAll ( )
slot

Selects all text.

See also
copy(), cut(), textCursor()
void QPlainTextEdit::selectionChanged ( )
signal

This signal is emitted whenever the selection changes.

See also
copyAvailable()
void QPlainTextEdit::setBackgroundVisible ( bool  visible)

Documentation pending.

void QPlainTextEdit::setCenterOnScroll ( bool  enabled)

Documentation pending.

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.

See also
currentCharFormat()
void QPlainTextEdit::setCursorWidth ( int  width)

Documentation pending.

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()
void QPlainTextEdit::setDocumentTitle ( const QString title)
inline

Documentation pending.

void QPlainTextEdit::setExtraSelections ( const QList< QTextEdit::ExtraSelection > &  selections)

This method 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()
void QPlainTextEdit::setLineWrapMode ( LineWrapMode  mode)

Documentation pending.

void QPlainTextEdit::setMaximumBlockCount ( int  maximum)
inline

Documentation pending.

void QPlainTextEdit::setOverwriteMode ( bool  overwrite)

Documentation pending.

void QPlainTextEdit::setPlaceholderText ( const QString placeholderText)

Documentation pending.

void QPlainTextEdit::setPlainText ( const QString text)
slot

Documentation pending.

void QPlainTextEdit::setReadOnly ( bool  ro)

Documentation pending.

void QPlainTextEdit::setTabChangesFocus ( bool  b)

Documentation pending.

void QPlainTextEdit::setTabStopWidth ( int  width)

Documentation pending.

void QPlainTextEdit::setTextCursor ( const QTextCursor cursor)

Sets the visible cursor.

See also
textCursor()
void QPlainTextEdit::setTextInteractionFlags ( Qt::TextInteractionFlags  flags)

Documentation pending.

void QPlainTextEdit::setUndoRedoEnabled ( bool  enable)
inline

Documentation pending.

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

Documentation pending.

void QPlainTextEdit::showEvent ( QShowEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::showEvent().

Reimplemented from QWidget.

bool QPlainTextEdit::tabChangesFocus ( ) const

Documentation pending.

int QPlainTextEdit::tabStopWidth ( ) const

Documentation pending.

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.

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.

See also
setTextCursor()
Qt::TextInteractionFlags QPlainTextEdit::textInteractionFlags ( ) const

Documentation pending.

QString QPlainTextEdit::toPlainText ( ) const
inline

Documentation pending.

void QPlainTextEdit::undo ( )
slot

Undoes the last operation. If there is no operation to undo, there there is no undo step in the undo/redo history and nothing happens.

See also
redo()
void QPlainTextEdit::undoAvailable ( bool  status)
signal

This signal is emitted when the undo operations become available. If the undo operation is possible then status will be true, otherwise it will be false.

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.

void QPlainTextEdit::wheelEvent ( QWheelEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::wheelEvent().

Reimplemented from QAbstractScrollArea.

QTextOption::WrapMode QPlainTextEdit::wordWrapMode ( ) const

Documentation pending.

void QPlainTextEdit::zoomIn ( int  range = 1)
slot

Documentation pending.

void QPlainTextEdit::zoomInF ( float  range)
protected

Documentation pending.

void QPlainTextEdit::zoomOut ( int  range = 1)
slot

Documentation pending.

Property Documentation

QPlainTextEdit::backgroundVisible

This property holds 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 will not. 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.

PropertiesClass Methods
read backgroundVisible
write setBackgroundVisible
QPlainTextEdit::blockCount

This property holds the number of text blocks in the document.

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

PropertiesClass Methods
read blockCount
QPlainTextEdit::centerOnScroll

This property holds 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()
PropertiesClass Methods
read centerOnScroll
write setCenterOnScroll
QPlainTextEdit::cursorWidth

This property specifies the width of the cursor in pixels. The default value is 1.

PropertiesClass Methods
read cursorWidth
write setCursorWidth
QPlainTextEdit::documentTitle

This property holds the title of the document parsed from the text.

By default, this property contains an empty string.

PropertiesClass Methods
read documentTitle
write setDocumentTitle
QPlainTextEdit::lineWrapMode

This property holds 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().

PropertiesClass Methods
read lineWrapMode
write setLineWrapMode
QPlainTextEdit::maximumBlockCount

This property holds 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. This setting this property will apply the limit immediately to the document contents. Setting this property also disables the undo redo history.

The default value is 0.

PropertiesClass Methods
read maximumBlockCount
write setMaximumBlockCount
QPlainTextEdit::overwriteMode

This property holds 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).

PropertiesClass Methods
read overwriteMode
write setOverwriteMode
QPlainTextEdit::placeholderText

This property holds the editor placeholder text. By default,this property contains an empty string.

Setting this property makes the editor display a grayed-out placeholder text when the document() is empty.

PropertiesClass Methods
read placeholderText
write setPlaceholderText
QPlainTextEdit::plainText

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.

PropertiesClass Methods
read toPlainText
write setPlainText
notify textChanged
user true
QPlainTextEdit::readOnly

This property holds 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.

PropertiesClass Methods
read isReadOnly
write setReadOnly
QPlainTextEdit::tabChangesFocus

This property holds 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.

PropertiesClass Methods
read tabChangesFocus
write setTabChangesFocus
QPlainTextEdit::tabStopWidth

This property holds the tab stop width in pixels.

By default, this property contains a value of 80.

PropertiesClass Methods
read tabStopWidth
write setTabStopWidth
QPlainTextEdit::textInteractionFlags

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.

PropertiesClass Methods
read textInteractionFlags
write setTextInteractionFlags
QPlainTextEdit::undoRedoEnabled

This property holds 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.

PropertiesClass Methods
read isUndoRedoEnabled
write setUndoRedoEnabled
QPlainTextEdit::wordWrapMode

This property holds the mode QPlainTextEdit will use when wrapping text by words.

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

See also
QTextOption::WrapMode
PropertiesClass Methods
read wordWrapMode
write setWordWrapMode