QPlainTextEdit Class

Documentation sur les fonctions membres

[explicit] QPlainTextEdit::QPlainTextEdit(QWidget *parent = nullptr)

Construit un QPlainTextEdit vide avec le parent parent.

[explicit] QPlainTextEdit::QPlainTextEdit(const QString &text, QWidget *parent = nullptr)

Construit un QPlainTextEdit avec le parent parent. L'éditeur de texte affichera le texte brut text.

[virtual noexcept] QPlainTextEdit::~QPlainTextEdit()

Destructeur.

QString QPlainTextEdit::anchorAt(const QPoint &pos) const

Renvoie la référence de l'ancre à la position pos, ou une chaîne vide si aucune ancre n'existe à cet endroit.

[slot] void QPlainTextEdit::appendHtml(const QString &html)

Ajoute un nouveau paragraphe avec html à la fin de l'édition de texte.

appendPlainText()

[slot] void QPlainTextEdit::appendPlainText(const QString &text)

Ajoute un nouveau paragraphe avec text à la fin de l'édition de texte.

Voir également appendHtml().

[protected] QRectF QPlainTextEdit::blockBoundingGeometry(const QTextBlock &block) const

Renvoie le rectangle de délimitation du texte block en coordonnées de contenu. Traduisez le rectangle avec contentOffset() pour obtenir des coordonnées visuelles sur la fenêtre d'affichage.

Voir aussi firstVisibleBlock() et blockBoundingRect().

[protected] QRectF QPlainTextEdit::blockBoundingRect(const QTextBlock &block) const

Renvoie le rectangle de délimitation du texte block dans les coordonnées du bloc.

Voir aussi blockBoundingGeometry().

[signal] void QPlainTextEdit::blockCountChanged(int newBlockCount)

Ce signal est émis lorsque le nombre de blocs change. Le nouveau nombre de blocs est transmis à newBlockCount.

[virtual protected] bool QPlainTextEdit::canInsertFromMimeData(const QMimeData *source) const

Cette fonction renvoie true si le contenu de l'objet de données MIME, spécifié par source, peut être décodé et inséré dans le document. Elle est appelée par exemple lorsque, au cours d'une opération de glissement, la souris entre dans ce widget et qu'il est nécessaire de déterminer s'il est possible d'accepter le glissement.

bool QPlainTextEdit::canPaste() const

Indique si le texte peut être collé depuis le presse-papiers dans la zone de texte.

[slot] void QPlainTextEdit::centerCursor()

Fait défiler le document afin de centrer le curseur verticalement.

Voir également ensureCursorVisible() et centerOnScroll.

[override virtual protected] void QPlainTextEdit::changeEvent(QEvent *e)

Réimplémente : QFrame::changeEvent(QEvent *ev).

[slot] void QPlainTextEdit::clear()

Supprime tout le texte de l'édition de texte.

Notes :

• L'historique annuler/refaire est également effacé.
• currentCharFormat() est réinitialisé, sauf si textCursor() se trouve déjà au début du document.

Voir également cut() et setPlainText().

[protected] QPointF QPlainTextEdit::contentOffset() const

Renvoie l'origine du contenu dans les coordonnées de la fenêtre.

L'origine du contenu d'un texte simple est toujours le coin supérieur gauche du premier bloc de texte visible. Le décalage du contenu est différent de (0,0) lorsque le texte a été déplacé horizontalement, ou lorsque le premier bloc visible a été déplacé partiellement hors de l'écran, c'est-à-dire que le texte visible ne commence pas à la première ligne du premier bloc visible, ou lorsque le premier bloc visible est le tout premier bloc et que l'éditeur affiche une marge.

Voir également firstVisibleBlock(), horizontalScrollBar() et verticalScrollBar().

[override virtual protected] void QPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)

Réimplémente : QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e).

Affiche le menu contextuel standard créé avec createStandardContextMenu().

