QUndoCommand Class

Documentation sur les fonctions membres

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

Construit un objet QUndoCommand avec le parent parent.

Si parent n'est pas nullptr, cette commande est ajoutée à la liste des enfants du parent. La commande parent possède alors cette commande et la supprimera dans son destructeur.

Voir aussi ~QUndoCommand().

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

Construit un objet QUndoCommand avec les données parent et text.

Si parent n'est pas nullptr, cette commande est ajoutée à la liste des enfants du parent. La commande parent possède alors cette commande et la supprimera dans son destructeur.

Voir aussi ~QUndoCommand().

[virtual noexcept] QUndoCommand::~QUndoCommand()

Détruit l'objet QUndoCommand et toutes les commandes enfant.

Voir aussi QUndoCommand().

QString QUndoCommand::actionText() const

Renvoie une courte chaîne de texte décrivant ce que fait cette commande ; par exemple, "insérer du texte".

Ce texte est utilisé lorsque les propriétés de texte des actions d'annulation et de rétablissement de la pile sont mises à jour.

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

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

Renvoie la commande enfant à index.

Voir aussi childCount() et QUndoStack::command().

int QUndoCommand::childCount() const

Renvoie le nombre de commandes enfants dans cette commande.

Voir aussi child().

[virtual] int QUndoCommand::id() const

Renvoie l'ID de cette commande.

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

Si la commande supporte la compression, cette fonction doit être surchargée dans la classe dérivée pour renvoyer l'identifiant correct. L'implémentation de base renvoie -1.

QUndoStack::push() n'essaiera de fusionner deux commandes que si elles ont le même ID, et si l'ID n'est pas -1.

Voir aussi mergeWith() et QUndoStack::push().

bool QUndoCommand::isObsolete() const

Indique si la commande est obsolète.

Ce booléen est utilisé pour la suppression automatique des 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 aussi 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 succès, sinon false.

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

QUndoStack n'essaiera de fusionner deux commandes que si elles ont le même identifiant, et si l'identifiant 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 aussi 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 de QUndoStack::push(), QUndoStack::undo() ou QUndoStack::redo() à partir de cette fonction entraîne un comportement non défini.

L'implémentation par défaut appelle redo() sur toutes les commandes enfant.

Voir également undo().

void QUndoCommand::setObsolete(bool obsolete)

Indique si la commande est obsolète à obsolete.

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

void QUndoCommand::setText(const QString &text)

Définit le texte de la commande à l'adresse text spécifiée.

Le texte spécifié doit être une courte chaîne lisible par l'utilisateur décrivant ce que fait cette commande.

Si vous avez besoin de deux chaînes différentes pour text() et actionText(), séparez-les par "\n" et passez-les dans cette fonction. Même si vous n'utilisez pas cette fonction pour les chaînes anglaises pendant le développement, vous pouvez toujours laisser les traducteurs utiliser deux chaînes différentes afin de répondre aux besoins de langues spécifiques. La fonctionnalité décrite et la fonction actionText() sont disponibles depuis Qt 4.8.

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

QString QUndoCommand::text() const

Renvoie une courte chaîne de texte décrivant l'action de cette commande ; par exemple, "insérer du texte".

Le texte est utilisé pour les noms des éléments dans QUndoView.

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

[virtual] void QUndoCommand::undo()

Annule une modification apportée au document. Après l'appel à undo(), l'état du document doit être le même qu'avant l'appel à redo(). Cette fonction doit être implémentée dans la classe dérivée. L'appel de QUndoStack::push(), QUndoStack::undo() ou QUndoStack::redo() à partir de cette fonction entraîne un comportement non défini.

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

Voir également redo().