CopperSpice API  1.7.2
QTextEdit Class Reference

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

Inheritance diagram for QTextEdit:
QAbstractScrollArea QFrame QWidget QObject QPaintDevice QTextBrowser

Classes

class  ExtraSelection
 The QTextEdit::ExtraSelection structure provides a way of specifying a character format for a given selection in a document More...
 

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 copyAvailable (bool status)
 
void currentCharFormatChanged (const QTextCharFormat &format)
 
void cursorPositionChanged ()
 
void redoAvailable (bool status)
 
void selectionChanged ()
 
void textChanged ()
 
void undoAvailable (bool status)
 
- 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 append (const QString &text)
 
void clear ()
 
void copy ()
 
void cut ()
 
void insertHtml (const QString &text)
 
void insertPlainText (const QString &text)
 
void paste ()
 
void redo ()
 
void scrollToAnchor (const QString &name)
 
void selectAll ()
 
void setAlignment (Qt::Alignment align)
 
void setCurrentFont (const QFont &font)
 
void setFontFamily (const QString &fontFamily)
 
void setFontItalic (bool italic)
 
void setFontPointSize (qreal size)
 
void setFontUnderline (bool underline)
 
void setFontWeight (int weight)
 
void setHtml (const QString &text)
 
void setPlainText (const QString &text)
 
void setText (const QString &text)
 
void setTextBackgroundColor (const QColor &color)
 
void setTextColor (const QColor &color)
 
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

 QTextEdit (const QString &text, QWidget *parent=nullptr)
 
 QTextEdit (QWidget *parent=nullptr)
 
virtual ~QTextEdit ()
 
bool acceptRichText () const
 
Qt::Alignment alignment () const
 
QString anchorAt (const QPoint &pos) const
 
AutoFormatting autoFormatting () const
 
bool canPaste () const
 
QMenucreateStandardContextMenu ()
 
QMenucreateStandardContextMenu (const QPoint &position)
 
QTextCharFormat currentCharFormat () const
 
QFont currentFont () 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< ExtraSelectionextraSelections () const
 
bool find (const QRegularExpression &exp, QTextDocument::FindFlags options=QTextDocument::FindFlags ())
 
bool find (const QString &exp, QTextDocument::FindFlags options=QTextDocument::FindFlags ())
 
QString fontFamily () const
 
bool fontItalic () const
 
qreal fontPointSize () const
 
bool fontUnderline () const
 
int fontWeight () const
 
QVariant inputMethodQuery (Qt::InputMethodQuery property) const override
 
bool isReadOnly () const
 
bool isUndoRedoEnabled () const
 
int lineWrapColumnOrWidth () const
 
LineWrapMode lineWrapMode () const
 
virtual QVariant loadResource (int type, const QUrl &name)
 
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 setAcceptRichText (bool accept)
 
void setAutoFormatting (AutoFormatting features)
 
void setCurrentCharFormat (const QTextCharFormat &format)
 
void setCursorWidth (int width)
 
void setDocument (QTextDocument *document)
 
void setDocumentTitle (const QString &title)
 
void setExtraSelections (const QList< ExtraSelection > &selections)
 
void setLineWrapColumnOrWidth (int w)
 
void setLineWrapMode (LineWrapMode mode)
 
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
 
QColor textBackgroundColor () const
 
QColor textColor () const
 
QTextCursor textCursor () const
 
Qt::TextInteractionFlags textInteractionFlags () const
 
QString toHtml () 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

virtual bool canInsertFromMimeData (const QMimeData *source) const
 
void changeEvent (QEvent *event) override
 
void contextMenuEvent (QContextMenuEvent *event) override
 
virtual QMimeDatacreateMimeDataFromSelection () const
 
void dragEnterEvent (QDragEnterEvent *event) override
 
void dragLeaveEvent (QDragLeaveEvent *event) override
 
void dragMoveEvent (QDragMoveEvent *event) override
 
void dropEvent (QDropEvent *event) override
 
void focusInEvent (QFocusEvent *event) override
 
bool focusNextPrevChild (bool next) override
 
void focusOutEvent (QFocusEvent *event) override
 
void inputMethodEvent (QInputMethodEvent *event) override
 
virtual 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
 
virtual void scrollContentsBy (int dx, int dy) override
 
void showEvent (QShowEvent *event) override
 
void wheelEvent (QWheelEvent *event) override
 