Si vous ne souhaitez pas que l'éditeur de texte dispose d'un menu contextuel, vous pouvez définir sa valeur contextMenuPolicy sur Qt::NoContextMenu. Si vous souhaitez personnaliser le menu contextuel, réimplémentez cette fonction. Si vous souhaitez étendre le menu contextuel standard, réimplémentez cette fonction, appelez createStandardContextMenu() et étendez le menu renvoyé.

Les informations relatives à l'événement sont transmises dans l'objet event.

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

[slot] void QPlainTextEdit::copy()

Copie le texte sélectionné dans le presse-papiers.

Voir aussi copyAvailable().

[signal] void QPlainTextEdit::copyAvailable(bool yes)

Ce signal est émis lorsque du texte est sélectionné ou désélectionné dans l'édition de texte.

Lorsqu'un texte est sélectionné, ce signal est émis lorsque yes vaut true. Si aucun texte n'a été sélectionné ou si le texte sélectionné est désélectionné, ce signal est émis avec yes à false.

Si yes est vrai, copy() peut être utilisé pour copier la sélection dans le presse-papiers. Si yes est faux, copy() ne fait rien.

Voir aussi selectionChanged().

[virtual protected] QMimeData *QPlainTextEdit::createMimeDataFromSelection() const

Cette fonction renvoie un nouvel objet de données MIME représentant le contenu de la sélection actuelle de l'éditeur de texte. Elle est appelée lorsque la sélection doit être encapsulée dans un nouvel objet QMimeData; par exemple, lorsqu'une opération de glisser-déposer est lancée ou lorsque des données sont copiées dans le presse-papiers.

Si vous réimplémentez cette fonction, notez que la propriété de l'objet QMimeData renvoyé est transmise à l'appelant. La sélection peut être récupérée à l'aide de la fonction textCursor().

QMenu *QPlainTextEdit::createStandardContextMenu()

Cette fonction crée le menu contextuel standard qui s'affiche lorsque l'utilisateur clique sur le texte à éditer avec le bouton droit de la souris. Elle est appelée à partir du gestionnaire par défaut contextMenuEvent(). La propriété du menu contextuel est transférée à l'appelant.

Nous vous recommandons d'utiliser plutôt la version createStandardContextMenu(QPoint) qui activera les actions sensibles à l'endroit où l'utilisateur a cliqué.

QMenu *QPlainTextEdit::createStandardContextMenu(const QPoint &position)

Cette fonction crée le menu contextuel standard qui s'affiche lorsque l'utilisateur clique sur le texte à éditer avec le bouton droit de la souris. Elle est appelée à partir du gestionnaire par défaut contextMenuEvent() et prend l'adresse position dans les coordonnées du document où le clic de la souris a eu lieu. Cela permet d'effectuer des actions sensibles à l'endroit où l'utilisateur a cliqué. La propriété du menu contextuel est transférée à l'appelant.

QTextCharFormat QPlainTextEdit::currentCharFormat() const

Renvoie le format de caractères utilisé lors de l'insertion d'un nouveau texte.

Voir aussi setCurrentCharFormat().

QTextCursor QPlainTextEdit::cursorForPosition(const QPoint &pos) const

renvoie une adresse QTextCursor à la position pos (en coordonnées de la fenêtre).

[signal] void QPlainTextEdit::cursorPositionChanged()

Ce signal est émis lorsque la position du curseur a changé.

QRect QPlainTextEdit::cursorRect() const

renvoie un rectangle (en coordonnées d'affichage) qui inclut le curseur de l'édition de texte.

QRect QPlainTextEdit::cursorRect(const QTextCursor &cursor) const

renvoie un rectangle (en coordonnées d'affichage) qui inclut le site cursor.

[slot] void QPlainTextEdit::cut()

Copie le texte sélectionné dans le presse-papiers et le supprime de l'édition de texte.

S'il n'y a pas de texte sélectionné, rien ne se passe.

Voir aussi copy() et paste().

QTextDocument *QPlainTextEdit::document() const

Renvoie un pointeur sur le document sous-jacent.

Voir aussi setDocument().

[override virtual protected] void QPlainTextEdit::dragEnterEvent(QDragEnterEvent *e)

Réimplémente : QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event).

[override virtual protected] void QPlainTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

Réimplémente : QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event).

