QListWidgetItem Class
QListWidgetItem クラスは、QListWidget アイテムビュークラスで使用するためのアイテムを提供します。詳細...
| ヘッダー: | #include <QListWidgetItem> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
パブリック型
| enum | ItemType { Type, UserType } |
パブリック関数
| QListWidgetItem(QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type) | |
| QListWidgetItem(const QListWidgetItem &other) | |
| virtual | ~QListWidgetItem() |
| QBrush | background() const |
| Qt::CheckState | checkState() const |
| virtual QListWidgetItem * | clone() const |
| virtual QVariant | data(int role) const |
| Qt::ItemFlags | flags() const |
| QFont | font() const |
| QBrush | foreground() const |
| QIcon | icon() const |
| bool | isHidden() const |
| bool | isSelected() const |
| QListWidget * | listWidget() const |
| virtual void | read(QDataStream &in) |
| void | setBackground(const QBrush &brush) |
| void | setCheckState(Qt::CheckState state) |
| virtual void | setData(int role, const QVariant &value) |
| void | setFlags(Qt::ItemFlags flags) |
| void | setFont(const QFont &font) |
| void | setForeground(const QBrush &brush) |
| void | setHidden(bool hide) |
| void | setIcon(const QIcon &icon) |
| void | setSelected(bool select) |
| void | setSizeHint(const QSize &size) |
| void | setStatusTip(const QString &statusTip) |
| void | setText(const QString &text) |
(since 6.4) void | setTextAlignment(Qt::Alignment alignment) |
| void | setToolTip(const QString &toolTip) |
| void | setWhatsThis(const QString &whatsThis) |
| QSize | sizeHint() const |
| QString | statusTip() const |
| QString | text() const |
| int | textAlignment() const |
| QString | toolTip() const |
| int | type() const |
| QString | whatsThis() const |
| virtual void | write(QDataStream &out) const |
| virtual bool | operator<(const QListWidgetItem &other) const |
| QListWidgetItem & | operator=(const QListWidgetItem &other) |
関連する非メンバー
| QDataStream & | operator<<(QDataStream &out, const QListWidgetItem &item) |
| QDataStream & | operator>>(QDataStream &in, QListWidgetItem &item) |
詳細な説明
QListWidgetItem は、QListWidget 内の単一の項目を表します。各項目は複数の情報を保持でき、それらを適切に表示します。
アイテムビューの利便性クラスは、純粋なモデル/ビューのアプローチではなく、従来のアイテムベースのインターフェースを採用しています。より柔軟なリストビューウィジェットが必要な場合は、標準のモデルと組み合わせてQListView クラスを使用することを検討してください。
リスト項目は、リストウィジェットを指定することで、生成時に自動的にリストに挿入することができます:
new QListWidgetItem(tr("Hazel"), listWidget);あるいは、親ウィジェットなしでリスト項目を作成し、後で `QListWidget::insertItem()` を使用してリストに挿入することも可能です。
リスト項目は通常、text() およびicon() を表示するために使用されます。これらは、setText() およびsetIcon() 関数で設定されます。テキストの外観は、setFont()、setForeground()、およびsetBackground() を使用してカスタマイズできます。リスト項目内のテキストは、setTextAlignment() 関数を使用して配置を調整できます。 リスト項目には、setToolTip()、setStatusTip()、およびsetWhatsThis() を使用して、ツールチップ、ステータスチップ、および「これは何?」ヘルプを追加できます。
デフォルトでは、項目は有効であり、選択可能、チェック可能であり、ドラッグ&ドロップ操作の対象となります。
各項目のフラグは、setFlags() を適切な値とともに呼び出すことで変更できます(Qt::ItemFlags を参照)。チェック可能な項目は、setCheckState() 関数を使用して、チェック、チェック解除、および部分的なチェックを行うことができます。対応するcheckState() 関数は、項目の現在のチェック状態を示します。
isHidden() 関数を使用すると、その項目が非表示かどうかを確認できます。項目を非表示にするには、setHidden() を使用します。
サブクラス化
QListWidgetItemをサブクラス化してカスタム項目を提供する場合、標準の項目と区別できるように、それらの項目に対して新しい型を定義することができます。この機能が必要なサブクラスについては、コンストラクタ内で、UserType 以上の新しい型値を指定して基底クラスのコンストラクタを呼び出すようにしてください。
関連項目: QListWidget 、モデル/ビュープログラミング、QTreeWidgetItem 、およびQTableWidgetItem 。
メンバ型のドキュメント
enum QListWidgetItem::ItemType
この列挙型は、リストウィジェットの項目を表すために使用されるタイプを定義しています。
| 定数 | 値 | 説明 |
|---|---|---|
QListWidgetItem::Type | 0 | リストウィジェットの項目に対するデフォルトの型。 |
QListWidgetItem::UserType | 1000 | カスタム型の最小値。UserType より小さい値は Qt によって予約されています。 |
QListWidgetItem のサブクラスで新しいユーザー型を定義することで、カスタム項目が特別に扱われるようにすることができます。
type()も参照してください 。
メンバ関数のドキュメント
[explicit] QListWidgetItem::QListWidgetItem(QListWidget *parent = nullptr, int type = Type)
指定されたtype の空のリストウィジェット項目を、与えられたparent を用いて生成します。parent が指定されていない場合、その項目はQListWidget::insertItem()を使用してリストウィジェットに挿入する必要があります。
このコンストラクタは、コンストラクタに渡された親のモデルにアイテムを挿入します。モデルがソートされている場合、この時点ではまだ構築されていないアイテムに対してモデルが'<' 演算子メソッドを呼び出すため、挿入時の挙動は未定義となります。この未定義の挙動を避けるため、親を指定せず、代わりにQListWidget::insertItem()を使用することを推奨します。
type()も参照してください 。
[explicit] QListWidgetItem::QListWidgetItem(const QString &text, QListWidget *parent = nullptr, int type = Type)
指定されたtype の空のリストウィジェット項目を、与えられたtext およびparent を用いて構築します。親が指定されていない場合、その項目はQListWidget::insertItem()を使用してリストウィジェットに挿入する必要があります。
このコンストラクタは、コンストラクタに渡された親のモデルにアイテムを挿入します。モデルがソートされている場合、この時点ではまだ構築されていないアイテムに対してモデルが'<' 演算子メソッドを呼び出すため、挿入時の挙動は未定義となります。この未定義の挙動を避けるため、親を指定せず、代わりにQListWidget::insertItem()を使用することを推奨します。
type()も参照してください 。
[explicit] QListWidgetItem::QListWidgetItem(const QIcon &icon, const QString &text, QListWidget *parent = nullptr, int type = Type)
指定されたtype の空のリストウィジェット項目を、与えられたicon 、text 、およびparent を用いて生成します。親が指定されていない場合、その項目はQListWidget::insertItem()を使用してリストウィジェットに挿入する必要があります。
このコンストラクタは、コンストラクタに渡された親のモデルにアイテムを挿入します。モデルがソートされている場合、モデルはアイテムに対して'<' 演算子メソッドを呼び出しますが、この時点ではアイテムはまだ構築されていないため、挿入時の挙動は未定義となります。この未定義の挙動を避けるため、親を指定せず、代わりにQListWidget::insertItem()を使用することを推奨します。
type()も参照してください 。
QListWidgetItem::QListWidgetItem(const QListWidgetItem &other)
other のコピーを作成します。なお、type()およびlistWidget()はコピーされません。
この関数は、clone() を再実装する際に役立ちます。
[virtual noexcept] QListWidgetItem::~QListWidgetItem()
リスト項目を削除します。
QBrush QListWidgetItem::background() const
リスト項目の背景を表示するために使用されるブラシを返します。
setBackground() およびforeground()も参照してください 。
Qt::CheckState QListWidgetItem::checkState() const
リスト項目のチェック状態を返します(Qt::CheckState を参照)。
setCheckState() およびflags()も参照してください 。
[virtual] QListWidgetItem *QListWidgetItem::clone() const
そのアイテムの完全なコピーを作成します。
[virtual] QVariant QListWidgetItem::data(int role) const
指定されたrole に対するアイテムのデータを返します。追加のロールや、特定のロールに対する特別な動作が必要な場合は、この関数を再実装してください。
Qt::ItemDataRole およびsetData()も参照してください 。
Qt::ItemFlags QListWidgetItem::flags() const
このアイテムのフラグを返します(Qt::ItemFlags を参照)。
setFlags()も参照してください 。
QFont QListWidgetItem::font() const
このリスト項目のテキストの表示に使用されているフォントを返します。
setFont()も参照してください 。
QBrush QListWidgetItem::foreground() const
リスト項目の前景色(テキストなど)の表示に使用されるブラシを返します。
setForeground() およびbackground()も参照してください 。
QIcon QListWidgetItem::icon() const
リスト項目のアイコンを返します。
setIcon() およびiconSizeも参照してください 。
bool QListWidgetItem::isHidden() const
アイテムが非表示の場合は `true ` を返し、それ以外の場合は `false` を返します。
setHidden()も参照してください 。
bool QListWidgetItem::isSelected() const
項目が選択されている場合は `true ` を返し、そうでない場合は `false` を返します。
setSelected()も参照してください 。
QListWidget *QListWidgetItem::listWidget() const
そのアイテムを含むリストウィジェットを返します。
[virtual] void QListWidgetItem::read(QDataStream &in)
ストリームin から項目を読み込みます。
write()も参照してください 。
void QListWidgetItem::setBackground(const QBrush &brush)
リスト項目の背景ブラシを、指定されたbrush に設定します。デフォルトのコンストラクタで生成されたブラシを設定すると、ビューはスタイルのデフォルトの色を使用するようになります。
background() およびsetForeground()も参照してください 。
void QListWidgetItem::setCheckState(Qt::CheckState state)
リスト項目のチェック状態を「state 」に設定します。
checkState()も参照してください 。
[virtual] void QListWidgetItem::setData(int role, const QVariant &value)
指定されたrole のデータを、指定されたvalue に設定します。特定のロールに対して追加のロールや特別な動作が必要な場合は、この関数を再実装してください。
注: デフォルトの実装では 、Qt::EditRole とQt::DisplayRole は同じデータを指すものとみなされます。
Qt::ItemDataRole およびdata()も参照してください 。
void QListWidgetItem::setFlags(Qt::ItemFlags flags)
リスト項目のアイテムフラグを「flags 」に設定します。
flags() およびQt::ItemFlagsも参照してください 。
void QListWidgetItem::setFont(const QFont &font)
アイテムの描画に使用するフォントを、指定されたfont に設定します。
font()も参照してください 。
void QListWidgetItem::setForeground(const QBrush &brush)
リスト項目の前景色ブラシを、指定されたbrush に設定します。デフォルトのコンストラクタで生成されたブラシを設定すると、ビューはスタイルのデフォルトの色を使用するようになります。
foreground() およびsetBackground()も参照してください 。
void QListWidgetItem::setHidden(bool hide)
hide が true の場合は項目を非表示にし、そうでない場合は項目を表示します。
isHidden()も参照してください 。
void QListWidgetItem::setIcon(const QIcon &icon)
リスト項目のアイコンを、指定されたicon に設定します。
icon()、text()、およびiconSizeも参照してください 。
void QListWidgetItem::setSelected(bool select)
項目の選択状態を「select 」に設定します。
isSelected()も参照してください 。
void QListWidgetItem::setSizeHint(const QSize &size)
リスト項目のサイズヒントをsize に設定します。サイズヒントが設定されていない場合、またはsize が無効な場合、アイテムデリゲートはアイテムデータに基づいてサイズヒントを計算します。
sizeHint()も参照してください 。
void QListWidgetItem::setStatusTip(const QString &statusTip)
リスト項目のステータスヒントを、statusTip で指定されたテキストに設定します。QListWidget この機能を利用するには、mouseTracking を有効にする必要があります。
関連項目: statusTip()、setToolTip()、setWhatsThis()、およびQWidget::setMouseTracking()。
void QListWidgetItem::setText(const QString &text)
リストウィジェットの各アイテムのテキストを、指定されたtext に設定します。
text()も参照してください 。
[since 6.4] void QListWidgetItem::setTextAlignment(Qt::Alignment alignment)
リスト項目のテキストの配置を「alignment 」に設定します。
この関数は Qt 6.4 で導入されました。
textAlignment()も参照してください 。
void QListWidgetItem::setToolTip(const QString &toolTip)
リスト項目のツールチップを、toolTip で指定されたテキストに設定します。
toolTip()、setStatusTip()、およびsetWhatsThis()も参照してください 。
void QListWidgetItem::setWhatsThis(const QString &whatsThis)
リスト項目の「What's This?」ヘルプを、whatsThis で指定されたテキストに設定します。
whatsThis()、setStatusTip()、およびsetToolTip()も参照してください 。
QSize QListWidgetItem::sizeHint() const
リスト項目に設定されているサイズヒントを返します。
setSizeHint()も参照してください 。
QString QListWidgetItem::statusTip() const
リスト項目のステータスヒントを返します。
setStatusTip()も参照してください 。
QString QListWidgetItem::text() const
リスト項目のテキストを返します。
setText()も参照してください 。
int QListWidgetItem::textAlignment() const
リスト項目のテキストの配置を返します。
注:この関数は 、過去の経緯により int 型を返します。Qt 7 では、Qt::Alignment を返すように修正される予定です。
関連項目: setTextAlignment() およびQt::Alignment 。
QString QListWidgetItem::toolTip() const
リスト項目のツールチップを返します。
setToolTip()、statusTip()、およびwhatsThis()も参照してください 。
int QListWidgetItem::type() const
QListWidgetItem コンストラクタに渡された型を返します。
QString QListWidgetItem::whatsThis() const
リスト項目の「これは何?」というヘルプテキストを返します。
setWhatsThis()、statusTip()、およびtoolTip()も参照してください 。
[virtual] void QListWidgetItem::write(QDataStream &out) const
アイテムをストリームout に書き込みます。
read()も参照してください 。
[virtual] bool QListWidgetItem::operator<(const QListWidgetItem &other) const
この項目のテキストがother 項目のテキストより短い場合はtrue を返し、そうでない場合はfalse を返します。
QListWidgetItem &QListWidgetItem::operator=(const QListWidgetItem &other)
other のデータとフラグをこの項目に割り当てます。なお、type()およびlistWidget()はコピーされない点に注意してください。
この関数は、clone() を再実装する際に役立ちます。
関連する非メンバー
QDataStream &operator<<(QDataStream &out, const QListWidgetItem &item)
リストウィジェットの項目 `item ` をストリーム `out` に書き込みます。
この演算子はQListWidgetItem::write() を使用します。
「Qt データ型のシリアライズ」も参照してください 。
QDataStream &operator>>(QDataStream &in, QListWidgetItem &item)
ストリーム `in ` からリストウィジェットの項目を読み取り、`item` に格納します。
この演算子はQListWidgetItem::read() を使用します。
「Qt データ型のシリアル化」も参照してください 。
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.