Q3ListView Class Reference

 #include <Q3ListView>

Member Function Documentation

Q3ListView::Q3ListView ( QWidget * parent = 0, const char * name = 0, Qt::WindowFlags f = 0 )

Constructs a new empty list view called name with parent parent and widget attributes f.

This constructor sets the WA_StaticContent and the Qt::WA_NoBackground attributes to boost performance when drawing Q3ListViewItems. This may be unsuitable for custom Q3ListViewItem classes, in which case Qt::WA_StaticContents and Qt::WA_NoBackground should be cleared on the viewport() after construction.

See also QWidget::setAttribute().

Q3ListView::~Q3ListView ()

Destroys the list view, deleting all its items, and frees up all allocated resources.

int Q3ListView::addColumn ( const QString & label, int width = -1 ) [virtual]

Adds a width pixels wide column with the column header label to the list view, and returns the index of the new column.

All columns apart from the first one are inserted to the right of the existing ones.

If width is negative, the new column's WidthMode is set to Maximum instead of Manual.

See also setColumnText(), setColumnWidth(), and setColumnWidthMode().

int Q3ListView::addColumn ( const QIcon & icon, const QString & label, int width = -1 ) [virtual]

This is an overloaded function.

Adds a width pixels wide new column with the header label and the icon to the list view, and returns the index of the column.

If width is negative, the new column's WidthMode is set to Maximum, and to Manual otherwise.

See also setColumnText(), setColumnWidth(), and setColumnWidthMode().

void Q3ListView::adjustColumn ( int col ) [slot]

Adjusts the column col to its preferred width

void Q3ListView::changeEvent ( QEvent * ev ) [virtual protected]

Reimplemented from QWidget::changeEvent().

void Q3ListView::clear () [virtual slot]

Removes and deletes all the items in this list view and triggers an update.

See also triggerUpdate().

void Q3ListView::clearSelection () [virtual]

Sets all the items to be not selected, updates the list view as necessary, and emits the selectionChanged() signals. Note that for Multi selection list views this function needs to iterate over all items.

See also setSelected() and setMultiSelection().

void Q3ListView::clicked ( Q3ListViewItem * item ) [signal]

This signal is emitted whenever the user clicks (mouse pressed and mouse released) in the list view. item is the clicked list view item, or 0 if the user didn't click on an item.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::clicked ( Q3ListViewItem * item, const QPoint & pnt, int c ) [signal]

This is an overloaded function.

This signal is emitted whenever the user clicks (mouse pressed and mouse released) in the list view. item is the clicked list view item, or 0 if the user didn't click on an item. pnt is the position where the user has clicked in global coordinates. If item is not 0, c is the list view column into which the user pressed; if item is 0 c's value is undefined.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::collapsed ( Q3ListViewItem * item ) [signal]

This signal is emitted when the item has been collapsed, i.e. when the children of item are hidden.

See also setOpen() and expanded().

int Q3ListView::columnAlignment ( int column ) const

Returns the alignment of column column. The default is Qt::AlignAuto.

See also setColumnAlignment() and Qt::Alignment.

QString Q3ListView::columnText ( int c ) const

Returns the text of column c.

See also setColumnText().

int Q3ListView::columnWidth ( int c ) const

Returns the width of column c.

See also setColumnWidth().

WidthMode Q3ListView::columnWidthMode ( int c ) const

Returns the WidthMode for column c.

See also setColumnWidthMode().