[override virtual protected] void QPlainTextEdit::dragMoveEvent(QDragMoveEvent *e)

Réimplémente : QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event).

[override virtual protected] void QPlainTextEdit::dropEvent(QDropEvent *e)

Réimplémente : QAbstractScrollArea::dropEvent(QDropEvent *event).

void QPlainTextEdit::ensureCursorVisible()

S'assure que le curseur est visible en faisant défiler l'édition de texte si nécessaire.

Voir également centerCursor() et centerOnScroll.

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

Renvoie les sélections supplémentaires précédemment définies.

Voir aussi setExtraSelections().

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

Trouve la prochaine occurrence de la chaîne de caractères exp, en utilisant la chaîne de caractères options. Renvoie true si exp a été trouvé et change le curseur pour sélectionner la correspondance ; sinon, renvoie false.

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

Recherche l'occurrence suivante, correspondant à l'expression régulière exp, en utilisant l'adresse options.

Renvoie true si une correspondance a été trouvée et change le curseur pour sélectionner la correspondance ; sinon, renvoie false.

[protected] QTextBlock QPlainTextEdit::firstVisibleBlock() const

Renvoie le premier bloc visible.

Voir aussi blockBoundingRect().

[override virtual protected] void QPlainTextEdit::focusInEvent(QFocusEvent *e)

Réimplémente : QWidget::focusInEvent(QFocusEvent *event).

[override virtual protected] bool QPlainTextEdit::focusNextPrevChild(bool next)

Réimplémente : QWidget::focusNextPrevChild(bool next).

[override virtual protected] void QPlainTextEdit::focusOutEvent(QFocusEvent *e)

Réimplémente : QWidget::focusOutEvent(QFocusEvent *event).

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

Renvoie le contexte de peinture pour viewport(), utile uniquement lors de la réimplémentation de paintEvent().

[override virtual protected] void QPlainTextEdit::inputMethodEvent(QInputMethodEvent *e)

Réimplémente : QWidget::inputMethodEvent(QInputMethodEvent *event).

[override virtual] QVariant QPlainTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

Réimplémente : QWidget::inputMethodQuery(Qt::InputMethodQuery query) const.

[virtual protected] void QPlainTextEdit::insertFromMimeData(const QMimeData *source)

Cette fonction insère le contenu de l'objet de données MIME, spécifié par source, dans l'édition de texte à la position actuelle du curseur. Elle est appelée chaque fois qu'un texte est inséré à la suite d'une opération de collage dans le presse-papiers ou lorsque l'éditeur de texte accepte des données provenant d'une opération de glisser-déposer.

[slot] void QPlainTextEdit::insertPlainText(const QString &text)

Slot de commodité qui insère text à la position actuelle du curseur.

Il est équivalent à

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

[override virtual protected] void QPlainTextEdit::keyPressEvent(QKeyEvent *e)

Réimplémente : QAbstractScrollArea::keyPressEvent(QKeyEvent *e).

[override virtual protected] void QPlainTextEdit::keyReleaseEvent(QKeyEvent *e)

Réimplémente : QWidget::keyReleaseEvent(QKeyEvent *event).

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

Charge la ressource spécifiée par les données type et name.

Cette fonction est une extension de QTextDocument::loadResource().

Voir aussi QTextDocument::loadResource().

void QPlainTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

Fusionne les propriétés spécifiées dans modifier dans le format de caractère actuel en appelant QTextCursor::mergeCharFormat sur le curseur de l'éditeur. Si l'éditeur a une sélection, les propriétés de modifier sont directement appliquées à la sélection.

Voir aussi QTextCursor::mergeCharFormat().

[signal] void QPlainTextEdit::modificationChanged(bool changed)

