Qt をはじめよう！ 第19回: 独自ウィジェットを作成しデザイナで使用しよう

前回 はタブオーダーの設定について学びました。今回は独自ウィジェットを作成し、それらのデザイナでは標準で提供 されていない ウィジェットをデザイナで使用する簡単な方法を学びましょう。

独自ウィジェットについて

Qt では ラベル や ボタン のような基本的なものから リストビュー や ウェブのコンテンツを表示するためのウィジェット など 多種多様なウィジェット を提供しています。これらのウィジェットをそのまま使用するだけではなく、あるウィジェットの派生クラスを作成して機能を拡張したり、いくつかのウィジェットを組み合わせて新しいウィジェットを作成したり、さらには全く新しいウィジェットを作成することも可能です。今回は最初の２つのケースを例に、独自クラスを作成し、それらをデザイナで使用する方法について解説します。

プロジェクトの作成

今回は新たなプロジェクトを作成するところから始めましょう。プロジェクトの作成方法は以前にも解説していますが、Qt Creator のバージョンアップに伴い若干変更されている点がありますので、今回は Qt Creator 2.2.1 を用いて再度説明します。

はじめに、メニューから「ファイル(F)」→「ファイル/プロジェクトの新規作成(N)…」 を選択してください。

テンプレートを選択してください：

プロジェクト名とパス

ターゲット設定

名前を「promotion」と変更し「次へ(N)>」をクリックしてください。パスは任意のディレクトリを指定してください。この際、日本語やスペースなどは含めないようにしましょう。
次に、使用する Qt のバージョンを選択します。Qt SDK のインストールの方法などによって、様々なターゲットやバージョンの Qt がここの一覧に現れることがありますが、上記のスクリーンショットを参考に Qt SDK に含まれるデスクトップ向けの Qt を選択し「次へ(N)>」をクリックしてください。

クラス情報

プロジェクト管理

クラス名を「Promotion」に、基底クラスを「QWidget」に変更してください。
今回も GUI で UI のデザインを作成するため、「フォームを生成する(G)」のチェックはつけたままにしてください。
最後に、ファイルの追加先と追加されるファイルを確認し、「完了(F)」をクリックするとプロジェクトの作成は完了です。

プロジェクトが作成されました

ウィジェットの派生クラスの作成

それではデザイナから使用するウィジェットを作成しましょう。QWidget は QObject の派生クラスのため、既に 第11回 で学んだ QObject の派生クラスの作成方法も参考にしてください。

ここでは QLineEdit の派生クラスを作成し、拡張する機能として text プロパティの文字列長を扱うことにします。
それではメニューから「ファイル(F)」→「ファイル/プロジェクトの新規作成(N)…」を選択してください。

テンプレートを選択してください：

クラス名を入力してください

プロジェクト管理

クラス名を「LineEdit」に、基底クラスを「QLineEdit」に、型情報を「QWidget を継承」変更し、「次へ(N)>」をクリックしてください。
最後に、先ほど作成した「promotion.pro」に「lineedit.h」と「lineedit.cpp」の２つのファイルが追加されることを確認し、「完了(F)」をクリックしクラスを生成します。

それでは LineEdit クラスを変更して文字列長の取得関数とそれが変更された際に発生するシグナルを作成しましょう。この情報は読み取り専用なので、設定関数は作成しません。以下がソースコードと変更箇所になります。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#ifndef LINEEDIT_H
#define LINEEDIT_H
 
#include <QLineEdit>
 
class LineEdit : public QLineEdit
{
    Q_OBJECT
public:
    explicit LineEdit(QWidget *parent = 0);
    int textLength() const;
 
signals:
    void textLengthChanged(int textLength);
 
private slots:
    void updateTextLength(const QString &text);
 
private:
    int m_textLength;
};
 
#endif // LINEEDIT_H

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#include "lineedit.h"
 
LineEdit::LineEdit(QWidget *parent) :
    QLineEdit(parent),
    m_textLength(0)
{
    connect(this, SIGNAL(textChanged(QString)),
                this, SLOT(updateTextLength(QString)));
}
 
int LineEdit::textLength() const
{
    return m_textLength;
}
 
void LineEdit::updateTextLength(const QString &text)
{
    if (m_textLength == text.length())
        return;
 
    m_textLength = text.length();
    emit textLengthChanged(m_textLength);
}

シグナル／スロットの作成の詳細は 第12回 で解説していますのでそちらをご覧ください。

デザイナで独自ウィジェットを使用する

それでは、作成した LineEdit を promotion.ui から使用してみましょう。
promotion.ui を開いて、下記のようなデザイナの画面を表示してください。

promotion.ui

