QTableWidgetItem Class Reference

The QTableWidgetItem class provides an item for use with the QTableWidget class. More...

#include <qtablewidget.h>

Public Types
enum	ItemType { Type = 0, UserType = 1000 }
	This enum describes the types that are used to describe table widget items. More...

Public Functions
QBrush	background () const
	Returns the brush used to render the item's background. More...
QColor	backgroundColor () const
	This function is deprecated. More...
Qt::CheckState	checkState () const
	Returns the checked state of the table item. More...
virtual QTableWidgetItem *	clone () const
	Creates a copy of the item. More...
int	column () const
	Returns the column of the item in the table. More...
virtual QVariant	data (int role) const
	Returns the item's data for the given role. More...
Qt::ItemFlags	flags () const
	Returns the flags used to describe the item. More...
QFont	font () const
	Returns the font used to render the item's text. More...
QBrush	foreground () const
	Returns the brush used to render the item's foreground (e. More...
QIcon	icon () const
	Returns the item's icon. More...
bool	isSelected () const
	Returns true if the item is selected, otherwise returns false. More...
virtual bool	operator< (const QTableWidgetItem &other) const
	Returns true if the item is less than the other item; otherwise returns false. More...
QTableWidgetItem &	operator= (const QTableWidgetItem &other)
	Assigns other's data and flags to this item. More...
	QTableWidgetItem (int type=Type)
	Constructs a table item of the specified type that does not belong to any table. More...
	QTableWidgetItem (const QString &text, int type=Type)
	Constructs a table item with the given text. More...
	QTableWidgetItem (const QIcon &icon, const QString &text, int type=Type)
	Constructs a table item with the given icon and text. More...
	QTableWidgetItem (const QTableWidgetItem &other)
	Constructs a copy of other. More...
virtual void	read (QDataStream &in)
	Reads the item from stream in. More...
int	row () const
	Returns the row of the item in the table. More...
void	setBackground (const QBrush &brush)
	Sets the item's background brush to the specified brush. More...
void	setBackgroundColor (const QColor &color)
	This function is deprecated. More...
void	setCheckState (Qt::CheckState state)
	Sets the check state of the table item to be state. More...
virtual void	setData (int role, const QVariant &value)
	Sets the item's data for the given role to the specified value. More...
void	setFlags (Qt::ItemFlags flags)
	Sets the flags for the item to the given flags. More...
void	setFont (const QFont &font)
	Sets the font used to display the item's text to the given font. More...
void	setForeground (const QBrush &brush)
	Sets the item's foreground brush to the specified brush. More...
void	setIcon (const QIcon &icon)
	Sets the item's icon to the icon specified. More...
void	setSelected (bool select)
	Sets the selected state of the item to select. More...
void	setSizeHint (const QSize &size)
	Sets the size hint for the table item to be size. More...
void	setStatusTip (const QString &statusTip)
	Sets the status tip for the table item to the text specified by statusTip. More...
void	setText (const QString &text)
	Sets the item's text to the text specified. More...
void	setTextAlignment (int alignment)
	Sets the text alignment for the item's text to the alignment specified. More...
void	setTextColor (const QColor &color)
	This function is deprecated. More...
void	setToolTip (const QString &toolTip)
	Sets the item's tooltip to the string specified by toolTip. More...
void	setWhatsThis (const QString &whatsThis)
	Sets the item's "What's This?" help to the string specified by whatsThis. More...
QSize	sizeHint () const
	Returns the size hint set for the table item. More...
QString	statusTip () const
	Returns the item's status tip. More...
QTableWidget *	tableWidget () const
	Returns the table widget that contains the item. More...
QString	text () const
	Returns the item's text. More...
int	textAlignment () const
	Returns the text alignment for the item's text. More...
QColor	textColor () const
	This function is deprecated. More...
QString	toolTip () const
	Returns the item's tooltip. More...
int	type () const
	Returns the type passed to the QTableWidgetItem constructor. More...
QString	whatsThis () const
	Returns the item's "What's This?" help. More...
virtual void	write (QDataStream &out) const
	Writes the item to stream out. More...
