Contents

• Public Types
• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Signals
• Protected Functions
• Reimplemented Protected Functions
• Protected Slots
• Detailed Description

Detailed Description

TheQ3ListView class implements a list/tree view.

It can display and control a hierarchy of multi-column items, and provides the ability to add new items at any time. The user may select one or many items (depending on theSelectionMode) and sort the list in increasing or decreasing order by any column.

The simplest pattern of use is to create aQ3ListView, add some column headers usingaddColumn() and create one or moreQ3ListViewItem orQ3CheckListItem objects with theQ3ListView as parent.

Further nodes can be added to the list view object (the root of the tree) or as child nodes to Q3ListViewItems.

The main setup functions are:

There are several functions for mapping between items and coordinates.itemAt() returns the item at a position on-screen,itemRect() returns the rectangle an item occupies on the screen, anditemPos() returns the position of any item (whether it is on-screen or not).firstChild() returns the list view's first item (not necessarily visible on-screen).

You can iterate over visible items usingQ3ListViewItem::itemBelow(); over a list view's top-level items usingQ3ListViewItem::firstChild() andQ3ListViewItem::nextSibling(); or every item using aQ3ListViewItemIterator. See theQ3ListViewItem documentation for examples of traversal.

An item can be moved amongst its siblings usingQ3ListViewItem::moveItem(). To move an item in the hierarchy usetakeItem() andinsertItem(). Item's (and all their child items) are deleted withdelete; to delete all the list view's items useclear().

There are a variety of selection modes described in theQ3ListView::SelectionMode documentation. The default isSingle selection, which you can change usingsetSelectionMode().

BecauseQ3ListView offers multiple selection it must display keyboard focus and selection state separately. Therefore there are functions both to set the selection state of an item (setSelected()) and to set which item displays keyboard focus (setCurrentItem()).

Q3ListView emits two groups of signals; one group signals changes in selection/focus state and one indicates selection. The first group consists ofselectionChanged() (applicable to all list views),selectionChanged(Q3ListViewItem*) (applicable only to aSingle selection list view), andcurrentChanged(Q3ListViewItem*). The second group consists ofdoubleClicked(Q3ListViewItem*),returnPressed(Q3ListViewItem*),rightButtonClicked(Q3ListViewItem*, constQPoint&, int), etc.

Note that changing the state of the list view in a slot connected to a list view signal may cause unexpected side effects. If you need to change the list view's state in response to a signal, use asingle shot timer with a time out of 0, and connect this timer to a slot that modifies the list view's state.

In Motif style,Q3ListView deviates fairly strongly from the look and feel of the Motif hierarchical tree view. This is done mostly to provide a usable keyboard interface and to make the list view look better with a white background.

IfselectionMode() isSingle (the default) the user can select one item at a time, e.g. by clicking an item with the mouse, seeQ3ListView::SelectionMode for details.

The list view can be navigated either using the mouse or the keyboard. Clicking a- icon closes an item (hides its children) and clicking a+ icon opens an item (shows its children). The keyboard controls are these:

If the user starts typing letters with the focus in the list view an incremental search will occur. For example if the user types 'd' the current item will change to the first item that begins with the letter 'd'; if they then type 'a', the current item will change to the first item that begins with 'da', and so on. If no item begins with the letters they type the current item doesn't change.

Note that the list view's size hint is calculated taking into account the heightand width to produce a nice aspect ratio. This may mean that you need to reimplementsizeHint() in some cases.

Warning: The list view assumes ownership of all list view items and will delete them when it does not need them any more.

Member Type Documentation

typedef Q3ListView::ComparisonFlags

This typedef is used inQ3ListView's API for values that are OR'd combinations ofStringComparisonMode values.

See alsoStringComparisonMode.

enum Q3ListView::RenameAction

This enum describes whether a rename operation is accepted if the rename editor loses focus without the user pressing Enter.

enum Q3ListView::ResizeMode

This enum describes how the list view's header adjusts to resize events which affect the width of the list view.

enum Q3ListView::SelectionMode

This enumerated type is used byQ3ListView to indicate how it reacts to selection by the user.

In other words,Single is a real single-selection list view,Multi a real multi-selection list view,Extended is a list view where users can select multiple items but usually want to select either just one or a range of contiguous items, andNoSelection is a list view where the user can look but not touch.

enum Q3ListView::StringComparisonMode

This enum type is used to set the string comparison mode when searching for an item. We'll refer to the string being searched as the 'target' string.

