kdeui Library API Documentation

KListView Class Reference

This Widget extends the functionality of QListView to honor the system wide settings for Single Click/Double Click mode, AutoSelection and ChangeCursorOverLink (TM). More...

#include <klistview.h>

Inheritance diagram for KListView:

QListView List of all members.

Public Types

enum  SelectionModeExt {
  Single = QListView::Single, Multi = QListView::Multi, Extended = QListView::Extended, NoSelection = QListView::NoSelection,
  FileManager
}

Public Slots

virtual void rename (QListViewItem *item, int c)
void setRenameable (int column, bool yesno=true)
virtual void setItemsMovable (bool b)
virtual void setItemsRenameable (bool b)
virtual void setDragEnabled (bool b)
virtual void setAutoOpen (bool b)
virtual void setDropVisualizer (bool b)
void setDropVisualizerWidth (int w)
virtual void setTooltipColumn (int column)
virtual void setDropHighlighter (bool b)
virtual void setCreateChildren (bool b) KDE_DEPRECATED
void setSelectionModeExt (SelectionModeExt mode)
void setTabOrderedRenaming (bool b)
bool tabOrderedRenaming () const

Signals

void executed (QListViewItem *item)
void executed (QListViewItem *item, const QPoint &pos, int c)
void dropped (QDropEvent *e, QListViewItem *after)
void dropped (KListView *list, QDropEvent *e, QListViewItem *after)
void dropped (KListView *list, QDropEvent *e, QListViewItem *parent, QListViewItem *after)
void dropped (QDropEvent *e, QListViewItem *parent, QListViewItem *after)
void moved ()
void aboutToMove ()
void moved (QListViewItem *item, QListViewItem *afterFirst, QListViewItem *afterNow)
void moved (QPtrList< QListViewItem > &items, QPtrList< QListViewItem > &afterFirst, QPtrList< QListViewItem > &afterNow)
void itemRenamed (QListViewItem *item, const QString &str, int col)
void itemRenamed (QListViewItem *item)
void menuShortCutPressed (KListView *list, QListViewItem *item)
void contextMenu (KListView *l, QListViewItem *i, const QPoint &p)
void itemAdded (QListViewItem *item)
void itemRemoved (QListViewItem *item)

Public Member Functions

 KListView (QWidget *parent=0, const char *name=0)
virtual ~KListView ()
virtual void setAcceptDrops (bool)
virtual bool isExecuteArea (const QPoint &point)
bool isExecuteArea (int x)
QPtrList< QListViewItemselectedItems () const
QPtrList< QListViewItemselectedItems (bool includeHiddenItems) const
void moveItem (QListViewItem *item, QListViewItem *parent, QListViewItem *after)
QListViewItemlastItem () const
QListViewItemlastChild () const
KLineEditrenameLineEdit () const
bool itemsMovable () const
bool itemsRenameable () const
bool dragEnabled () const
bool autoOpen () const
bool isRenameable (int column) const
bool dropVisualizer () const
int tooltipColumn () const
bool createChildren () const KDE_DEPRECATED
bool dropHighlighter () const
int dropVisualizerWidth () const
SelectionModeExt selectionModeExt () const
int itemIndex (const QListViewItem *item) const
QListViewItemitemAtIndex (int index)
void setFullWidth () KDE_DEPRECATED
void setFullWidth (bool fullWidth)
bool fullWidth () const
virtual int addColumn (const QString &label, int width=-1)
virtual int addColumn (const QIconSet &iconset, const QString &label, int width=-1)
virtual void removeColumn (int index)
void setAlternateBackground (const QColor &c)
const QColoralternateBackground () const
void saveLayout (KConfig *config, const QString &group) const
void restoreLayout (KConfig *config, const QString &group)
virtual void setSorting (int column, bool ascending=true)
int columnSorted (void) const
bool ascendingSort (void) const
virtual void takeItem (QListViewItem *i)
void setShadeSortColumn (bool shadeSortColumn)
bool shadeSortColumn (void) const

Protected Slots

void slotSettingsChanged (int)
void slotMouseButtonClicked (int btn, QListViewItem *item, const QPoint &pos, int c)
void doneEditing (QListViewItem *item, int row)
void cleanDropVisualizer ()
void cleanItemHighlighter ()
void emitContextMenu (QListViewItem *, const QPoint &, int)
void emitContextMenu (KListView *, QListViewItem *)
void slotOnItem (QListViewItem *item)
void slotOnViewport ()
void slotAutoSelect ()
void slotDragExpand ()
void slotHeaderChanged ()

Protected Member Functions

