• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDE3Support

K3ListView Class Reference

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

#include <k3listview.h>

Inheritance diagram for K3ListView:

Inheritance graph
[legend]

List of all members.


Public Types

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

Public Slots

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

Signals

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

Public Member Functions

virtual int addColumn (const QIcon &iconset, const QString &label, int width=-1)
virtual int addColumn (const QString &label, int width=-1)
const QColor & alternateBackground () const
bool ascendingSort (void) const
bool autoOpen () const
int columnSorted (void) const
bool dragEnabled () const
bool dropHighlighter () const
bool dropVisualizer () const
int dropVisualizerWidth () const
bool fullWidth () const
bool isExecuteArea (int x)
virtual bool isExecuteArea (const QPoint &point)
bool isRenameable (int column) const
Q3ListViewItem * itemAtIndex (int index)
int itemIndex (const Q3ListViewItem *item) const
bool itemsMovable () const
bool itemsRenameable () const
 K3ListView (QWidget *parent=0)
Q3ListViewItem * lastChild () const
Q3ListViewItem * lastItem () const
void moveItem (Q3ListViewItem *item, Q3ListViewItem *parent, Q3ListViewItem *after)
virtual void removeColumn (int index)
KLineEdit * renameLineEdit () const
void restoreLayout (KConfigGroup &cg)
void restoreLayout (KConfig *config, const QString &group)
void saveLayout (KConfigGroup &cg) const
void saveLayout (KConfig *config, const QString &group) const
QList< Q3ListViewItem * > selectedItems (bool includeHiddenItems=true) const
SelectionModeExt selectionModeExt () const
virtual void setAcceptDrops (bool)
void setAlternateBackground (const QColor &c)
void setFullWidth (bool fullWidth)
KDE_DEPRECATED void setFullWidth ()
void setShadeSortColumn (bool shadeSortColumn)
virtual void setSorting (int column, bool ascending=true)
bool shadeSortColumn (void) const
virtual void takeItem (Q3ListViewItem *i)
int tooltipColumn () const
virtual ~K3ListView ()

Protected Slots

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

Protected Member Functions

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

Properties

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

Detailed Description

This Widget extends the functionality of Q3ListView 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 Q3ListView::clicked() or Q3ListView::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 Q3ListView::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*)

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

Definition at line 57 of file k3listview.h.


Member Enumeration Documentation

enum K3ListView::SelectionModeExt

Possible selection modes.

The first four correspond directly to Q3ListView::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

Enumerator:
Single 
Multi 
Extended 
NoSelection 
FileManager 

Definition at line 108 of file k3listview.h.


Constructor & Destructor Documentation

K3ListView::K3ListView ( QWidget *  parent = 0  )  [explicit]

Constructor.

The parameter parent is handled by Q3ListView, as usual.

Definition at line 419 of file k3listview.cpp.

K3ListView::~K3ListView (  )  [virtual]

Destructor.

Definition at line 462 of file k3listview.cpp.


Member Function Documentation

void K3ListView::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 K3ListView calls

See also:
moveItem()

bool K3ListView::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 K3FileTreeView.

Definition at line 1409 of file k3listview.cpp.

void K3ListView::activateAutomaticSelection (  )  [protected]

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

Definition at line 1472 of file k3listview.cpp.

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

Reimplemented for full width support.

Reimplemented from Q3ListView.

Definition at line 1972 of file k3listview.cpp.

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

Reimplemented for full width support.

See also:
removeColumn()

Reimplemented from Q3ListView.

Definition at line 1962 of file k3listview.cpp.

const QColor& K3ListView::alternateBackground (  )  const

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

bool K3ListView::ascendingSort ( void   )  const

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

Definition at line 2117 of file k3listview.cpp.

bool K3ListView::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 1489 of file k3listview.cpp.

bool K3ListView::autoOpen (  )  const

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

