QUndoStack Class

Dokumentation der Mitgliedsfunktionen

[explicit] QUndoStack::QUndoStack(QObject *parent = nullptr)

Erstellt einen leeren Rückgängig-Stapel mit dem übergeordneten Objekt „ parent “. Der Stapel befindet sich zunächst im „clean“-Zustand. Wenn „ parent “ ein „ QUndoGroup “-Objekt ist, wird der Stapel automatisch der Gruppe hinzugefügt.

Siehe auch ` push()`.

[virtual noexcept] QUndoStack::~QUndoStack()

Löscht den Rückgängig-Stapel und entfernt dabei alle darin enthaltenen Befehle. Befindet sich der Stapel in einer Arbeitsgruppe ( QUndoGroup), wird er automatisch aus der Gruppe entfernt.

Siehe auch „ QUndoStack()“.

void QUndoStack::beginMacro(const QString &text)

Leitet die Erstellung eines Makrobefehls mit der angegebenen Beschreibung unter text ein.

Ein leerer Befehl, der durch die angegebene ` text ` beschrieben wird, wird auf den Stack geschoben. Alle nachfolgenden Befehle, die auf den Stack geschoben werden, werden an die untergeordneten Elemente des leeren Befehls angehängt, bis ` endMacro()` aufgerufen wird.

Aufrufe von `beginMacro()` und ` endMacro()` können verschachtelt werden, jedoch muss jedem Aufruf von `beginMacro()` ein entsprechender Aufruf von ` endMacro()` entsprechen.

Während ein Makro zusammengestellt wird, ist der Stack deaktiviert. Das bedeutet, dass:

• indexChanged() und cleanChanged() nicht ausgegeben werden,
• canUndo() und ` canRedo()` geben `false` zurück,
• der Aufruf von ` undo()` oder ` redo()` keine Wirkung hat,
• die Rückgängig-/Wiederherstellen-Aktionen sind deaktiviert.

Der Stack wird aktiviert und entsprechende Signale werden ausgegeben, wenn „ endMacro()“ für das äußerste Makro aufgerufen wird.

stack.beginMacro("insert red text");
stack.push(new InsertText(document, idx, text));
stack.push(new SetColor(document, idx, text.length(), Qt::red));
stack.endMacro(); // indexChanged() is emitted

Dieser Code entspricht:

QUndoCommand *insertRed = new QUndoCommand(); // an empty command
insertRed->setText("insert red text");

new InsertText(document, idx, text, insertRed); // becomes child of insertRed
new SetColor(document, idx, text.length(), Qt::red, insertRed);

stack.push(insertRed);

Siehe auch ` endMacro()`.

bool QUndoStack::canRedo() const

Gibt „ true “ zurück, wenn ein Befehl zum Wiederherstellen verfügbar ist; andernfalls gibt die Funktion „ false “ zurück.

Diese Funktion gibt „ false “ zurück, wenn der Stapel leer ist oder wenn der oberste Befehl auf dem Stapel bereits wiederholt wurde.

Synonym mit ` index()` == ` count()`.

Siehe auch „ index()“ und „ canUndo()“.

[signal] void QUndoStack::canRedoChanged(bool canRedo)

Dieses Signal wird immer dann ausgelöst, wenn sich der Wert von ` canRedo()` ändert. Es dient dazu, die von ` createRedoAction()` zurückgegebene Wiederholungsaktion zu aktivieren oder zu deaktivieren. ` canRedo ` gibt den neuen Wert an.

bool QUndoStack::canUndo() const

Gibt „ true “ zurück, wenn ein Befehl zum Rückgängigmachen verfügbar ist; andernfalls wird „ false “ zurückgegeben.

Diese Funktion gibt ` false ` zurück, wenn der Stapel leer ist oder wenn der unterste Befehl auf dem Stapel bereits rückgängig gemacht wurde.

Synonym mit ` index()` == 0.

Siehe auch „ index()“ und „ canRedo()“.

[signal] void QUndoStack::canUndoChanged(bool canUndo)