If you OR these flags together (excludingCaseSensitive), the search criteria be applied in the following order:ExactMatch,BeginsWith,EndsWith,Contains.

Matching is case-insensitive unlessCaseSensitive is set.CaseSensitive can be OR-ed with any combination of the other flags.

See alsoComparisonFlags.

enum Q3ListView::WidthMode

This enum type describes how the width of a column in the view changes.

See alsosetColumnWidth(),setColumnWidthMode(), andcolumnWidth().

Property Documentation

allColumnsShowFocus :bool

This property holds whether items should show keyboard focus using all columns.

If this property is true all columns will show focus and selection states, otherwise only column 0 will show focus.

The default is false.

Setting this to true if it's not necessary may cause noticeable flicker.

Access functions:

childCount : constint

This property holds the number of parentless (top-level) Q3ListViewItem objects in this Q3ListView.

Holds the current number of parentless (top-level)Q3ListViewItem objects in thisQ3ListView.

Access functions:

See alsoQ3ListViewItem::childCount().

columns : constint

This property holds the number of columns in this list view.

Access functions:

See alsoaddColumn() andremoveColumn().

defaultRenameAction :RenameAction

This property holds what action to perform when the editor loses focus during renaming.

If this property isAccept, and the user renames an item and the editor loses focus (without the user pressing Enter), the item will still be renamed. If the property's value isReject, the item will not be renamed unless the user presses Enter. The default isReject.

Access functions:

itemMargin :int

This property holds the advisory item margin that list items may use.

The item margin defaults to one pixel and is the margin between the item's edges and the area where it draws its contents.Q3ListViewItem::paintFocus() draws in the margin.

Access functions:

See alsoQ3ListViewItem::paintCell().

multiSelection :bool

This property holds whether the list view is in multi-selection or extended-selection mode.

If you enable multi-selection,Multi, mode, it is possible to specify whether or not this mode should be extended.Extended means that the user can select multiple items only when pressing the Shift or Ctrl key at the same time.

The default selection mode isSingle.

Access functions:

See alsoselectionMode().

resizeMode :ResizeMode

This property holds whether all, none or the only the last column should be resized.

Specifies whether all, none or only the last column should be resized to fit the full width of the list view. The values for this property can be one of:NoColumn (the default),AllColumns orLastColumn.

Warning: Setting the resize mode should be done after all necessary columns have been added to the list view, otherwise the behavior is undefined.

Access functions:

See alsoQ3Header andheader().

rootIsDecorated :bool

This property holds whether the list view shows open/close signs on root items.

Open/close signs are small+ or- symbols in windows style, or arrows in Motif style. The default is false.

Access functions:

selectionMode :SelectionMode

This property holds the list view's selection mode.

The mode can beSingle (the default),Extended,Multi orNoSelection.

Access functions:

See alsomultiSelection.

showSortIndicator :bool

This property holds whether the list view header should display a sort indicator.

If this property is true, an arrow is drawn in the header of the list view to indicate the sort order of the list view contents. The arrow will be drawn in the correct column and will point up or down, depending on the current sort direction. The default is false (don't show an indicator).

Access functions:

See alsoQ3Header::setSortIndicator().

showToolTips :bool

This property holds whether this list view should show tooltips for truncated column texts.

The default is true.

Access functions:

treeStepSize :int

This property holds the number of pixels a child is offset from its parent.

The default is 20 pixels.

Of course, this property is only meaningful for hierarchical list views.

Access functions:

Member Function Documentation

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

Constructs a new empty list view calledname with parentparent and widget attributesf.

This constructor sets theWA_StaticContent and theQt::WA_NoBackground attributes to boost performance when drawing Q3ListViewItems. This may be unsuitable for customQ3ListViewItem classes, in which caseQt::WA_StaticContents andQt::WA_NoBackground should be cleared on theviewport() after construction.

See alsoQWidget::setAttribute().

Q3ListView::~Q3ListView()

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

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

Adds awidth pixels wide column with the column headerlabel 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.

Ifwidth is negative, the new column'sWidthMode is set toMaximum instead ofManual.

See alsosetColumnText(),setColumnWidth(), andsetColumnWidthMode().

[virtual]int Q3ListView::addColumn(constQIcon & icon, constQString & label,int width = -1)

This is an overloaded function.

Adds awidth pixels wide new column with the headerlabel and theicon to the list view, and returns the index of the column.

Ifwidth is negative, the new column'sWidthMode is set toMaximum, and toManual otherwise.

See alsosetColumnText(),setColumnWidth(), andsetColumnWidthMode().

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

Adjusts the columncol to its preferred width

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

Reimplemented fromQWidget::changeEvent().

[virtual slot]void Q3ListView::clear()

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

See alsotriggerUpdate().

[virtual]void Q3ListView::clearSelection()

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

See alsosetSelected() andsetMultiSelection().

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

This signal is emitted whenever the user clicks (mouse pressedand 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 anyQ3ListViewItem objects in slots connected to this signal.

Note:Signalclicked is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*)>(&Q3ListView::clicked),[=](Q3ListViewItem*item){/* ... */ });

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

