QUndoStack Class

メンバ関数ドキュメント

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

親関数parent で空のアンドゥスタックを構築する。スタックは初期状態ではクリーンな状態である。parent がQUndoGroup オブジェクトの場合、スタックは自動的にグループに追加されます。

push()も参照してください 。

[virtual noexcept] QUndoStack::~QUndoStack()

undo スタックを破棄し、その上にあるコマンドをすべて削除します。スタックがQUndoGroup の場合、スタックは自動的にグループから削除される。

QUndoStack() も参照 。

void QUndoStack::beginMacro(const QString &text)

指定されたtext 記述を持つマクロコマンドの作成を開始する。

指定されたtext で記述された空のコマンドがスタックにプッシュされる。スタックにプッシュされた後続のコマンドは、endMacro() が呼び出されるまで、空のコマンドの子に追加される。

beginMacro()とendMacro()の呼び出しは入れ子にすることができるが、 beginMacro()の呼び出しには必ずendMacro()の呼び出しが必要である。

マクロの実行中は、スタックは無効になる。つまり、beginMacro()と()はネストできる：

• indexChanged() とcleanChanged() は出力されない、
• canUndo() とcanRedo() は false を返す、
• undo() やredo() を呼び出しても効果がない、
• 元に戻す/やり直すアクションは無効になる。

一番外側のマクロに対してendMacro() が呼び出されると、スタックが有効になり、適切なシグナルが発せられる。

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

このコードは以下と等価である：

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

endMacro()も参照 。

bool QUndoStack::canRedo() const

やり直しが可能なコマンドがある場合はtrue を返し、そうでない場合はfalse を返す。

この関数は、スタックが空であるか、スタックの一番上のコマンドが既にやり直されている場合、false を返す。

index() ==count() と同義。

index() およびcanUndo()も参照 。

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

このシグナルは、canRedo() の値が変更されるたびに発行されます。このシグナルは、createRedoAction() が返すやり直しアクションを有効または無効にするために使用されます。canRedo は、新しい値を指定します。

bool QUndoStack::canUndo() const

元に戻せるコマンドがある場合はtrue を返し、そうでない場合はfalse を返す。

この関数は、スタックが空の場合、またはスタック上の最下位のコマンドがすでにアンドゥされている場合、false を返す。

index() == 0と同義です。

index() およびcanRedo()も参照 。

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

このシグナルは、canUndo() の値が変化するたびに発せられる。このシグナルは、createUndoAction() が返すアンドゥ動作を有効または無効にするために使用されます。canUndo は、新しい値を指定します。

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

このシグナルは、スタックがクリーン状態になったり、クリーン状態から離れたりするたびに発せられます。clean が真の場合、スタックはクリーンな状態にある。そうでない場合、このシグナルはスタックがクリーンな状態から離脱したことを示す。

isClean() およびsetClean()も参照のこと 。

int QUndoStack::cleanIndex() const

クリーン・インデックスを返す。これはsetClean() が呼び出されたときのインデックスである。

スタックがクリーン・インデックスを持たないこともあります。これは、ドキュメントが保存され、いくつかのコマンドが取り消され、新しいコマンドがプッシュされた場合に発生します。push() は、新しいコマンドをプッシュする前に、取り消したコマンドをすべて削除するので、スタックは再びクリーンな状態に戻ることはできない。この場合、この関数は-1を返す。この -1 は、resetClean() を明示的に呼び出した後にも返されることがある。

isClean() およびsetClean()も参照のこと 。

void QUndoStack::clear()

コマンド・スタック上のすべてのコマンドを削除することによりコマンド・スタックをク リアし、スタックをクリーンな状態に戻す。

コマンドの取り消しややり直しは行われず、編集されたオブジェクトの状態は変更されません。

この関数は通常、ドキュメントの内容が破棄されたときに使用される。

QUndoStack()も参照 。

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

index にあるコマンドへの const ポインタを返します。

なぜなら、コマンドを一度スタックにプッシュして実行した後に、そのコマンドを変更すると、ほとんどの場合、後でそのコマンドを取り消したり、やり直したりした場合に、ドキュメントの状態が壊れてしまうからです。

QUndoCommand::child()も参照 。

int QUndoStack::count() const

スタック上のコマンド数を返す。マクロコマンドもひとつのコマンドとして数えます。

index()、setIndex()、command()も参照 。

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

指定されたparent を持つQAction オブジェクトを作成します。

このアクションをトリガすると、redo() が呼び出される。このアクションのテキストは、次に呼び出されるredo() で再実行されるコマンドのテキストで、指定されたprefix が先頭に付きます。やり直しが可能なコマンドがない場合、このアクションは無効になる。

prefix が空の場合、接頭辞の代わりにデフォルトのテンプレート "Redo %1" が使われます。Qt 4.8以前では、接頭辞 "Redo "がデフォルトで使われていました。

createUndoAction(),canRedo(),QUndoCommand::text()も参照してください 。

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

与えられたparent で、元に戻すQAction オブジェクトを作成します。

このアクションをトリガすると、undo() が呼び出される。このアクションのテキストは、次に呼び出されるundo() で元に戻されるコマンドのテキストで、指定されたprefix が先頭に付きます。元に戻せるコマンドがない場合、このアクションは無効になる。

prefix が空の場合、接頭辞の代わりにデフォルトテンプレート "Undo %1" が使われます。Qt 4.8以前では、接頭辞 "Undo "がデフォルトで使われていました。

createRedoAction(),canUndo(),QUndoCommand::text()も参照して ください。

void QUndoStack::endMacro()

マクロコマンドの構成を終了します。

この関数が、ネストされたマクロのセットで一番外側のマクロである場合、マクロコマンド全体に対してindexChanged() を一度だけ発行します。

