Qt GUI プログラミング： QUndoGroup::createUndoAction() で元に戻す機能を実装

Qt GUI プログラミング： QUndoGroup::createUndoAction() の詳細解説

QUndoGroup::createUndoAction() メソッドは、現在アクティブな QUndoStack に対する "元に戻す" アクションを作成します。このアクションは、QAction クラスの派生クラスであり、以下の機能を提供します:

• テキストとアイコン: アクションの名前とアイコンを設定できます。
• 有効状態: QUndoStack の canUndo() メソッドに基づいて、アクションの有効状態が自動的に更新されます。
• 実行: アクションが実行されると、QUndoStack::undo() メソッドが呼び出され、最後に実行された操作が元に戻されます。

このメソッドの使い方は以下の通りです:

1. QUndoGroup オブジェクトを作成します。
2. グループに QUndoStack オブジェクトを追加します。
3. QUndoGroup::createUndoAction() メソッドを呼び出し、アクションを作成します。
4. 作成されたアクションをメニューやツールバーに追加します。

例:

// QUndoGroup オブジェクトを作成
QUndoGroup group;

// グループに QUndoStack オブジェクトを追加
QUndoStack stack;
group.addStack(&stack);

// "元に戻す" アクションを作成
QAction* undoAction = group.createUndoAction();

// メニューに追加
QMenu* menu = ...;
menu->addAction(undoAction);

メソッドの詳細:

• 戻り値: 現在アクティブな QUndoStack に対する "元に戻す" アクション
• 引数:
  • parent: アクションの親ウィジェット
  • prefix: アクションのテキストに付加されるプレフィックス (省略可能)

補足:

• QUndoGroup::createRedoAction() メソッドは、現在アクティブな QUndoStack に対する "やり直す" アクションを作成します。
• QUndoStack::undo() と QUndoStack::redo() メソッドは、直接呼び出すこともできます。
• QUndoView クラスは、QUndoGroup と連携して、操作履歴を表示するウィジェットを提供します。

理解を深めるために:

• 上記のコード例を実際に試してみてください。
• Qt ドキュメントの "Undo/Redo Framework" の章を読んで、QUndoGroup と QUndoStack の仕組みを理解しましょう。
• Qt チュートリアル "Undo/Redo Functionality" を試して、QUndoGroup と QUndoStack を使用したアプリケーションの作り方を学びましょう。

Qt GUI プログラミング： QUndoGroup::createUndoAction() サンプルコード

シンプルな "元に戻す" アクション

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>
#include <QtWidgets/QTextEdit>
#include <QtWidgets/QUndoGroup>

class MainWindow : public QMainWindow {
  Q_OBJECT
public:
  MainWindow() {
    // テキストエディットを作成
    textEdit = new QTextEdit(this);
    setCentralWidget(textEdit);

    // QUndoGroup と QUndoStack を作成
    undoGroup = new QUndoGroup(this);
    undoStack = new QUndoStack(undoGroup);

    // "元に戻す" アクションを作成
    undoAction = undoGroup->createUndoAction(this, "元に戻す");

    // ツールバーに追加
    toolbar = addToolBar("Undo");
    toolbar->addAction(undoAction);
  }

private slots:
  void onTextChanged() {
    // テキストが変更されたら、"元に戻す" アクションを有効にする
    undoAction->setEnabled(undoStack->canUndo());
  }

private:
  QTextEdit* textEdit;
  QUndoGroup* undoGroup;
  QUndoStack* undoStack;
  QAction* undoAction;
  QToolBar* toolbar;
};

int main(int argc, char* argv[]) {
  QApplication app(argc, argv);

  MainWindow mainWindow;
  mainWindow.show();

  return app.exec();
}

複数の "元に戻す" アクション

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow>
#include <QtWidgets/QTextEdit>
#include <QtWidgets/QUndoGroup>
#include <QtWidgets/QUndoCommand>

class TextEditCommand : public QUndoCommand {
  Q_OBJECT
public:
  TextEditCommand(QTextEdit* textEdit, const QString& text) :
    QUndoCommand(textEdit), textEdit(textEdit), text(text) {}