This is an overloaded function.

This signal is emitted whenever the user clicks (mouse pressedand 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. Ifitem is not 0,c is the list view column into which the user pressed; ifitem is 0c's value is undefined.

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

Note:Signalclicked is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*,constQPoint&,int)>(&Q3ListView::clicked),[=](Q3ListViewItem*item,constQPoint&pnt,int c){/* ... */ });

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

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

See alsosetOpen() andexpanded().

int Q3ListView::columnAlignment(int column) const

Returns the alignment of columncolumn. The default isQt::AlignAuto.

See alsosetColumnAlignment() andQt::Alignment.

QString Q3ListView::columnText(int c) const

Returns the text of columnc.

See alsosetColumnText().

int Q3ListView::columnWidth(int c) const

Returns the width of columnc.

See alsosetColumnWidth().

WidthMode Q3ListView::columnWidthMode(int c) const

Returns theWidthMode for columnc.

See alsosetColumnWidthMode().

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

Reimplemented fromQ3ScrollView::contentsContextMenuEvent().

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

Reimplemented fromQ3ScrollView::contentsDragEnterEvent().

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

Reimplemented fromQ3ScrollView::contentsDragLeaveEvent().

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

Reimplemented fromQ3ScrollView::contentsDragMoveEvent().

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

Reimplemented fromQ3ScrollView::contentsDropEvent().

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

Reimplemented fromQ3ScrollView::contentsMouseDoubleClickEvent().

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

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

Reimplemented fromQ3ScrollView::contentsMouseMoveEvent().

Processes the mouse move evente on behalf of the viewed widget.

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

Reimplemented fromQ3ScrollView::contentsMousePressEvent().

Processes the mouse press evente on behalf of the viewed widget.

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

Reimplemented fromQ3ScrollView::contentsMouseReleaseEvent().

Processes the mouse release evente on behalf of the viewed widget.

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

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

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

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 currentitem, 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 anyQ3ListViewItem objects in slots connected to this signal.

See alsosetCurrentItem() andcurrentItem().

Q3ListViewItem * Q3ListView::currentItem() const

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

See alsosetCurrentItem().

[protected slot]void Q3ListView::doAutoScroll()

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

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

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.

Note:SignaldoubleClicked is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*)>(&Q3ListView::doubleClicked),[=](Q3ListViewItem*item){/* ... */ });

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

This signal is emitted when a double-click occurs. It's emitted on the second button press, not the second button release. Theitem is theQ3ListViewItem the button was double-clicked on (which could be 0 if it wasn't double-clicked on an item). Thepoint 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; otherwisecolumn is -1.

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

Note:SignaldoubleClicked is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*,constQPoint&,int)>(&Q3ListView::doubleClicked),[=](Q3ListViewItem*item,constQPoint&point,int column){/* ... */ });

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

