QUndoCommand Class

メンバ関数のドキュメント

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

親がparent であるQUndoCommandオブジェクトを作成します。

parent がnullptr でない場合、このコマンドは親の子リストに追加されます。その後、親コマンドがこのコマンドを所有し、そのデストラクタ内で削除します。

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

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

指定されたparent およびtext を使用して、QUndoCommandオブジェクトを構築します。

parent がnullptr でない場合、このコマンドは親の子リストに追加されます。その後、親コマンドがこのコマンドを所有し、そのデストラクタ内でこのコマンドを削除します。

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

[virtual noexcept] QUndoCommand::~QUndoCommand()

QUndoCommand オブジェクトと、そのすべての子コマンドを破棄します。

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

QString QUndoCommand::actionText() const

このコマンドの機能説明となる短いテキスト文字列を返します。例：「テキストを挿入」。

このテキストは、スタックの「元に戻す」および「やり直し」アクションのテキストプロパティが更新される際に使用されます。

text()、setText()、QUndoStack::createUndoAction()、およびQUndoStack::createRedoAction()も参照してください 。

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

index にある子コマンドを返します。

childCount() およびQUndoStack::command()も参照してください 。

int QUndoCommand::childCount() const

このコマンドに含まれる子コマンドの数を返します。

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

[virtual] int QUndoCommand::id() const

このコマンドの ID を返します。

コマンド ID はコマンドの圧縮に使用されます。このコマンドのクラス内で一意な整数である必要があります。コマンドが圧縮をサポートしていない場合は -1 を返します。

コマンドが圧縮をサポートしている場合、正しい ID を返すために、派生クラスでこの関数をオーバーライドする必要があります。基底クラスの実装では -1 を返します。

QUndoStack::push() は、2 つのコマンドの ID が同じであり、かつその ID が -1 でない場合にのみ、それらのコマンドの統合を試みます。

mergeWith() およびQUndoStack::push()も参照してください 。

bool QUndoCommand::isObsolete() const

そのコマンドが廃止済みであるかどうかを返します。

このブール値は、スタック内でもはや必要とされないコマンドを自動的に削除するために使用されます。isObsolete関数は、QUndoStack::push()、QUndoStack::undo()、QUndoStack::redo()、およびQUndoStack::setIndex()の各関数内でチェックされます。

setObsolete()、mergeWith()、QUndoStack::push()、QUndoStack::undo()、およびQUndoStack::redo()も参照してください 。

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

このコマンドをcommand とマージしようとします。成功した場合はtrue を返し、失敗した場合はfalse を返します。

この関数が `true` を返した場合、このコマンドの `redo()` を呼び出すと、このコマンドと `command` の両方を再実行したのと同じ効果が得られなければなりません。同様に、このコマンドの `undo()` を呼び出すと、`command ` とこのコマンドを元に戻したのと同じ効果が得られなければなりません。

QUndoStack 2つのコマンドのIDが同一であり、かつそのIDが-1でない場合にのみ、それらの統合が試みられます。

デフォルトの実装では、false を返します。

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

id() およびQUndoStack::push()も参照してください 。

[virtual] void QUndoCommand::redo()

ドキュメントに変更を適用します。この関数は派生クラスで実装する必要があります。この関数からQUndoStack::push()、QUndoStack::undo()、またはQUndoStack::redo()を呼び出すと、未定義の挙動を引き起こします。

デフォルトの実装では、すべての子コマンドに対してredo()を呼び出します。

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

void QUndoCommand::setObsolete(bool obsolete)

obsolete に対して、そのコマンドが廃止されたかどうかを設定します。

isObsolete()、mergeWith()、QUndoStack::push()、QUndoStack::undo()、およびQUndoStack::redo()も参照してください 。

void QUndoCommand::setText(const QString &text)

コマンドのテキストを、指定されたtext に設定します。

指定するテキストは、このコマンドの機能を一言で説明する、ユーザーが理解しやすい短い文字列である必要があります。

text() とactionText() で 2 つの異なる文字列を使用する必要がある場合は、それらを "\n" で区切って、この関数に渡してください。開発中に英語の文字列に対してこの機能を使用しない場合でも、特定の言語のニーズに合わせて、翻訳者が 2 つの異なる文字列を使用できるようにすることができます。 上記の機能および関数 `actionText()` は、Qt 4.8 以降で利用可能です。

text()、actionText()、QUndoStack::createUndoAction()、およびQUndoStack::createRedoAction()も参照してください 。

QString QUndoCommand::text() const

このコマンドの機能の説明となる短いテキスト文字列を返します。例えば、「テキストを挿入」などです。

このテキストは、QUndoView 内の項目の名前として使用されます。

actionText()、setText()、QUndoStack::createUndoAction()、およびQUndoStack::createRedoAction()も参照してください 。

[virtual] void QUndoCommand::undo()

ドキュメントへの変更を元に戻します。undo() が呼び出された後、ドキュメントの状態は、redo() が呼び出される前の状態と同じになる必要があります。この関数は派生クラスで実装する必要があります。この関数内からQUndoStack::push()、QUndoStack::undo()、またはQUndoStack::redo() を呼び出すと、未定義の挙動を引き起こします。

デフォルトの実装では、すべての子コマンドに対して、逆順で undo() を呼び出します。

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