virtual	~QTableWidgetItem ()
	Destroys the table item. More...

Properties
QTableWidgetItemPrivate *	d
Qt::ItemFlags	itemFlags
int	rtti
QVector< QWidgetItemData >	values
QTableWidget *	view

Friends
class	QTableModel
class	QTableWidget

Related Functions
(Note that these are not member functions.)
QDataStream &	operator<< (QDataStream &out, const QTableWidgetItem &item)
	Writes the table widget item item to stream out. More...
QDataStream &	operator>> (QDataStream &in, QTableWidgetItem &item)
	Reads a table widget item from stream in into item. More...

Detailed Description

The QTableWidgetItem class provides an item for use with the QTableWidget class.

Table items are used to hold pieces of information for table widgets. Items usually contain text, icons, or checkboxes

The QTableWidgetItem class is a convenience class that replaces the QTableItem class in Qt 3. It provides an item for use with the QTableWidget class.

Top-level items are constructed without a parent then inserted at the position specified by a pair of row and column numbers:

    QTableWidgetItem *newItem = new QTableWidgetItem(tr("%1").arg(
        pow(row, column+1)));
    tableWidget->setItem(row, column, newItem);

Each item can have its own background brush which is set with the setBackground() function. The current background brush can be found with background(). The text label for each item can be rendered with its own font and brush. These are specified with the setFont() and setForeground() functions, and read with font() and foreground().

By default, items are enabled, editable, selectable, checkable, and can be used both as the source of a drag and drop operation and as a drop target. Each item's flags can be changed by calling setFlags() with the appropriate value (see Qt::ItemFlags). Checkable items can be checked and unchecked with the setCheckState() function. The corresponding checkState() function indicates whether the item is currently checked.

Subclassing

When subclassing QTableWidgetItem 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 .

See also

QTableWidget, {Model/View Programming}, QListWidgetItem, QTreeWidgetItem

Definition at line 82 of file qtablewidget.h.

Enumerations

ItemType

enum QTableWidgetItem::ItemType

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

• Type The default type for table widget items.
• UserType The minimum value for custom types. Values below UserType are reserved by Qt.

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

See also

type()

Enumerator
Type
UserType

Definition at line 87 of file qtablewidget.h.

{ Type = 0, UserType = 1000 };

Constructors and Destructors

QTableWidgetItem() [1/4]

QTableWidgetItem::QTableWidgetItem

(

int

type = Type

)

Constructs a table item of the specified type that does not belong to any table.

See also

type()

Definition at line 1410 of file qtablewidget.cpp.

Referenced by clone().

    :  rtti(type), view(0), d(new QTableWidgetItemPrivate(this)),
      itemFlags(Qt::ItemIsEditable
                |Qt::ItemIsSelectable
                |Qt::ItemIsUserCheckable
                |Qt::ItemIsEnabled
                |Qt::ItemIsDragEnabled
                |Qt::ItemIsDropEnabled)
{
}

QTableWidgetItem() [2/4]

QTableWidgetItem::QTableWidgetItem ( const QString &  text, int  type = Type  )

explicit

Constructs a table item with the given text.

See also

type()

Definition at line 1426 of file qtablewidget.cpp.

    :  rtti(type), view(0), d(new QTableWidgetItemPrivate(this)),
      itemFlags(Qt::ItemIsEditable
                |Qt::ItemIsSelectable
                |Qt::ItemIsUserCheckable
                |Qt::ItemIsEnabled
                |Qt::ItemIsDragEnabled
                |Qt::ItemIsDropEnabled)
{
    setData(Qt::DisplayRole, text);
}

QTableWidgetItem() [3/4]

QTableWidgetItem::QTableWidgetItem ( const QIcon &  icon, const QString &  text, int  type = Type  )

explicit

Constructs a table item with the given icon and text.

See also

type()

Definition at line 1443 of file qtablewidget.cpp.

    :  rtti(type), view(0), d(new QTableWidgetItemPrivate(this)),
       itemFlags(Qt::ItemIsEditable
                |Qt::ItemIsSelectable
                |Qt::ItemIsUserCheckable
                |Qt::ItemIsEnabled
                |Qt::ItemIsDragEnabled
                |Qt::ItemIsDropEnabled)
{
    setData(Qt::DecorationRole, icon);
    setData(Qt::DisplayRole, text);
}

QTableWidgetItem() [4/4]

QTableWidgetItem::QTableWidgetItem

(

const QTableWidgetItem &

other

)

Constructs a copy of other.

Since

4.1

Note that type() and tableWidget() are not copied.

This function is useful when reimplementing clone().

See also

data(), flags()

Definition at line 1595 of file qtablewidget.cpp.

    : rtti(Type), values(other.values), view(0),
      d(new QTableWidgetItemPrivate(this)),
      itemFlags(other.itemFlags)
{
}

~QTableWidgetItem()

QTableWidgetItem::~QTableWidgetItem ( )

virtual

Destroys the table item.

Definition at line 1459 of file qtablewidget.cpp.

{
    if (QTableModel *model = (view ? qobject_cast<QTableModel*>(view->model()) : 0))
        model->removeItem(this);
    view = 0;
    delete d;
}

Functions

background()

QBrush QTableWidgetItem::background ( ) const

inline

Returns the brush used to render the item's background.

Since

4.2

See also

foreground()

Definition at line 145 of file qtablewidget.h.

        { return qvariant_cast<QBrush>(data(Qt::BackgroundRole)); }

backgroundColor()

QColor QTableWidgetItem::backgroundColor ( ) const

inline

This function is deprecated.

Use background() instead.

Definition at line 140 of file qtablewidget.h.

        { return qvariant_cast<QColor>(data(Qt::BackgroundColorRole)); }

checkState()

Qt::CheckState QTableWidgetItem::checkState ( ) const

inline

Returns the checked state of the table item.

See also

flags()

Definition at line 160 of file qtablewidget.h.

        { return static_cast<Qt::CheckState>(data(Qt::CheckStateRole).toInt()); }

clone()

QTableWidgetItem * QTableWidgetItem::clone ( ) const

virtual

Creates a copy of the item.

Definition at line 1470 of file qtablewidget.cpp.

Referenced by QTableModel::createItem().

{
    return new QTableWidgetItem(*this);
}

column()

int QTableWidgetItem::column ( ) const

inline

Returns the column of the item in the table.

Since

4.2

If the item is not in a table, this function will return -1.

See also

row()

Definition at line 362 of file qtablewidget.h.

Referenced by QTableWidgetPrivate::_q_dataChanged(), and QTableWidgetPrivate::_q_sort().

{ return (view ? view->column(this) : -1); }

data()

QVariant QTableWidgetItem::data ( int  role ) const

virtual

Returns the item's data for the given role.

Definition at line 1503 of file qtablewidget.cpp.

Referenced by QTableModel::data(), QTableModel::headerData(), and operator<().

{
    role = (role == Qt::EditRole ? Qt::DisplayRole : role);
    for (int i = 0; i < values.count(); ++i)
        if (values.at(i).role == role)
            return values.at(i).value;
    return QVariant();
}

flags()

Qt::ItemFlags QTableWidgetItem::flags ( ) const

inline

Returns the flags used to describe the item.

These determine whether the item can be checked, edited, and selected.

See also

setFlags()

Definition at line 104 of file qtablewidget.h.

Referenced by QTableModel::itemChanged().

{ return itemFlags; }

font()

QFont QTableWidgetItem::font ( ) const

inline

Returns the font used to render the item's text.

See also

setFont()

Definition at line 131 of file qtablewidget.h.

        { return qvariant_cast<QFont>(data(Qt::FontRole)); }

foreground()

QBrush QTableWidgetItem::foreground ( ) const

inline

Returns the brush used to render the item's foreground (e.

Since

4.2

g. text).

\sa background()

Definition at line 155 of file qtablewidget.h.

        { return qvariant_cast<QBrush>(data(Qt::ForegroundRole)); }

icon()

QIcon QTableWidgetItem::icon ( ) const

inline

Returns the item's icon.

See also

setIcon(), {QAbstractItemView::iconSize}{iconSize}

Definition at line 111 of file qtablewidget.h.

        { return qvariant_cast<QIcon>(data(Qt::DecorationRole)); }

isSelected()

bool QTableWidgetItem::isSelected ( ) const

inline

Returns true if the item is selected, otherwise returns false.

Since

4.2

See also

setSelected()

Definition at line 368 of file qtablewidget.h.

{ return (view ? view->isItemSelected(this) : false); }

operator<()

bool QTableWidgetItem::operator< ( const QTableWidgetItem &  other ) const

virtual

Returns true if the item is less than the other item; otherwise returns false.

Definition at line 1516 of file qtablewidget.cpp.

{
    const QVariant v1 = data(Qt::DisplayRole), v2 = other.data(Qt::DisplayRole);
    return QAbstractItemModelPrivate::variantLessThan(v1, v2);
}

operator=()

QTableWidgetItem & QTableWidgetItem::operator=

(

const QTableWidgetItem &

other

)

Assigns other's data and flags to this item.

Note that type() and tableWidget() are not copied.

This function is useful when reimplementing clone().

See also

data(), flags()

Definition at line 1610 of file qtablewidget.cpp.

{
    values = other.values;
    itemFlags = other.itemFlags;
    return *this;
}

read()

void QTableWidgetItem::read ( QDataStream &  in )

virtual

Reads the item from stream in.

See also

write()

Definition at line 1529 of file qtablewidget.cpp.

Referenced by operator>>().

{
    in >> values;
}

row()

int QTableWidgetItem::row ( ) const

inline

Returns the row of the item in the table.

Since

4.2

If the item is not in a table, this function will return -1.

See also

column()

Definition at line 359 of file qtablewidget.h.

{ return (view ? view->row(this) : -1); }

setBackground()

void QTableWidgetItem::setBackground ( const QBrush &  brush )

inline

Sets the item's background brush to the specified brush.

Since

4.2

See also

setForeground()

Definition at line 147 of file qtablewidget.h.

        { setData(Qt::BackgroundRole, brush); }

setBackgroundColor()

void QTableWidgetItem::setBackgroundColor ( const QColor &  color )

inline

This function is deprecated.

Use setBackground() instead.

Definition at line 142 of file qtablewidget.h.

        { setData(Qt::BackgroundColorRole, color); }

setCheckState()

void QTableWidgetItem::setCheckState ( Qt::CheckState  state )

inline

Sets the check state of the table item to be state.

Definition at line 162 of file qtablewidget.h.

        { setData(Qt::CheckStateRole, state); }

setData()

void QTableWidgetItem::setData ( int  role, const QVariant &  value  )

virtual

Sets the item's data for the given role to the specified value.

See also

Qt::ItemDataRole, data()

Definition at line 1480 of file qtablewidget.cpp.

Referenced by QTableWidgetItem(), QTableModel::setData(), and QTableModel::setHeaderData().

{
    bool found = false;
    role = (role == Qt::EditRole ? Qt::DisplayRole : role);
    for (int i = 0; i < values.count(); ++i) {
        if (values.at(i).role == role) {
            if (values[i].value == value)
                return;

            values[i].value = value;
            found = true;
            break;
        }
    }
    if (!found)
        values.append(QWidgetItemData(role, value));
    if (QTableModel *model = (view ? qobject_cast<QTableModel*>(view->model()) : 0))
        model->itemChanged(this);
}

setFlags()

void QTableWidgetItem::setFlags

(

Qt::ItemFlags

flags

)

Sets the flags for the item to the given flags.

These determine whether the item can be selected or modified.

See also

flags()

Definition at line 1151 of file qtablewidget.cpp.

{
    itemFlags = aflags;
    if (QTableModel *model = (view ? qobject_cast<QTableModel*>(view->model()) : 0))
        model->itemChanged(this);
}

setFont()

void QTableWidgetItem::setFont ( const QFont &  font )

inline

Sets the font used to display the item's text to the given font.

See also

font() setText() setForeground()

Definition at line 210 of file qtablewidget.h.

{ setData(Qt::FontRole, afont); }

setForeground()

void QTableWidgetItem::setForeground ( const QBrush &  brush )

inline

Sets the item's foreground brush to the specified brush.