If the user presses the mouse on an item and starts moving the mouse, and the item allow dragging (seeQ3ListViewItem::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 aQ3DragObject depending on the selected items.

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

Reimplemented fromQ3ScrollView::drawContentsOffset().

CallsQ3ListViewItem::paintCell() andQ3ListViewItem::paintBranches() as necessary for all list view items that require repainting in thecw pixels wide andch pixels high bounding rectangle starting at positioncx,cy with offsetox,oy. Uses the painterp.

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

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(constQ3ListViewItem * i)

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

See alsoitemRect() andQ3ScrollView::ensureVisible().

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

Reimplemented fromQObject::eventFilter().

Redirects the evente relating to objecto, for the viewport tomousePressEvent(),keyPressEvent() and friends.

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

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

See alsosetOpen() andcollapsed().

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

Finds the first list view item in columncolumn, that matchestext and returns the item, or returns 0 of no such item could be found. Pass OR-ed togetherComparisonFlags values in thecompare 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 thisQ3ListView. Returns 0 if there is no first item.

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

See alsoitemAt(),Q3ListViewItem::itemBelow(), andQ3ListViewItem::itemAbove().

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

Reimplemented fromQWidget::focusInEvent().

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

Reimplemented fromQWidget::focusOutEvent().

Q3Header * Q3ListView::header() const

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

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

void Q3ListView::hideColumn(int column)

Hides the column specified atcolumn. This is a convenience function that callssetColumnWidth(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 alsosetColumnWidth().

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

Reimplemented fromQWidget::inputMethodQuery().

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

Inserts itemi into the list view as a top-level item. You do not need to call this unless you've calledtakeItem(i) orQ3ListViewItem::takeItem(i) and need to reinserti elsewhere.

See alsoQ3ListViewItem::takeItem() andtakeItem().

[virtual slot]void Q3ListView::invertSelection()

Inverts the selection. Only works inMulti andExtended selection modes.

bool Q3ListView::isOpen(constQ3ListViewItem * item) const

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

Identical toitem->isOpen(). Provided for completeness.

See alsosetOpen().

bool Q3ListView::isRenaming() const

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

bool Q3ListView::isSelected(constQ3ListViewItem * i) const

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

See alsoQ3ListViewItem::isSelected().

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

Returns the list view item atviewPos. Note thatviewPos is in theviewport()'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 ifviewPos points to the root decoration (seesetRootIsDecorated()) of the item. To check whether or notviewPos 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 decorationelse        ;// 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 alsoitemPos(),itemRect(), andviewportToContents().

int Q3ListView::itemPos(constQ3ListViewItem * item)

Returns the y-coordinate ofitem in the list view's coordinate system. This function is normally much slower thanitemAt() but it works for all items, whereasitemAt() normally works only for items on the screen.

This is a thin wrapper aroundQ3ListViewItem::itemPos().

See alsoitemAt() anditemRect().

QRect Q3ListView::itemRect(constQ3ListViewItem * item) const

Returns the rectangle on the screen that itemitem occupies inviewport()'s coordinates, or an invalid rectangle ifitem is 0 or is not currently visible.

The rectangle returned does not include any children of the rectangle (i.e. it usesQ3ListViewItem::height(), rather thanQ3ListViewItem::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.

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

This signal is emitted whenitem has been renamed totext, e.g. by in in-place renaming, in columncol.

Note:SignalitemRenamed is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*,int,constQString&)>(&Q3ListView::itemRenamed),[=](Q3ListViewItem*item,int col,constQString&text){/* ... */ });

See alsoQ3ListViewItem::setRenameEnabled().

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

This is an overloaded function.

This signal is emitted whenitem has been renamed, e.g. by in-place renaming, in columncol.

Note:SignalitemRenamed is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*,int)>(&Q3ListView::itemRenamed),[=](Q3ListViewItem*item,int col){/* ... */ });

See alsoQ3ListViewItem::setRenameEnabled().

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

Reimplemented fromQWidget::keyPressEvent().

Q3ListViewItem * Q3ListView::lastItem() const

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

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

[virtual]QSize Q3ListView::minimumSizeHint() const

Reimplemented fromQWidget::minimumSizeHint().

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

This signal is emitted whenever the user clicks (mouse pressedand mouse released) in the list view at positionpos.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. Ifitem is not 0,c is the list view column into which the user pressed; ifitem is 0c's value is undefined.

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

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

This signal is emitted whenever the user pressed the mouse button in the list view at positionpos.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. Ifitem is not 0,c is the list view column into which the user pressed; ifitem is 0c's value is undefined.

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

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

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

[signal]void Q3ListView::onViewport()

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

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

Paintsrect so that it looks like empty background using painterp.rect is in widget coordinates, ready to be fed top.

The default function fillsrect with theviewport()->backgroundBrush().

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

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 anyQ3ListViewItem objects in slots connected to this signal.

Note:Signalpressed is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*)>(&Q3ListView::pressed),[=](Q3ListViewItem*item){/* ... */ });

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

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, andc is the column where the mouse cursor was when the user pressed the mouse button.

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

Note:Signalpressed is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*,constQPoint&,int)>(&Q3ListView::pressed),[=](Q3ListViewItem*item,constQPoint&pnt,int c){/* ... */ });

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

Removes the column at positionindex.

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

Removes the givenitem. UsetakeItem() instead.

void Q3ListView::repaintItem(constQ3ListViewItem * item) const

Repaintsitem on the screen ifitem is currently visible. Takes care to avoid multiple repaints.

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