Ce signal est émis chaque fois que le contenu du document change d'une manière qui affecte l'état de modification. Si changed est vrai, le document a été modifié ; sinon, il est faux.

Par exemple, l'appel à setModified(false) sur un document et l'insertion d'un texte entraînent l'émission du signal. Si vous annulez cette opération, ce qui ramène le document à son état initial non modifié, le signal sera à nouveau émis.

[override virtual protected] void QPlainTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

Réimplémente : QAbstractScrollArea::mouseDoubleClickEvent(QMouseEvent *e).

[override virtual protected] void QPlainTextEdit::mouseMoveEvent(QMouseEvent *e)

Réimplémente : QAbstractScrollArea::mouseMoveEvent(QMouseEvent *e).

[override virtual protected] void QPlainTextEdit::mousePressEvent(QMouseEvent *e)

Réimplémente : QAbstractScrollArea::mousePressEvent(QMouseEvent *e).

[override virtual protected] void QPlainTextEdit::mouseReleaseEvent(QMouseEvent *e)

Réimplémente : QAbstractScrollArea::mouseReleaseEvent(QMouseEvent *e).

void QPlainTextEdit::moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor)

Déplace le curseur en exécutant la commande operation.

Si mode est QTextCursor::KeepAnchor, le curseur sélectionne le texte sur lequel il se déplace. Il s'agit du même effet que celui obtenu par l'utilisateur lorsqu'il maintient la touche Shift enfoncée et déplace le curseur à l'aide des touches du curseur.

Voir aussi QTextCursor::movePosition().

[override virtual protected] void QPlainTextEdit::paintEvent(QPaintEvent *e)

Réimplémente : QAbstractScrollArea::paintEvent(QPaintEvent *event).

[slot] void QPlainTextEdit::paste()

Colle le texte du presse-papiers dans l'édition de texte à la position actuelle du curseur.

S'il n'y a pas de texte dans le presse-papiers, rien ne se passe.

Pour modifier le comportement de cette fonction, c'est-à-dire pour modifier ce que QPlainTextEdit peut coller et comment il est collé, réimplémentez les fonctions virtuelles canInsertFromMimeData() et insertFromMimeData().

Voir également cut() et copy().

void QPlainTextEdit::print(QPagedPaintDevice *printer) const

Fonction de commodité pour imprimer le document de l'éditeur de texte à l'adresse printer. Cela équivaut à appeler directement la méthode d'impression sur le document, sauf que cette fonction prend également en charge QPrinter::Selection en tant que plage d'impression.

Voir aussi QTextDocument::print().

[slot] void QPlainTextEdit::redo()

Refait la dernière opération.

S'il n'y a pas d'opération à refaire, c'est-à-dire s'il n'y a pas d'étape à refaire dans l'historique undo/redo, rien ne se passe.

Voir également undo().

[signal] void QPlainTextEdit::redoAvailable(bool available)

Ce signal est émis lorsque les opérations de rétablissement deviennent disponibles (available est vrai) ou indisponibles (available est faux).

[override virtual protected] void QPlainTextEdit::resizeEvent(QResizeEvent *e)

Réimplémente : QAbstractScrollArea::resizeEvent(QResizeEvent *event).

[override virtual protected] void QPlainTextEdit::scrollContentsBy(int dx, int dy)

Réimplémente : QAbstractScrollArea::scrollContentsBy(int dx, int dy).

[slot] void QPlainTextEdit::selectAll()

Sélectionne tout le texte.

Voir aussi copy(), cut() et textCursor().

[signal] void QPlainTextEdit::selectionChanged()

Ce signal est émis lorsque la sélection change.

Voir également copyAvailable().

void QPlainTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

Définit le format de caractères à utiliser lors de l'insertion d'un nouveau texte à format en appelant QTextCursor::setCharFormat() sur le curseur de l'éditeur. Si l'éditeur dispose d'une sélection, le format de caractères est directement appliqué à la sélection.

