From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/qlistview.html | 1231 ----------------------------------------------- 1 file changed, 1231 deletions(-) delete mode 100644 doc/html/qlistview.html (limited to 'doc/html/qlistview.html') diff --git a/doc/html/qlistview.html b/doc/html/qlistview.html deleted file mode 100644 index b95403aba..000000000 --- a/doc/html/qlistview.html +++ /dev/null @@ -1,1231 +0,0 @@ - - - - - -TQListView Class - - - - - - - -
- -Home - | -All Classes - | -Main Classes - | -Annotated - | -Grouped Classes - | -Functions -

TQListView Class Reference

- -

The TQListView class implements a list/tree view. -More... -

#include <qlistview.h> -

Inherits TQScrollView. -

List of all member functions. -

Public Members

- -

Public Slots

- -

Signals

- -

Properties

- -

Protected Members

- -

Protected Slots

- -

Detailed Description

- - -The TQListView 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 the SelectionMode) and -sort the list in increasing or decreasing order by any column. -

The simplest pattern of use is to create a TQListView, add some -column headers using addColumn() and create one or more -TQListViewItem or TQCheckListItem objects with the TQListView as -parent: -

- -

        TQListView * table;
-
- -
        table->addColumn( "Qualified name" );
-        table->addColumn( "Namespace" );
-
            element = new TQListViewItem( table, qName, namespaceURI );
-
-

Further nodes can be added to the list view object (the root of the -tree) or as child nodes to TQListViewItems: -

            for ( int i = 0 ; i < attributes.length(); i++ ) {
-                new TQListViewItem( element, attributes.qName(i), attributes.uri(i) );
-            }
-
-

(From xml/tagreader-with-features/structureparser.cpp) -

The main setup functions are: -

-
Function Action -
addColumn() -Adds a column with a text label and perhaps width. Columns -are counted from the left starting with column 0. -
setColumnWidthMode() -Sets the column to be resized automatically or not. -
setAllColumnsShowFocus() -Sets whether items should show keyboard focus using all -columns or just column 0. The default is to show focus -just using column 0. -
setRootIsDecorated() -Sets whether root items should show open/close decoration to their left. -The default is FALSE. -
setTreeStepSize() -Sets how many pixels an item's children are indented -relative to their parent. The default is 20. This is -mostly a matter of taste. -
setSorting() -Sets whether the items should be sorted, whether it should -be in ascending or descending order, and by what column -they should be sorted. By default the list view is sorted -by the first column; to switch this off call setSorting(-1). -
-

To handle events such as mouse presses on the list view, derived -classes can reimplement the TQScrollView functions: -contentsMousePressEvent, -contentsMouseReleaseEvent, -contentsMouseDoubleClickEvent, -contentsMouseMoveEvent, -contentsDragEnterEvent, -contentsDragMoveEvent, -contentsDragLeaveEvent, -contentsDropEvent, and -contentsWheelEvent. -

There are also 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, -and itemPos() 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 using -TQListViewItem::itemBelow(); over a list view's top-level items -using TQListViewItem::firstChild() and -TQListViewItem::nextSibling(); or every item using a -TQListViewItemIterator. See -the TQListViewItem documentation for examples of traversal. -

An item can be moved amongst its siblings using -TQListViewItem::moveItem(). To move an item in the hierarchy use -takeItem() and insertItem(). Item's (and all their child items) -are deleted with delete; to delete all the list view's items -use clear(). -

There are a variety of selection modes described in the -TQListView::SelectionMode documentation. The default is Single -selection, which you can change using setSelectionMode(). -

Because TQListView 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()). -