void Q3ListView::contentsContextMenuEvent ( QContextMenuEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsContextMenuEvent().

void Q3ListView::contentsDragEnterEvent ( QDragEnterEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsDragEnterEvent().

void Q3ListView::contentsDragLeaveEvent ( QDragLeaveEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsDragLeaveEvent().

void Q3ListView::contentsDragMoveEvent ( QDragMoveEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsDragMoveEvent().

void Q3ListView::contentsDropEvent ( QDropEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsDropEvent().

void Q3ListView::contentsMouseDoubleClickEvent ( QMouseEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsMouseDoubleClickEvent().

Processes the mouse double-click event e on behalf of the viewed widget.

void Q3ListView::contentsMouseMoveEvent ( QMouseEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsMouseMoveEvent().

Processes the mouse move event e on behalf of the viewed widget.

void Q3ListView::contentsMousePressEvent ( QMouseEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsMousePressEvent().

Processes the mouse press event e on behalf of the viewed widget.

void Q3ListView::contentsMouseReleaseEvent ( QMouseEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::contentsMouseReleaseEvent().

Processes the mouse release event e on behalf of the viewed widget.

void Q3ListView::contextMenuRequested ( Q3ListViewItem * item, const QPoint & pos, int col ) [signal]

This signal is emitted when the user invokes a context menu with the right mouse button or with special system keys. If the keyboard was used item is the current item; if the mouse was used, item is the item under the mouse pointer or 0 if there is no item under the mouse pointer. If no item is clicked, the column index emitted is -1.

pos is the position for the context menu in the global coordinate system.

col is the column on which the user pressed, or -1 if the signal was triggered by a key event.

void Q3ListView::currentChanged ( Q3ListViewItem * item ) [signal]

This signal is emitted whenever the current item has changed (normally after the screen update). The current item is the item responsible for indicating keyboard focus.

The argument is the newly current item, or 0 if the change made no item current. This can happen, for example, if all the items in the list view are deleted.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

See also setCurrentItem() and currentItem().

Q3ListViewItem * Q3ListView::currentItem () const

Returns the current item, or 0 if there isn't one.

See also setCurrentItem().

void Q3ListView::doAutoScroll () [protected slot]

This slot handles auto-scrolling when the mouse button is pressed and the mouse is outside the widget.

void Q3ListView::doubleClicked ( Q3ListViewItem * item ) [signal]

This signal is emitted whenever an item is double-clicked. It's emitted on the second button press, not the second button release. item is the list view item on which the user did the double-click.

void Q3ListView::doubleClicked ( Q3ListViewItem * item, const QPoint & point, int column ) [signal]

This signal is emitted when a double-click occurs. It's emitted on the second button press, not the second button release. The item is the Q3ListViewItem the button was double-clicked on (which could be 0 if it wasn't double-clicked on an item). The point where the double-click occurred is given in global coordinates. If an item was double-clicked on, column is the column within the item that was double-clicked; otherwise column is -1.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

Q3DragObject * Q3ListView::dragObject () [virtual protected]

If the user presses the mouse on an item and starts moving the mouse, and the item allow dragging (see Q3ListViewItem::setDragEnabled()), this function is called to get a drag object and a drag is started unless dragObject() returns 0.

By default this function returns 0. You should reimplement it and create a Q3DragObject depending on the selected items.

void Q3ListView::drawContentsOffset ( QPainter * p, int ox, int oy, int cx, int cy, int cw, int ch ) [virtual protected]

Reimplemented from Q3ScrollView::drawContentsOffset().

Calls Q3ListViewItem::paintCell() and Q3ListViewItem::paintBranches() as necessary for all list view items that require repainting in the cw pixels wide and ch pixels high bounding rectangle starting at position cx, cy with offset ox, oy. Uses the painter p.

void Q3ListView::dropped ( QDropEvent * e ) [signal]

This signal is emitted, when a drop event occurred on the viewport (not onto an item).

e provides all the information about the drop.

void Q3ListView::ensureItemVisible ( const Q3ListViewItem * i )

Ensures that item i is visible, scrolling the list view vertically if necessary and opening (expanding) any parent items if this is required to show the item.

See also itemRect() and Q3ScrollView::ensureVisible().

bool Q3ListView::eventFilter ( QObject * o, QEvent * e ) [virtual]

Reimplemented from QObject::eventFilter().

Redirects the event e relating to object o, for the viewport to mousePressEvent(), keyPressEvent() and friends.

void Q3ListView::expanded ( Q3ListViewItem * item ) [signal]

This signal is emitted when item has been expanded, i.e. when the children of item are shown.

See also setOpen() and collapsed().

Q3ListViewItem * Q3ListView::findItem ( const QString & text, int column, ComparisonFlags compare = ExactMatch | Qt::CaseSensitive ) const

Finds the first list view item in column column, that matches text and returns the item, or returns 0 of no such item could be found. Pass OR-ed together ComparisonFlags values in the compare flag, to control how the matching is performed. The default comparison mode is case-sensitive, exact match.

Q3ListViewItem * Q3ListView::firstChild () const

Returns the first item in this Q3ListView. Returns 0 if there is no first item.

A list view's items can be traversed using firstChild() and nextSibling() or using a Q3ListViewItemIterator.

See also itemAt(), Q3ListViewItem::itemBelow(), and Q3ListViewItem::itemAbove().

void Q3ListView::focusInEvent ( QFocusEvent * e ) [virtual protected]

Reimplemented from QWidget::focusInEvent().

void Q3ListView::focusOutEvent ( QFocusEvent * e ) [virtual protected]

Reimplemented from QWidget::focusOutEvent().

Q3Header * Q3ListView::header () const

Returns the Q3Header object that manages this list view's columns. Please don't modify the header behind the list view's back.

You may safely call Q3Header::setClickEnabled(), Q3Header::setResizeEnabled(), Q3Header::setMovingEnabled(), Q3Header::hide() and all the const Q3Header functions.

void Q3ListView::hideColumn ( int column )

Hides the column specified at column. This is a convenience function that calls setColumnWidth(column, 0).

Note: The user may still be able to resize the hidden column using the header handles. To prevent this, call setResizeEnabled(false, column) on the list views header.

See also setColumnWidth().

QVariant Q3ListView::inputMethodQuery ( Qt::InputMethodQuery query ) const [virtual]

Reimplemented from QWidget::inputMethodQuery().

void Q3ListView::insertItem ( Q3ListViewItem * i ) [virtual]

Inserts item i into the list view as a top-level item. You do not need to call this unless you've called takeItem(i) or Q3ListViewItem::takeItem(i) and need to reinsert i elsewhere.

See also Q3ListViewItem::takeItem() and takeItem().

void Q3ListView::invertSelection () [virtual slot]

Inverts the selection. Only works in Multi and Extended selection modes.

bool Q3ListView::isOpen ( const Q3ListViewItem * item ) const

Returns true if this list view item has children and they are not explicitly hidden; otherwise returns false.

Identical to item->isOpen(). Provided for completeness.

See also setOpen().

bool Q3ListView::isRenaming () const

Returns true if an item is being renamed; otherwise returns false.

bool Q3ListView::isSelected ( const Q3ListViewItem * i ) const

Returns true if the list view item i is selected; otherwise returns false.

See also Q3ListViewItem::isSelected().

Q3ListViewItem * Q3ListView::itemAt ( const QPoint & viewPos ) const

Returns the list view item at viewPos. Note that viewPos is in the viewport()'s coordinate system, not in the list view's own, much larger, coordinate system.

itemAt() returns 0 if there is no such item.

Note that you also get the pointer to the item if viewPos points to the root decoration (see setRootIsDecorated()) of the item. To check whether or not viewPos is on the root decoration of the item, you can do something like this:

 Q3ListViewItem *i = itemAt(p);
 if (i) {
     if (p.x() > header()->sectionPos(header()->mapToIndex(0)) +
             treeStepSize() * (i->depth() + (rootIsDecorated() ? 1 : 0)) + itemMargin() ||
             p.x() < header()->sectionPos(header()->mapToIndex(0))) {
         ; // p is not on root decoration
     else
         ; // p is on the root decoration
 }

This might be interesting if you use this function to find out where the user clicked and if you want to start a drag (which you do not want to do if the user clicked onto the root decoration of an item).

See also itemPos(), itemRect(), and viewportToContents().

int Q3ListView::itemPos ( const Q3ListViewItem * item )

Returns the y-coordinate of item in the list view's coordinate system. This function is normally much slower than itemAt() but it works for all items, whereas itemAt() normally works only for items on the screen.

This is a thin wrapper around Q3ListViewItem::itemPos().

See also itemAt() and itemRect().

QRect Q3ListView::itemRect ( const Q3ListViewItem * item ) const

Returns the rectangle on the screen that item item occupies in viewport()'s coordinates, or an invalid rectangle if item is 0 or is not currently visible.

The rectangle returned does not include any children of the rectangle (i.e. it uses Q3ListViewItem::height(), rather than Q3ListViewItem::totalHeight()). If you want the rectangle to include children you can use something like this:

 QRect r(listView->itemRect(item));
 r.setHeight(qMin(item->totalHeight(),
                  listView->viewport->height() - r.y()))

Note the way it avoids too-high rectangles. totalHeight() can be much larger than the window system's coordinate system allows.

itemRect() is comparatively slow. It's best to call it only for items that are probably on-screen.

void Q3ListView::itemRenamed ( Q3ListViewItem * item, int col, const QString & text ) [signal]

This signal is emitted when item has been renamed to text, e.g. by in in-place renaming, in column col.

See also Q3ListViewItem::setRenameEnabled().

void Q3ListView::itemRenamed ( Q3ListViewItem * item, int col ) [signal]

This is an overloaded function.

This signal is emitted when item has been renamed, e.g. by in-place renaming, in column col.

See also Q3ListViewItem::setRenameEnabled().

void Q3ListView::keyPressEvent ( QKeyEvent * e ) [virtual protected]

Reimplemented from QWidget::keyPressEvent().

Q3ListViewItem * Q3ListView::lastItem () const

Returns the last item in the list view tree. Returns 0 if there are no items in the Q3ListView.

This function is slow because it traverses the entire tree to find the last item.

QSize Q3ListView::minimumSizeHint () const [virtual]

Reimplemented from QWidget::minimumSizeHint().

void Q3ListView::mouseButtonClicked ( int button, Q3ListViewItem * item, const QPoint & pos, int c ) [signal]

This signal is emitted whenever the user clicks (mouse pressed and mouse released) in the list view at position pos. button is the mouse button that the user pressed, item is the clicked list view item or 0 if the user didn't click on an item. If item is not 0, c is the list view column into which the user pressed; if item is 0 c's value is undefined.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::mouseButtonPressed ( int button, Q3ListViewItem * item, const QPoint & pos, int c ) [signal]

This signal is emitted whenever the user pressed the mouse button in the list view at position pos. button is the mouse button which the user pressed, item is the pressed list view item or 0 if the user didn't press on an item. If item is not 0, c is the list view column into which the user pressed; if item is 0 c's value is undefined.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::onItem ( Q3ListViewItem * i ) [signal]

This signal is emitted when the user moves the mouse cursor onto item i, similar to the QWidget::enterEvent() function.

void Q3ListView::onViewport () [signal]

This signal is emitted when the user moves the mouse cursor from an item to an empty part of the list view.

void Q3ListView::paintEmptyArea ( QPainter * p, const QRect & rect ) [virtual protected]

Paints rect so that it looks like empty background using painter p. rect is in widget coordinates, ready to be fed to p.

The default function fills rect with the viewport()->backgroundBrush().

void Q3ListView::pressed ( Q3ListViewItem * item ) [signal]

This signal is emitted whenever the user presses the mouse button in a list view. item is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::pressed ( Q3ListViewItem * item, const QPoint & pnt, int c ) [signal]

This is an overloaded function.

This signal is emitted whenever the user presses the mouse button in a list view. item is the list view item on which the user pressed the mouse button, or 0 if the user didn't press the mouse on an item. pnt is the position of the mouse cursor in global coordinates, and c is the column where the mouse cursor was when the user pressed the mouse button.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

void Q3ListView::removeColumn ( int index ) [virtual]

Removes the column at position index.

void Q3ListView::removeItem ( Q3ListViewItem * item ) [virtual]

Removes the given item. Use takeItem() instead.

void Q3ListView::repaintItem ( const Q3ListViewItem * item ) const

Repaints item on the screen if item is currently visible. Takes care to avoid multiple repaints.

void Q3ListView::resizeEvent ( QResizeEvent * e ) [virtual protected]

Reimplemented from QWidget::resizeEvent().

Ensures that the header is correctly sized and positioned when the resize event e occurs.

void Q3ListView::returnPressed ( Q3ListViewItem * item ) [signal]

This signal is emitted when Enter or Return is pressed. The item parameter is the currentItem().

void Q3ListView::rightButtonClicked ( Q3ListViewItem * item, const QPoint & point, int column ) [signal]

This signal is emitted when the right button is clicked. The item is the Q3ListViewItem the button was clicked on (which could be 0 if it wasn't clicked on an item). The point where the click occurred is given in global coordinates. If an item was clicked on, column is the column within the item that was clicked; otherwise column is -1.

void Q3ListView::rightButtonPressed ( Q3ListViewItem * item, const QPoint & point, int column ) [signal]

This signal is emitted when the right button is pressed. The item is the Q3ListViewItem the button was pressed on (which could be 0 if it wasn't pressed on an item). The point where the press occurred is given in global coordinates. If an item was pressed on, column is the column within the item that was pressed; otherwise column is -1.

void Q3ListView::selectAll ( bool select ) [virtual slot]

If select is true, all the items get selected; otherwise all the items get unselected. This only works in the selection modes Multi and Extended. In Single and NoSelection mode the selection of the current item is just set to select.

Q3ListViewItem * Q3ListView::selectedItem () const

Returns the selected item if the list view is in Single selection mode and an item is selected.

If no items are selected or the list view is not in Single selection mode this function returns 0.

See also setSelected() and setMultiSelection().

void Q3ListView::selectionChanged () [signal]

This signal is emitted whenever the set of selected items has changed (normally before the screen update). It is available both in Single selection and Multi selection mode but is most useful in Multi selection mode.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

See also setSelected() and Q3ListViewItem::setSelected().

void Q3ListView::selectionChanged ( Q3ListViewItem * item ) [signal]

This is an overloaded function.

This signal is emitted whenever the selected item has changed in Single selection mode (normally after the screen update). The argument is the newly selected item.

In Multi selection mode, use the no argument overload of this signal.

Warning: Do not delete any Q3ListViewItem objects in slots connected to this signal.

See also setSelected(), Q3ListViewItem::setSelected(), and currentChanged().

void Q3ListView::setColumnAlignment ( int column, int align ) [virtual]

Sets column column's alignment to align. The alignment is ultimately passed to Q3ListViewItem::paintCell() for each item in the list view. For horizontally aligned text with Qt::AlignLeft or Qt::AlignHCenter the ellipsis (...) will be to the right, for Qt::AlignRight the ellipsis will be to the left.

See also columnAlignment() and Qt::Alignment.

void Q3ListView::setColumnText ( int column, const QString & label ) [virtual]

Sets the heading of column column to label.

See also columnText().

void Q3ListView::setColumnText ( int column, const QIcon & icon, const QString & label ) [virtual]

This is an overloaded function.

Sets the heading of column column to icon and label.

See also columnText().

void Q3ListView::setColumnWidth ( int column, int w ) [virtual]

Sets the width of column column to w pixels. Note that if the column has a WidthMode other than Manual, this width setting may be subsequently overridden.

See also columnWidth().

void Q3ListView::setColumnWidthMode ( int c, WidthMode mode ) [virtual]

Sets column c's width mode to mode. The default depends on the original width argument to addColumn().

See also columnWidthMode() and Q3ListViewItem::width().

void Q3ListView::setContentsPos ( int x, int y ) [virtual slot]

Reimplemented from Q3ScrollView::setContentsPos().

void Q3ListView::setCurrentItem ( Q3ListViewItem * i ) [virtual]

Sets item i to be the current item and repaints appropriately (i.e. highlights the item). The current item is used for keyboard navigation and focus indication; it is independent of any selected items, although a selected item can also be the current item.

See also currentItem() and setSelected().

void Q3ListView::setOpen ( Q3ListViewItem * item, bool open ) [virtual]

Sets item to be open if open is true and item is expandable, and to be closed if open is false. Repaints accordingly.

See also isOpen(), Q3ListViewItem::setOpen(), and Q3ListViewItem::setExpandable().

void Q3ListView::setSelected ( Q3ListViewItem * item, bool selected ) [virtual]

If selected is true the item is selected; otherwise it is unselected.

If the list view is in Single selection mode and selected is true, the currently selected item is unselected and item is made current. Unlike Q3ListViewItem::setSelected(), this function updates the list view as necessary and emits the selectionChanged() signals.

setCurrentItem(), setSelectionAnchor()

See also isSelected(), setMultiSelection(), and isMultiSelection().

void Q3ListView::setSelectionAnchor ( Q3ListViewItem * item )

Sets the selection anchor to item, if item is selectable.

The selection anchor is the item that remains selected when Shift-selecting with either mouse or keyboard in Extended selection mode.

See also setSelected().

void Q3ListView::setSortColumn ( int column )

Sets the sorting column for the list view.

If column is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If column is larger than the number of columns the user must click on a column header to sort the list view.

See also sortColumn() and setSorting().

void Q3ListView::setSortOrder ( Qt::SortOrder order )

Sets the sort order for the items in the list view to order.

See also sortOrder() and setSorting().

void Q3ListView::setSorting ( int column, bool ascending = true ) [virtual]

Sets the list view to be sorted by column column in ascending order if ascending is true or descending order if it is false.

If column is -1, sorting is disabled and the user cannot sort columns by clicking on the column headers. If column is larger than the number of columns the user must click on a column header to sort the list view.

void Q3ListView::showEvent ( QShowEvent * ) [virtual protected]

Reimplemented from QWidget::showEvent().

QSize Q3ListView::sizeHint () const [virtual]

Reimplemented from QWidget::sizeHint().

void Q3ListView::sort () [virtual]

Sorts the list view using the last sorting configuration (sort column and ascending/descending).

int Q3ListView::sortColumn () const

Returns the column by which the list view is sorted, or -1 if sorting is disabled.

See also setSortColumn() and sortOrder().

Qt::SortOrder Q3ListView::sortOrder () const

Returns the sorting order of the list view items.

See also setSortOrder() and sortColumn().

void Q3ListView::spacePressed ( Q3ListViewItem * item ) [signal]

This signal is emitted when Space is pressed. The item parameter is the currentItem().

void Q3ListView::startDrag () [virtual protected]

Starts a drag.

void Q3ListView::takeItem ( Q3ListViewItem * i ) [virtual]

Removes item i from the list view; i must be a top-level item. The warnings regarding Q3ListViewItem::takeItem() apply to this function, too.

See also insertItem().

void Q3ListView::triggerUpdate () [slot]

Triggers a size, geometry and content update during the next iteration of the event loop. Ensures that there'll be just one update to avoid flicker.

void Q3ListView::updateContents () [protected slot]

Updates the sizes of the viewport, header, scroll bars and so on.

Warning: Don't call this directly; call triggerUpdate() instead.

void Q3ListView::viewportResizeEvent ( QResizeEvent * e ) [virtual protected]

Reimplemented from Q3ScrollView::viewportResizeEvent().