bool below (const QRect &rect, const QPoint &p)
bool below (QListViewItem *i, const QPoint &p)
virtual bool event (QEvent *)
void emitExecute (QListViewItem *item, const QPoint &pos, int c)
virtual void focusInEvent (QFocusEvent *fe)
virtual void focusOutEvent (QFocusEvent *fe)
virtual void leaveEvent (QEvent *e)
virtual QString tooltip (QListViewItem *item, int column) const
virtual bool showTooltip (QListViewItem *item, const QPoint &pos, int column) const
virtual void contentsDragMoveEvent (QDragMoveEvent *event)
virtual void contentsMousePressEvent (QMouseEvent *e)
virtual void contentsMouseMoveEvent (QMouseEvent *e)
virtual void contentsMouseDoubleClickEvent (QMouseEvent *e)
virtual void contentsDragLeaveEvent (QDragLeaveEvent *event)
virtual void contentsMouseReleaseEvent (QMouseEvent *)
virtual void contentsDropEvent (QDropEvent *)
virtual void contentsDragEnterEvent (QDragEnterEvent *)
virtual QDragObjectdragObject ()
virtual bool acceptDrag (QDropEvent *event) const
virtual QRect drawDropVisualizer (QPainter *p, QListViewItem *parent, QListViewItem *after)
virtual QRect drawItemHighlighter (QPainter *painter, QListViewItem *item)
virtual void startDrag ()
virtual void keyPressEvent (QKeyEvent *)
virtual void viewportPaintEvent (QPaintEvent *)
void activateAutomaticSelection ()
void deactivateAutomaticSelection ()
bool automaticSelection () const
virtual void viewportResizeEvent (QResizeEvent *e)
void disableAutoSelection ()
void resetAutoSelection ()
void doubleClicked (QListViewItem *item, const QPoint &pos, int c)
virtual void movableDropEvent (QListViewItem *parent, QListViewItem *afterme)
virtual void findDrop (const QPoint &pos, QListViewItem *&parent, QListViewItem *&after)
void fileManagerKeyPressEvent (QKeyEvent *)
int depthToPixels (int depth)
virtual void virtual_hook (int id, void *data)

Properties

bool fullWidth
bool itemsMovable
bool itemsRenameable
bool dragEnabled
bool autoOpen
bool dropVisualizer
int tooltipColumn
int dropVisualizerWidth
QColor alternateBackground
bool shadeSortColumn

Friends

class KListViewItem

Detailed Description

This Widget extends the functionality of QListView to honor the system wide settings for Single Click/Double Click mode, AutoSelection and ChangeCursorOverLink (TM).

There is a new signal executed(). It gets connected to either QListView::clicked() or QListView::doubleClicked() depending on the KDE wide Single Click/Double Click settings. It is strongly recommended that you use this signal instead of the above mentioned. This way you donīt need to care about the current settings. If you want to get informed when the user selects something connect to the QListView::selectionChanged() signal.

Drag-and-Drop is supported with the signal dropped(), just setAcceptDrops(true) and connect it to a suitable slot. To see where you are dropping, setDropVisualizer(true). And also you'll need acceptDrag(QDropEvent*)

KListView is drag-enabled, too: to benefit from that you've got derive from it. Reimplement dragObject() and (possibly) startDrag(), and setDragEnabled(true).

Definition at line 53 of file klistview.h.


Member Enumeration Documentation

enum KListView::SelectionModeExt
 

Possible selection modes.

The first four correspond directly to QListView::SelectionMode, while the FileManager selection mode is defined as follows:

  • home: move to the first
  • end: move to the last
  • PgUp/PgDn: move one page up/down
  • up/down: move one item up/down
  • insert: toggle selection of current and move to the next
  • space: toggle selection of the current
  • CTRL+up: move to the previous item and toggle selection of this one
  • CTRL+down: toggle selection of the current item and move to the next
  • CTRL+end: toggle selection from (including) the current item to (including) the last item
  • CTRL+home: toggle selection from (including) the current item to the (including) the first item
  • CTRL+PgDn: toggle selection from (including) the current item to (excluding) the item one page down
  • CTRL+PgUp: toggle selection from (excluding) the current item to (including) the item one page up
The combinations work the same with SHIFT instead of CTRL, except that if you start selecting something using SHIFT everything selected before will be deselected first.

Additionally the current item is always selected automatically when navigating using the keyboard, except other items were selected explicitly.

This way e.g. SHIFT+up/PgUp then SHIFT+down/PgDn leaves no item selected

Definition at line 104 of file klistview.h.


Constructor & Destructor Documentation

KListView::KListView QWidget parent = 0,
const char *  name = 0
 

Constructor.

The parameters parent and name are handled by QListView, as usual.

Definition at line 411 of file klistview.cpp.

References KGlobalSettings::alternateBackgroundColor(), cleanDropVisualizer(), cleanItemHighlighter(), emitContextMenu(), menuShortCutPressed(), QListView::onItem(), QListView::onViewport(), QListView::rightButtonClicked(), QListView::rightButtonPressed(), slotAutoSelect(), slotDragExpand(), slotOnItem(), slotOnViewport(), and slotSettingsChanged().

KListView::~KListView  )  [virtual]
 

Destructor.

Definition at line 456 of file klistview.cpp.


Member Function Documentation

void KListView::setAcceptDrops bool   )  [virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Definition at line 1896 of file klistview.cpp.

bool KListView::isExecuteArea const QPoint point  )  [virtual]
 

This function determines whether the given coordinates are within the execute area.

The execute area is the part of a QListViewItem where mouse clicks or double clicks respectively generate a executed() signal. Depending on QListView::allColumnsShowFocus() this is either the whole item or only the first column.

Returns:
true if point is inside execute area of an item, false in all other cases including the case that it is over the viewport.

Definition at line 461 of file klistview.cpp.

References QListView::itemAt(), and QPoint::x().

Referenced by contentsDragMoveEvent(), contentsMouseMoveEvent(), emitExecute(), isExecuteArea(), and slotOnItem().

bool KListView::isExecuteArea int  x  ) 
 

Same thing, but from an x coordinate only.

This only checks if x is in the first column (if all columns don't show focus), without testing if the y coordinate is over an item or not.

Definition at line 471 of file klistview.cpp.

References isExecuteArea().

QPtrList< QListViewItem > KListView::selectedItems  )  const
 

