Qt 4.0: QTableWidgetItem Class Reference

|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QTableWidgetItem Class Reference
[QtGui module]

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

    #include <QTableWidgetItem>

- List of all members, including inherited members

### Public Functions

- QTableWidgetItem ( int type = Type )
- QTableWidgetItem ( const QString & text, int type = Type )
- virtual ~QTableWidgetItem ()
- QColor backgroundColor () const
- Qt::CheckState checkState () const
- virtual QTableWidgetItem * clone () const
- virtual QVariant data ( int role ) const
- Qt::ItemFlags flags () const
- QFont font () const
- QIcon icon () const
- virtual void read ( QDataStream & in )
- void setBackgroundColor ( const QColor & color )
- void setCheckState ( Qt::CheckState state )
- virtual void setData ( int role, const QVariant & value )
- void setFlags ( Qt::ItemFlags flags )
- void setFont ( const QFont & font )
- void setIcon ( const QIcon & icon )
- void setStatusTip ( const QString & statusTip )
- void setText ( const QString & text )
- void setTextAlignment ( int alignment )
- void setTextColor ( const QColor & color )
- void setToolTip ( const QString & toolTip )
- void setWhatsThis ( const QString & whatsThis )
- QString statusTip () const
- QTableWidget * tableWidget () const
- QString text () const
- int textAlignment () const
- QColor textColor () const
- QString toolTip () const
- int type () const
- QString whatsThis () const
- virtual void write ( QDataStream & out ) const
- virtual bool operator< ( const QTableWidgetItem & other ) const
- QTableWidgetItem & operator= ( const QTableWidgetItem & other )

### Static Public Members

- const int Type
- const int UserType

### Related Non-Members

- QDataStream & operator<< ( QDataStream & out, const QTableWidgetItem & item )
- QDataStream & operator>> ( QDataStream & in, QTableWidgetItem & item )

## 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.

Items are usually constructed with a table widget as their parent then inserted at a particular position specified by 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 color which is set with the setBackgroundColor() function. The current background color can be found with backgroundColor(). The text label for each item can be rendered with its own font and text color. These are specified with the setFont() and setTextColor() functions, and read with font() and textColor().

Items can be made checkable by setting the appropriate flag value with the setFlags() function. The current state of the item's flags can be read with flags().

See also QTableWidget.

## Member Function Documentation

### QTableWidgetItem::QTableWidgetItem ( int type = Type )

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

See also type().

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

Constructs a table item with the given text.

See also type().

### QTableWidgetItem::~QTableWidgetItem () `[virtual]`

Destroys the table item.

### QColor QTableWidgetItem::backgroundColor () const

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

See also textColor() and setBackgroundColor().

### Qt::CheckState QTableWidgetItem::checkState () const

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

See also setCheckState() and flags().

### QTableWidgetItem * QTableWidgetItem::clone () const `[virtual]`

Creates an exact copy of the item.

### QVariant QTableWidgetItem::data ( int role ) const `[virtual]`

Returns the item's data for the given role.

See also setData().

### Qt::ItemFlags QTableWidgetItem::flags () const

Returns the flags used to describe the item. These determine whether the item can be checked, edited, and selected.

See also setFlags().

### QFont QTableWidgetItem::font () const

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

See also setFont().

### QIcon QTableWidgetItem::icon () const

Returns the item's icon.

See also setIcon().

### void QTableWidgetItem::read ( QDataStream & in ) `[virtual]`

Reads the item from stream in.

See also write().

### void QTableWidgetItem::setBackgroundColor ( const QColor & color )

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

See also backgroundColor() and setTextColor().

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

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

See also checkState().

### void QTableWidgetItem::setData ( int role, const QVariant & value ) `[virtual]`

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

See also data().

### 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().

### void QTableWidgetItem::setFont ( const QFont & font )

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

See also font(), setText(), and setTextColor().

### void QTableWidgetItem::setIcon ( const QIcon & icon )

Sets the item's icon to the icon specified.

See also icon() and setText().

### void QTableWidgetItem::setStatusTip ( const QString & statusTip )

Sets the item's status tip to the string specified by statusTip.

See also statusTip(), setToolTip(), and setWhatsThis().

### void QTableWidgetItem::setText ( const QString & text )

Sets the item's text to the text specified.

See also text(), setFont(), and setTextColor().

### void QTableWidgetItem::setTextAlignment ( int alignment )

Sets the text alignment for the item's text to the alignment specified (see Qt::AlignmentFlag).

See also textAlignment().

### void QTableWidgetItem::setTextColor ( const QColor & color )

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

See also textColor(), setFont(), and setText().

### void QTableWidgetItem::setToolTip ( const QString & toolTip )

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

See also toolTip(), setStatusTip(), and setWhatsThis().

### void QTableWidgetItem::setWhatsThis ( const QString & whatsThis )

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

See also whatsThis(), setStatusTip(), and setToolTip().

### QString QTableWidgetItem::statusTip () const

Returns the item's status tip.

See also setStatusTip().

### QTableWidget * QTableWidgetItem::tableWidget () const

Returns the table widget that contains the item.

### QString QTableWidgetItem::text () const

Returns the item's text.

See also setText().

### int QTableWidgetItem::textAlignment () const

Returns the text alignment for the item's text (see Qt::AlignmentFlag).

See also setTextAlignment().

### QColor QTableWidgetItem::textColor () const

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

See also backgroundColor() and setTextColor().

### QString QTableWidgetItem::toolTip () const

Returns the item's tooltip.

See also setToolTip().

### int QTableWidgetItem::type () const

Returns the type passed to the QTableWidgetItem constructor.

### QString QTableWidgetItem::whatsThis () const

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

See also setWhatsThis().

### void QTableWidgetItem::write ( QDataStream & out ) const `[virtual]`

Writes the item to stream out.

See also read().

### bool QTableWidgetItem::operator< ( const QTableWidgetItem & other ) const `[virtual]`

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

### 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() and flags().

## Member Variable Documentation

### const int QTableWidgetItem::Type

The default type for table widget items.

See also UserType and type().

### const int QTableWidgetItem::UserType

The minimum value for custom types. Values below UserType are reserved by Qt.

See also Type and type().

## Related Non-Members

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Writes the table widget item item to stream out.

This operator uses QTableWidgetItem::write().

See also Format of the QDataStream Operators.

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Reads a table widget item from stream in into item.

This operator uses QTableWidgetItem::read().

See also Format of the QDataStream Operators.