QUndoCommand Class

Documentation sur les fonctions membres

[explicit] QUndoCommand::QUndoCommand(QUndoCommand *parent = nullptr)

Crée un objet QUndoCommand dont le parent est parent.

Si parent n'est pas de type « nullptr », cette commande est ajoutée à la liste des enfants de la commande parente. La commande parente devient alors propriétaire de cette commande et la supprimera dans son destructeur.

Voir aussi ~QUndoCommand().

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

Crée un objet QUndoCommand avec les paramètres parent et text fournis.

Si parent n’est pas nullptr, cette commande est ajoutée à la liste des enfants de la commande parente. La commande parente devient alors propriétaire de cette commande et la supprimera dans son destructeur.

Voir également ~QUndoCommand().

[virtual noexcept] QUndoCommand::~QUndoCommand()

Supprime l'objet « QUndoCommand » et toutes ses commandes enfants.

Voir aussi QUndoCommand().

QString QUndoCommand::actionText() const

Renvoie une courte chaîne de texte décrivant la fonction de cette commande ; par exemple, « insérer du texte ».

Ce texte est utilisé lors de la mise à jour des propriétés de texte des actions « Annuler » et « Rétablir » de la pile.

Voir également text(), setText(), QUndoStack::createUndoAction() et QUndoStack::createRedoAction().

const QUndoCommand *QUndoCommand::child(int index) const

Renvoie la commande enfant à l'adresse index.

Voir également childCount() et QUndoStack::command().

int QUndoCommand::childCount() const

Renvoie le nombre de commandes enfants contenues dans cette commande.

Voir aussi child().

[virtual] int QUndoCommand::id() const

Renvoie l'identifiant de cette commande.

L'identifiant d'une commande est utilisé dans la compression des commandes. Il doit s'agir d'un entier unique pour la classe de cette commande, ou de -1 si la commande ne prend pas en charge la compression.

Si la commande prend en charge la compression, cette fonction doit être redéfinie dans la classe dérivée afin de renvoyer l'ID correct. L'implémentation de base renvoie -1.

QUndoStack::push() ne tentera de fusionner deux commandes que si elles ont le même ID et si celui-ci n'est pas -1.

Voir également mergeWith() et QUndoStack::push().

bool QUndoCommand::isObsolete() const

Indique si la commande est obsolète.

Cette valeur booléenne sert à supprimer automatiquement les commandes qui ne sont plus nécessaires dans la pile. La fonction isObsolete est vérifiée dans les fonctions QUndoStack::push(), QUndoStack::undo(), QUndoStack::redo() et QUndoStack::setIndex().

Voir également setObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo() et QUndoStack::redo().

[virtual] bool QUndoCommand::mergeWith(const QUndoCommand *command)

Tente de fusionner cette commande avec command. Renvoie true en cas de réussite ; sinon, renvoie false.

Si cette fonction renvoie true, l'appel de la fonction redo() de cette commande doit avoir le même effet que de refaire à la fois cette commande et command. De même, l'appel de la fonction undo() de cette commande doit avoir le même effet que d'annuler command et cette commande.

QUndoStack ne tentera de fusionner deux commandes que si elles ont le même identifiant et que celui-ci n’est pas -1.

L’implémentation par défaut renvoie « false ».

bool AppendText::mergeWith(const QUndoCommand *other)
{
    if (other->id() != id()) // make sure other is also an AppendText command
        return false;
    m_text += static_cast<const AppendText*>(other)->m_text;
    return true;
}

Voir également id() et QUndoStack::push().

[virtual] void QUndoCommand::redo()

Applique une modification au document. Cette fonction doit être implémentée dans la classe dérivée. L'appel des fonctions ` QUndoStack::push()`, ` QUndoStack::undo()` ou ` QUndoStack::redo()` depuis cette fonction entraîne un comportement indéfini.

L'implémentation par défaut appelle la fonction `redo()` sur toutes les commandes enfants.

Voir également undo().

void QUndoCommand::setObsolete(bool obsolete)

Indique si la commande est obsolète sur obsolete.

Voir également isObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo() et QUndoStack::redo().

void QUndoCommand::setText(const QString &text)

Définit le texte de la commande sur la chaîne « text » indiquée.

Le texte spécifié doit être une courte chaîne lisible par l'utilisateur décrivant la fonction de cette commande.

Si vous avez besoin de deux chaînes différentes pour text() et actionText(), séparez-les par «\n » et transmettez-les à cette fonction. Même si vous n’utilisez pas cette fonctionnalité pour les chaînes en anglais pendant le développement, vous pouvez tout de même permettre aux traducteurs d’utiliser deux chaînes différentes afin de répondre aux besoins spécifiques de certaines langues. La fonctionnalité décrite et la fonction actionText() sont disponibles depuis Qt 4.8.

Voir également text(), actionText(), QUndoStack::createUndoAction() et QUndoStack::createRedoAction().

QString QUndoCommand::text() const

Renvoie une courte chaîne de texte décrivant la fonction de cette commande ; par exemple, « insérer du texte ».

Ce texte est utilisé pour nommer les éléments dans QUndoView.

Voir également actionText(), setText(), QUndoStack::createUndoAction() et QUndoStack::createRedoAction().

[virtual] void QUndoCommand::undo()

Annule une modification apportée au document. Une fois la fonction `undo()` appelée, l'état du document doit être identique à celui qui prévalait avant l'appel de ` redo()`. Cette fonction doit être implémentée dans la classe dérivée. L'appel des fonctions ` QUndoStack::push()`, ` QUndoStack::undo()` ou ` QUndoStack::redo()` depuis cette fonction entraîne un comportement indéfini.

L'implémentation par défaut appelle undo() sur toutes les commandes enfants dans l'ordre inverse.

Voir également redo().