beginMacro()も参照 。

int QUndoStack::index() const

現在のコマンドのインデックスを返します。これは、次にredo() を呼び出したときに実行されるコマンドである。多くのコマンドが取り消された可能性があるため、常にスタック上の最上位コマンドとは限りません。

setIndex()、undo()、redo()、count()も参照 。

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

このシグナルは、コマンドによってドキュメントの状態が変更されるたびに発せられる。これは、コマンドが取り消されたり、やり直されたりしたときに発生する。マクロ・コマンドの取り消しややり直し、setIndex()が呼び出されると、このシグナルは1回だけ発せられる。

idx は、現在のコマンドのインデックス、つまり、次に () を呼び出したときに実行されるコマンドを指定する。redo

index() およびsetIndex()も参照 。

bool QUndoStack::isClean() const

スタックがクリーンな状態の場合、true を返し、そうでない場合はfalse を返す。

setClean() およびcleanIndex() も参照 。

void QUndoStack::push(QUndoCommand *cmd)

cmd をスタックにプッシュするか、最近実行されたコマンドにマージします。いずれの場合も、redo() 関数を呼び出してcmd を実行する。

cmd のidが-1でなく、そのidが最近実行されたコマンドのidと同じ場合、QUndoStack は、最近実行されたコマンドでQUndoCommand::mergeWith() を呼び出して、2つのコマンドのマージを試みる。QUndoCommand::mergeWith()がtrue を返した場合、cmd は削除される。

QUndoCommand::redo （）、および該当する場合はQUndoCommand::mergeWith （）を呼 び出した後、cmd またはマージされたコマンドに対してQUndoCommand::isObsolete （）が呼び出される。QUndoCommand::isObsolete()がtrue を返す場合、cmd またはマージされたコマンドはスタックから削除される。

それ以外の場合、cmd は単にスタックにプッシュされる。

cmd がプッシュされる前にコマンドが取り消されていた場合、現在のコマンドとその上のすべてのコマンドが削除される。したがって、cmd は常にスタックの一番上になる。

コマンドがプッシュされると、スタックはそのコマンドの所有権を持つ。実行後にコマンドを変更すると、ほとんどの場合、ドキュメントの状態が壊れてしまうので、コマンドを返すゲッターはありません。

QUndoCommand::id() およびQUndoCommand::mergeWith()も参照の こと。

[slot] void QUndoStack::redo()

QUndoCommand::redo() をコールすることで、現在のコマンドを再実行します。現在のコマンドのインデックスをインクリメントする。

スタックが空の場合、またはスタックの先頭のコマンドが既にやり直されている場合、 この関数は何もしません。

現在のコマンドに対してQUndoCommand::isObsolete() が真を返した場合、そのコマンドはスタックから削除される。さらに、クリーン・インデックスが現在のコマンド・インデックス以上である場合、 クリーン・インデックスはリセットされます。

undo() およびindex()も参照 。

QString QUndoStack::redoText() const

redo() の次の呼び出しでやり直されるコマンドのテキストを返す。

QUndoCommand::actionText() およびundoText()も参照 。

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

このシグナルは、redoText() の値が変更されるたびに発行されます。このシグナルは、createRedoAction() によって返された redo アクションの text プロパティを更新するために使用されます。redoText は、新しいテキストを指定します。

[slot] void QUndoStack::resetClean()

スタックがクリーンであった場合、クリーン状態を去り、cleanChanged() を発する。このメソッドは、クリーン・インデックスを -1 にリセットします。

このメソッドは通常、以下のような場合に呼び出されます：

• 何らかのテンプレートに基づいて作成され、まだ保存されておらず、ドキュメントにファイル名が関連付けられていない場合。
• バックアップファイルから復元された場合。
• エディター外で変更され、ユーザーが再読み込みしなかった場合。

isClean(),setClean(),cleanIndex()も参照してください 。

[slot] void QUndoStack::setClean()

スタックがまだクリーンでなかった場合、スタックをクリーンとしてマークし、cleanChanged() を発行します。

これは通常、ドキュメントが保存されるときなどに呼び出される。

undo/redo コマンドを使用してスタックがこの状態に戻るときはいつでも、シグナルcleanChanged() を発する。このシグナルは、スタックがクリーン状態を離れるときにも発せられる。

isClean()、resetClean()、cleanIndex()も参照のこと 。

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

現在のコマンド・インデックスがidx に達するまで、undo() またはredo() を繰り返し呼び出す。この関数は、ドキュメントの状態を前方にも後方にもロールするために使用できる。indexChanged() は一度だけ呼び出される。

index()、count()、undo()、redo()も参照のこと 。

QString QUndoStack::text(int idx) const

インデックスidx にあるコマンドのテキストを返す。

beginMacro() も参照 。

[slot] void QUndoStack::undo()

QUndoCommand::undo() を呼び出すと、現在のコマンドより下のコマンドを取り消します。現在のコマンドのインデックスをデクリメントします。

スタックが空の場合、またはスタック上の最下位のコマンドが既にアンドゥされている場合、 この関数は何もしません。

コマンドが取り消された後、QUndoCommand::isObsolete() がtrue を返す場合、そのコマンドはスタックから削除される。さらに、クリーン・インデックスが現在のコマンド・インデックス以上であれば、 クリーン・インデックスはリセットされる。

redo() およびindex()も参照 。

QString QUndoStack::undoText() const

次にundo() を呼び出したときに元に戻されるコマンドのテキストを返します。

QUndoCommand::actionText() およびredoText()も参照してください 。

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

このシグナルは、undoText() の値が変更されるたびに発行されます。このシグナルは、createUndoAction() が返す undo アクションの text プロパティを更新するために使用されます。undoText は、新しいテキストを指定します。