Returns:
a list containing the currently selected items.
Deprecated:

Definition at line 1208 of file klistview.cpp.

Referenced by fileManagerKeyPressEvent().

QPtrList< QListViewItem > KListView::selectedItems bool  includeHiddenItems  )  const
 

Returns:
a list containing the currently selected items.
Parameters:
includeHiddenItems Set to true to return all items regardless of visibility. Set to false to only return items that are isVisible().
Returns:
a list of all selected listview items
Since:
3.4

Definition at line 1213 of file klistview.cpp.

References QPtrList::append(), QListViewItemIterator::current(), QListView::selectedItem(), and QListView::selectionMode().

void KListView::moveItem QListViewItem item,
QListViewItem parent,
QListViewItem after
 

Arbitrarily move item to parent, positioned immediately after item after.

If after is 0, item is made the first child of parent.

(Un-deprecated in kde-3.4)

Definition at line 1250 of file klistview.cpp.

References QListView::insertItem(), QListViewItem::insertItem(), QListViewItem::moveItem(), QListViewItem::parent(), and takeItem().

Referenced by movableDropEvent().

QListViewItem * KListView::lastItem  )  const
 

Returns:
the last item (not child!) of this listview.
See also:
lastChild()

Definition at line 1122 of file klistview.cpp.

References lastChild().

Referenced by findDrop().

QListViewItem * KListView::lastChild  )  const
 

Returns:
the last child of this listview.
See also:
lastItem()

Definition at line 1112 of file klistview.cpp.

References QListView::firstChild(), and QListViewItem::nextSibling().

Referenced by lastItem().

KLineEdit * KListView::renameLineEdit  )  const
 

Returns:
the lineedit used for inline renaming. Use that to setup a KCompletion or QValidator for the lineedit
Since:
3.2

Definition at line 1132 of file klistview.cpp.

bool KListView::itemsMovable  )  const
 

Returns:
if it is legal to move items in the list view. True by default.
See also:
setDragEnabled()

setItemsMovable()

Referenced by acceptDrag(), and contentsDropEvent().

bool KListView::itemsRenameable  )  const
 

Returns:
whether inplace-renaming has been enabled. False by default.
See also:
setItemsRenameable()

Referenced by contentsMouseReleaseEvent().

bool KListView::dragEnabled  )  const
 

Returns:
whether dragging is enabled. False by default.
See also:
setDragEnabled()

Referenced by contentsMouseMoveEvent().

bool KListView::autoOpen  )  const
 

Returns:
true if AutoOpen is enabled (not implemented currently).
See also:
setAutoOpen()

bool KListView::isRenameable int  column  )  const
 

Returns:
true if column is renamable.
See also:
setRenameable()

Definition at line 1373 of file klistview.cpp.

bool KListView::dropVisualizer  )  const
 

Returns:
true if drawing of the drop-visualizer has been enabled. True by default.
See also:
setDropVisualizer()

Referenced by contentsDragMoveEvent().

int KListView::tooltipColumn  )  const
 

Returns:
the column for which tooltips are displayed (or -1 if none set).
See also:
setTooltipColumn()

Referenced by showTooltip().

bool KListView::createChildren  )  const
 

For future expansions.

Do not use.

Deprecated:

Definition at line 1403 of file klistview.cpp.

bool KListView::dropHighlighter  )  const
 

Returns:
true if drawing of the drop-highlighter has been enabled. False by default.
See also:
setDropHighlighter()

Definition at line 1424 of file klistview.cpp.

Referenced by contentsDragMoveEvent().

int KListView::dropVisualizerWidth  )  const
 

The dropVisualizerWidth defaults to 4.

See also:
setDropVisualizerWidth()
Returns:
the current width of the drop-visualizer.

KListView::SelectionModeExt KListView::selectionModeExt  )  const
 

Returns:
the "extended" selection mode of this listview.
See also:
SelectionModeExt

setSelectionModeExt

Definition at line 1839 of file klistview.cpp.

Referenced by contentsMousePressEvent().

int KListView::itemIndex const QListViewItem item  )  const
 

Returns the index of item within the item tree or -1 if item doesn't exist in this list view.

This function takes all items into account not only the visible ones.

Definition at line 1844 of file klistview.cpp.

References QListViewItemIterator::current(), and QListView::firstChild().

Referenced by slotAutoSelect().

QListViewItem * KListView::itemAtIndex int  index  ) 
 

Returns the item of index within the item tree or 0 if index doesn't exist in this list view.

This function takes all items into account not only the visible ones.

Definition at line 1863 of file klistview.cpp.

References QListView::firstChild().

void KListView::setFullWidth  ) 
 

Deprecated:
See also:
setFullWidth()

Definition at line 1935 of file klistview.cpp.

void KListView::setFullWidth bool  fullWidth  ) 
 

Let the last column fit exactly all the available width.

See also:
fullWidth()

Definition at line 1940 of file klistview.cpp.

References QListView::columns(), and QListView::header().

bool KListView::fullWidth  )  const
 

Returns whether the last column is set to fit the available width.

See also:
setFullWidth()

int KListView::addColumn const QString label,
int  width = -1
[virtual]
 

Reimplemented for full width support.

See also:
removeColumn()

Reimplemented from QListView.

Definition at line 1951 of file klistview.cpp.

References QListView::addColumn(), QListView::columns(), and QListView::header().