Voir aussi currentCharFormat().

void QPlainTextEdit::setDocument(QTextDocument *document)

Fait de document le nouveau document de l'éditeur de texte.

Le parent QObject du document fourni reste le propriétaire de l'objet. Si le document actuel est un enfant de l'éditeur de texte, il est supprimé.

Le document doit avoir une mise en page qui hérite de QPlainTextDocumentLayout (voir QTextDocument::setDocumentLayout()).

Voir également document().

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

Cette fonction permet de marquer temporairement certaines régions du document avec une couleur donnée, spécifiée sous selections. Cela peut être utile, par exemple, dans un éditeur de programmation pour marquer toute une ligne de texte avec une couleur de fond donnée afin d'indiquer l'existence d'un point d'arrêt.

Voir également QTextEdit::ExtraSelection et extraSelections().

[slot] void QPlainTextEdit::setPlainText(const QString &text)

Modifie le texte de l'édition de texte en le remplaçant par la chaîne text. Tout texte précédent est supprimé.

text est interprété comme du texte brut.

Remarques :

• L'historique d'annulation et de rétablissement est également effacé.
• currentCharFormat() est réinitialisé, sauf si textCursor() se trouve déjà au début du document.

Voir également toPlainText().

void QPlainTextEdit::setTextCursor(const QTextCursor &cursor)

Définit la valeur visible de cursor.

Voir aussi textCursor().

[override virtual protected] void QPlainTextEdit::showEvent(QShowEvent *)

Réimplémente : QWidget::showEvent(QShowEvent *event).

[signal] void QPlainTextEdit::textChanged()

Ce signal est émis chaque fois que le contenu du document est modifié, par exemple lorsque du texte est inséré ou supprimé, ou lorsque le formatage est appliqué.

QTextCursor QPlainTextEdit::textCursor() const

Renvoie une copie de QTextCursor qui représente le curseur actuellement visible. Notez que les modifications apportées au curseur retourné n'affectent pas le curseur de QPlainTextEdit; utilisez setTextCursor() pour mettre à jour le curseur visible.

Voir aussi setTextCursor().

QString QPlainTextEdit::toPlainText() const

Renvoie le texte de l'édition de texte sous forme de texte brut.

Voir aussi QPlainTextEdit::setPlainText().

[slot] void QPlainTextEdit::undo()

Annule la dernière opération.

S'il n'y a pas d'opération à annuler, c'est-à-dire s'il n'y a pas d'étape d'annulation dans l'historique d'annulation/de rétablissement, rien ne se produit.

Voir également redo().

[signal] void QPlainTextEdit::undoAvailable(bool available)

Ce signal est émis lorsque les opérations d'annulation deviennent disponibles (available est vrai) ou indisponibles (available est faux).

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

Ce signal est émis lorsque le document texte a besoin d'une mise à jour de l'élément spécifié rect. Si le texte est déroulé, rect couvrira la totalité de la zone de visualisation. Si le texte est défilé verticalement, dy porte la quantité de pixels de la fenêtre de visualisation qui a été défilée.

L'objectif de ce signal est de prendre en charge des widgets supplémentaires dans les sous-classes d'édition de texte brut, qui affichent par exemple les numéros de ligne, les points d'arrêt ou d'autres informations supplémentaires.

[override virtual protected] void QPlainTextEdit::wheelEvent(QWheelEvent *e)

Réimplémente : QAbstractScrollArea::wheelEvent(QWheelEvent *e).

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

Effectue un zoom sur le texte en augmentant la taille de la police de base range points et en recalculant toutes les tailles de police pour qu'elles correspondent à la nouvelle taille. Cette opération ne modifie pas la taille des images.

Voir également zoomOut().

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

Effectue un zoom arrière sur le texte en réduisant la taille de la police de base range points et en recalculant toutes les tailles de police pour qu'elles correspondent à la nouvelle taille. Cela ne modifie pas la taille des images.

Voir également zoomIn().