- 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

 acceptRichText
 
 autoFormatting
 
 cursorWidth
 
 document
 
 documentTitle
 
 html
 
 lineWrapColumnOrWidth
 
 lineWrapMode
 
 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
 

Friends

class QTextDocument
 

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 QTextEdit class provides a widget that is used to edit and display both plain and rich text. It is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. QTextEdit is optimized to handle large documents and to respond quickly to user input.

QTextEdit 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. The words in the paragraph are aligned in accordance with the paragraph's alignment. Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.

QTextEdit can display images, lists and tables. If the text is too large to view within the text edit's viewport, scroll bars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4).

If you just need to display a small piece of rich text consider using QLabel.

The rich text support in CopperSpice is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors. If you find the HTML support insufficient for your needs you may consider the use of CsWebKit, which provides a full-featured web browser widget.

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

Using QTextEdit as a Display Widget

QTextEdit can display a large HTML subset, including tables and images.

The text is set or replaced using setHtml() which deletes any existing text and replaces it with the text passed in the setHtml() call. If you call setHtml() with legacy HTML, and then call toHtml(), the text that is returned may have different markup, but will render the same. The entire text can be deleted with clear().

Text itself can be inserted using the QTextCursor class or using the convenience functions insertHtml(), insertPlainText(), append() or paste(). QTextCursor is also able to insert complex objects like tables or lists into the document, and it deals with creating selections and applying changes to selected text.

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, or NoWrap if you do not want any wrapping. Call setLineWrapMode() to set a fixed pixel width FixedPixelWidth, or character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified with setLineWrapColumnOrWidth(). 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 QTextEdit, as for example it is often useful in a log viewer, then you can use QTextDocument's maximumBlockCount property for that.

Read-only Key Bindings

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

KeypressesAction
UpMoves one line up.
DownMoves one line down.
LeftMoves one character to the left.
RightMoves 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.

The text edit may be able to provide some meta information. For example, the documentTitle() method will return the text from within HTML <title> tags.

Using QTextEdit as an Editor

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

The current char format's attributes are set with setFontItalic(), setFontWeight(), setFontUnderline(), setFontFamily(), setFontPointSize(), setTextColor() and setCurrentFont(). The current paragraph's alignment is set with setAlignment(). 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 QTextEdit just create one on a QTextCursor object and then make that cursor the visible cursor using setTextCursor(). 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().

When the cursor is moved and the underlying formatting attributes change, the currentCharFormatChanged() signal is emitted to reflect the new attributes at the new cursor position.

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

Drag and Drop

QTextEdit also supports custom drag and drop behavior. By default, QTextEdit will insert plain text, HTML and rich text when the user drops data of these MIME types onto a document. Reimplement canInsertFromMimeData() and insertFromMimeData() to add support for additional MIME types.

As an example, to allow the user to drag and drop an image onto a QTextEdit, you could the implement these functions in the following way.

bool TextEdit::canInsertFromMimeData( const QMimeData *source ) const {
if (source->hasImage()) {
return true;
} else {
}
}

We add support for image MIME types by returning true. For all other MIME types, we use the default implementation.

void TextEdit::insertFromMimeData( const QMimeData *source ) {
if (source->hasImage()) {
QImage image = qvariant_cast<QImage>(source->imageData());
document->addResource(QTextDocument::ImageResource, QUrl("image"), image);
cursor.insertImage("image");
}
}

We unpack the image from the QVariant held by the MIME source and insert it into the document as a resource.

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.
LeftMoves the cursor one character to the left.
Ctrl+LeftMoves the cursor one word to the left.
RightMoves the cursor one character to the right.
Ctrl+RightMoves the cursor one word to the right.
UpMoves the cursor one line up.
DownMoves the cursor one line 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).

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

See also
QTextDocument, QTextCursor, Rich Text Processing

Member Enumeration Documentation

ConstantValue
QTextEdit::NoWrap0
QTextEdit::WidgetWidth1
QTextEdit::FixedPixelWidth2
QTextEdit::FixedColumnWidth3

Constructor & Destructor Documentation

QTextEdit::QTextEdit ( QWidget parent = nullptr)
explicit

Constructs an empty QTextEdit with parent parent.

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

Constructs a QTextEdit with parent parent. The text edit will display the text text. The text is interpreted as html.

QTextEdit::~QTextEdit ( )
virtual