Referenced by KJanusWidget::KJanusWidget().

int KListView::addColumn const QIconSet iconset,
const QString label,
int  width = -1
[virtual]
 

Reimplemented for full width support.

Reimplemented from QListView.

Definition at line 1961 of file klistview.cpp.

References QListView::addColumn(), QListView::columns(), and QListView::header().

void KListView::removeColumn int  index  )  [virtual]
 

Reimplemented for full width support.

See also:
addColumn()

Reimplemented from QListView.

Definition at line 1971 of file klistview.cpp.

References QListView::columns(), QListView::header(), and QListView::removeColumn().

void KListView::setAlternateBackground const QColor c  ) 
 

sets the alternate background background color.

This only has an effect if the items are KListViewItems

Parameters:
c the color to use for every other item. Set to an invalid color to disable alternate colors.
See also:
alternateBackground()

Definition at line 1987 of file klistview.cpp.

const QColor& KListView::alternateBackground  )  const
 

Returns:
the alternate background color
See also:
setAlternateBackground()

void KListView::saveLayout KConfig config,
const QString group
const
 

Saves the list view's layout (column widtsh, column order, sort column) to a KConfig group.

Parameters:
config the KConfig object to write to
group the config group to use

Definition at line 2004 of file klistview.cpp.

References QListView::columns(), QListView::columnWidth(), QListView::header(), QHeader::mapToIndex(), QString::number(), and KConfigBase::writeEntry().

void KListView::restoreLayout KConfig config,
const QString group
 

Reads the list view's layout from a KConfig group as stored with saveLayout.

Parameters:
config the KConfig object to read from
group the config group to use

Definition at line 2022 of file klistview.cpp.

References QListView::columns(), KConfigBase::hasKey(), QListView::header(), KConfigBase::readBoolEntry(), KConfigBase::readListEntry(), KConfigBase::readNumEntry(), QListView::setColumnWidth(), and setSorting().

void KListView::setSorting int  column,
bool  ascending = true
[virtual]
 

Reimplemented to remember the current sort column and order.

Parameters:
column is the column to be sorted, or -1 to sort in order of insertion
ascending whether to sort ascending (or descending)

Reimplemented from QListView.

Definition at line 2057 of file klistview.cpp.

References QListView::ensureItemVisible(), QListView::firstChild(), QListViewItem::isSelected(), QListViewItem::isVisible(), QListViewItem::itemBelow(), KListViewItem::m_known, QListView::selectedItem(), QListView::selectionMode(), and QListView::setSorting().

Referenced by KJanusWidget::KJanusWidget(), and restoreLayout().

int KListView::columnSorted void   )  const
 

Returns:
the currently sorted column, or -1 if none is sorted

Definition at line 2090 of file klistview.cpp.

Referenced by KListViewItem::backgroundColor().

bool KListView::ascendingSort void   )  const
 

Returns:
whether the current sort is ascending (or descending)

Definition at line 2095 of file klistview.cpp.

void KListView::takeItem QListViewItem i  )  [virtual]
 

Reimplemented for internal reasons.

Reimplemented from QListView.

Definition at line 2100 of file klistview.cpp.

References QListView::takeItem().

Referenced by moveItem().

void KListView::setShadeSortColumn bool  shadeSortColumn  ) 
 

Set to true if the currently sorted column should be drawn shaded.

Defaults to true

Parameters:
shadeSortColumn True if sort column should be shaded.
Since:
3.4

Definition at line 1993 of file klistview.cpp.

bool KListView::shadeSortColumn void   )  const
 

See if the sort column should be drawn shaded.

Returns:
true if the sort column should be shaded
Since:
3.4

void KListView::executed QListViewItem item  )  [signal]
 

This signal is emitted whenever the user executes an listview item.

That means depending on the KDE wide Single Click/Double Click setting the user clicked or double clicked on that item.

Parameters:
item is the pointer to the executed listview item.
Note that you may not delete any QListViewItem objects in slots connected to this signal.

Referenced by emitExecute().

void KListView::executed QListViewItem item,
const QPoint pos,
int  c
[signal]
 

This signal is emitted whenever the user executes an listview item.

That means depending on the KDE wide Single Click/Double Click setting the user clicked or double clicked on that item.

Parameters:
item is the pointer to the executed listview item.
pos is the position where the user has clicked
c is the column into which the user clicked.
Note that you may not delete any QListViewItem objects in slots connected to this signal.