  void redo() override {
    textEdit->insertPlainText(text);
  }

  void undo() override {
    textEdit->textCursor().deletePreviousChar();
  }

private:
  QTextEdit* textEdit;
  QString text;
};

class MainWindow : public QMainWindow {
  Q_OBJECT
public:
  MainWindow() {
    // テキストエディットを作成
    textEdit = new QTextEdit(this);
    setCentralWidget(textEdit);

    // QUndoGroup と QUndoStack を作成
    undoGroup = new QUndoGroup(this);
    undoStack = new QUndoStack(undoGroup);

    // "元に戻す" アクションを作成
    undoAction = undoGroup->createUndoAction(this, "元に戻す");

    // ツールバーに追加
    toolbar = addToolBar("Undo");
    toolbar->addAction(undoAction);
  }

private slots:
  void onTextChanged() {
    // テキストが変更されたら、"元に戻す" アクションを有効にする
    undoAction->setEnabled(undoStack->canUndo());
  }

  void onAddText() {
    // テキストを追加するコマンドを作成して実行
    QString text = "Hello, world!";
    TextEditCommand* command = new TextEditCommand(textEdit, text);
    undoStack->push(command);
  }

private:
  QTextEdit* textEdit;
  QUndoGroup* undoGroup;
  QUndoStack* undoStack;
  QAction* undoAction;
  QToolBar* toolbar;
};

int main(int argc, char* argv[]) {
  QApplication app(argc, argv);

  MainWindow mainWindow;
  mainWindow.show();

  return app.exec();
}

このコードは、テキストエディットに対して "元に戻す" 機能と "テキストを追加" 機能を実装します。"テキストを追加" 機能は、TextEditCommand クラスを使用して実装されています。

"やり直す" アクション

#include <QtWidgets/QApplication>
#include <QtWidgets/QMainWindow

Qt GUI プログラミング： QUndoGroup::createUndoAction() の代替方法

QUndoStack::undo() と QUndoStack::redo() メソッドを直接呼び出す

// テキストエディットのテキストを変更
textEdit->setText("新しいテキスト");

// "元に戻す" を実行
undoStack->undo();

// "やり直す" を実行
undoStack->redo();

この方法はシンプルですが、アクションを作成したり、ツールバーに追加したりする必要がない場合にのみ適しています。

QPushButton や QToolButton を使用して "元に戻す" と "やり直す" を実装する

// "元に戻す" ボタンを作成
QPushButton* undoButton = new QPushButton("元に戻す");

// "やり直す" ボタンを作成
QPushButton* redoButton = new QPushButton("やり直す");

// ボタンクリック時のスロットを設定
connect(undoButton, &QPushButton::clicked, undoStack, &QUndoStack::undo);
connect(redoButton, &QPushButton::clicked, undoStack, &QUndoStack::redo);

// ツールバーに追加
toolbar->addWidget(undoButton);
toolbar->addWidget(redoButton);

この方法は、より多くのカスタマイズ性を提供しますが、コード量が増えます。

カスタム "元に戻す" アクションを作成する

class MyUndoAction : public QAction {
  Q_OBJECT
public:
  MyUndoAction(QUndoStack* undoStack) : QAction(undoStack), undoStack(undoStack) {}

  void trigger() override {
    // カスタム処理を実行
    // ...

    // "元に戻す" を実行
    undoStack->undo();
  }

private:
  QUndoStack* undoStack;
};

// アクションを作成
MyUndoAction* undoAction = new MyUndoAction(undoStack);

// メニューに追加
menu->addAction(undoAction);

この方法は、最も柔軟な方法ですが、最も複雑な方法でもあります。

どの方法を選択するべきかは、要件と開発者のスキルレベルによって異なります。

• シンプルな "元に戻す" 機能を実装したい場合は、QUndoGroup::createUndoAction() メソッドを使用するのが最も簡単です。
• より多くのカスタマイズ性を必要とする場合は、QUndoStack::undo() と QUndoStack::redo() メソッドを直接呼び出すか、カスタム "元に戻す" アクションを作成する必要があります。