TQListView emits two groups of signals; one group signals changes -in selection/focus state and one indicates selection. The first -group consists of selectionChanged() (applicable to all list -views), selectionChanged(TQListViewItem*) (applicable only to a -Single selection list view), and currentChanged(TQListViewItem*). -The second group consists of doubleClicked(TQListViewItem*), -returnPressed(TQListViewItem*), -rightButtonClicked(TQListViewItem*, const TQPoint&, 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 -a single 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, TQListView 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. -

If selectionMode() is Single (the default) the user can select -one item at a time, e.g. by clicking an item with the mouse, see -TQListView::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: -

-
Keypress Action -
Home -Make the first item current and visible. -
End -Make the last item current and visible. -
Page Up -Make the item above the top visible item current and visible. -
Page Down -Make the item below the bottom visible item current and visible. -
Up Arrow -Make the item above the current item current and visible. -
Down Arrow -Make the item below the current item current and visible. -
Left Arrow -If the current item is closed (+ icon) or has no -children, make its parent item current and visible. If the -current item is open (- icon) close it, i.e. hide its -children. Exception: if the current item is the first item -and is closed and the horizontal scrollbar is offset to -the right the list view will be scrolled left. -
Right Arrow -If the current item is closed (+ icon) and has -children, the item is opened. If the current item is -opened (- icon) and has children the item's first -child is made current and visible. If the current item has -no children the list view is scrolled right. -
-

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

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

-

See also TQListViewItem, TQCheckListItem, and Advanced Widgets. - -

Member Type Documentation

-

TQListView::RenameAction

- -

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

-

TQListView::ResizeMode

- -

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

-

TQListView::SelectionMode

- -

This enumerated type is used by TQListView 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, and NoSelection -is a list view where the user can look but not touch. - -

TQListView::WidthMode

- -

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

See also setColumnWidth(), setColumnWidthMode(), and columnWidth(). - -

Member Function Documentation

-

TQListView::TQListView ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 ) -

-Constructs a new empty list view called name with parent parent. -

Performance is boosted by modifying the widget flags f so that -only part of the TQListViewItem children is redrawn. This may be -unsuitable for custom TQListViewItem classes, in which case WStaticContents and WNoAutoErase should be cleared. -

See also TQWidget::clearWFlags() and TQt::WidgetFlags. - -

TQListView::~TQListView () -

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

