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でない場合にのみ、2つのコマンドのマージを試みます。

mergeWith() およびQUndoStack::push()も参照 。

bool QUndoCommand::isObsolete() const

コマンドが廃止されたかどうかを返します。

この boolean は、スタック内で不要になったコマンドを自動的に削除するために使用される。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でない場合にのみ、2つのコマンドのマージを試みます。

デフォルトの実装は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()も参照してください 。