Reimplemented fromQWidget::resizeEvent().

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

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

This signal is emitted when Enter or Return is pressed. Theitem parameter is thecurrentItem().

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

This signal is emitted when the right button is clicked. Theitem is theQ3ListViewItem the button was clicked on (which could be 0 if it wasn't clicked on an item). Thepoint 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; otherwisecolumn is -1.

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

This signal is emitted when the right button is pressed. Theitem is theQ3ListViewItem the button was pressed on (which could be 0 if it wasn't pressed on an item). Thepoint 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; otherwisecolumn is -1.

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

Ifselect is true, all the items get selected; otherwise all the items get unselected. This only works in the selection modesMulti andExtended. InSingle andNoSelection mode the selection of the current item is just set toselect.

Q3ListViewItem * Q3ListView::selectedItem() const

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

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

See alsosetSelected() andsetMultiSelection().

[signal]void Q3ListView::selectionChanged()

This signal is emitted whenever the set of selected items has changed (normally before the screen update). It is available both inSingle selection andMulti selection mode but is most useful inMulti selection mode.

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

Note:SignalselectionChanged is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)()>(&Q3ListView::selectionChanged),[=](){/* ... */ });

See alsosetSelected() andQ3ListViewItem::setSelected().

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

This is an overloaded function.

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

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

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

Note:SignalselectionChanged is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(3ListView,static_cast<void(Q3ListView::*)(Q3ListViewItem*)>(&Q3ListView::selectionChanged),[=](Q3ListViewItem*item){/* ... */ });

See alsosetSelected(),Q3ListViewItem::setSelected(), andcurrentChanged().

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

Sets columncolumn's alignment toalign. The alignment is ultimately passed toQ3ListViewItem::paintCell() for each item in the list view. For horizontally aligned text withQt::AlignLeft orQt::AlignHCenter the ellipsis (...) will be to the right, forQt::AlignRight the ellipsis will be to the left.

See alsocolumnAlignment() andQt::Alignment.

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

Sets the heading of columncolumn tolabel.

See alsocolumnText().

[virtual]void Q3ListView::setColumnText(int column, constQIcon & icon, constQString & label)

This is an overloaded function.

Sets the heading of columncolumn toicon andlabel.

See alsocolumnText().

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

Sets the width of columncolumn tow pixels. Note that if the column has aWidthMode other thanManual, this width setting may be subsequently overridden.

See alsocolumnWidth().

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

Sets columnc's width mode tomode. The default depends on the original width argument toaddColumn().

See alsocolumnWidthMode() andQ3ListViewItem::width().

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

Reimplemented fromQ3ScrollView::setContentsPos().

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

Sets itemi 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 alsocurrentItem() andsetSelected().

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

Setsitem to be open ifopen is true anditem is expandable, and to be closed ifopen is false. Repaints accordingly.

See alsoisOpen(),Q3ListViewItem::setOpen(), andQ3ListViewItem::setExpandable().

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

Ifselected is true theitem is selected; otherwise it is unselected.

If the list view is inSingle selection mode andselected is true, the currently selected item is unselected anditem is made current. UnlikeQ3ListViewItem::setSelected(), this function updates the list view as necessary and emits theselectionChanged() signals.

setCurrentItem(),setSelectionAnchor()

See alsoisSelected(),setMultiSelection(), andisMultiSelection().

void Q3ListView::setSelectionAnchor(Q3ListViewItem * item)

Sets the selection anchor toitem, ifitem is selectable.

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

See alsosetSelected().

void Q3ListView::setSortColumn(int column)

Sets the sorting column for the list view.

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

See alsosortColumn() andsetSorting().

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

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

See alsosortOrder() andsetSorting().

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

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

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

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

Reimplemented fromQWidget::showEvent().

[virtual]QSize Q3ListView::sizeHint() const

Reimplemented fromQWidget::sizeHint().

[virtual]void Q3ListView::sort()

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 alsosetSortColumn() andsortOrder().

Qt::SortOrder Q3ListView::sortOrder() const

Returns the sorting order of the list view items.

See alsosetSortOrder() andsortColumn().

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

This signal is emitted when Space is pressed. Theitem parameter is thecurrentItem().

[virtual protected]void Q3ListView::startDrag()

Starts a drag.

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

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

See alsoinsertItem().

[slot]void Q3ListView::triggerUpdate()

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.

[protected slot]void Q3ListView::updateContents()

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

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

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

Reimplemented fromQ3ScrollView::viewportResizeEvent().