デザイナでは自分で作成したウィジェットをそのまま直接配置して使用することはできません。直接配置できるようにするためには 独自ウィジェット用のデザイナプラグインを作成し ウィジェットリストに追加する作業が必要で、Qt Creator ではそのためのプロジェクトのテンプレート(「ファイル/プロジェクトの新規作成(N)…」→「他のプロジェクト」→「Qt カスタム デザイナ ウィジェット」)も用意しています。しかし、これはプロジェクトに依らない汎用のウィジェットを作成して使う場合の上級者向けの方法のため、今回はもう少し簡単な「格上げ」という方法を使用することにします。これは独自ウィジェットの代わりとなるデザイナで使用可能なウィジェットを最初に配置し、それを独自ウィジェットに変換する方法です。

まずはじめに、作成したクラスの基底クラスのウィジェットをさかのぼり、その中で一番近い、デザイナで配置可能なウィジェットを選び配置します。

継承関係はドキュメントに記載されています

このため、LineEdit の代わりに一度 QLineEdit をフォームに配置します。

QLineEdit を配置

それでは配置した QLineEdit を LineEdit に変更しましょう。Qt の GUI デザイナではこの操作を「格上げ(promotion)」と呼びます。
QLineEdit 上で右クリックをし、コンテキストメニューの中から「格上げ先を指定…」を選択します。

コンテキストメニューから「格上げ先を指定...」を選択

格上げされたウィジェット

ダイアログの上部「格上げされたクラス」は格上げするためのウィジェットの一覧の情報です。現在はまだこれに関する情報は設定していないため、一覧に何もない状態です。
ダイアログの下部「新しい格上げされたクラス」で格上げするウィジェットを追加します。

格上げするクラスの登録

それでは格上げするクラスを登録しましょう。ダイアログの各項目(図中の赤で囲んだところ)を図の右の内容に従って編集してください。

格上げするクラスの追加

これが QLineEdit クラスをヘッダファイル lineedit.h 内に定義されている LineEdit という名前のクラスに格上げ可能にする設定になります。「追加」ボタンをクリックし「格上げされたクラス一覧」にこの情報が登録されることを確認しましょう。

LineEdit の格上げ情報が登録されました

「グローバルにインクルードする」のチェックは、デフォルトでは #include "lineedit.h" とインクルードされるヘッダファイルを #include <lineedit.h> とインクルードするための設定になります。今回の場合は widget.ui と同じフォルダに lineedit.h があるため、グローバルにはインクルードせず、 #include "~.h" の形式を採用します。このチェックは状況に応じて使い分けてください。

格上げをする

それではここで登録した格上げ情報を使用し、フォームに配置した QLineEdit を LineEdit に格上げしましょう。「格上げされたクラス一覧」の LineEdit の行を選択し、「格上げ」ボタンをクリックします。

格上げをクリック

LineEdit に格上げされました

これにより QLineEdit だったウィジェットが LineEdit として扱われるようになりました。オブジェクトツリーで該当するウィジェットのクラス名が LineEdit に変わっており、このウィジェットのプロパティービューでもクラス名が LineEdit と表示されます。ここで、デザイナでの見た目上は QLineEdit のままであることに注意してください。

シグナル／スロットの接続

LineEdit の文字列長を表示するために今回は QLCDNumber クラスを使用します。このクラスは数字や一部のアルファベットを 7セグメントディスプレイ 形式で表示するためのウィジェットになります。

LCD Number を配置

先ほど作成した LineEdit の textLengthChanged(int) シグナルを、LCD Number の display(int) スロットに接続するためにシグナル／スロットの接続モードに移行します。

LineEdit のシグナルを LCD Number のスロットに接続

textLengthChanged(int) は表示されません

この際、Qt のデザイナでは格上げされたクラスからはシグナルやスロットなどの情報を自動では読み込みませんので、LineEdit の textLengthChanged(int) シグナルは表示されません。格上げ後のクラスに作成してあるシグナル(やスロット)を使用するには 第16回 で学んだ方法で手動で追加する必要があります。

上記の画面で「編集…」ボタンをクリックし、シグナルに textLengthChanged(int) を追加します。

textLengthChanged(int) シグナルを追加

シグナル／スロットを接続

「OK(O)」ボタンをクリックし、戻ったダイアログで textLengthChanged(int) を display(int) に接続します。

それでは確認してみましょう。プレビューでは格上げされたウィジェットは格上げ前のウィジェットと同じ動作をしますので、今回の場合は動作を確認できません。このため、プロジェクトをビルドし実行して確認する必要があります。アプリケーションを実行し、LineEdit に適当な文字を入力し、内容が変更された際に文字列長が QLCDNumber ウィジェットに表示されることを確認してください。

実行して文字列長が表示されることを確認

Qt Designer フォームクラスの作成

