Q3ListViewItem Class Reference
[Qt3Support module]

Detailed Description

The Q3ListViewItem class implements a list view item.

A list view item is a multi-column object capable of displaying itself in a Q3ListView.

The easiest way to use Q3ListViewItem is to construct one with a few constant strings, and either a Q3ListView or another Q3ListViewItem as parent.

 (void) new Q3ListViewItem(listView, "Column 1", "Column 2");
 (void) new Q3ListViewItem(listView->firstChild(), "A", "B", "C");

We've discarded the pointers to the items since we can still access them via their parent listView. By default, Q3ListView sorts its items; this can be switched off with Q3ListView::setSorting(-1).

The parent must be another Q3ListViewItem or a Q3ListView. If the parent is a Q3ListView, the item becomes a top-level item within that Q3ListView. If the parent is another Q3ListViewItem, the item becomes a child of that list view item.

If you keep the pointer, you can set or change the texts using setText(), add pixmaps using setPixmap(), change its mode using setSelectable(), setSelected(), setOpen() and setExpandable(). You'll also be able to change its height using setHeight(), and traverse its sub-items. You don't have to keep the pointer since you can get a pointer to any Q3ListViewItem in a Q3ListView using Q3ListView::selectedItem(), Q3ListView::currentItem(), Q3ListView::firstChild(), Q3ListView::lastItem() and Q3ListView::findItem().

If you call delete on a list view item, it will be deleted as expected, and as usual for QObjects, if it has any child items (to any depth), all these will be deleted too.

Q3CheckListItems are list view items that have a checkbox or radio button and can be used in place of plain Q3ListViewItems.

You can traverse the tree as if it were a doubly-linked list using itemAbove() and itemBelow(); they return pointers to the items directly above and below this item on the screen (even if none of them are actually visible at the moment).

Here's how to traverse all of an item's children (but not its children's children, etc.): Example:

 Q3ListViewItem * myChild = myItem->firstChild();
 while(myChild) {
     doSomething(myChild);
     myChild = myChild->nextSibling();
 }

If you want to iterate over every item, to any level of depth use an iterator. To iterate over the entire tree, initialize the iterator with the list view itself; to iterate over an item's children (and children's children to any depth), initialize the iterator with the item:

 Q3ListViewItemIterator it(listview);
 while (it.current()) {
     Q3ListViewItem *item = it.current();
     doSomething(item);
     ++it;
 }

Note that the order of the children will change when the sorting order changes and is undefined if the items are not visible. You can, however, call enforceSortOrder() at any time; Q3ListView will always call it before it needs to show an item.

Many programs will need to reimplement Q3ListViewItem. The most commonly reimplemented functions are:

Some subclasses call setExpandable(true) even when they have no children, and populate themselves when setup() or setOpen(true) is called. The dirview/dirview.cpp example program uses this technique to start up quickly: The files and subdirectories in a directory aren't inserted into the tree until they're actually needed.

See also Q3CheckListItem and Q3ListView.

Member Function Documentation

Q3ListViewItem::Q3ListViewItem ( Q3ListView * parent )

Constructs a new top-level list view item in the Q3ListView parent.

Q3ListViewItem::Q3ListViewItem ( Q3ListViewItem * parent )

Constructs a new list view item that is a child of parent and first in the parent's list of children.

Q3ListViewItem::Q3ListViewItem ( Q3ListView * parent, Q3ListViewItem * after )

Constructs an empty list view item that is a child of parent and is after item after in the parent's list of children. Since parent is a Q3ListView the item will be a top-level item.

Q3ListViewItem::Q3ListViewItem ( Q3ListViewItem * parent, Q3ListViewItem * after )

Constructs an empty list view item that is a child of parent and is after item after in the parent's list of children.

Q3ListViewItem::Q3ListViewItem ( Q3ListView * parent, const QString & label1, const QString & label2 = QString(), const QString & label3 = QString(), const QString & label4 = QString(), const QString & label5 = QString(), const QString & label6 = QString(), const QString & label7 = QString(), const QString & label8 = QString() )

Constructs a new top-level list view item in the Q3ListView parent, with up to eight constant strings, label1, label2, label3, label4, label5, label6, label7 and label8 defining its columns' contents.

See also setText().

Q3ListViewItem::Q3ListViewItem ( Q3ListViewItem * parent, const QString & label1, const QString & label2 = QString(), const QString & label3 = QString(), const QString & label4 = QString(), const QString & label5 = QString(), const QString & label6 = QString(), const QString & label7 = QString(), const QString & label8 = QString() )

