Qt 4.8: Q3TableItem Class Reference

Qt Reference Documentation

- Qt 4.8
- ALL VERSIONS

- A
- A
- A
- Print

# Q3TableItem Class Reference

The Q3TableItem class provides the cell content for Q3Table cells. More...

     #include <Q3TableItem>

This class is part of the Qt 3 support library. It is provided to keep old source code working. We strongly advise against using it in new code. See Porting to Qt 4 for more information.

Inherited by: Q3CheckTableItem and Q3ComboTableItem.

- List of all members, including inherited members

## Public Types

enum | EditType { Always, WhenCurrent, OnTyping, Never }

## Public Functions

| Q3TableItem ( Q3Table * table, EditType et )
| Q3TableItem ( Q3Table * table, EditType et, const QString & text )
| Q3TableItem ( Q3Table * table, EditType et, const QString & text, const QPixmap & p )
virtual | ~Q3TableItem ()
virtual int | alignment () const
int | col () const
int | colSpan () const
virtual QWidget * | createEditor () const
EditType | editType () const
bool | isEnabled () const
bool | isReplaceable () const
virtual QString | key () const
virtual void | paint ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )
virtual QPixmap | pixmap () const
int | row () const
int | rowSpan () const
virtual int | rtti () const
virtual void | setCol ( int c )
virtual void | setContentFromEditor ( QWidget * w )
virtual void | setEnabled ( bool b )
virtual void | setPixmap ( const QPixmap & p )
virtual void | setReplaceable ( bool b )
virtual void | setRow ( int r )
virtual void | setSpan ( int rs, int cs )
virtual void | setText ( const QString & str )
virtual void | setWordWrap ( bool b )
virtual QSize | sizeHint () const
Q3Table * | table () const
virtual QString | text () const
bool | wordWrap () const

## Detailed Description

The Q3TableItem class provides the cell content for Q3Table cells.

For many applications Q3TableItems are ideal for presenting and editing the contents of Q3Table cells. In situations where you need to create very large tables you may prefer an alternative approach to using Q3TableItems: see the notes on large tables.

A Q3TableItem contains a cell's data, by default, a string and a pixmap. The table item also holds the cell's display size and how the data should be aligned. The table item specifies the cell's EditType and the editor used for in-place editing (by default a QLineEdit). If you want checkboxes use Q3CheckTableItem, and if you want comboboxes use Q3ComboTableItem. The EditType (set in the constructor) determines whether the cell's contents may be edited.

If a pixmap is specified it is displayed to the left of any text. You can change the text or pixmap with setText() and setPixmap() respectively. For text you can use setWordWrap().

When sorting table items the key() function is used; by default this returns the table item's text(). Reimplement key() to customize how your table items will sort.

Table items are inserted into a table using Q3Table::setItem(). If you insert an item into a cell that already contains a table item the original item will be deleted.

Example:

     for (int row = 0; row < table->numRows(); row++) {
         for (int col = 0; col < table->numCols(); col++) {
             table->setItem(row, col,
                 new Q3TableItem(table, Q3TableItem::WhenCurrent, QString::number(row * col)));
         }
     }

You can move a table item from one cell to another, in the same or a different table, using Q3Table::takeItem() and Q3Table::setItem() but see also Q3Table::swapCells().

Table items can be deleted with delete in the standard way; the table and cell will be updated accordingly.

Note, that if you have a table item that is not currently in a table then anything you do to that item other than insert it into a table will result in undefined behaviour.

Reimplement createEditor() and setContentFromEditor() if you want to use your own widget instead of a QLineEdit for editing cell contents. Reimplement paint() if you want to display custom content.

It is important to ensure that your custom widget can accept the keyboard focus, so that the user can use the tab key to navigate the table as normal. Therefore, if the widget returned by createEditor() does not itself accept the keyboard focus, it is necessary to nominate a child widget to do so on its behalf. For example, a QHBox with two child QLineEdit widgets may use one of them to accept the keyboard focus:

     QWidget* MyTableItem::createEditor() const
     {
         QHBox* hbox = new QHBox(table()->viewport());
         hbox->setFocusProxy(new QLineEdit(hbox));
         new QLineEdit(hbox);
         return hbox;
     }

By default, table items may be replaced by new Q3TableItems during the lifetime of a Q3Table. Therefore, if you create your own subclass of Q3TableItem, and you want to ensure that this does not happen, you must call setReplaceable(false) in the constructor of your subclass.

See also Q3CheckTableItem and Q3ComboTableItem.

## Member Type Documentation

### enum Q3TableItem::EditType

This enum is used to define whether a cell is editable or read-only (in conjunction with other settings), and how the cell should be displayed.

Constant | Value | Description
--- | --- | ---
`Q3TableItem::Always` | `3` | The cell always looks editable.

Using this EditType ensures that the editor created with createEditor() (by default a QLineEdit) is always visible. This has implications for the alignment of the content: the default editor aligns everything (even numbers) to the left whilst numerical values in the cell are by default aligned to the right.