Dieses Signal wird immer dann ausgelöst, wenn sich der Wert von ` canUndo()` ändert. Es dient dazu, die von ` createUndoAction()` zurückgegebene Rückgängig-Aktion zu aktivieren oder zu deaktivieren. ` canUndo ` gibt den neuen Wert an.

[signal] void QUndoStack::cleanChanged(bool clean)

Dieses Signal wird immer dann ausgegeben, wenn der Stack in den „clean“-Zustand wechselt oder diesen verlässt. Ist clean wahr, befindet sich der Stack im „clean“-Zustand; andernfalls zeigt dieses Signal an, dass er den „clean“-Zustand verlassen hat.

Siehe auch „ isClean()“ und „ setClean()“.

int QUndoStack::cleanIndex() const

Gibt den „clean“-Index zurück. Dies ist der Index, an dem setClean() aufgerufen wurde.

Ein Stapel verfügt möglicherweise nicht über einen sauberen Index. Dies ist der Fall, wenn ein Dokument gespeichert, einige Befehle rückgängig gemacht und anschließend ein neuer Befehl auf den Stapel gelegt wird. Da ` push()` alle rückgängig gemachten Befehle löscht, bevor der neue Befehl auf den Stapel gelegt wird, kann der Stapel nicht mehr in den sauberen Zustand zurückkehren. In diesem Fall gibt diese Funktion -1 zurück. Der Wert -1 kann auch nach einem expliziten Aufruf von ` resetClean()` zurückgegeben werden.

Siehe auch isClean() und setClean().

void QUndoStack::clear()

Löscht den Befehlsstapel, indem alle darin enthaltenen Befehle entfernt werden, und versetzt den Stapel wieder in den ursprünglichen Zustand.

Befehle werden weder rückgängig gemacht noch wiederholt; der Zustand des bearbeiteten Objekts bleibt unverändert.

Diese Funktion wird in der Regel verwendet, wenn der Inhalt des Dokuments verworfen wird.

Siehe auch „ QUndoStack()“.

const QUndoCommand *QUndoStack::command(int index) const

Gibt einen const-Zeiger auf den Befehl unter index zurück.

Diese Funktion gibt einen const-Zeiger zurück, da das Ändern eines Befehls, sobald dieser auf den Stack gelegt und ausgeführt wurde, fast immer zu einer Beschädigung des Dokumentzustands führt, falls der Befehl später rückgängig gemacht oder wiederholt wird.

Siehe auch QUndoCommand::child().

int QUndoStack::count() const

Gibt die Anzahl der Befehle auf dem Stack zurück. Makrobefehle werden als ein Befehl gezählt.

Siehe auch index(), setIndex() und command().

QAction *QUndoStack::createRedoAction(QObject *parent, const QString &prefix = QString()) const

Erstellt ein „Redo“- QAction -Objekt mit dem angegebenen parent.

Das Auslösen dieser Aktion führt zu einem Aufruf von ` redo()`. Der Text dieser Aktion ist der Text des Befehls, der beim nächsten Aufruf von ` redo()` wiederholt wird, vorangestellt durch das angegebene ` prefix`. Wenn kein Befehl zum Wiederholen verfügbar ist, wird diese Aktion deaktiviert.

Ist ` prefix ` leer, wird anstelle des Präfixes die Standardvorlage „Redo %1“ verwendet. Vor Qt 4.8 wurde standardmäßig das Präfix „Redo“ verwendet.

Siehe auch createUndoAction(), canRedo() und QUndoCommand::text().

QAction *QUndoStack::createUndoAction(QObject *parent, const QString &prefix = QString()) const

Erstellt ein „Undo“- QAction -Objekt mit dem angegebenen „ parent “.

Das Auslösen dieser Aktion führt zu einem Aufruf von ` undo()`. Der Text dieser Aktion entspricht dem Text des Befehls, der beim nächsten Aufruf von ` undo()` rückgängig gemacht wird, vorangestellt durch das angegebene ` prefix`. Ist kein Befehl zum Rückgängigmachen verfügbar, wird diese Aktion deaktiviert.

Ist ` prefix ` leer, wird anstelle des Präfixes die Standardvorlage „Undo %1“ verwendet. Vor Qt 4.8 wurde standardmäßig das Präfix „Undo“ verwendet.