void KListView::dropped QDropEvent e,
QListViewItem after
[signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

Parameters:
e is the drop event itself (it has already been accepted)
after is the item after which the drop occurred (or 0L, if the drop was above all items)
See also:
acceptDrop()

Reimplemented in KFileTreeView.

Referenced by contentsDropEvent().

void KListView::dropped KListView list,
QDropEvent e,
QListViewItem after
[signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

This is an overloaded version of the above (provided to simplify processing drops outside of the class).

Parameters:
list is the listview
e is the drop event itself (it has already been accepted)
after is the item after which the drop occurred (or 0L, if the drop was above all items

void KListView::dropped KListView list,
QDropEvent e,
QListViewItem parent,
QListViewItem after
[signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

This function also provides a parent, in the event that your listview is a tree

Parameters:
list is the listview
e is the drop event itself (it has already been accepted)
parent the item that is to be the parent of the new item
after is the item after which the drop occurred (or 0L, if the drop was above all items

void KListView::dropped QDropEvent e,
QListViewItem parent,
QListViewItem after
[signal]
 

This signal gets emitted whenever something acceptable is dropped onto the listview.

This function also provides a parent, in the event that your listview is a tree

Parameters:
e is the drop event itself (it has already been accepted)
parent the item that is to be the parent of the new item
after is the item after which the drop occurred (or 0L, if the drop was above all items

Reimplemented in KFileTreeView.

void KListView::moved  )  [signal]
 

This signal is emitted when ever the user moves an item in the list via DnD.

If more than one item is moved at the same time, this signal is only emitted once.

Referenced by movableDropEvent(), and startDrag().

void KListView::aboutToMove  )  [signal]
 

Connect to this signal if you want to do some preprocessing before a move is made, for example, to disable sorting.

This is sent only once per each groups of moves. That is, for each drop that is a move this will be emitted once, before KListView calls

See also:
moveItem()

Referenced by movableDropEvent().

void KListView::moved QListViewItem item,
QListViewItem afterFirst,
QListViewItem afterNow
[signal]
 

This signal is emitted when ever the user moves an item in the list via DnD.

If more than one item is moved at the same time, afterFirst and afterNow will reflect what was true before the move. This differs from moved(), so be careful. All the items will have been moved before moved() is emitted, which is not true in this method. // FIXME

Parameters:
item the item that was moved
afterFirst the item that parameter item was in before the move, in the list
afterNow the item it's currently after.

void KListView::moved QPtrList< QListViewItem > &  items,
QPtrList< QListViewItem > &  afterFirst,
QPtrList< QListViewItem > &  afterNow
[signal]
 

This signal is emitted after all the items have been moved.

It reports info for each and every item moved, in order. The first element in items associates with the first of afterFirst and afterNow.

void KListView::itemRenamed QListViewItem item,
const QString str,
int  col
[signal]
 

This signal gets emitted when an item is renamed via in-place renaming.

Parameters:
item is the renamed item.
str is the new value of column col.
col is the renamed column.

Referenced by doneEditing().

void KListView::itemRenamed QListViewItem item  )  [signal]
 

Same as above, but without the extra information.

void KListView::menuShortCutPressed KListView list,
QListViewItem item
[signal]
 

This signal is emitted when the shortcut key for popup-menus is pressed.

Normally you should not use this, just connect a slot to signal contextMenu (KListView*, QListViewItem*, const QPoint&) to correctly handle showing context menus regardless of settings.

Parameters:
list is this listview.
item is the currentItem() at the time the key was pressed. May be 0L.

Referenced by keyPressEvent(), and KListView().

void KListView::contextMenu KListView l,
QListViewItem i,
const QPoint p
[signal]
 

This signal is emitted whenever a context-menu should be shown for item i.

It automatically adjusts for all settings involved (Menu key, showMenuOnPress/Click).

Parameters:
l is this listview.
i is the item for which the menu should be shown. May be 0L.
p is the point at which the menu should be shown.

Referenced by emitContextMenu().

void KListView::rename QListViewItem item,
int  c
[virtual, slot]
 

Rename column c of item.

Definition at line 1364 of file klistview.cpp.

References QListView::ensureItemVisible().

Referenced by contentsMouseReleaseEvent(), and KListViewLineEdit::selectNextCell().

void KListView::setRenameable int  column,
bool  yesno = true
[slot]
 

By default, if you called setItemsRenameable(true), only the first column is renameable.

Use this function to enable the feature on other columns.

If you want more intelligent (dynamic) selection, you'll have to derive from KListView, and override rename() and call only call it if you want the item to be renamed.

Definition at line 1378 of file klistview.cpp.

References QListView::header().

void KListView::setItemsMovable bool  b  )  [virtual, slot]
 

Set whether items in the list view can be moved.

It is enabled by default.

See also:
itemsMovable()

Definition at line 1157 of file klistview.cpp.

void KListView::setItemsRenameable bool  b  )  [virtual, slot]
 

Enables inplace-renaming of items.

It is disabled by default.

See also:
itemsRenameable()

setRenameable()

Definition at line 1167 of file klistview.cpp.

void KListView::setDragEnabled bool  b  )  [virtual, slot]
 

Enable/Disable the dragging of items.

It is disabled by default.

Definition at line 1178 of file klistview.cpp.

void KListView::setAutoOpen bool  b  )  [virtual, slot]
 

Enable/Disable AutoOpen (not implemented currently).

Definition at line 1188 of file klistview.cpp.

void KListView::setDropVisualizer bool  b  )  [virtual, slot]
 

Enable/Disable the drawing of a drop-visualizer (a bar that shows where a dropped item would be inserted).

It is enabled by default, if dragging is enabled

Definition at line 1203 of file klistview.cpp.

void KListView::setDropVisualizerWidth int  w  )  [slot]
 

Set the width of the (default) drop-visualizer.

If you don't call this method, the width is set to 4.

Definition at line 1286 of file klistview.cpp.

void KListView::setTooltipColumn int  column  )  [virtual, slot]
 

Set which column should be used for automatic tooltips.

Parameters:
column is the column for which tooltips will be shown. Set -1 to disable this feature.

Definition at line 1414 of file klistview.cpp.

void KListView::setDropHighlighter bool  b  )  [virtual, slot]
 

Enable/Disable the drawing of a drop-highlighter (a rectangle around the item under the mouse cursor).

It is disabled by default.

Definition at line 1419 of file klistview.cpp.