Constructs a new list view item as a child of the Q3ListViewItem parent with up to eight constant strings, label1, label2, label3, label4, label5, label6, label7 and label8 as columns' contents.

See also setText().

Q3ListViewItem::Q3ListViewItem ( Q3ListView * parent, Q3ListViewItem * after, const QString & label1, const QString & label2 = QString(), const QString & label3 = QString(), const QString & label4 = QString(), const QString & label5 = QString(), const QString & label6 = QString(), const QString & label7 = QString(), const QString & label8 = QString() )

Constructs a new list view item in the Q3ListView parent that is included after item after and that has up to eight column texts, label1, label2, label3, label4, label5, label6, label7 andlabel8.

Note that the order is changed according to Q3ListViewItem::key() unless the list view's sorting is disabled using Q3ListView::setSorting(-1).

See also setText().

Q3ListViewItem::Q3ListViewItem ( Q3ListViewItem * parent, Q3ListViewItem * after, const QString & label1, const QString & label2 = QString(), const QString & label3 = QString(), const QString & label4 = QString(), const QString & label5 = QString(), const QString & label6 = QString(), const QString & label7 = QString(), const QString & label8 = QString() )

Constructs a new list view item as a child of the Q3ListViewItem parent. It is inserted after item after and may contain up to eight strings, label1, label2, label3, label4, label5, label6, label7 and label8 as column entries.

Note that the order is changed according to Q3ListViewItem::key() unless the list view's sorting is disabled using Q3ListView::setSorting(-1).

See also setText().

Q3ListViewItem::~Q3ListViewItem ()   [virtual]

Destroys the item, deleting all its children and freeing up all allocated resources.

bool Q3ListViewItem::acceptDrop ( const QMimeSource * mime ) const   [virtual]

Returns true if the item can accept drops of type QMimeSource mime; otherwise returns false.

The default implementation does nothing and returns false. A subclass must reimplement this to accept drops.

void Q3ListViewItem::activate ()   [virtual protected]

This virtual function is called whenever the user presses the mouse on this item or presses Space on it.

See also activatedPos().

bool Q3ListViewItem::activatedPos ( QPoint & pos )   [protected]

When called from a reimplementation of activate(), this function gives information on how the item was activated. Otherwise the behavior is undefined.

If activate() was caused by a mouse press, the function sets pos to where the user clicked and returns true; otherwise it returns false and does not change pos.

pos is relative to the top-left corner of this item.

See also activate().

void Q3ListViewItem::cancelRename ( int col )   [virtual protected]

This function is called if the user cancels in-place renaming of this item in column col (e.g. by pressing Esc).

See also okRename().

int Q3ListViewItem::childCount () const

Returns how many children this item has. The count only includes the item's immediate children.

int Q3ListViewItem::compare ( Q3ListViewItem * i, int col, bool ascending ) const   [virtual]

Compares this list view item to i using the column col in ascending order. Returns < 0 if this item is less than i, 0 if they are equal and > 0 if this item is greater than i.

This function is used for sorting.

The default implementation compares the item keys (key()) using QString::localeAwareCompare(). A reimplementation can use different values and a different comparison function. Here is a reimplementation that uses plain Unicode comparison:

 int MyListViewItem::compare(Q3ListViewItem *i, int col,
                              bool ascending) const
 {
     return key(col, ascending).compare(i->key(col, ascending));
 }

We don't recommend using ascending so your code can safely ignore it.

See also key(), QString::localeAwareCompare(), and QString::compare().

int Q3ListViewItem::depth () const

Returns the depth of this item.

bool Q3ListViewItem::dragEnabled () const

Returns true if this item can be dragged; otherwise returns false.

See also setDragEnabled().

void Q3ListViewItem::dragEntered ()   [virtual protected]

This function is called when a drag enters the item's bounding rectangle.

The default implementation does nothing, subclasses may need to reimplement this function.

void Q3ListViewItem::dragLeft ()   [virtual protected]

This function is called when a drag leaves the item's bounding rectangle.

The default implementation does nothing, subclasses may need to reimplement this function.

bool Q3ListViewItem::dropEnabled () const

Returns true if this item accepts drops; otherwise returns false.

See also setDropEnabled() and acceptDrop().

void Q3ListViewItem::dropped ( QDropEvent * e )   [virtual protected]

This function is called when something was dropped on the item. e contains all the information about the drop.

The default implementation does nothing, subclasses may need to reimplement this function.

void Q3ListViewItem::enforceSortOrder () const   [virtual protected]

Makes sure that this object's children are sorted appropriately.

This only works if every item from the root item down to this item is already sorted.

See also sortChildItems().