If a cell with the edit type `Always` looks misaligned you could reimplement createEditor() for these items.

Constant | Value | Description
--- | --- | ---
`Q3TableItem::WhenCurrent` | `2` | The cell looks editable only when it has keyboard focus (see Q3Table::setCurrentCell()).
`Q3TableItem::OnTyping` | `1` | The cell looks editable only when the user types in it or double-clicks it. It resembles the `WhenCurrent` functionality but is, perhaps, nicer.

The `OnTyping` edit type is the default when Q3TableItem objects are created by the convenience functions Q3Table::setText() and Q3Table::setPixmap().

Constant | Value | Description
--- | --- | ---
`Q3TableItem::Never` | `0` | The cell is not editable.

The cell is actually editable only if Q3Table::isRowReadOnly() is false for its row, Q3Table::isColumnReadOnly() is false for its column, and Q3Table::isReadOnly() is false.

Q3ComboTableItems have an isEditable() property. This property is used to indicate whether the user may enter their own text or are restricted to choosing one of the choices in the list. Q3ComboTableItems may be interacted with only if they are editable in accordance with their EditType as described above.

## Member Function Documentation

### Q3TableItem::Q3TableItem ( Q3Table * table, EditType et )

Creates a table item that is a child of table table with no text. The item has the EditType et.

The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with Q3Table::setItem().

The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time.

### Q3TableItem::Q3TableItem ( Q3Table * table, EditType et, const QString & text )

Creates a table item that is a child of table table with text text. The item has the EditType et.

The table item will use a QLineEdit for its editor, will not word-wrap and will occupy a single cell. Insert the table item into a table with Q3Table::setItem().

The table takes ownership of the table item, so a table item should not be inserted into more than one table at a time.

### Q3TableItem::Q3TableItem ( Q3Table * table, EditType et, const QString & text, const QPixmap & p )

Creates a table item that is a child of table table with text text and pixmap p. The item has the EditType et.

The table item will display the pixmap to the left of the text. It will use a QLineEdit for editing the text, will not word-wrap and will occupy a single cell. Insert the table item into a table with Q3Table::setItem().

The table takes ownership of the table item, so a table item should not be inserted in more than one table at a time.

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

The destructor deletes this item and frees all allocated resources.

If the table item is in a table (i.e. was inserted with setItem()), it will be removed from the table and the cell it occupied.

### int Q3TableItem::alignment () const`[virtual]`

The alignment function returns how the text contents of the cell are aligned when drawn. The default implementation aligns numbers to the right and any other text to the left.

See also Qt::Alignment.

### int Q3TableItem::col () const

Returns the column where the table item is located. If the cell spans multiple columns, this function returns the left-most column.

See also row() and setCol().

### int Q3TableItem::colSpan () const

Returns the column span of the table item, usually 1.

See also setSpan() and rowSpan().

### QWidget * Q3TableItem::createEditor () const`[virtual]`

This virtual function creates an editor which the user can interact with to edit the cell's contents. The default implementation creates a QLineEdit.

If the function returns 0, the cell is read-only.

The returned widget should preferably be invisible, ideally with Q3Table::viewport() as parent.

If you reimplement this function you'll almost certainly need to reimplement setContentFromEditor(), and may need to reimplement sizeHint().

See also Q3Table::createEditor(), setContentFromEditor(), Q3Table::viewport(), and setReplaceable().

### EditType Q3TableItem::editType () const

Returns the table item's edit type.

This is set when the table item is constructed.

See also EditType and Q3TableItem().

### bool Q3TableItem::isEnabled () const

Returns true if the table item is enabled; otherwise returns false.

See also setEnabled().

### bool Q3TableItem::isReplaceable () const

This function returns whether the contents of the cell may be replaced with the contents of another table item. Regardless of this setting, table items that span more than one cell may not have their contents replaced by another table item.

(This differs from EditType because EditType is concerned with whether the user is able to change the contents of a cell.)

See also setReplaceable() and EditType.

### QString Q3TableItem::key () const`[virtual]`

This virtual function returns the key that should be used for sorting. The default implementation returns the text() of the relevant item.

See also Q3Table::setSorting().

### void Q3TableItem::paint ( QPainter * p, const QColorGroup & cg, const QRect & cr, bool selected )`[virtual]`

This virtual function is used to paint the contents of an item using the painter p in the rectangular area cr using the color group cg.

If selected is true the cell is displayed in a way that indicates that it is highlighted.

You don't usually need to use this function but if you want to draw custom content in a cell you will need to reimplement it.

The painter passed to this function is translated so that 0, 0 is the top-left corner of the item that is being painted.

Note that the painter is not clipped by default in order to get maximum efficiency. If you want clipping, use

     p->setClipRect(table()->cellRect(row, col), QPainter::ClipPainter);
     //... your drawing code
     p->setClipping(false);