void KListView::setCreateChildren bool  b  )  [virtual, slot]
 

For future expansions.

Do not use.

Deprecated:

Definition at line 1398 of file klistview.cpp.

void KListView::setSelectionModeExt SelectionModeExt  mode  )  [slot]
 

Set the selection mode.

A different name was chosen to avoid API-clashes with QListView::setSelectionMode().

Definition at line 1816 of file klistview.cpp.

References endl(), kdWarning(), and QListView::setSelectionMode().

void KListView::setTabOrderedRenaming bool  b  )  [slot]
 

Enable/disable tabbing between editable cells.

Since:
3.1

Definition at line 1439 of file klistview.cpp.

bool KListView::tabOrderedRenaming  )  const [slot]
 

Returns whether tab ordered renaming is enabled.

Since:
3.1

Definition at line 1444 of file klistview.cpp.

Referenced by KListViewLineEdit::event().

bool KListView::below const QRect rect,
const QPoint p
[inline, protected]
 

Determine whether a drop on position p would count as being above or below the QRect rect.

Parameters:
rect is the rectangle we examine.
p is the point located in the rectangle, p is assumed to be in viewport coordinates.

Definition at line 671 of file klistview.h.

bool KListView::below QListViewItem i,
const QPoint p
[inline, protected]
 

An overloaded version of below(const QRect&, const QPoint&).

It differs from the above only in what arguments it takes.

Parameters:
i the item whose rect() is passed to the above function.
p is translated from contents coordinates to viewport coordinates before being passed to the above function.

Definition at line 685 of file klistview.h.

References QListView::itemRect().

bool KListView::event QEvent  )  [protected, virtual]
 

Reimplemented to reload the alternate background in palette changes.

Definition at line 739 of file klistview.cpp.

References KGlobalSettings::alternateBackgroundColor(), and QEvent::type().

void KListView::emitExecute QListViewItem item,
const QPoint pos,
int  c
[protected]
 

Emit signal executed.

Definition at line 666 of file klistview.cpp.

References executed(), isExecuteArea(), and KApplication::keyboardMouseState().

Referenced by contentsMouseDoubleClickEvent(), and slotMouseButtonClicked().

void KListView::focusInEvent QFocusEvent fe  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Definition at line 694 of file klistview.cpp.

References QListView::currentItem(), QFocusEvent::reason(), and QListView::selectionChanged().

void KListView::focusOutEvent QFocusEvent fe  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Definition at line 710 of file klistview.cpp.

References cleanDropVisualizer(), cleanItemHighlighter(), QListView::currentItem(), QFocusEvent::reason(), and QListView::selectionChanged().

void KListView::leaveEvent QEvent e  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Definition at line 732 of file klistview.cpp.

QString KListView::tooltip QListViewItem item,
int  column
const [protected, virtual]
 

Returns:
the tooltip for column of item.

Definition at line 1434 of file klistview.cpp.

References QListViewItem::text().

Referenced by showTooltip().

bool KListView::showTooltip QListViewItem item,
const QPoint pos,
int  column
const [protected, virtual]
 

Returns:
whether the tooltip for column of item shall be shown at point pos.

Definition at line 1429 of file klistview.cpp.

References tooltip(), and tooltipColumn().

void KListView::contentsDragMoveEvent QDragMoveEvent event  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 971 of file klistview.cpp.

References acceptDrag(), cleanDropVisualizer(), cleanItemHighlighter(), drawDropVisualizer(), drawItemHighlighter(), dropHighlighter(), dropVisualizer(), findDrop(), QDragMoveEvent::ignore(), isExecuteArea(), QListView::itemAt(), and QApplication::startDragTime().

void KListView::contentsMousePressEvent QMouseEvent e  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from QListView.

Definition at line 747 of file klistview.cpp.

References QMouseEvent::button(), QListView::clearSelection(), QListView::contentsMousePressEvent(), QListView::currentItem(), QListViewItem::depth(), QListView::header(), QListViewItem::isSelected(), QListView::itemAt(), QListView::itemMargin(), QMouseEvent::pos(), QListView::rootIsDecorated(), selectionModeExt(), QMouseEvent::state(), QListView::treeStepSize(), and QPoint::x().

void KListView::contentsMouseMoveEvent QMouseEvent e  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from QListView.

Definition at line 794 of file klistview.cpp.

References QListView::contentsMouseMoveEvent(), QListView::contentsMouseReleaseEvent(), dragEnabled(), KCursor::handCursor(), isExecuteArea(), QListView::itemAt(), QMouseEvent::pos(), startDrag(), QPoint::x(), and QPoint::y().

void KListView::contentsMouseDoubleClickEvent QMouseEvent e  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from QListView.

Definition at line 867 of file klistview.cpp.

References QMouseEvent::button(), doubleClicked(), QListView::doubleClicked(), emitExecute(), QMouseEvent::globalPos(), QListView::header(), QListView::itemAt(), QMouseEvent::pos(), and QPoint::x().

void KListView::contentsDragLeaveEvent QDragLeaveEvent event  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 1021 of file klistview.cpp.

References cleanDropVisualizer(), and cleanItemHighlighter().

void KListView::contentsMouseReleaseEvent QMouseEvent  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented from QListView.

Definition at line 834 of file klistview.cpp.

References QMouseEvent::button(), QListView::contentsMouseReleaseEvent(), QListViewItem::depth(), QListView::header(), QListView::itemAt(), QListView::itemMargin(), itemsRenameable(), QMouseEvent::pos(), rename(), QListView::rootIsDecorated(), QListView::treeStepSize(), and QPoint::x().