Since

4.2

See also

setBackground()

Definition at line 157 of file qtablewidget.h.

        { setData(Qt::ForegroundRole, brush); }

setIcon()

void QTableWidgetItem::setIcon ( const QIcon &  icon )

inline

Sets the item's icon to the icon specified.

See also

icon(), setText(), {QAbstractItemView::iconSize}{iconSize}

Definition at line 194 of file qtablewidget.h.

{ setData(Qt::DecorationRole, aicon); }

setSelected()

void QTableWidgetItem::setSelected ( bool  select )

inline

Sets the selected state of the item to select.

Since

4.2

See also

isSelected()

Definition at line 365 of file qtablewidget.h.

{ if (view) view->setItemSelected(this, aselect); }

setSizeHint()

void QTableWidgetItem::setSizeHint ( const QSize &  size )

inline

Sets the size hint for the table item to be size.

Since

4.1

If no size hint is set, the item delegate will compute the size hint based on the item data.

Definition at line 167 of file qtablewidget.h.

        { setData(Qt::SizeHintRole, size); }

setStatusTip()

void QTableWidgetItem::setStatusTip ( const QString &  statusTip )

inline

Sets the status tip for the table item to the text specified by statusTip.

QTableWidget mouse tracking needs to be enabled for this feature to work.

See also

statusTip() setToolTip() setWhatsThis()

Definition at line 197 of file qtablewidget.h.

{ setData(Qt::StatusTipRole, astatusTip); }

setText()

void QTableWidgetItem::setText ( const QString &  text )

inline

Sets the item's text to the text specified.

See also

text() setFont() setForeground()

Definition at line 191 of file qtablewidget.h.

Referenced by QTableWidget::setHorizontalHeaderLabels(), and QTableWidget::setVerticalHeaderLabels().

{ setData(Qt::DisplayRole, atext); }

setTextAlignment()

void QTableWidgetItem::setTextAlignment ( int  alignment )

inline

Sets the text alignment for the item's text to the alignment specified.

See also

Qt::Alignment

Definition at line 137 of file qtablewidget.h.

        { setData(Qt::TextAlignmentRole, alignment); }

setTextColor()

void QTableWidgetItem::setTextColor ( const QColor &  color )

inline

This function is deprecated.

Use setForeground() instead.

Definition at line 152 of file qtablewidget.h.

        { setData(Qt::TextColorRole, color); }

setToolTip()

void QTableWidgetItem::setToolTip ( const QString &  toolTip )

inline

Sets the item's tooltip to the string specified by toolTip.

See also

toolTip() setStatusTip() setWhatsThis()

Definition at line 201 of file qtablewidget.h.

{ setData(Qt::ToolTipRole, atoolTip); }

setWhatsThis()

void QTableWidgetItem::setWhatsThis ( const QString &  whatsThis )

inline

Sets the item's "What's This?" help to the string specified by whatsThis.

See also

whatsThis() setStatusTip() setToolTip()

Definition at line 206 of file qtablewidget.h.

{ setData(Qt::WhatsThisRole, awhatsThis); }

sizeHint()

QSize QTableWidgetItem::sizeHint ( ) const

inline

Returns the size hint set for the table item.

Since

4.1

Definition at line 165 of file qtablewidget.h.

        { return qvariant_cast<QSize>(data(Qt::SizeHintRole)); }

statusTip()

QString QTableWidgetItem::statusTip ( ) const

inline

Returns the item's status tip.

See also

setStatusTip()

Definition at line 115 of file qtablewidget.h.

        { return data(Qt::StatusTipRole).toString(); }

tableWidget()

QTableWidget * QTableWidgetItem::tableWidget ( ) const

inline

Returns the table widget that contains the item.

Definition at line 96 of file qtablewidget.h.

{ return view; }

text()

QString QTableWidgetItem::text ( ) const

inline

Returns the item's text.

See also

setText()

Definition at line 107 of file qtablewidget.h.

        { return data(Qt::DisplayRole).toString(); }

textAlignment()

int QTableWidgetItem::textAlignment ( ) const

inline

Returns the text alignment for the item's text.

See also

Qt::Alignment

