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

スタック上のコマンド数を返す。マクロ・コマンドは 1 つのコマンドとしてカウントされる。

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() が呼び出されたりすると、このシグナルは一度だけ発せられる。

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() によって返されたやり直しアクションの 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 は、新しいテキストを指定します。