void KListView::contentsDropEvent QDropEvent  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 895 of file klistview.cpp.

References acceptDrag(), cleanDropVisualizer(), cleanItemHighlighter(), dropped(), findDrop(), itemsMovable(), and movableDropEvent().

void KListView::contentsDragEnterEvent QDragEnterEvent  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 1280 of file klistview.cpp.

References acceptDrag().

QDragObject * KListView::dragObject  )  [protected, virtual]
 

Returns:
a dragobject encoding the current selection.
See also:
setDragEnabled()

Reimplemented from QListView.

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 1148 of file klistview.cpp.

References QListView::currentItem().

Referenced by startDrag().

bool KListView::acceptDrag QDropEvent event  )  const [protected, virtual]
 

Returns:
true if the event provides some acceptable format. A common mistake is to forget the "const" in your reimplementation

Reimplemented in KFileDetailView, and KFileTreeView.

Definition at line 1393 of file klistview.cpp.

References itemsMovable(), and QDropEvent::source().

Referenced by contentsDragEnterEvent(), contentsDragMoveEvent(), and contentsDropEvent().

QRect KListView::drawDropVisualizer QPainter p,
QListViewItem parent,
QListViewItem after
[protected, virtual]
 

Paint the drag line.

If painter is null, don't try to :)

If after == 0 then the marker should be drawn at the top.

Returns:
the rectangle that you painted to.

Definition at line 1291 of file klistview.cpp.

References QRect::bottom(), QListViewItem::depth(), QPainter::fillRect(), QListViewItem::firstChild(), QListViewItem::isOpen(), QListView::itemMargin(), QListView::itemRect(), QListViewItem::nextSibling(), QListView::rootIsDecorated(), QRect::setBottom(), QRect::setLeft(), QRect::setRight(), QRect::setTop(), and QListView::treeStepSize().

Referenced by contentsDragMoveEvent().

QRect KListView::drawItemHighlighter QPainter painter,
QListViewItem item
[protected, virtual]
 

Paint the drag rectangle.

If painter is null, don't try to :)

Returns:
the rectangle that you painted to.

Definition at line 1338 of file klistview.cpp.

References QListViewItem::depth(), QListView::itemRect(), QRect::left(), QListView::rootIsDecorated(), QRect::setLeft(), and QListView::treeStepSize().

Referenced by contentsDragMoveEvent().

void KListView::startDrag  )  [protected, virtual]
 

This method calls dragObject() and starts the drag.

Reimplement it to do fancy stuff like setting a pixmap or using a non-default DragMode

Reimplemented from QListView.

Definition at line 1137 of file klistview.cpp.

References QDragObject::drag(), dragObject(), moved(), and QDragObject::target().

Referenced by contentsMouseMoveEvent().

void KListView::keyPressEvent QKeyEvent  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Reimplemented in KFileDetailView.

Definition at line 1449 of file klistview.cpp.

References QListView::currentItem(), fileManagerKeyPressEvent(), QKeyEvent::key(), and menuShortCutPressed().

void KListView::viewportPaintEvent QPaintEvent  )  [protected, virtual]
 

Reimplemented for internal reasons.

Further reimplementations should call this function or else some features may not work correctly.

The API is unaffected.

Definition at line 1908 of file klistview.cpp.

References QPainter::fillRect(), and QPaintEvent::rect().

void KListView::activateAutomaticSelection  )  [protected]
 

In FileManager selection mode: explicitly activate the mode in which the current item is automatically selected.

Definition at line 1464 of file klistview.cpp.

References QListView::currentItem(), and QListView::selectionChanged().

void KListView::deactivateAutomaticSelection  )  [protected]
 

In FileManager selection mode: explicitly deactivate the mode in which the current item is automatically selected.

Definition at line 1476 of file klistview.cpp.

bool KListView::automaticSelection  )  const [protected]
 

In FileManager selection mode: return whether it is currently in the mode where the current item is selected automatically.

Returns false if items were selected explicitly, e.g. using the mouse.

Definition at line 1481 of file klistview.cpp.

void KListView::viewportResizeEvent QResizeEvent e  )  [protected, virtual]
 

Reimplemented for setFullWidth().

Definition at line 1977 of file klistview.cpp.

void KListView::disableAutoSelection  )  [protected]
 

Disable AutoSelection.

This overrides the system wide setting for AutoSelection. Please don't call this unless you have good reasons to override the system wide setting for AutoSelection.

See also:
resetAutoSelection()
Since:
3.2

Definition at line 2108 of file klistview.cpp.

void KListView::resetAutoSelection  )  [protected]
 

Reset AutoSelection to the system wide setting.

See also:
disableAutoSelection()
Since:
3.2

Definition at line 2118 of file klistview.cpp.

References KGlobalSettings::autoSelectDelay().

void KListView::doubleClicked QListViewItem item,
const QPoint pos,
int  c
[protected]
 

Deprecated:
This is just here for binary compatibility.
Use the signal in QListView instead.

Reimplemented from QListView.

Definition at line 2127 of file klistview.cpp.

References QListView::doubleClicked().

Referenced by contentsMouseDoubleClickEvent().

void KListView::slotSettingsChanged int   )  [protected, slot]
 

Update internal settings whenever the global ones change.

Definition at line 528 of file klistview.cpp.