Q3ListViewItem * Q3ListViewItem::firstChild () const

Returns the first (top) child of this item, or 0 if this item has no children.

Note that the children are not guaranteed to be sorted properly. Q3ListView and Q3ListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy.

See also nextSibling() and sortChildItems().

int Q3ListViewItem::height () const

Returns the height of this item in pixels. This does not include the height of any children; totalHeight() returns that.

See also setHeight().

void Q3ListViewItem::insertItem ( Q3ListViewItem * newChild )   [virtual]

Inserts newChild into this list view item's list of children. You should not need to call this function; it is called automatically by the constructor of newChild.

Warning: If you are using Single selection mode, then you should only insert unselected items.

void Q3ListViewItem::invalidateHeight ()   [virtual]

Invalidates the cached total height of this item, including all open children.

See also setHeight(), height(), and totalHeight().

bool Q3ListViewItem::isEnabled () const

Returns true if this item is enabled; otherwise returns false.

See also setEnabled().

bool Q3ListViewItem::isExpandable () const

Returns true if this item is expandable even when it has no children; otherwise returns false.

bool Q3ListViewItem::isOpen () const

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

See also setOpen().

bool Q3ListViewItem::isSelectable () const

Returns true if the item is selectable (as it is by default); otherwise returns false

See also setSelectable().

bool Q3ListViewItem::isSelected () const

Returns true if this item is selected; otherwise returns false.

See also setSelected(), Q3ListView::setSelected(), and Q3ListView::selectionChanged().

bool Q3ListViewItem::isVisible () const

Returns true if the item is visible; otherwise returns false.

See also setVisible().

Q3ListViewItem * Q3ListViewItem::itemAbove () const

Returns a pointer to the item immediately above this item on the screen. This is usually the item's closest older sibling, but it may also be its parent or its next older sibling's youngest child, or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately above this item.

This function assumes that all parents of this item are open (i.e. that this item is visible, or can be made visible by scrolling).

This function might be relatively slow because of the tree traversions needed to find the correct item.

See also itemBelow() and Q3ListView::itemRect().

Q3ListViewItem * Q3ListViewItem::itemBelow () const

Returns a pointer to the item immediately below this item on the screen. This is usually the item's eldest child, but it may also be its next younger sibling, its parent's next younger sibling, grandparent's, etc., or something else if anyoftheabove->height() returns 0. Returns 0 if there is no item immediately below this item.

This function assumes that all parents of this item are open (i.e. that this item is visible or can be made visible by scrolling).

See also itemAbove() and Q3ListView::itemRect().

int Q3ListViewItem::itemPos () const

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

See also Q3ListView::itemAt(), Q3ListView::itemRect(), and Q3ListView::itemPos().

QString Q3ListViewItem::key ( int column, bool ascending ) const   [virtual]

Returns a key that can be used for sorting by column column. The default implementation returns text(). Derived classes may also incorporate the order indicated by ascending into this key, although this is not recommended.

If you want to sort on non-alphabetical data, e.g. dates, numbers, etc., it is more efficient to reimplement compare().

See also compare() and sortChildItems().

Q3ListView * Q3ListViewItem::listView () const

Returns a pointer to the list view containing this item.

Note that this function traverses the items to the root to find the listview. This function will return 0 for taken items - see Q3ListViewItem::takeItem()

void Q3ListViewItem::moveItem ( Q3ListViewItem * after )

Move the item to be after item after, which must be one of the item's siblings. To move an item in the hierarchy, use takeItem() and insertItem().

Note that this function will have no effect if sorting is enabled in the list view.

bool Q3ListViewItem::multiLinesEnabled () const

Returns true if the item can display multiple lines of text in its columns; otherwise returns false.

See also setMultiLinesEnabled().

Q3ListViewItem * Q3ListViewItem::nextSibling () const

Returns the sibling item below this item, or 0 if there is no sibling item after this item.

Note that the siblings are not guaranteed to be sorted properly. Q3ListView and Q3ListViewItem try to postpone or avoid sorting to the greatest degree possible, in order to keep the user interface snappy.

See also firstChild() and sortChildItems().

void Q3ListViewItem::okRename ( int col )   [virtual protected]

This function is called if the user presses Enter during in-place renaming of the item in column col.

See also cancelRename().

void Q3ListViewItem::paintBranches ( QPainter * p, const QColorGroup & cg, int w, int y, int h )   [virtual]

Paints a set of branches from this item to (some of) its children.

Painter p is set up with clipping and translation so that you can only draw in the rectangle that needs redrawing; cg is the color group to use; the update rectangle is at (0, 0) and has size width w by height h. The top of the rectangle you own is at y (which is never greater than 0 but can be outside the window system's allowed coordinate range).

The update rectangle is in an undefined state when this function is called; this function must draw on all of the pixels.

See also paintCell() and Q3ListView::drawContentsOffset().

void Q3ListViewItem::paintCell ( QPainter * painter, const QColorGroup & cg, int column, int width, int align )   [virtual]

This virtual function paints the contents of one column of an item and aligns it as described by align.

The painter is a Q3Painter open on the relevant paint device. It is translated so (0, 0) is the top-left pixel in the cell and width - 1, height() - 1 is the bottom-right pixel in the cell. The other properties of the painter (pen, brush, etc) are undefined. cg is the color group to use. column is the logical column number within the item that is to be painted; 0 is the column which may contain a tree.

This function may use Q3ListView::itemMargin() for readability spacing on the left and right sides of data such as text, and should honor isSelected() and Q3ListView::allColumnsShowFocus().

If you reimplement this function, you should also reimplement width().

The rectangle to be painted is in an undefined state when this function is called, so you must draw on all the pixels. The painter has the right font on entry.

See also paintBranches() and Q3ListView::drawContentsOffset().

void Q3ListViewItem::paintFocus ( QPainter * p, const QColorGroup & cg, const QRect & r )   [virtual]

Paints a focus indicator on the rectangle r using painter p and colors cg.

p is already clipped.

See also paintCell(), paintBranches(), and Q3ListView::setAllColumnsShowFocus().

Q3ListViewItem * Q3ListViewItem::parent () const

Returns the parent of this item, or 0 if this item has no parent.

See also firstChild() and nextSibling().

const QPixmap * Q3ListViewItem::pixmap ( int column ) const   [virtual]

Returns the pixmap for column, or 0 if there is no pixmap for column.

See also setText() and setPixmap().

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

Removes the given item. Use takeItem() instead.

bool Q3ListViewItem::renameEnabled ( int col ) const

Returns true if this item can be in-place renamed in column col; otherwise returns false.

See also setRenameEnabled().

void Q3ListViewItem::repaint () const

Repaints this item on the screen if it is currently visible.

int Q3ListViewItem::rtti () const   [virtual]

Returns 0.

Make your derived classes return their own values for rtti(), so that you can distinguish between different kinds of list view items. You should use values greater than 1000 to allow for extensions to this class.

void Q3ListViewItem::setDragEnabled ( bool allow )   [virtual]

If allow is true, the list view starts a drag (see Q3ListView::dragObject()) when the user presses and moves the mouse on this item.

See also dragEnabled().

void Q3ListViewItem::setDropEnabled ( bool allow )   [virtual]

If allow is true, the list view accepts drops onto the item; otherwise drops are not allowed.

See also dropEnabled().

void Q3ListViewItem::setEnabled ( bool b )   [virtual]

If b is true the item is enabled; otherwise it is disabled. Disabled items are drawn differently (e.g. grayed-out) and are not accessible by the user.

See also isEnabled().

void Q3ListViewItem::setExpandable ( bool enable )   [virtual]

Sets this item to be expandable even if it has no children if enable is true, and to be expandable only if it has children if enable is false (the default).

The dirview example uses this in the canonical fashion. It checks whether the directory is empty in setup() and calls setExpandable(true) if not; in setOpen() it reads the contents of the directory and inserts items accordingly. This strategy means that dirview can display the entire file system without reading very much at startup.

Note that root items are not expandable by the user unless Q3ListView::setRootIsDecorated() is set to true.

See also isExpandable() and setSelectable().

void Q3ListViewItem::setHeight ( int height )   [virtual protected]

Sets this item's height to height pixels. This implicitly changes totalHeight(), too.

Note that a font change causes this height to be overwritten unless you reimplement setup().

For best results in Windows style we suggest using an even number of pixels.

See also height(), totalHeight(), and isOpen().

void Q3ListViewItem::setMultiLinesEnabled ( bool b )   [virtual]

If b is true each of the item's columns may contain multiple lines of text; otherwise each of them may only contain a single line.

See also multiLinesEnabled().

void Q3ListViewItem::setOpen ( bool o )   [virtual]

Opens or closes an item, i.e. shows or hides an item's children.

If o is true all child items are shown initially. The user can hide them by clicking the - icon to the left of the item. If o is false, the children of this item are initially hidden. The user can show them by clicking the + icon to the left of the item.

See also height(), totalHeight(), and isOpen().

void Q3ListViewItem::setPixmap ( int column, const QPixmap & pm )   [virtual]

Sets the pixmap in column column to pm, if pm is non-null and different from the current pixmap, and if column is non-negative.

See also pixmap() and setText().

void Q3ListViewItem::setRenameEnabled ( int col, bool b )   [virtual]

If b is true, this item can be in-place renamed in the column col by the user; otherwise it cannot be renamed in-place.

See also renameEnabled().

void Q3ListViewItem::setSelectable ( bool enable )   [virtual]

Sets this items to be selectable if enable is true (the default) or not to be selectable if enable is false.

The user is not able to select a non-selectable item using either the keyboard or the mouse. The application programmer still can though, e.g. using setSelected().

See also isSelectable().

void Q3ListViewItem::setSelected ( bool s )   [virtual]

If s is true this item is selected; otherwise it is deselected.

This function does not maintain any invariants or repaint anything -- Q3ListView::setSelected() does that.

See also isSelected(), height(), and totalHeight().

void Q3ListViewItem::setText ( int column, const QString & text )   [virtual]

Sets the text in column column to text, if column is a valid column number and text is different from the existing text.

If the text() function has been reimplemented, this function may be a no-op.

See also text() and key().

void Q3ListViewItem::setVisible ( bool b )

If b is true, the item is made visible; otherwise it is hidden.

If the item is not visible, itemAbove() and itemBelow() will never return this item, although you still can reach it by using e.g. Q3ListViewItemIterator.

See also isVisible().

void Q3ListViewItem::setup ()   [virtual]

This virtual function is called before the first time Q3ListView needs to know the height or any other graphical attribute of this object, and whenever the font, GUI style, or colors of the list view change.

The default calls widthChanged() and sets the item's height to the height of a single line of text in the list view's font. (If you use icons, multi-line text, etc., you will probably need to call setHeight() yourself or reimplement it.)

void Q3ListViewItem::sort ()   [virtual]

Sorts all this item's child items using the current sorting configuration (sort column and direction).

See also enforceSortOrder().

void Q3ListViewItem::sortChildItems ( int column, bool ascending )   [virtual]

Sorts this item's children using column column. This is done in ascending order if ascending is true and in descending order if ascending is false.

Asks some of the children to sort their children. (Q3ListView and Q3ListViewItem ensure that all on-screen objects are properly sorted but may avoid or defer sorting other objects in order to be more responsive.)

See also key() and compare().

void Q3ListViewItem::startRename ( int col )   [virtual]

If in-place renaming of this item is enabled (see renameEnabled()), this function starts renaming the item in column col, by creating and initializing an edit box.

void Q3ListViewItem::takeItem ( Q3ListViewItem * item )   [virtual]

Removes item from this object's list of children and causes an update of the screen display. The item is not deleted. You should not normally need to call this function because Q3ListViewItem::~Q3ListViewItem() calls it.

The normal way to delete an item is to use delete.

If you need to move an item from one place in the hierarchy to another you can use takeItem() to remove the item from the list view and then insertItem() to put the item back in its new position.

If a taken item is part of a selection in Single selection mode, it is unselected and selectionChanged() is emitted. If a taken item is part of a selection in Multi or Extended selection mode, it remains selected.

Warning: This function leaves item and its children in a state where most member functions are unsafe. Only a few functions work correctly on an item in this state, most notably insertItem(). The functions that work on taken items are explicitly documented as such.

See also Q3ListViewItem::insertItem().

QString Q3ListViewItem::text ( int column ) const   [virtual]

Returns the text in column column, or an empty string if there is no text in that column.

See also setText(), key(), and paintCell().

int Q3ListViewItem::totalHeight () const

Returns the total height of this object, including any visible children. This height is recomputed lazily and cached for as long as possible.

Functions which can affect the total height are, setHeight() which is used to set an item's height, setOpen() to show or hide an item's children, and invalidateHeight() to invalidate the cached height.

See also height().

int Q3ListViewItem::width ( const QFontMetrics & fm, const Q3ListView * lv, int c ) const   [virtual]

Returns the number of pixels of width required to draw column c of list view lv, using the metrics fm without cropping. The list view containing this item may use this information depending on the Q3ListView::WidthMode settings for the column.

The default implementation returns the width of the bounding rectangle of the text of column c.

Q3ListView::itemMargin()

See also listView(), widthChanged(), and Q3ListView::setColumnWidthMode().

void Q3ListViewItem::widthChanged ( int c = -1 ) const

Call this function when the value of width() may have changed for column c. Normally, you should call this if text(c) changes. Passing -1 for c indicates that all columns may have changed. It is more efficient to pass -1 if two or more columns have changed than to call widthChanged() separately for each one.

See also width().