Destroys this QTextEdit.

Method Documentation

bool QTextEdit::acceptRichText ( ) const

Property documentation pending.

Qt::Alignment QTextEdit::alignment ( ) const

Returns the alignment of the current paragraph.

See also
setAlignment()
QString QTextEdit::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 QTextEdit::append ( const QString text)
slot

Appends a new paragraph with text to the end of the text edit. The new paragraph appended will have the same character format and block format as the current paragraph, determined by the position of the cursor.

See also
currentCharFormat(), QTextCursor::blockFormat()
AutoFormatting QTextEdit::autoFormatting ( ) const

Property documentation pending.

bool QTextEdit::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 and drop operation.

Reimplement this function to enable drag and drop support for additional MIME types.

bool QTextEdit::canPaste ( ) const

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

void QTextEdit::changeEvent ( QEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::changeEvent().

Reimplemented from QFrame.

void QTextEdit::clear ( )
slot

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

See also
cut(), setPlainText(), setHtml()
void QTextEdit::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 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 MyTextEdit::contextMenuEvent(QContextMenuEvent *event) {
menu->addAction(tr("My Menu Item"));
menu->exec(event->globalPos());
delete menu;
}

Reimplemented from QAbstractScrollArea.

void QTextEdit::copy ( )
slot

Copies any selected text to the clipboard.

See also
copyAvailable()
void QTextEdit::copyAvailable ( bool  status)
signal

This signal is emitted when text is selected or deselected 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 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()
QMimeData * QTextEdit::createMimeDataFromSelection ( ) const
protectedvirtual

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

QMenu * QTextEdit::createStandardContextMenu ( )

This method creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

We recommend that you use the createStandardContextMenu(QPoint) version instead which will enable the actions that are sensitive to where the user clicked.

QMenu * QTextEdit::createStandardContextMenu ( const QPoint position)

This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. It is called from the default contextMenuEvent() handler and it takes the position of where the mouse click was. This can enable actions that are sensitive to the position where the user clicked. The popup menu's ownership is transferred to the caller.

QTextCharFormat QTextEdit::currentCharFormat ( ) const

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

See also
setCurrentCharFormat()
void QTextEdit::currentCharFormatChanged ( const QTextCharFormat format)
signal

This signal is emitted if the current character format has changed. For example. a change in the cursor position.

See also
setCurrentCharFormat()
QFont QTextEdit::currentFont ( ) const

Returns the font of the current format.

See also
setCurrentFont(), setFontFamily(), setFontPointSize()
QTextCursor QTextEdit::cursorForPosition ( const QPoint pos) const

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

void QTextEdit::cursorPositionChanged ( )
signal

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

QRect QTextEdit::cursorRect ( ) const

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

QRect QTextEdit::cursorRect ( const QTextCursor cursor) const

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

int QTextEdit::cursorWidth ( ) const

Property documentation pending.

void QTextEdit::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 * QTextEdit::document ( ) const

Returns a pointer to the underlying document.

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

Property documentation pending.

void QTextEdit::dragEnterEvent ( QDragEnterEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive drag events for the viewport() widget. The event is passed in event.

See also
QWidget::dragEnterEvent()

Reimplemented from QAbstractScrollArea.

void QTextEdit::dragLeaveEvent ( QDragLeaveEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive drag leave events for the viewport() widget. The event is passed in event.

See also
QWidget::dragLeaveEvent()

Reimplemented from QAbstractScrollArea.

void QTextEdit::dragMoveEvent ( QDragMoveEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive drag move events or the viewport() widget. The event is passed in event.

See also
QWidget::dragMoveEvent()

Reimplemented from QAbstractScrollArea.

void QTextEdit::dropEvent ( QDropEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive drop events for the viewport() widget. The event is passed in event.

See also
QWidget::dropEvent()

Reimplemented from QAbstractScrollArea.

void QTextEdit::ensureCursorVisible ( )

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

QList< ExtraSelection > QTextEdit::extraSelections ( ) const

Returns previously set extra selections.

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

Finds the next occurrence, matching the regular expression, exp, using the given options. The QTextDocument::FindCaseSensitively option is ignored for this overload, use QRegularExpression::CaseInsensitiveOption instead.

Returns true if a match was found and changes the cursor to select the match, otherwise returns false.

bool QTextEdit::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.

void QTextEdit::focusInEvent ( QFocusEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive keyboard focus events for the widget. The default implementation updates the widget if a focusPolicy() is specified. The event is passed in the event parameter.

A widget normally must the setFocusPolicy() to something other than Qt::NoFocus in order to receive focus events.

See also
focusOutEvent(), setFocusPolicy(), keyPressEvent(), keyReleaseEvent(), event(), QFocusEvent

Reimplemented from QWidget.

bool QTextEdit::focusNextPrevChild ( bool  next)
overrideprotectedvirtual

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

If next is true this method searches forward, if next is false it searches backward.

You may want to reimplement this method. For example, a web browser might reimplement it to move its "current active link" forward or backward, and call focusNextPrevChild() only when it reaches the last or first link on the "page".

Child widgets call focusNextPrevChild() on their parent widgets, but only the window that contains the child widgets decides where to redirect focus. By reimplementing this method for an object, you thus gain control of focus traversal for all child widgets.

See also
focusNextChild(), focusPreviousChild()

Reimplemented from QWidget.

void QTextEdit::focusOutEvent ( QFocusEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive keyboard focus events for the widget. The default implementation updates the widget if a focusPolicy() is specified. The events is passed in the event parameter.

A widget normally must setFocusPolicy() to something other than Qt::NoFocus in order to receive focus events.

See also
focusInEvent(), setFocusPolicy(), keyPressEvent(), keyReleaseEvent(), event(), QFocusEvent

Reimplemented from QWidget.

QString QTextEdit::fontFamily ( ) const

Returns the font family of the current format.

See also
setFontFamily(), setCurrentFont(), setFontPointSize()
bool QTextEdit::fontItalic ( ) const

Returns true if the font of the current format is italic, otherwise returns false.

See also
setFontItalic()
qreal QTextEdit::fontPointSize ( ) const

Returns the point size of the font of the current format.

See also
setFontFamily(), setCurrentFont(), setFontPointSize()
bool QTextEdit::fontUnderline ( ) const

Returns true if the font of the current format is underlined, otherwise returns false.

See also
setFontUnderline()
int QTextEdit::fontWeight ( ) const

Returns the font weight of the current format.

See also
setFontWeight(), setCurrentFont(), setFontPointSize(), QFont::Weight
void QTextEdit::inputMethodEvent ( QInputMethodEvent event)
overrideprotectedvirtual

This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the state of the input method changes.

Note that when creating custom text editing widgets, the Qt::WA_InputMethodEnabled window attribute must be set explicitly (using the setAttribute() function) in order to receive input method events.

The default implementation calls event->ignore(), which rejects the Input Method event.

See also
event(), QInputMethodEvent

Reimplemented from QWidget.

QVariant QTextEdit::inputMethodQuery ( Qt::InputMethodQuery  query) const
overridevirtual

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.

The given query specifies which property is queried.

See also
inputMethodEvent(), QInputMethodEvent, inputMethodHints

Reimplemented from QWidget.

void QTextEdit::insertFromMimeData ( const QMimeData source)
protectedvirtual

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.

Reimplement this method to enable drag and drop support for additional MIME types.

void QTextEdit::insertHtml ( const QString text)
slot

Convenience slot that inserts text which is assumed to be of html formatting at the current cursor position.

Note
When using this method with a style sheet, the style sheet will only apply to the current block in the document. In order to apply a style sheet throughout a document, use QTextDocument::setDefaultStyleSheet() instead.

Calling this method is equivalent to the following line of code.

edit->textCursor().insertHtml(fragment);
void QTextEdit::insertPlainText ( const QString text)
slot

Convenience slot that inserts text at the current cursor position.

It is equivalent to the following line of code.

edit->textCursor().insertText(text);
bool QTextEdit::isReadOnly ( ) const

Property documentation pending.

bool QTextEdit::isUndoRedoEnabled ( ) const
inline

Property documentation pending.

void QTextEdit::keyPressEvent ( QKeyEvent event)
overrideprotectedvirtual

This method is called with key event event when key presses occur. It handles PageUp, PageDown, Up, Down, Left, and Right, and ignores all other key presses.

Reimplemented from QAbstractScrollArea.

void QTextEdit::keyReleaseEvent ( QKeyEvent event)
overrideprotectedvirtual

The event handler for event event can be reimplemented in a subclass to receive key release events for the widget. A widget must call setFocusPolicy() to accept focus initially and have focus in order to receive a key release event.

If you reimplement this handler it is very important to call the base class implementation if you do not act upon the key. A QKeyEvent starts with isAccepted() set to true so you do not need to call QKeyEvent::accept(). Do not call the base class implementation if you consume the key event.

The default implementation closes popup widgets if the user presses Esc. Otherwise the event is ignored and the widget's parent can react to it.

See also
keyPressEvent(), QKeyEvent::ignore(), setFocusPolicy(), focusInEvent(), focusOutEvent(), event(), QKeyEvent

Reimplemented from QWidget.

int QTextEdit::lineWrapColumnOrWidth ( ) const

Property documentation pending.

LineWrapMode QTextEdit::lineWrapMode ( ) const

Property documentation pending.

QVariant QTextEdit::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()

Reimplemented in QTextBrowser.

void QTextEdit::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 QTextEdit::mouseDoubleClickEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseDoubleClickEvent().

Reimplemented from QAbstractScrollArea.

void QTextEdit::mouseMoveEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseMoveEvent().

Reimplemented from QAbstractScrollArea.

void QTextEdit::mousePressEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mousePressEvent().

Reimplemented from QAbstractScrollArea.

void QTextEdit::mouseReleaseEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::mouseReleaseEvent().

Reimplemented from QAbstractScrollArea.

void QTextEdit::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 QTextEdit::overwriteMode ( ) const

Property documentation pending.

void QTextEdit::paintEvent ( QPaintEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive paint events passed in event. It is usually unnecessary to reimplement this function in a subclass of QTextEdit.

Warning
The underlying text document must not be modified from within a reimplementation of this function.

Reimplemented from QAbstractScrollArea.

void QTextEdit::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 QTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() functions.

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

Property documentation pending.

void QTextEdit::print ( QPagedPaintDevice printer) const

Convenience function to print the text edit's document to the given printer. This is equivalent to calling the print method on the document directly except that this function also supports QPrinter::Selection as print range.

See also
QTextDocument::print()
void QTextEdit::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()
void QTextEdit::redoAvailable ( bool  status)
signal

This signal is emitted whenever the status of redo operations changes. If status is true it is possible to redo. If status is false then a redo is not possible.

void QTextEdit::resizeEvent ( QResizeEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive resize events for the viewport() widget. The event is passed in event.

When resizeEvent() is called, the viewport already has its new geometry: Its new size is accessible through the QResizeEvent::size() function, and the old size through QResizeEvent::oldSize().

See also
QWidget::resizeEvent()

Reimplemented from QAbstractScrollArea.

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

This virtual handler is called when the scroll bars are moved by dx, dy, and consequently the viewport's contents should be scrolled accordingly.

The default implementation simply calls update() on the entire viewport(). Subclasses can reimplement this handler for optimization purposes, or as with QScrollArea to move a contents widget. The parameters dx and dy are there for convenience, so that the class knows how much should be scrolled. You may ignore these values and scroll directly to the position the scroll bars indicate.

Calling this method in order to scroll programmatically is an error, use the scroll bars instead (e.g. by calling QScrollBar::setValue() directly).

Reimplemented from QAbstractScrollArea.

void QTextEdit::scrollToAnchor ( const QString name)
slot

Scrolls the text edit so that the anchor with the given name is visible; does nothing if the name is empty, or is already visible, or is not found.

void QTextEdit::selectAll ( )
slot

Selects all text.

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

This signal is emitted whenever the selection changes.

See also
copyAvailable()
void QTextEdit::setAcceptRichText ( bool  accept)

Property documentation pending.

void QTextEdit::setAlignment ( Qt::Alignment  align)
slot

Sets the alignment of the current paragraph to align. Valid alignments are Qt::AlignLeft, Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally).

See also
alignment()
void QTextEdit::setAutoFormatting ( AutoFormatting  features)

Property documentation pending.

void QTextEdit::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 QTextEdit::setCurrentFont ( const QFont font)
slot

Sets the font of the current format to font.

See also
currentFont(), setFontPointSize(), setFontFamily()
void QTextEdit::setCursorWidth ( int  width)

Property documentation pending.

void QTextEdit::setDocument ( QTextDocument document)

Makes document the new document of the text editor.

The editor does not take ownership of the document unless it is the document's parent object. The parent object of the provided document remains the owner of the object. The editor does not delete the current document, even if it is a child of the editor.

See also
document()
void QTextEdit::setDocumentTitle ( const QString title)
inline

Property documentation pending.

void QTextEdit::setExtraSelections ( const QList< 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()
void QTextEdit::setFontFamily ( const QString fontFamily)
slot

Sets the font family of the current format to fontFamily.

See also
fontFamily(), setCurrentFont()
void QTextEdit::setFontItalic ( bool  italic)
slot

If italic is true, sets the current format to italic, otherwise sets the current format to non-italic.

See also
fontItalic()
void QTextEdit::setFontPointSize ( qreal  size)
slot

Sets the point size of the current format to size. If size is zero or negative, the behavior of this method is not defined.

See also
fontPointSize(), setCurrentFont(), setFontFamily()
void QTextEdit::setFontUnderline ( bool  underline)
slot

If underline is true, sets the current format to underline, otherwise sets the current format to non-underline.

See also
fontUnderline()
void QTextEdit::setFontWeight ( int  weight)
slot

Sets the font weight of the current format to the given weight, where the value used is in the range defined by the QFont::Weight enum.

See also
fontWeight(), setCurrentFont(), setFontFamily()
void QTextEdit::setHtml ( const QString text)
slot

Changes the text of this QTextEdit to edit. Any previous text is removed and the undo/redo history is cleared. The input text is interpreted as rich text in html format.

It is the responsibility of the caller to make sure that the text is correctly decoded when a QString containing HTML is created and passed to setHtml().

void QTextEdit::setLineWrapColumnOrWidth ( int  w)

Property documentation pending.

void QTextEdit::setLineWrapMode ( LineWrapMode  mode)

Property documentation pending.

void QTextEdit::setOverwriteMode ( bool  overwrite)

Property documentation pending.

void QTextEdit::setPlaceholderText ( const QString placeholderText)

Property documentation pending.

void QTextEdit::setPlainText ( const QString text)
slot

The method changes the text of the QTextE to the given text. It is assumed the text is plain text. Any previous text will be removed. The redo/undo history will also be cleared. The currentCharFormat property will be reset unless the textCursor property is at the beginning of the document.

See also
toPlainText()
void QTextEdit::setReadOnly ( bool  ro)

Property documentation pending.

void QTextEdit::setTabChangesFocus ( bool  b)

Property documentation pending.

void QTextEdit::setTabStopWidth ( int  width)

Property documentation pending.

void QTextEdit::setText ( const QString text)
slot

Sets the text for QTextEdit. The text can be plain text or HTML and the text edit will try to guess the right format. Use setHtml() or setPlainText() to specify how the text should be interpreted.

See also
toPlainText(), toHtml()
void QTextEdit::setTextBackgroundColor ( const QColor color)
slot

Sets the text background color of the current format to color.

See also
textBackgroundColor()
void QTextEdit::setTextColor ( const QColor color)
slot

Sets the text color of the current format to color.

See also
textColor()
void QTextEdit::setTextCursor ( const QTextCursor cursor)

Sets the visible cursor.

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

Property documentation pending.

void QTextEdit::setUndoRedoEnabled ( bool  enable)
inline

Property documentation pending.

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

Property documentation pending.

void QTextEdit::showEvent ( QShowEvent event)
overrideprotectedvirtual

Reimplemented from QWidget::showEvent().

Reimplemented from QWidget.

bool QTextEdit::tabChangesFocus ( ) const

Property documentation pending.

int QTextEdit::tabStopWidth ( ) const

Property documentation pending.

QColor QTextEdit::textBackgroundColor ( ) const

Returns the text background color of the current format.

See also
setTextBackgroundColor()
void QTextEdit::textChanged ( )
signal

This signal is emitted whenever the document content changes. This may occur when text is inserted or deleted, or when formatting is applied.

QColor QTextEdit::textColor ( ) const

Returns the text color of the current format.

See also
setTextColor()
QTextCursor QTextEdit::textCursor ( ) const

Returns a copy of the QTextCursor that represents the currently visible cursor. Note that changes on the returned cursor do not affect QTextEdit's cursor; use setTextCursor() to update the visible cursor.

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

Property documentation pending.

QString QTextEdit::toHtml ( ) const

Returns the text of the text edit as html.

QString QTextEdit::toPlainText ( ) const

Returns the text of the text edit as plain text.

See also
QTextEdit::setPlainText()
void QTextEdit::undo ( )
slot

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

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

This signal is emitted whenever undo operations become available (true) or unavailable (false) based on the given parameter status.

void QTextEdit::wheelEvent ( QWheelEvent event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive wheel events for the viewport() widget. The event is passed in event.

See also
QWidget::wheelEvent()

Reimplemented from QAbstractScrollArea.

QTextOption::WrapMode QTextEdit::wordWrapMode ( ) const

Property documentation pending.

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

Zooms in on the text by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See also
zoomOut()
void QTextEdit::zoomOut ( int  range = 1)
slot

Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See also
zoomIn()

Property Documentation

QTextEdit::acceptRichText

This property holds whether the text edit accepts rich text insertions by the user.

When this property is set to false text edit will accept only plain text input from the user. For example through clipboard or drag and drop.

This property's default is true.

PropertiesClass Methods
read acceptRichText
write setAcceptRichText
QTextEdit::autoFormatting

This property holds the enabled set of auto formatting features. The value can be any combination of the values in the AutoFormattingFlag enum. The default is AutoNone. Choose AutoAll to enable all automatic formatting.

Currently the only automatic formatting feature provided is AutoBulletList.

PropertiesClass Methods
read autoFormatting
write setAutoFormatting
QTextEdit::cursorWidth

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

PropertiesClass Methods
read cursorWidth
write setCursorWidth
QTextEdit::document

This property holds the underlying document of the text editor.

The editor does not take ownership of the document unless it is the document's parent object. The parent object of the provided document remains the owner of the object. If the previously assigned document is a child of the editor then it will be deleted.

PropertiesClass Methods
read document
write setDocument
designable true
QTextEdit::documentTitle

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

By default, for a newly-created, empty document, this property contains an empty string.

PropertiesClass Methods
read documentTitle
write setDocumentTitle
QTextEdit::html

This property provides an HTML interface to the text of the text edit. By default for a new empty document this property contains text to describe an HTML 4.0 document with no body text.

See also
Supported HTML Subset, plainText
PropertiesClass Methods
read toHtml
write setHtml
notify textChanged
user true
QTextEdit::lineWrapColumnOrWidth

This property holds the position (in pixels or columns depending on the wrap mode) where text will be wrapped.

If the wrap mode is FixedPixelWidth, the value is the number of pixels from the left edge of the text edit at which text should be wrapped. If the wrap mode is FixedColumnWidth, the value is the column number (in character columns) from the left edge of the text edit at which text should be wrapped.

By default this property contains a value of 0.

See also
lineWrapMode
PropertiesClass Methods
read lineWrapColumnOrWidth
write setLineWrapColumnOrWidth
QTextEdit::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(). If you set a wrap mode of FixedPixelWidth or FixedColumnWidth you should also call setLineWrapColumnOrWidth() with the width you want.

See also
lineWrapColumnOrWidth
PropertiesClass Methods
read lineWrapMode
write setLineWrapMode
QTextEdit::overwriteMode

This property holds whether text entered by the user will overwrite existing text.

As with many text editors, the 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
QTextEdit::placeholderText

This property holds the editor placeholder text. Setting this property makes the editor display a grayed-out placeholder text as long as the document() is empty.

By default this property contains an empty string.

PropertiesClass Methods
read placeholderText
write setPlaceholderText
QTextEdit::plainText

This property gets and sets the text editor's contents as plain text. Previous contents are removed and undo/redo history is reset when the property is set.

If the text edit has another content type, it will not be replaced by plain text if you call toPlainText(). The only exception to this is the non-break space, nbsp;, that will be converted into standard space.

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

See also
html
PropertiesClass Methods
read toPlainText
write setPlainText
designable true
QTextEdit::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
QTextEdit::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
QTextEdit::tabStopWidth

This property holds the tab stop width in pixels. By default this property contains a value of 80 pixels.

PropertiesClass Methods
read tabStopWidth
write setTabStopWidth
QTextEdit::textInteractionFlags

Specifies how the widget should interact with user input. The default value depends on whether the QTextEdit is read-only or editable, and whether it is a QTextBrowser or not.

PropertiesClass Methods
read textInteractionFlags
write setTextInteractionFlags
QTextEdit::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).

PropertiesClass Methods
read isUndoRedoEnabled
write setUndoRedoEnabled
QTextEdit::wordWrapMode

This property holds the mode QTextEdit 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