### QPixmap Q3TableItem::pixmap () const`[virtual]`

Returns the table item's pixmap or a null pixmap if no pixmap has been set.

See also setPixmap() and text().

### int Q3TableItem::row () const

Returns the row where the table item is located. If the cell spans multiple rows, this function returns the top-most row.

See also col() and setRow().

### int Q3TableItem::rowSpan () const

Returns the row span of the table item, usually 1.

See also setSpan() and colSpan().

### int Q3TableItem::rtti () const`[virtual]`

Returns the Run Time Type Identification value for this table item which for Q3TableItems is 0.

When you create subclasses based on Q3TableItem make sure that each subclass returns a unique rtti() value. It is advisable to use values greater than 1000, preferably large random numbers, to allow for extensions to this class.

See also Q3CheckTableItem::rtti() and Q3ComboTableItem::rtti().

### void Q3TableItem::setCol ( int c )`[virtual]`

Sets column c as the table item's column. Usually you will not need to call this function.

If the cell spans multiple columns, this function sets the left-most column and retains the width of the multi-cell table item.

See also col(), setRow(), and colSpan().

### void Q3TableItem::setContentFromEditor ( QWidget * w )`[virtual]`

Whenever the content of a cell has been edited by the editor w, Q3Table calls this virtual function to copy the new values into the Q3TableItem.

If you reimplement createEditor() and return something that is not a QLineEdit you will need to reimplement this function.

See also Q3Table::setCellContentFromEditor().

### void Q3TableItem::setEnabled ( bool b )`[virtual]`

If b is true, the table item is enabled; if b is false the table item is disabled.

A disabled item doesn't respond to user interaction.

See also isEnabled().

### void Q3TableItem::setPixmap ( const QPixmap & p )`[virtual]`

Sets pixmap p to be this item's pixmap.

Note that setPixmap() does not update the cell the table item belongs to. Use Q3Table::updateCell() to repaint the cell's contents.

For Q3ComboTableItems and Q3CheckTableItems this function has no visible effect.

See also Q3Table::setPixmap(), pixmap(), and setText().

### void Q3TableItem::setReplaceable ( bool b )`[virtual]`

If b is true it is acceptable to replace the contents of the cell with the contents of another Q3TableItem. If b is false the contents of the cell may not be replaced by the contents of another table item. Table items that span more than one cell may not have their contents replaced by another table item.

(This differs from EditType because EditType is concerned with whether the user is able to change the contents of a cell.)

See also isReplaceable().

### void Q3TableItem::setRow ( int r )`[virtual]`

Sets row r as the table item's row. Usually you do not need to call this function.

If the cell spans multiple rows, this function sets the top row and retains the height of the multi-cell table item.

See also row(), setCol(), and rowSpan().

### void Q3TableItem::setSpan ( int rs, int cs )`[virtual]`

Changes the extent of the Q3TableItem so that it spans multiple cells covering rs rows and cs columns. The top left cell is the original cell.

Warning: This function only works if the item has already been inserted into the table using e.g. Q3Table::setItem(). This function also checks to make sure if rs and cs are within the bounds of the table and returns without changing the span if they are not. In addition swapping, inserting or removing rows and columns that cross Q3TableItems spanning more than one cell is not supported.

See also rowSpan() and colSpan().

### void Q3TableItem::setText ( const QString & str )`[virtual]`

Changes the table item's text to str.

Note that setText() does not update the cell the table item belongs to. Use Q3Table::updateCell() to repaint the cell's contents.

See also Q3Table::setText(), text(), setPixmap(), and Q3Table::updateCell().

### void Q3TableItem::setWordWrap ( bool b )`[virtual]`

If b is true, the cell's text will be wrapped over multiple lines, when necessary, to fit the width of the cell; otherwise the text will be written as a single line.

See also wordWrap(), Q3Table::adjustColumn(), and Q3Table::setColumnStretchable().

### QSize Q3TableItem::sizeHint () const`[virtual]`

This virtual function returns the size a cell needs to show its entire content.

If you subclass Q3TableItem you will often need to reimplement this function.

### Q3Table * Q3TableItem::table () const

Returns the Q3Table the table item belongs to.

See also Q3Table::setItem() and Q3TableItem().

### QString Q3TableItem::text () const`[virtual]`

Returns the text of the table item or an empty string if there is no text.

To ensure that the current value of the editor is returned, setContentFromEditor() is called:

1. if the editMode() is `Always`, or
2. if editMode() is not `Always` but the editor of the cell is active and the editor is not a QLineEdit.

This means that text() returns the original text value of the item if the editor is a line edit, until the user commits an edit (e.g. by pressing Enter or Tab) in which case the new text is returned. For other editors (e.g. a combobox) setContentFromEditor() is always called so the currently display value is the one returned.

See also setText() and pixmap().

### bool Q3TableItem::wordWrap () const

Returns true if word wrap is enabled for the cell; otherwise returns false.

See also setWordWrap().