References KGlobalSettings::autoSelectDelay(), KGlobalSettings::changeCursorOverIcon(), KGlobalSettings::contextMenuKey(), KGlobalSettings::dndEventDelay(), emitContextMenu(), QListView::mouseButtonClicked(), QListView::rightButtonClicked(), QListView::rightButtonPressed(), KGlobalSettings::showContextMenusOnPress(), KGlobalSettings::singleClick(), and slotMouseButtonClicked().

Referenced by KListView().

void KListView::cleanDropVisualizer  )  [protected, slot]
 

Repaint the rect where I was drawing the drop line.

Definition at line 1028 of file klistview.cpp.

Referenced by contentsDragLeaveEvent(), contentsDragMoveEvent(), contentsDropEvent(), focusOutEvent(), and KListView().

void KListView::cleanItemHighlighter  )  [protected, slot]
 

Repaint the rect where I was drawing the drop rectangle.

Definition at line 1354 of file klistview.cpp.

Referenced by contentsDragLeaveEvent(), contentsDragMoveEvent(), contentsDropEvent(), focusOutEvent(), and KListView().

void KListView::emitContextMenu QListViewItem ,
const QPoint ,
int 
[protected, slot]
 

Emit the contextMenu signal.

This slot is for mouse actions.

Definition at line 1891 of file klistview.cpp.

References contextMenu().

Referenced by KListView(), and slotSettingsChanged().

void KListView::emitContextMenu KListView ,
QListViewItem
[protected, slot]
 

Emit the contextMenu signal.

This slot is for key presses.

Definition at line 1879 of file klistview.cpp.

References contextMenu(), and QListView::itemRect().

void KListView::slotOnItem QListViewItem item  )  [protected, slot]
 

Accessory slot for AutoSelect.

Definition at line 510 of file klistview.cpp.

References isExecuteArea(), QCursor::pos(), and QPoint::x().

Referenced by KListView().

void KListView::slotOnViewport  )  [protected, slot]
 

Accessory slot for AutoSelect/ChangeCursorOverItem.

Definition at line 519 of file klistview.cpp.

Referenced by KListView().

void KListView::slotAutoSelect  )  [protected, slot]
 

Process AutoSelection.

Definition at line 577 of file klistview.cpp.

References QListView::clearSelection(), QListViewItemIterator::current(), QListView::currentItem(), endl(), itemIndex(), QListViewItem::itemPos(), kdDebug(), KApplication::keyboardMouseState(), QListView::selectionChanged(), QListView::selectionMode(), QListView::setCurrentItem(), QListView::setSelected(), and QListView::triggerUpdate().

Referenced by KListView().

void KListView::slotHeaderChanged  )  [protected, slot]
 

Reacts to header changes in full width mode.

Definition at line 653 of file klistview.cpp.

References QListView::columns(), QListView::columnWidth(), and QListView::setColumnWidth().

void KListView::movableDropEvent QListViewItem parent,
QListViewItem afterme
[protected, virtual]
 

Handle dropEvent when itemsMovable() is set to true.

Definition at line 921 of file klistview.cpp.

References aboutToMove(), QPtrList::append(), QListView::clearSelection(), QListView::currentItem(), QPtrList::first(), QListView::firstChild(), moved(), moveItem(), QPtrList::next(), and QListView::setCurrentItem().

Referenced by contentsDropEvent().

void KListView::findDrop const QPoint pos,
QListViewItem *&  parent,
QListViewItem *&  after
[protected, virtual]
 

Where is the nearest QListViewItem that I'm going to drop?

FIXME KDE 4.0: Make this method const so it can be called from an acceptDrag method without ugly casts

Definition at line 1043 of file klistview.cpp.

References QListViewItem::childCount(), QListViewItem::depth(), depthToPixels(), QListViewItem::firstChild(), QListViewItem::height(), QListViewItem::isExpandable(), QListViewItem::isOpen(), QListViewItem::itemAbove(), QListView::itemAt(), QListView::itemRect(), lastItem(), QListViewItem::nextSibling(), QListViewItem::parent(), QPoint::x(), and QPoint::y().

Referenced by contentsDragMoveEvent(), and contentsDropEvent().

void KListView::fileManagerKeyPressEvent QKeyEvent  )  [protected]
 

A special keyPressEvent (for FileManager selection mode).

Definition at line 1486 of file klistview.cpp.

References QListViewItem::childCount(), QListView::currentItem(), QListView::ensureItemVisible(), QListView::firstChild(), QListViewItem::height(), QRect::isEmpty(), QListViewItem::isExpandable(), QListViewItem::isOpen(), QListViewItem::isSelected(), QListViewItem::itemAbove(), QListViewItem::itemBelow(), QListView::itemRect(), QKeyEvent::key(), QRect::moveBy(), QListView::selectAll(), selectedItems(), QListView::selectionChanged(), QListView::selectionMode(), QListView::setCurrentItem(), QListView::setOpen(), QListViewItem::setSelected(), QListView::setSelectionMode(), QKeyEvent::state(), QRect::unite(), and QRect::x().

Referenced by keyPressEvent().

int KListView::depthToPixels int  depth  )  [protected]
 

Convert the depth of an item into its indentation in pixels.

Definition at line 1038 of file klistview.cpp.

References QListView::itemMargin(), QListView::rootIsDecorated(), and QListView::treeStepSize().

Referenced by findDrop().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Jun 12 11:31:40 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003