Siehe auch createRedoAction(), canUndo() und QUndoCommand::text().

void QUndoStack::endMacro()

Beendet die Zusammensetzung eines Makrobefehls.

Wenn dies das äußerste Makro in einer Reihe verschachtelter Makros ist, gibt diese Funktion einmalig „ indexChanged()“ für den gesamten Makrobefehl aus.

Siehe auch beginMacro().

int QUndoStack::index() const

Gibt den Index des aktuellen Befehls zurück. Dies ist der Befehl, der beim nächsten Aufruf von ` redo()` ausgeführt wird. Es handelt sich dabei nicht immer um den obersten Befehl im Stapel, da möglicherweise bereits mehrere Befehle rückgängig gemacht wurden.

Siehe auch setIndex(), undo(), redo() und count().

[signal] void QUndoStack::indexChanged(int idx)

Dieses Signal wird immer dann ausgelöst, wenn ein Befehl den Zustand des Dokuments verändert. Dies geschieht, wenn ein Befehl rückgängig gemacht oder wiederholt wird. Wenn ein Makrobefehl rückgängig gemacht oder wiederholt wird oder die Funktion ` setIndex()` aufgerufen wird, wird dieses Signal nur einmal ausgelöst.

idx Gibt den Index des aktuellen Befehls an, d. h. des Befehls, der beim nächsten Aufruf von ` redo()` ausgeführt wird.

Siehe auch ` index()` und ` setIndex()`.

bool QUndoStack::isClean() const

Befindet sich der Stack im „clean“-Zustand, wird „ true “ zurückgegeben; andernfalls wird „ false “ zurückgegeben.

Siehe auch „ setClean()“ und „ cleanIndex()“.

void QUndoStack::push(QUndoCommand *cmd)

Fügt „ cmd “ auf den Stapel ein oder führt es mit dem zuletzt ausgeführten Befehl zusammen. In beiden Fällen wird „ cmd “ durch Aufruf der Funktion „ redo()“ ausgeführt.

Wenn die ID von „ cmd “ nicht -1 ist und mit der des zuletzt ausgeführten Befehls übereinstimmt, versucht „ QUndoStack “, die beiden Befehle zusammenzuführen, indem „ QUndoCommand::mergeWith()“ für den zuletzt ausgeführten Befehl aufgerufen wird. Wenn „ QUndoCommand::mergeWith()“ den Wert „ true “ zurückgibt, wird „ cmd “ gelöscht.

Nach dem Aufruf von „ QUndoCommand::redo()“ und gegebenenfalls „ QUndoCommand::mergeWith()“ wird „ QUndoCommand::isObsolete()“ für „ cmd “ oder den zusammengeführten Befehl aufgerufen. Wenn „ QUndoCommand::isObsolete()“ „ true “ zurückgibt, wird „ cmd “ oder der zusammengeführte Befehl vom Stapel entfernt.

In allen anderen Fällen wird „ cmd “ einfach auf den Stapel gelegt.

Wurden Befehle rückgängig gemacht, bevor „ cmd “ auf den Stapel gelegt wurde, werden der aktuelle Befehl und alle darüber liegenden Befehle gelöscht. Daher befindet sich „ cmd “ am Ende immer ganz oben auf dem Stapel.

Sobald ein Befehl auf den Stapel gelegt wurde, übernimmt der Stapel die Verantwortung dafür. Es gibt keine Getter-Methoden, um den Befehl zurückzugeben, da eine Änderung nach seiner Ausführung fast immer zu einer Beschädigung des Dokumentzustands führen würde.

Siehe auch „ QUndoCommand::id()“ und „ QUndoCommand::mergeWith()“.

[slot] void QUndoStack::redo()

Führt den aktuellen Befehl erneut aus, indem „ QUndoCommand::redo()“ aufgerufen wird. Erhöht den aktuellen Befehlsindex.

Ist der Stapel leer oder wurde der oberste Befehl im Stapel bereits wiederholt, führt diese Funktion keine Aktion aus.

Wenn „ QUndoCommand::isObsolete()“ für den aktuellen Befehl den Wert „true“ zurückgibt, wird der Befehl aus dem Stapel gelöscht. Ist der „clean“-Index größer oder gleich dem aktuellen Befehlsindex, wird der „clean“-Index zudem zurückgesetzt.