ここまでは、QLineEdit の派生クラス LineEdit 作成し、それをデザイナから使用する方法について学びました。次にいくつかのウィジェットを組み合わせた場合についても試してみましょう。

ここでは QLineEdit と QToolButton を組み合わせた簡単なウィジェットを作成します。機能の実装は省略しますが、ファイルのパスやディレクトリを指定するようなウィジェットを想定しています。

それでは Qt Creator の「ファイル/プロジェクトの新規作成」から「Qt」の「Qt Designer フォームクラス」を作成しましょう。
ここで「Qt Designer フォーム」の方は .ui ファイルだけを作成するテンプレートで、「Qt Designer フォームクラス」は .ui ファイルとそれを使用するクラス(の .h ファイルと .cpp ファイル)を作成するテンプレートです。.ui ファイルは Qt 独自の形式のため、「C++」ではなく「Qt」のカテゴリに分類されています。

テンプレートを選択してください：

フォーム テンプレートを選択して下さい

フォームテンプレートは「Widget」を選択します。

クラス名を選択して下さい

プロジェクト管理

C++ クラスの作成時と同様に、クラス名を「FilePathWidget」に変更し、promotion.pro に filepathwidget.h と filepathwidget.cpp が追加されることを確認して「完了(F)」をクリックします。

filepathwidget.ui をデザインモードで開き、QLineEdit と QToolButton を配置し、フォーム上で水平方向に並べます。

ウィジェットを配置

sizePolicy の設定

また、フォームの sizePolicy の「縦方向のポリシー」を「Fixed」に設定しておきましょう。これは、このウィジェットをレイアウトの中で使用する際に縦方向には広がらないための設定になります。

それでは FilePathWidget を promotion.ui で使用してみましょう。promotion.ui をデザイナで開きます。
ここで、FilePathWidget の基底クラスは QWidget のため、今回は Widget をフォームに配置します。

Widget を配置

この Widget を先ほどと同じ手順で FilePathWidget に格上げしましょう。

FilePathWidget を格上げ情報に登録

FilePathWidget に格上げ

FilePathWidget に格上げ完了

レイアウトを設定

実行して確認

格上げした FilePathWidget になって表示されることを確認しましょう。
このように「格上げ」を用いる場合、デザイナ上では FilePathWidget のサイズ関連の情報(sizeHint や sizePolicy など)が使用する側のフォームに反映されないことに注意しましょう。このため、レイアウト適用後にフォームやウィンドウをリサイズしたときの見た目や動きがデザイナと実行時に異なる場合があります。デザイナではサイズ情報の無い Widget としてレイアウトが行われますが、実行時には格上げしたウィジェットのサイズ関連の情報を使用しレイアウトが行われます。

格上げの仕組みについて

最後に、格上げの仕組みを見てみましょう。
promotion.ui をサイドバーの「編集」ボタンを押して「編集モード」で開き、XML 形式のソースを見てみましょう。

「編集モード」でソースを表示

48
49
50
51
52
53
54
55
56

<customwidgets>
 <customwidget>
  <class>LineEdit</class>
  <extends>QLineEdit</extends>
  <header>lineedit.h</header>
  <slots>
   <signal>textLengthChanged(int)</signal>
  </slots>
 </customwidget>

この情報を使用して、以下のように実際のウィジェットの情報が定義されています。

16
17
18
19
20
21
22
23
24
25

<widget class="LineEdit" name="lineEdit">
 <property name="geometry">
  <rect>
   <x>10</x>
   <y>10</y>
   <width>113</width>
   <height>27</height>
  </rect>
 </property>
</widget>

また、この ui ファイルから生成される ui_promotion.h を見てみると、自分で作成した LineEdit のヘッダファイル “lineeidt.h” がインクルードされ、setupUi() 関数の中では LineEdit のインスタンスが生成されていることが分かります。
ui_promotion.h

21

#include "lineedit.h"

…

37

lineEdit = new LineEdit(Promotion);

おわりに

今回は２種類の独自ウィジェットの作成方法とそれらをデザイナ上で使うためのの「格上げ」機能について勉強しました。
Qt でアプリケーションの開発をする際には本当によく使う便利な機能ですので、是非活用して下さい。
次回からは QWidget を派生した独自ウィジェットの作成を通して様々な機能を学んでいきましょう。

Related posts:

1. Qt をはじめよう！ 第16回: GUI デザイナでスロットを作成しよう
2. Qt をはじめよう！ 第15回: GUI デザイナでシグナル／スロットを接続しよう
3. Qt をはじめよう！ 第18回: タブオーダーを設定しよう
4. Qt をはじめよう！ 第17回: アクセスキーを設定しよう
5. Qt をはじめよう！ 第10回: シグナルとスロット

Tagged as: Qt デザイナ, 派生クラス