QUndoCommand Class

Dokumentation zu Mitgliedsfunktionen

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

Erstellt ein QUndoCommand-Objekt mit dem übergeordneten Objekt „ parent “.

Wenn „ parent “ nicht „ nullptr “ ist, wird dieser Befehl an die untergeordnete 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)

Erstellt ein QUndoCommand-Objekt mit den angegebenen Werten für „ parent “ und „ text “.

Wenn ` parent ` nicht ` nullptr` ist, wird dieser Befehl an die untergeordnete 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()

Löscht das „ QUndoCommand “-Objekt und alle untergeordneten Befehle.

Siehe auch QUndoCommand().

QString QUndoCommand::actionText() const

Gibt eine kurze Textzeichenfolge zurück, die beschreibt, was dieser Befehl bewirkt; zum Beispiel „Text einfügen“.

Der Text wird verwendet, wenn die Texteigenschaften der Rückgängig- und Wiederherstellen-Aktionen des Stacks 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. Es muss sich um eine für die Klasse dieses Befehls eindeutige Ganzzahl handeln oder um -1, falls 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 dieselbe 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 Stack nicht mehr benötigt werden. Die Funktion `isObsolete` wird in den Funktionen ` QUndoStack::push()`, ` QUndoStack::undo()`, ` QUndoStack::redo()` und ` QUndoStack::setIndex()` überprü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. Gibt bei Erfolg „ true “ zurück; andernfalls wird „ false “ zurückgegeben.

Wenn diese Funktion „ true “ zurückgibt, muss der Aufruf von „ redo()“ dieses Befehls denselben Effekt haben wie das erneute Ausführen sowohl dieses Befehls als auch von „ command “. Ebenso muss der Aufruf von „ undo()“ dieses Befehls denselben Effekt haben wie das Rückgängigmachen von „ command “ und dieses Befehls.

QUndoStack Es wird nur versucht, zwei Befehle zusammenzuführen, wenn sie dieselbe 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 werden. Der Aufruf von ` QUndoStack::push()`, ` QUndoStack::undo()` oder ` QUndoStack::redo()` aus dieser Funktion heraus führt zu undefiniertem Verhalten.

Die Standardimplementierung ruft für alle untergeordneten Befehle die Funktion `redo()` auf.

Siehe auch ` undo()`.

void QUndoCommand::setObsolete(bool obsolete)

Legt fest, ob der Befehl für „ obsolete “ veraltet ist.

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

void QUndoCommand::setText(const QString &text)

Legt den Text des Befehls auf den angegebenen „ text “ fest.

Der angegebene Text sollte eine kurze, für den Benutzer verständliche Zeichenfolge sein, die beschreibt, was dieser Befehl bewirkt.

Wenn Sie zwei verschiedene Zeichenfolgen für „ text()“ und „ actionText()“ benötigen, trennen Sie diese durch „\n “ und übergeben Sie sie an diese Funktion. Auch wenn Sie diese Funktion während der Entwicklung nicht für englische Zeichenfolgen nutzen, können Sie Übersetzern dennoch die Verwendung zweier verschiedener Zeichenfolgen ermöglichen, um den Anforderungen bestimmter Sprachen gerecht zu werden. Die beschriebene Funktion sowie 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; zum Beispiel „Text einfügen“.

Der Text wird für die Bezeichnungen 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 heraus führt zu undefiniertem Verhalten.

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

Siehe auch „ redo()“.