Definition at line 135 of file qtablewidget.h.

        { return data(Qt::TextAlignmentRole).toInt(); }

textColor()

QColor QTableWidgetItem::textColor ( ) const

inline

This function is deprecated.

Use foreground() instead.

Definition at line 150 of file qtablewidget.h.

        { return qvariant_cast<QColor>(data(Qt::TextColorRole)); }

toolTip()

QString QTableWidgetItem::toolTip ( ) const

inline

Returns the item's tooltip.

See also

setToolTip()

Definition at line 120 of file qtablewidget.h.

        { return data(Qt::ToolTipRole).toString(); }

type()

int QTableWidgetItem::type ( ) const

inline

Returns the type passed to the QTableWidgetItem constructor.

Definition at line 181 of file qtablewidget.h.

{ return rtti; }

whatsThis()

QString QTableWidgetItem::whatsThis ( ) const

inline

Returns the item's "What's This?" help.

See also

setWhatsThis()

Definition at line 126 of file qtablewidget.h.

        { return data(Qt::WhatsThisRole).toString(); }

write()

void QTableWidgetItem::write ( QDataStream &  out ) const

virtual

Writes the item to stream out.

See also

read()

Definition at line 1539 of file qtablewidget.cpp.

Referenced by operator<<().

{
    out << values;
}

Friends and Related Functions

operator<<()

QDataStream & operator<< ( QDataStream &  out, const QTableWidgetItem &  item  )

related

Writes the table widget item item to stream out.

This operator uses QTableWidgetItem::write().

See also

{Serializing Qt Data Types}

Definition at line 1574 of file qtablewidget.cpp.

{
    item.write(out);
    return out;
}

operator>>()

QDataStream & operator>> ( QDataStream &  in, QTableWidgetItem &  item  )

related

Reads a table widget item from stream in into item.

This operator uses QTableWidgetItem::read().

See also

{Serializing Qt Data Types}

Definition at line 1556 of file qtablewidget.cpp.

{
    item.read(in);
    return in;
}

QTableModel

friend class QTableModel

friend

Definition at line 85 of file qtablewidget.h.

QTableWidget

friend class QTableWidget

friend

Definition at line 84 of file qtablewidget.h.

Properties

d

QTableWidgetItemPrivate* QTableWidgetItem::d

private

Definition at line 187 of file qtablewidget.h.

Referenced by QTableModel::index(), QTableModel::setItem(), QTableModel::takeItem(), and ~QTableWidgetItem().

itemFlags

Qt::ItemFlags QTableWidgetItem::itemFlags

private

Definition at line 188 of file qtablewidget.h.

Referenced by operator=(), QTableModel::setHorizontalHeaderItem(), QTableModel::setVerticalHeaderItem(), QTableModel::takeHorizontalHeaderItem(), and QTableModel::takeVerticalHeaderItem().

rtti

int QTableWidgetItem::rtti

private

Definition at line 184 of file qtablewidget.h.

values

QVector<QWidgetItemData> QTableWidgetItem::values

private

Definition at line 185 of file qtablewidget.h.

Referenced by data(), QTableModel::itemData(), operator=(), read(), setData(), and write().

view

QTableWidget* QTableWidgetItem::view

private

Definition at line 186 of file qtablewidget.h.

Referenced by QTableModel::clear(), QTableModel::clearContents(), QTableModel::removeColumns(), QTableModel::removeRows(), setData(), QTableModel::setHorizontalHeaderItem(), QTableWidget::setHorizontalHeaderItem(), QTableModel::setItem(), QTableWidget::setItem(), QTableModel::setVerticalHeaderItem(), QTableWidget::setVerticalHeaderItem(), QTableModel::takeHorizontalHeaderItem(), QTableWidget::takeHorizontalHeaderItem(), QTableModel::takeItem(), QTableWidget::takeItem(), QTableModel::takeVerticalHeaderItem(), QTableWidget::takeVerticalHeaderItem(), and ~QTableWidgetItem().

---

The documentation for this class was generated from the following files:

• /src/gui/itemviews/qtablewidget.h
• /src/gui/itemviews/qtablewidget.cpp