QUndoCommand Class

Dokumentation der Mitgliedsfunktionen

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

Konstruiert ein QUndoCommand-Objekt mit übergeordnetem parent.

Wenn parent nicht nullptr ist, wird dieser Befehl an die Child-Liste des übergeordneten Befehls angehängt. Der übergeordnete Befehl ist dann Eigentümer dieses Befehls und löscht ihn in seinem Destruktor.

Siehe auch ~QUndoCommand().

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

Konstruiert ein QUndoCommand-Objekt mit den angegebenen parent und text.

Wenn parent nicht nullptr ist, wird dieser Befehl an die Child-Liste des übergeordneten Befehls angehängt. Der übergeordnete Befehl ist dann Eigentümer dieses Befehls und löscht ihn in seinem Destruktor.

Siehe auch ~QUndoCommand().

[virtual noexcept] QUndoCommand::~QUndoCommand()

Zerstört das Objekt QUndoCommand und alle untergeordneten Befehle.

Siehe auch QUndoCommand().

QString QUndoCommand::actionText() const

Gibt eine kurze Textzeichenfolge zurück, die beschreibt, was dieser Befehl bewirkt, z. B. "Text einfügen".

Der Text wird verwendet, wenn die Texteigenschaften der Rückgängig- und Wiederherstellungsaktionen des Stapels aktualisiert werden.

Siehe auch text(), setText(), QUndoStack::createUndoAction(), und QUndoStack::createRedoAction().

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

Gibt den untergeordneten Befehl unter index zurück.

Siehe auch childCount() und QUndoStack::command().

int QUndoCommand::childCount() const

Gibt die Anzahl der untergeordneten Befehle in diesem Befehl zurück.

Siehe auch child().

[virtual] int QUndoCommand::id() const

Gibt die ID dieses Befehls zurück.

Eine Befehls-ID wird bei der Befehlskomprimierung verwendet. Sie muss eine ganze Zahl sein, die für die Klasse dieses Befehls eindeutig ist, oder -1, wenn der Befehl keine Komprimierung unterstützt.

Wenn der Befehl die Komprimierung unterstützt, muss diese Funktion in der abgeleiteten Klasse überschrieben werden, um die richtige ID zurückzugeben. Die Basisimplementierung gibt -1 zurück.

QUndoStack::push() versucht nur dann, zwei Befehle zusammenzuführen, wenn sie die gleiche ID haben und die ID nicht -1 ist.

Siehe auch mergeWith() und QUndoStack::push().

bool QUndoCommand::isObsolete() const

Gibt zurück, ob der Befehl veraltet ist.

Der boolesche Wert wird für die automatische Entfernung von Befehlen verwendet, die im Stapel nicht mehr benötigt werden. Die Funktion isObsolete wird in den Funktionen QUndoStack::push(), QUndoStack::undo(), QUndoStack::redo(), und QUndoStack::setIndex() geprüft.

Siehe auch setObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo(), und QUndoStack::redo().

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

Versucht, diesen Befehl mit command zusammenzuführen. Bei Erfolg wird true zurückgegeben; andernfalls wird false zurückgegeben.

Wenn diese Funktion true zurückgibt, muss der Aufruf von redo() die gleiche Wirkung haben wie die Wiederholung dieses Befehls und command. Ebenso muss der Aufruf von undo() dieses Befehls die gleiche Wirkung haben wie das Rückgängigmachen von command und dieses Befehls.

QUndoStack wird nur dann versuchen, zwei Befehle zusammenzuführen, wenn sie die gleiche id haben und die id nicht -1 ist.

Die Standardimplementierung gibt false zurück.

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;
}

Siehe auch id() und QUndoStack::push().

[virtual] void QUndoCommand::redo()

Wendet eine Änderung auf das Dokument an. Diese Funktion muss in der abgeleiteten Klasse implementiert sein. Der Aufruf von QUndoStack::push(), QUndoStack::undo() oder QUndoStack::redo() aus dieser Funktion führt zu undefiniertem Verhalten.

Die Standardimplementierung ruft redo() bei allen untergeordneten Befehlen auf.

Siehe auch undo().

void QUndoCommand::setObsolete(bool obsolete)

Legt fest, ob der Befehl auf obsolete veraltet ist.

Siehe auch isObsolete(), mergeWith(), QUndoStack::push(), QUndoStack::undo(), und QUndoStack::redo().

void QUndoCommand::setText(const QString &text)

Setzt den Text des Befehls auf den angegebenen text.

Der angegebene Text sollte eine kurze, für den Benutzer lesbare Zeichenkette sein, die beschreibt, was dieser Befehl tut.

Wenn Sie zwei verschiedene Zeichenketten für text() und actionText() benötigen, trennen Sie sie mit "\n" und übergeben Sie sie an diese Funktion. Auch wenn Sie diese Funktion während der Entwicklung nicht für englische Zeichenketten verwenden, können Sie Übersetzern die Möglichkeit geben, zwei verschiedene Zeichenketten zu verwenden, um die Anforderungen bestimmter Sprachen zu erfüllen. Das beschriebene Feature und die Funktion actionText() sind seit Qt 4.8 verfügbar.

Siehe auch text(), actionText(), QUndoStack::createUndoAction(), und QUndoStack::createRedoAction().

QString QUndoCommand::text() const

Gibt eine kurze Textzeichenfolge zurück, die beschreibt, was dieser Befehl bewirkt, z. B. "Text einfügen".

Der Text wird für die Namen der Elemente in QUndoView verwendet.

Siehe auch actionText(), setText(), QUndoStack::createUndoAction(), und QUndoStack::createRedoAction().

[virtual] void QUndoCommand::undo()

Macht eine Änderung am Dokument rückgängig. Nach dem Aufruf von Undo() sollte der Zustand des Dokuments derselbe sein wie vor dem Aufruf von redo(). Diese Funktion muss in der abgeleiteten Klasse implementiert werden. Der Aufruf von QUndoStack::push(), QUndoStack::undo() oder QUndoStack::redo() aus dieser Funktion führt zu undefiniertem Verhalten.

Die Standardimplementierung ruft undo() für alle untergeordneten Befehle in umgekehrter Reihenfolge auf.

Siehe auch redo().