Siehe auch „ undo()“ und „ index()“.

QString QUndoStack::redoText() const

Gibt den Text des Befehls zurück, der beim nächsten Aufruf von ` redo()` erneut ausgeführt wird.

Siehe auch „ QUndoCommand::actionText()“ und „ undoText()“.

[signal] void QUndoStack::redoTextChanged(const QString &redoText)

Dieses Signal wird immer dann ausgelöst, wenn sich der Wert von ` redoText()` ändert. Es dient dazu, die Texteigenschaft der von ` createRedoAction()` zurückgegebenen „Wiederherstellen“-Aktion zu aktualisieren. ` redoText ` gibt den neuen Text an.

[slot] void QUndoStack::resetClean()

Verlässt den „clean“-Zustand und gibt „ cleanChanged()“ zurück, wenn der Stack sauber war. Diese Methode setzt den „clean“-Index auf -1 zurück.

Dies wird typischerweise in den folgenden Fällen aufgerufen, wenn ein Dokument:

• auf der Grundlage einer Vorlage erstellt und noch nicht gespeichert wurde, sodass dem Dokument noch kein Dateiname zugewiesen wurde.
• aus einer Sicherungsdatei wiederhergestellt wurde.
• außerhalb des Editors geändert wurde und der Benutzer es nicht neu geladen hat.

Siehe auch ` isClean()`, ` setClean()` und ` cleanIndex()`.

[slot] void QUndoStack::setClean()

Markiert den Stack als bereinigt und gibt „ cleanChanged()“ aus, falls der Stack noch nicht bereinigt war.

Dies wird typischerweise beispielsweise beim Speichern eines Dokuments aufgerufen.

Immer wenn der Stapel durch die Verwendung von Rückgängig-/Wiederherstellen-Befehlen in diesen Zustand zurückkehrt, sendet er das Signal „ cleanChanged()“ aus. Dieses Signal wird auch ausgesendet, wenn der Stapel den sauberen Zustand verlässt.

Siehe auch ` isClean()`, ` resetClean()` und ` cleanIndex()`.

[slot] void QUndoStack::setIndex(int idx)

Ruft wiederholt „ undo “ () oder „ redo “ () auf, bis der aktuelle Befehlsindex den Wert „ idx “ erreicht. Diese Funktion kann verwendet werden, um den Zustand des Dokuments vorwärts oder rückwärts zu verschieben. „ indexChanged “ () wird nur einmal ausgegeben.

Siehe auch index(), count(), undo() und redo().

QString QUndoStack::text(int idx) const

Gibt den Text des Befehls am Index idx zurück.

Siehe auch beginMacro().

[slot] void QUndoStack::undo()

Macht den Befehl unterhalb des aktuellen Befehls rückgängig, indem „ QUndoCommand::undo()“ aufgerufen wird. Verringert den aktuellen Befehlsindex um eins.

Ist der Stapel leer oder wurde der unterste Befehl im Stapel bereits rückgängig gemacht, führt diese Funktion keine Aktion aus.

Wird der Befehl rückgängig gemacht und gibt ` QUndoCommand::isObsolete()` den Wert ` true` zurück, wird der Befehl aus dem Stapel gelöscht. Ist der „Clean“-Index größer oder gleich dem aktuellen Befehlsindex, wird der „Clean“-Index zudem zurückgesetzt.

Siehe auch ` redo()` und ` index()`.

QString QUndoStack::undoText() const

Gibt den Text des Befehls zurück, der beim nächsten Aufruf von ` undo()` rückgängig gemacht wird.

Siehe auch „ QUndoCommand::actionText()“ und „ redoText()“.

[signal] void QUndoStack::undoTextChanged(const QString &undoText)

Dieses Signal wird immer dann ausgelöst, wenn sich der Wert von ` undoText()` ändert. Es dient dazu, die Texteigenschaft der Rückgängig-Aktion zu aktualisieren, die von ` createUndoAction()` zurückgegeben wird. ` undoText ` gibt den neuen Text an.