Home · All Classes · Modules

QListWidgetItem Class Reference
^{^{[QtGui module]}}

The QListWidgetItem class provides an item for use with the QListWidget item view class. More...

Types

enum ItemType { Type, UserType }

Methods

__init__ (self, QListWidget view = None, int type = QListWidgetItem.Type)
__init__ (self, QString text, QListWidget view = None, int type = QListWidgetItem.Type)
__init__ (self, QIcon icon, QString text, QListWidget view = None, int type = QListWidgetItem.Type)
__init__ (self, QListWidgetItem other)
QBrush background (self)
QColor backgroundColor (self)
Qt.CheckState checkState (self)
QListWidgetItem clone (self)
QVariant data (self, int role)
Qt.ItemFlags flags (self)
QFont font (self)
QBrush foreground (self)
QIcon icon (self)
bool isHidden (self)
bool isSelected (self)
QListWidget listWidget (self)
read (self, QDataStream in)
setBackground (self, QBrush brush)
setBackgroundColor (self, QColor color)
setCheckState (self, Qt.CheckState state)
setData (self, int role, QVariant value)
setFlags (self, Qt.ItemFlags aflags)
setFont (self, QFont afont)
setForeground (self, QBrush brush)
setHidden (self, bool ahide)
setIcon (self, QIcon aicon)
setSelected (self, bool aselect)
setSizeHint (self, QSize size)
setStatusTip (self, QString astatusTip)
setText (self, QString atext)
setTextAlignment (self, int alignment)
setTextColor (self, QColor color)
setToolTip (self, QString atoolTip)
setWhatsThis (self, QString awhatsThis)
QSize sizeHint (self)
QString statusTip (self)
QString text (self)
int textAlignment (self)
QColor textColor (self)
QString toolTip (self)
int type (self)
QString whatsThis (self)
write (self, QDataStream out)

Special Methods

bool __lt__ (self, QListWidgetItem other)

Detailed Description

The QListWidgetItem class provides an item for use with the QListWidget item view class.

QListWidgetItem is used to represent items in a list provided by the QListWidget class. Each item can hold several pieces of information, and will display these appropriately.

The item view convenience classes use a classic item-based interface rather than a pure model/view approach. For a more flexible list view widget, consider using the QListView class with a standard model.

List items can be automatically inserted into a list when they are constructed by specifying the list widget:

     new QListWidgetItem(tr("Hazel"), listWidget);

They can also be created without a parent widget, and later inserted into a list (see QListWidget.insertItem()).

List items are typically used to display text() and an icon(). These are set with the setText() and setIcon() functions. The appearance of the text can be customized with setFont(), setForeground(), and setBackground(). Text in list items can be aligned using the setTextAlignment() function. Tooltips, status tips and "What's This?" help can be added to list items with setToolTip(), setStatusTip(), and setWhatsThis().

By default, items are enabled, selectable, checkable, and can be the source of a drag and drop operation. Each item's flags can be changed by calling setFlags() with the appropriate value (see Qt.ItemFlags). Checkable items can be checked, unchecked and partially checked with the setCheckState() function. The corresponding checkState() function indicates what check state the item currently has.

The isHidden() function can be used to determine whether the item is hidden. Items can be hidden with setHidden().

Subclassing

When subclassing QListWidgetItem to provide custom items, it is possible to define new types for them so that they can be distinguished from standard items. The constructors for subclasses that require this feature need to call the base class constructor with a new type value equal to or greater than UserType.

Type Documentation

QListWidgetItem.ItemType

This enum describes the types that are used to describe list widget items.

Constant	Value	Description
`QListWidgetItem.Type`	`0`	The default type for list widget items.
`QListWidgetItem.UserType`	`1000`	The minimum value for custom types. Values below UserType are reserved by Qt.

You can define new user types in QListWidgetItem subclasses to ensure that custom items are treated specially.

See also type().

Method Documentation

QListWidgetItem.init (self, QListWidget view = None, int type = QListWidgetItem.Type)

The view argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an empty list widget item of the specified type with the given parent. If the parent is not specified, the item will need to be inserted into a list widget with QListWidget.insertItem().

See also type().

QListWidgetItem.init (self, QString text, QListWidget view = None, int type = QListWidgetItem.Type)

The view argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an empty list widget item of the specified type with the given text and parent. If the parent is not specified, the item will need to be inserted into a list widget with QListWidget.insertItem().

See also type().

QListWidgetItem.init (self, QIcon icon, QString text, QListWidget view = None, int type = QListWidgetItem.Type)

The view argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an empty list widget item of the specified type with the given icon, text and parent. If the parent is not specified, the item will need to be inserted into a list widget with QListWidget.insertItem().

See also type().

QListWidgetItem.init (self, QListWidgetItem other)

Constructs a copy of other. Note that type() and listWidget() are not copied.

This function is useful when reimplementing clone().

This function was introduced in Qt 4.1.

QBrush QListWidgetItem.background (self)

Returns the brush used to display the list item's background.

This function was introduced in Qt 4.2.

See also setBackground() and foreground().

QColor QListWidgetItem.backgroundColor (self)

Qt.CheckState QListWidgetItem.checkState (self)

Returns the checked state of the list item (see Qt.CheckState).

QListWidgetItem QListWidgetItem.clone (self)

Creates an exact copy of the item.

QVariant QListWidgetItem.data (self, int role)

This function returns the item's data for a given role (see Qt.ItemDataRole). Reimplement this function if you need extra roles or special behavior for certain roles.