int TQListView::addColumn ( const TQString & 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(). - -

Examples: addressbook/centralwidget.cpp, checklists/checklists.cpp, dirview/main.cpp, fileiconview/mainwindow.cpp, listviews/listviews.cpp, and qdir/qdir.cpp. -

int TQListView::addColumn ( const TQIconSet & iconset, const TQString & label, int width = -1 ) [virtual] -

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

Adds a width pixels wide new column with the header label -and the iconset 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 TQListView::adjustColumn ( int col ) [slot] -

Adjusts the column col to its preferred width -

bool TQListView::allColumnsShowFocus () const -

Returns TRUE if items should show keyboard focus using all columns; otherwise returns FALSE. -See the "allColumnsShowFocus" property for details. -

int TQListView::childCount () const -

Returns the number of parentless (top-level) TQListViewItem objects in this TQListView. -See the "childCount" property for details. -

void TQListView::clear () [virtual slot] -

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

Note that the currentChanged() signal is not emitted when this slot is invoked. -

See also triggerUpdate(). - -

Examples: addressbook/centralwidget.cpp, checklists/checklists.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. -

void TQListView::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 multiSelection. - -

Example: addressbook/centralwidget.cpp. -

void TQListView::clicked ( TQListViewItem * 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 TQListViewItem objects in slots -connected to this signal. - -

Example: addressbook/centralwidget.cpp. -

void TQListView::clicked ( TQListViewItem * item, const TQPoint & pnt, int c ) [signal] -

- -

This is an overloaded member function, provided for convenience. It behaves essentially like the above 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 TQListViewItem objects in slots -connected to this signal. - -

void TQListView::collapsed ( TQListViewItem * 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 TQListView::columnAlignment ( int column ) const -

-Returns the alignment of column column. The default is AlignAuto. -

See also TQt::AlignmentFlags. - -

TQString TQListView::columnText ( int c ) const -

-Returns the text of column c. -

See also setColumnText(). - -

int TQListView::columnWidth ( int c ) const -

-Returns the width of column c. -

See also setColumnWidth(). - -

WidthMode TQListView::columnWidthMode ( int c ) const -

-Returns the WidthMode for column c. -

See also setColumnWidthMode(). - -

int TQListView::columns () const -

Returns the number of columns in this list view. -See the "columns" property for details. -

void TQListView::contentsMouseDoubleClickEvent ( TQMouseEvent * e ) [virtual protected] -

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

Reimplemented from TQScrollView. -

void TQListView::contentsMouseMoveEvent ( TQMouseEvent * e ) [virtual protected] -

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

Example: dirview/dirview.cpp. -

Reimplemented from TQScrollView. -

void TQListView::contentsMousePressEvent ( TQMouseEvent * e ) [virtual protected] -

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

Example: dirview/dirview.cpp. -

Reimplemented from TQScrollView. -

void TQListView::contentsMouseReleaseEvent ( TQMouseEvent * e ) [virtual protected] -

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

Example: dirview/dirview.cpp. -

Reimplemented from TQScrollView. -

void TQListView::contextMenuRequested ( TQListViewItem * item, const TQPoint & 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. - -

Example: listviews/listviews.cpp. -

void TQListView::currentChanged ( TQListViewItem * ) [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 items in the -list view are deleted. -

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

See also setCurrentItem() and currentItem(). - -

Example: listviews/listviews.cpp. -

TQListViewItem * TQListView::currentItem () const -

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

See also setCurrentItem(). - -

Examples: addressbook/centralwidget.cpp, listviews/listviews.cpp, and qutlook/centralwidget.cpp. -

RenameAction TQListView::defaultRenameAction () const -

Returns what action to perform when the editor loses focus during renaming. -See the "defaultRenameAction" property for details. -

void TQListView::doAutoScroll () [protected slot] -

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

void TQListView::doubleClicked ( TQListViewItem *, const TQPoint &, int ) [signal] -

- -

This signal is emitted whenever an item is double-clicked. It's -emitted on the second button press, not the second button release. -The arguments are the relevant TQListViewItem (may be 0), the point -in global coordinates and the relevant column (or -1 if the click -was outside the list). -

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

void TQListView::doubleClicked ( TQListViewItem * item ) [signal] -

- -

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. -(use doubleClicked( TQListViewItem *, const TQPoint&, int )) -

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

TQDragObject * TQListView::dragObject () [virtual protected] -

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

void TQListView::drawContentsOffset ( TQPainter * p, int ox, int oy, int cx, int cy, int cw, int ch ) [virtual protected] -

-Calls TQListViewItem::paintCell() and -TQListViewItem::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. - -

Reimplemented from TQScrollView. -

void TQListView::dropped ( TQDropEvent * 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 TQListView::ensureItemVisible ( const TQListViewItem * 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 TQScrollView::ensureVisible(). - -

bool TQListView::eventFilter ( TQObject * o, TQEvent * e ) [virtual] -

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

Reimplemented from TQScrollView. -

void TQListView::expanded ( TQListViewItem * 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(). - -

TQListViewItem * TQListView::findItem ( const TQString & text, int column, ComparisonFlags compare = ExactMatch | 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. -The search starts from the current item if the current item exists, -otherwise it starts from the first list view item. After reaching -the last item the search continues from the first item. -Pass OR-ed together TQt::StringComparisonMode values -in the compare flag, to control how the matching is performed. -The default comparison mode is case-sensitive, exact match. - -

TQListViewItem * TQListView::firstChild () const -

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

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

See also itemAt(), TQListViewItem::itemBelow(), and TQListViewItem::itemAbove(). - -

Examples: addressbook/centralwidget.cpp and listviews/listviews.cpp. -

TQHeader * TQListView::header () const -

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

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

Examples: listviews/listviews.cpp and qdir/qdir.cpp. -

void TQListView::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(). - -

void TQListView::insertItem ( TQListViewItem * 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 -TQListViewItem::takeItem(i) and need to reinsert i elsewhere. -

See also TQListViewItem::takeItem() and takeItem(). - -

void TQListView::invertSelection () [virtual slot] -

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

bool TQListView::isMultiSelection () const -

Returns TRUE if the list view is in multi-selection or extended-selection mode; otherwise returns FALSE. -See the "multiSelection" property for details. -

bool TQListView::isOpen ( const TQListViewItem * item ) const -

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

See also setOpen(). - -

bool TQListView::isRenaming () const -

-Returns TRUE if an item is being renamed; otherwise returns FALSE. - -

bool TQListView::isSelected ( const TQListViewItem * i ) const -

-Returns TRUE if the list view item i is selected; otherwise -returns FALSE. -

See also TQListViewItem::isSelected(). - -

TQListViewItem * TQListView::itemAt ( const TQPoint & 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: -

-    TQListViewItem *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 TQListView::itemMargin () const -

Returns the advisory item margin that list items may use. -See the "itemMargin" property for details. -

int TQListView::itemPos ( const TQListViewItem * 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 TQListViewItem::itemPos(). -

See also itemAt() and itemRect(). - -

TQRect TQListView::itemRect ( const TQListViewItem * i ) const -

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

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

-    TQRect r( listView->itemRect( item ) );
-    r.setHeight( (TQCOORD)(TQMIN( 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 TQListView::itemRenamed ( TQListViewItem * item, int col, const TQString & 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 TQListViewItem::setRenameEnabled(). - -

void TQListView::itemRenamed ( TQListViewItem * item, int col ) [signal] -

- -

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

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

See also TQListViewItem::setRenameEnabled(). - -

TQListViewItem * TQListView::lastItem () const -

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

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

void TQListView::mouseButtonClicked ( int button, TQListViewItem * item, const TQPoint & 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 TQListViewItem objects in slots -connected to this signal. - -

void TQListView::mouseButtonPressed ( int button, TQListViewItem * item, const TQPoint & 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 TQListViewItem objects in slots -connected to this signal. - -

void TQListView::onItem ( TQListViewItem * i ) [signal] -

- -

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

void TQListView::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 TQListView::paintEmptyArea ( TQPainter * p, const TQRect & 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 TQListView::pressed ( TQListViewItem * 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 TQListViewItem objects in slots -connected to this signal. - -

void TQListView::pressed ( TQListViewItem * item, const TQPoint & pnt, int c ) [signal] -

- -

This is an overloaded member function, provided for convenience. It behaves essentially like the above 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 TQListViewItem objects in slots -connected to this signal. - -

void TQListView::removeColumn ( int index ) [virtual] -

-Removes the column at position index. -

If no columns remain after the column is removed, the -list view will be cleared. -

See also clear(). - -

void TQListView::removeItem ( TQListViewItem * item ) [virtual] -

- -This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. -

This function has been renamed takeItem(). - -

void TQListView::repaintItem ( const TQListViewItem * item ) const -

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

void TQListView::resizeEvent ( TQResizeEvent * e ) [virtual protected] -

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

ResizeMode TQListView::resizeMode () const -

Returns TRUE if all, none or the only the last column should be resized; otherwise returns FALSE. -See the "resizeMode" property for details. -

void TQListView::returnPressed ( TQListViewItem * ) [signal] -

- -

This signal is emitted when Enter or Return is pressed. The -argument is the currentItem(). - -

void TQListView::rightButtonClicked ( TQListViewItem *, const TQPoint &, int ) [signal] -

- -

This signal is emitted when the right button is clicked (i.e. when -it's released). The arguments are the relevant TQListViewItem (may -be 0), the point in global coordinates and the relevant column (or --1 if the click was outside the list). - -

void TQListView::rightButtonPressed ( TQListViewItem *, const TQPoint &, int ) [signal] -

- -

This signal is emitted when the right button is pressed. The -arguments are the relevant TQListViewItem (may be 0), the point in -global coordinates and the relevant column (or -1 if the click was -outside the list). - -

bool TQListView::rootIsDecorated () const -

Returns TRUE if the list view shows open/close signs on root items; otherwise returns FALSE. -See the "rootIsDecorated" property for details. -

void TQListView::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. - -

TQListViewItem * TQListView::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 multiSelection. - -

void TQListView::selectionChanged () [signal] -

- -

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

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

See also setSelected() and TQListViewItem::setSelected(). - -

Example: listviews/listviews.cpp. -

void TQListView::selectionChanged ( TQListViewItem * ) [signal] -

- -

This is an overloaded member function, provided for convenience. It behaves essentially like the above 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. If the selection is cleared -(when, for example, the user clicks in the unused area of the list -view) then this signal will not be emitted. -

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

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

See also setSelected(), TQListViewItem::setSelected(), and currentChanged(). - -

SelectionMode TQListView::selectionMode () const -

Returns the list view's selection mode. -See the "selectionMode" property for details. -

void TQListView::setAllColumnsShowFocus ( bool ) [virtual] -

Sets whether items should show keyboard focus using all columns. -See the "allColumnsShowFocus" property for details. -

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

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

See also TQt::AlignmentFlags. - -

Example: listviews/listviews.cpp. -

void TQListView::setColumnText ( int column, const TQString & label ) [virtual] -

-Sets the heading of column column to label. -

See also columnText(). - -

void TQListView::setColumnText ( int column, const TQIconSet & iconset, const TQString & label ) [virtual] -

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

Sets the heading of column column to iconset and label. -

See also columnText(). - -

void TQListView::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 TQListView::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 TQListViewItem::width(). - -

void TQListView::setCurrentItem ( TQListViewItem * 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. -

This function does not set the selection anchor. Use -setSelectionAnchor() instead. -

See also currentItem() and setSelected(). - -

Example: listviews/listviews.cpp. -

void TQListView::setDefaultRenameAction ( RenameAction a ) [virtual] -

Sets what action to perform when the editor loses focus during renaming to a. -See the "defaultRenameAction" property for details. -

void TQListView::setItemMargin ( int ) [virtual] -

Sets the advisory item margin that list items may use. -See the "itemMargin" property for details. -

void TQListView::setMultiSelection ( bool enable ) [virtual] -

Sets whether the list view is in multi-selection or extended-selection mode to enable. -See the "multiSelection" property for details. -

void TQListView::setOpen ( TQListViewItem * 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 TQListViewItem::setOpen() and TQListViewItem::setExpandable(). - -

void TQListView::setResizeMode ( ResizeMode m ) [virtual] -

Sets whether all, none or the only the last column should be resized to m. -See the "resizeMode" property for details. -

void TQListView::setRootIsDecorated ( bool ) [virtual] -

Sets whether the list view shows open/close signs on root items. -See the "rootIsDecorated" property for details. -

void TQListView::setSelected ( TQListViewItem * 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 TQListViewItem::setSelected(), this function -updates the list view as necessary and emits the -selectionChanged() signals. -

See also isSelected(), multiSelection, multiSelection, setCurrentItem(), and setSelectionAnchor(). - -

Example: listviews/listviews.cpp. -

void TQListView::setSelectionAnchor ( TQListViewItem * 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 TQListView::setSelectionMode ( SelectionMode mode ) -

Sets the list view's selection mode to mode. -See the "selectionMode" property for details. -

void TQListView::setShowSortIndicator ( bool show ) [virtual] -

Sets whether the list view header should display a sort indicator to show. -See the "showSortIndicator" property for details. -

void TQListView::setShowToolTips ( bool b ) [virtual] -

Sets whether this list view should show tooltips for truncated column texts to b. -See the "showToolTips" property for details. -

void TQListView::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 setSorting(). - -

void TQListView::setSortOrder ( SortOrder order ) -

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

See also setSorting(). - -

void TQListView::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 TQListView::setTreeStepSize ( int ) [virtual] -

Sets the number of pixels a child is offset from its parent. -See the "treeStepSize" property for details. -

bool TQListView::showSortIndicator () const -

Returns TRUE if the list view header should display a sort indicator; otherwise returns FALSE. -See the "showSortIndicator" property for details. -

bool TQListView::showToolTips () const -

Returns TRUE if this list view should show tooltips for truncated column texts; otherwise returns FALSE. -See the "showToolTips" property for details. -

void TQListView::sort () [virtual] -

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

int TQListView::sortColumn () const -

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

See also sortOrder(). - -

SortOrder TQListView::sortOrder () const -

-Returns the sorting order of the list view items. -

See also sortColumn(). - -

void TQListView::spacePressed ( TQListViewItem * ) [signal] -

- -

This signal is emitted when Space is pressed. The argument is -the currentItem(). - -

void TQListView::startDrag () [virtual protected] -

-Starts a drag. - -

void TQListView::takeItem ( TQListViewItem * i ) [virtual] -

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

See also insertItem(). - -

int TQListView::treeStepSize () const -

Returns the number of pixels a child is offset from its parent. -See the "treeStepSize" property for details. -

void TQListView::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 TQListView::updateContents () [protected slot] -

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

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

Property Documentation

-

bool allColumnsShowFocus

-

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

Set this property's value with setAllColumnsShowFocus() and get this property's value with allColumnsShowFocus(). -

int childCount

-

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

Holds the current number of parentless (top-level) TQListViewItem -objects in this TQListView. -

See also TQListViewItem::childCount(). - -

Get this property's value with childCount(). -

int columns

-

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

Get this property's value with columns(). -

See also addColumn() and removeColumn(). - -

RenameAction defaultRenameAction

-

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

If this property is Accept, 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 is Reject, -the item will not be renamed unless the user presses Enter. The -default is Reject. - -

Set this property's value with setDefaultRenameAction() and get this property's value with defaultRenameAction(). -

int itemMargin

-

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. -TQListViewItem::paintFocus() draws in the margin. -

See also TQListViewItem::paintCell(). - -

Set this property's value with setItemMargin() and get this property's value with itemMargin(). -

bool multiSelection

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. -

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 is Single. -

See also selectionMode. - -

Set this property's value with setMultiSelection() and get this property's value with isMultiSelection(). -

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 -or LastColumn. -

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

See also TQHeader and header(). - -

Set this property's value with setResizeMode() and get this property's value with resizeMode(). -

bool rootIsDecorated

-

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

Set this property's value with setRootIsDecorated() and get this property's value with rootIsDecorated(). -

SelectionMode selectionMode

-

This property holds the list view's selection mode. -

The mode can be Single (the default), Extended, Multi or -NoSelection. -

See also multiSelection. - -

Set this property's value with setSelectionMode() and get this property's value with selectionMode(). -

bool showSortIndicator

-

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

See also TQHeader::setSortIndicator(). - -

Set this property's value with setShowSortIndicator() and get this property's value with showSortIndicator(). -

bool showToolTips

-

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

The default is TRUE. - -

Set this property's value with setShowToolTips() and get this property's value with showToolTips(). -

int treeStepSize

-

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

Set this property's value with setTreeStepSize() and get this property's value with treeStepSize(). - -

-This file is part of the TQt toolkit. -Copyright © 1995-2007 -Trolltech. All Rights Reserved.

- -
Copyright © 2007 -TrolltechTrademarks -
TQt 3.3.8
-
- -- cgit v1.2.1