QCompleter::CompletionModeを使いこなして、Qt Widgetsの補完機能を強化しよう！

Qt WidgetsにおけるQCompleter::CompletionMode

QCompleter::CompletionModeは、Qt WidgetsにおけるQCompleterクラスで使用される列挙型です。これは、補完候補の表示方法を制御するために使用されます。

メンバー

• CaseInsensitiveCompletion: 大文字と小文字を区別せずに候補を表示します。
• PopupCompletion: 候補をポップアップウィンドウに表示します。
• InlineCompletion: 候補をエディットライン内に直接表示します。

例

#include <QtWidgets>

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

  //LineEditの作成
  QLineEdit lineEdit;

  //Completerの作成
  QCompleter completer(QStringList() << "apple" << "banana" << "cherry");

  //CompleterをLineEditに設定
  lineEdit.setCompleter(&completer);

  //CompletionModeの設定
  completer.setCompletionMode(QCompleter::PopupCompletion);

  //LineEditを表示
  lineEdit.show();

  return app.exec();
}

この例では、PopupCompletionモードが設定されているため、候補はポップアップウィンドウに表示されます。

その他のモード

• UnfilteredCompletion: 入力された文字列に一致する候補をすべて表示します。

補足

• Qt Widgetsは、QtフレームワークのGUIライブラリです。
• QCompleterクラスは、エディットラインに入力された文字列を補完する機能を提供します。
• QCompleter::CompletionModeは、補完候補の表示方法を制御するために使用されます。

QCompleter::CompletionMode を使用したサンプルコード

複数のCompletionModeを組み合わせる

#include <QtWidgets>

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

  //LineEditの作成
  QLineEdit lineEdit;

  //Completerの作成
  QCompleter completer(QStringList() << "apple" << "banana" << "cherry");

  //CompletionModeの設定
  completer.setCompletionMode(QCompleter::CaseInsensitiveCompletion |
                               QCompleter::PopupCompletion);

  //LineEditをエディットラインに設定
  lineEdit.setCompleter(&completer);

  //LineEditを表示
  lineEdit.show();

  return app.exec();
}

フィルタリングされた補完候補を表示する

#include <QtWidgets>

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

  //LineEditの作成
  QLineEdit lineEdit;

  //Completerの作成
  QCompleter completer(QStringList() << "apple" << "banana" << "cherry");

  //CompletionModeの設定
  completer.setCompletionMode(QCompleter::FilteredCompletion);

  //LineEditをエディットラインに設定
  lineEdit.setCompleter(&completer);

  //LineEditを表示
  lineEdit.show();

  return app.exec();
}

この例では、FilteredCompletionモードを使用しているため、入力された文字列に前方一致する候補のみが表示されます。

カスタムモデルを使用した補完

#include <QtWidgets>

class MyModel : public QAbstractListModel {
  Q_OBJECT

public:
  MyModel(QObject *parent = nullptr) : QAbstractListModel(parent) {}

  int rowCount(const QModelIndex &parent = QModelIndex()) const override {
    return m_data.size();
  }

  QVariant data(const QModelIndex &index, int role) const override {
    if (role == Qt::DisplayRole) {
      return m_data[index.row()];
    }
    return QVariant();
  }

  void addData(const QString &data) {
    beginInsertRows(QModelIndex(), m_data.size(), m_data.size() + 1);
    m_data.append(data);
    endInsertRows();
  }

private:
  QStringList m_data;
};

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

  //LineEditの作成
  QLineEdit lineEdit;

  //Modelの作成
  MyModel model;
  model.addData("apple");
  model.addData("banana");
  model.addData("cherry");

  //Completerの作成
  QCompleter completer(&model);

  //CompletionModeの設定
  completer.setCompletionMode(QCompleter::PopupCompletion);

  //LineEditをエディットラインに設定
  lineEdit.setCompleter(&completer);

  //LineEditを表示
  lineEdit.show();

  return app.exec();
}

この例では、カスタムモデルを使用して補完候補を提供しています。

補足

• QCompleter::CompletionModeは、Qt Widgets 5.15以降で使用できます。
• Qt Widgets 5.14以前を使用している場合は、QCompleter::setCompletionModel()を使用する必要があります。

QCompleter::CompletionMode 以外の補完方法

QComboBox

#include <QtWidgets>

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

  //ComboBoxの作成
  QComboBox comboBox;

  //アイテムの追加
  comboBox.addItem("apple");
  comboBox.addItem("banana");
  comboBox.addItem("cherry");

  //ComboBoxを表示
  comboBox.show();

  return app.exec();
}

QAbstractItemViewは、テーブルビューやリストビューなどの抽象的なアイテムビューを表すクラスです。QCompleterよりも柔軟な方法で補完機能を提供できます。

#include <QtWidgets>

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

  //LineEditの作成
  QLineEdit lineEdit;

  //Modelの作成
  QStringListModel model;
  model.setStringList(QStringList() << "apple" << "banana" << "cherry");

  //Viewの作成
  QListView listView;
  listView.setModel(&model);

  //LineEditとViewを接続
  lineEdit.setCompleter(&listView);

  //LineEditを表示
  lineEdit.show();

  return app.exec();
}

自作の補完機能

上記の方法でニーズを満たせない場合は、自作の補完機能を作成することができます。

自作の補完機能を作成する際の考慮事項

• 入力された文字列と候補のマッチングアルゴリズム
• 候補の表示方法
• ユーザー入力の処理

補足

• QCompleterは、Qt Widgets 4.6以降で使用できます。
• Qt Widgets 4.6以前を使用している場合は、QComboBoxやQAbstractItemViewなどの他の方法を使用する必要があります。