bool K3ListView::below ( Q3ListViewItem *  i,
const QPoint &  p 
) [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 1459 of file k3listview.cpp.

bool K3ListView::below ( const QRect &  rect,
const QPoint &  p 
) [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 1454 of file k3listview.cpp.

void K3ListView::cleanDropVisualizer (  )  [protected, slot]

Repaint the rect where I was drawing the drop line.

Definition at line 1035 of file k3listview.cpp.

void K3ListView::cleanItemHighlighter (  )  [protected, slot]

Repaint the rect where I was drawing the drop rectangle.

Definition at line 1370 of file k3listview.cpp.

int K3ListView::columnSorted ( void   )  const

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

Definition at line 2112 of file k3listview.cpp.

void K3ListView::contentsContextMenuEvent ( QContextMenuEvent *  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.

Definition at line 1287 of file k3listview.cpp.

void K3ListView::contentsDragEnterEvent ( QDragEnterEvent *  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 K3FileTreeView.

Definition at line 1282 of file k3listview.cpp.

void K3ListView::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 K3FileTreeView.

Definition at line 1028 of file k3listview.cpp.

void K3ListView::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 K3FileTreeView.

Definition at line 976 of file k3listview.cpp.

void K3ListView::contentsDropEvent ( QDropEvent *  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 in K3FileTreeView.

Definition at line 900 of file k3listview.cpp.

void K3ListView::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 Q3ListView.

Definition at line 872 of file k3listview.cpp.

void K3ListView::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 Q3ListView.

Definition at line 799 of file k3listview.cpp.

void K3ListView::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 Q3ListView.

Definition at line 752 of file k3listview.cpp.

void K3ListView::contentsMouseReleaseEvent ( 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 Q3ListView.

Definition at line 839 of file k3listview.cpp.

void K3ListView::contextMenu ( K3ListView *  l,
Q3ListViewItem *  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.

void K3ListView::deactivateAutomaticSelection (  )  [protected]

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

Definition at line 1484 of file k3listview.cpp.

int K3ListView::depthToPixels ( int  depth  )  [protected]

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

Definition at line 1045 of file k3listview.cpp.

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

Definition at line 2130 of file k3listview.cpp.

void K3ListView::doneEditing ( Q3ListViewItem *  item,
int  row 
) [protected, slot]

Definition at line 1403 of file k3listview.cpp.

void K3ListView::doubleClicked ( Q3ListViewItem *  item,
const QPoint &  pos,
int  c 
) [protected]

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

Reimplemented from Q3ListView.

Definition at line 2149 of file k3listview.cpp.

bool K3ListView::dragEnabled (  )  const

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

Q3DragObject * K3ListView::dragObject (  )  [protected, virtual]

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

Reimplemented from Q3ListView.

Reimplemented in K3FileTreeView.

Definition at line 1155 of file k3listview.cpp.

QRect K3ListView::drawDropVisualizer ( QPainter *  p,
Q3ListViewItem *  parent,
Q3ListViewItem *  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 1301 of file k3listview.cpp.

QRect K3ListView::drawItemHighlighter ( QPainter *  painter,
Q3ListViewItem *  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 1348 of file k3listview.cpp.

bool K3ListView::dropHighlighter (  )  const

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

Definition at line 1429 of file k3listview.cpp.

void K3ListView::dropped ( QDropEvent *  e,
Q3ListViewItem *  parent,
Q3ListViewItem *  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 K3FileTreeView.

void K3ListView::dropped ( K3ListView *  list,
QDropEvent *  e,
Q3ListViewItem *  parent,
Q3ListViewItem *  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 K3ListView::dropped ( K3ListView *  list,
QDropEvent *  e,
Q3ListViewItem *  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 K3ListView::dropped ( QDropEvent *  e,
Q3ListViewItem *  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 K3FileTreeView.

bool K3ListView::dropVisualizer (  )  const

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

int K3ListView::dropVisualizerWidth (  )  const

The dropVisualizerWidth defaults to 4.

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

void K3ListView::emitContextMenu ( K3ListView *  ,
Q3ListViewItem *  i 
) [protected, slot]

Emit the contextMenu signal.

This slot is for key presses.

Definition at line 1887 of file k3listview.cpp.

void K3ListView::emitContextMenu ( Q3ListViewItem *  i,
const QPoint &  p,
int   
) [protected, slot]

Emit the contextMenu signal.

This slot is for mouse actions.

Definition at line 1899 of file k3listview.cpp.

void K3ListView::emitExecute ( Q3ListViewItem *  item,
const QPoint &  pos,
int  c 
) [protected]

Emit signal executed.

For internal use only.

Definition at line 671 of file k3listview.cpp.

bool K3ListView::event ( QEvent *  e  )  [protected, virtual]

Reimplemented to reload the alternate background in palette changes.

For internal use only.

Definition at line 744 of file k3listview.cpp.

void K3ListView::executed ( Q3ListViewItem *  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 Q3ListViewItem objects in slots connected to this signal.

void K3ListView::executed ( Q3ListViewItem *  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 Q3ListViewItem objects in slots connected to this signal.

void K3ListView::fileManagerKeyPressEvent ( QKeyEvent *  e  )  [protected]

A special keyPressEvent (for FileManager selection mode).

Definition at line 1494 of file k3listview.cpp.

void K3ListView::findDrop ( const QPoint &  pos,
Q3ListViewItem *&  parent,
Q3ListViewItem *&  after 
) [protected, virtual]

Where is the nearest Q3ListViewItem 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 1050 of file k3listview.cpp.

void K3ListView::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 699 of file k3listview.cpp.

void K3ListView::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 715 of file k3listview.cpp.

bool K3ListView::fullWidth (  )  const

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

See also:
setFullWidth()

bool K3ListView::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 477 of file k3listview.cpp.

bool K3ListView::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 Q3ListViewItem where mouse clicks or double clicks respectively generate a executed() signal. Depending on Q3ListView::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 467 of file k3listview.cpp.

bool K3ListView::isRenameable ( int  column  )  const

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

Definition at line 1389 of file k3listview.cpp.

void K3ListView::itemAdded ( Q3ListViewItem *  item  )  [signal]

Q3ListViewItem * K3ListView::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 1871 of file k3listview.cpp.

int K3ListView::itemIndex ( const Q3ListViewItem *  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 1852 of file k3listview.cpp.

void K3ListView::itemRemoved ( Q3ListViewItem *  item  )  [signal]

void K3ListView::itemRenamed ( Q3ListViewItem *  item  )  [signal]

Same as above, but without the extra information.

void K3ListView::itemRenamed ( Q3ListViewItem *  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.

bool K3ListView::itemsMovable (  )  const

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

setItemsMovable()

bool K3ListView::itemsRenameable (  )  const

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

void K3ListView::keyPressEvent ( QKeyEvent *  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 1464 of file k3listview.cpp.

Q3ListViewItem * K3ListView::lastChild (  )  const

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

Definition at line 1119 of file k3listview.cpp.

Q3ListViewItem * K3ListView::lastItem (  )  const

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

Definition at line 1129 of file k3listview.cpp.

void K3ListView::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 737 of file k3listview.cpp.

void K3ListView::menuShortCutPressed ( K3ListView *  list,
Q3ListViewItem *  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 (K3ListView*, Q3ListViewItem*, 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.

void K3ListView::movableDropEvent ( Q3ListViewItem *  parent,
Q3ListViewItem *  afterme 
) [protected, virtual]

Handle dropEvent when itemsMovable() is set to true.

Definition at line 926 of file k3listview.cpp.

void K3ListView::moved ( Q3PtrList< Q3ListViewItem > &  items,
Q3PtrList< Q3ListViewItem > &  afterFirst,
Q3PtrList< Q3ListViewItem > &  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 K3ListView::moved ( Q3ListViewItem *  item,
Q3ListViewItem *  afterFirst,
Q3ListViewItem *  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 K3ListView::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.

void K3ListView::moveItem ( Q3ListViewItem *  item,
Q3ListViewItem *  parent,
Q3ListViewItem *  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 1252 of file k3listview.cpp.

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

Reimplemented for full width support.

See also:
addColumn()

Reimplemented from Q3ListView.

Definition at line 1982 of file k3listview.cpp.

void K3ListView::rename ( Q3ListViewItem *  item,
int  c 
) [virtual, slot]

Rename column c of item.

Definition at line 1380 of file k3listview.cpp.

KLineEdit * K3ListView::renameLineEdit (  )  const

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

Definition at line 1139 of file k3listview.cpp.

void K3ListView::resetAutoSelection (  )  [protected]

Reset AutoSelection to the system wide setting.

See also:
disableAutoSelection()

Definition at line 2140 of file k3listview.cpp.

void K3ListView::restoreLayout ( KConfigGroup &  cg  ) 

Definition at line 2045 of file k3listview.cpp.

void K3ListView::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 2039 of file k3listview.cpp.

void K3ListView::saveLayout ( KConfigGroup &  cg  )  const

Definition at line 2022 of file k3listview.cpp.

void K3ListView::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 2016 of file k3listview.cpp.

QList< Q3ListViewItem * > K3ListView::selectedItems ( bool  includeHiddenItems = true  )  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

Definition at line 1215 of file k3listview.cpp.

K3ListView::SelectionModeExt K3ListView::selectionModeExt (  )  const

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

setSelectionModeExt

Definition at line 1847 of file k3listview.cpp.

void K3ListView::setAcceptDrops ( bool  val  )  [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 1904 of file k3listview.cpp.

void K3ListView::setAlternateBackground ( const QColor &  c  ) 

sets the alternate background background color.

This only has an effect if the items are K3ListViewItems

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 1998 of file k3listview.cpp.

void K3ListView::setAutoOpen ( bool  b  )  [virtual, slot]

Enable/Disable AutoOpen (not implemented currently).

Definition at line 1195 of file k3listview.cpp.

void K3ListView::setDragEnabled ( bool  b  )  [virtual, slot]

Enable/Disable the dragging of items.

It is disabled by default.

Definition at line 1185 of file k3listview.cpp.

void K3ListView::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 1424 of file k3listview.cpp.

void K3ListView::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 1210 of file k3listview.cpp.

void K3ListView::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 1296 of file k3listview.cpp.

void K3ListView::setFullWidth ( bool  fullWidth  ) 

Let the last column fit exactly all the available width.

See also:
fullWidth()

Definition at line 1951 of file k3listview.cpp.

void K3ListView::setFullWidth (  ) 

Deprecated:
See also:
setFullWidth()

Definition at line 1946 of file k3listview.cpp.

void K3ListView::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 1164 of file k3listview.cpp.

void K3ListView::setItemsRenameable ( bool  b  )  [virtual, slot]

Enables inplace-renaming of items.

It is disabled by default.

See also:
itemsRenameable()

setRenameable()

Definition at line 1174 of file k3listview.cpp.

void K3ListView::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 K3ListView, and override rename() and call only call it if you want the item to be renamed.

Definition at line 1394 of file k3listview.cpp.

void K3ListView::setSelectionModeExt ( SelectionModeExt  mode  )  [slot]

Set the selection mode.

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

Definition at line 1824 of file k3listview.cpp.

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

Definition at line 2004 of file k3listview.cpp.

void K3ListView::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 Q3ListView.

Definition at line 2079 of file k3listview.cpp.

void K3ListView::setTabOrderedRenaming ( bool  b  )  [slot]

Enable/disable tabbing between editable cells.

Definition at line 1444 of file k3listview.cpp.

void K3ListView::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 1419 of file k3listview.cpp.

bool K3ListView::shadeSortColumn ( void   )  const

See if the sort column should be drawn shaded.

Returns:
true if the sort column should be shaded

bool K3ListView::showTooltip ( Q3ListViewItem *  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 1434 of file k3listview.cpp.

void K3ListView::slotAutoSelect (  )  [protected, slot]

Process AutoSelection.

For internal use only.

Definition at line 582 of file k3listview.cpp.

void K3ListView::slotDragExpand (  )  [protected, slot]

Definition at line 1022 of file k3listview.cpp.

void K3ListView::slotHeaderChanged (  )  [protected, slot]

Reacts to header changes in full width mode.

For internal use only.

Definition at line 658 of file k3listview.cpp.

void K3ListView::slotMouseButtonClicked ( int  btn,
Q3ListViewItem *  item,
const QPoint &  pos,
int  c 
) [protected, slot]

Definition at line 894 of file k3listview.cpp.

void K3ListView::slotOnItem ( Q3ListViewItem *  item  )  [protected, slot]

Accessory slot for AutoSelect.

For internal use only.

Definition at line 516 of file k3listview.cpp.

void K3ListView::slotOnViewport (  )  [protected, slot]

Accessory slot for AutoSelect/ChangeCursorOverItem.

For internal use only.

Definition at line 525 of file k3listview.cpp.

void K3ListView::slotSettingsChanged ( int  category  )  [protected, slot]

Update internal settings whenever the global ones change.

For internal use only.

Definition at line 534 of file k3listview.cpp.

void K3ListView::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 Q3ListView.

Definition at line 1144 of file k3listview.cpp.

bool K3ListView::tabOrderedRenaming (  )  const [slot]

Returns whether tab ordered renaming is enabled.

Definition at line 1449 of file k3listview.cpp.

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

Reimplemented for internal reasons.

Reimplemented from Q3ListView.

Definition at line 2122 of file k3listview.cpp.

QString K3ListView::tooltip ( Q3ListViewItem *  item,
int  column 
) const [protected, virtual]

Returns:
the tooltip for column of item.

Definition at line 1439 of file k3listview.cpp.

int K3ListView::tooltipColumn (  )  const

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

void K3ListView::viewportPaintEvent ( QPaintEvent *  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 1916 of file k3listview.cpp.

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

Reimplemented for setFullWidth().

Definition at line 1988 of file k3listview.cpp.


Property Documentation

const QColor & K3ListView::alternateBackground [read, write]

Definition at line 71 of file k3listview.h.

bool K3ListView::autoOpen [read, write]

Definition at line 67 of file k3listview.h.

bool K3ListView::dragEnabled [read, write]

Definition at line 66 of file k3listview.h.

bool K3ListView::dropVisualizer [read, write]

Definition at line 68 of file k3listview.h.

int K3ListView::dropVisualizerWidth [read, write]

Definition at line 70 of file k3listview.h.

bool K3ListView::fullWidth [read, write]

Definition at line 63 of file k3listview.h.

bool K3ListView::itemsMovable [read, write]

Definition at line 64 of file k3listview.h.

bool K3ListView::itemsRenameable [read, write]

Definition at line 65 of file k3listview.h.

bool K3ListView::shadeSortColumn [read, write]

Definition at line 72 of file k3listview.h.

int K3ListView::tooltipColumn [read, write]

Definition at line 69 of file k3listview.h.


The documentation for this class was generated from the following files:
  • k3listview.h
  • k3listview.cpp

KDE3Support

Skip menu "KDE3Support"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal