• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdeui
 

kdeui

Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | Friends | List of all members
KListView Class Reference

#include <klistview.h>

Inheritance diagram for KListView:
KTimezoneWidget

Public Types

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

Public Slots

virtual void rename (TQListViewItem *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
 
virtual void selectAll (bool select)
 

Signals

void executed (TQListViewItem *item)
 
void executed (TQListViewItem *item, const TQPoint &pos, int c)
 
void dropped (TQDropEvent *e, TQListViewItem *after)
 
void dropped (KListView *list, TQDropEvent *e, TQListViewItem *after)
 
void dropped (KListView *list, TQDropEvent *e, TQListViewItem *parent, TQListViewItem *after)
 
void dropped (TQDropEvent *e, TQListViewItem *parent, TQListViewItem *after)
 
void moved ()
 
void aboutToMove ()
 
void moved (TQListViewItem *item, TQListViewItem *afterFirst, TQListViewItem *afterNow)
 
void moved (TQPtrList< TQListViewItem > &items, TQPtrList< TQListViewItem > &afterFirst, TQPtrList< TQListViewItem > &afterNow)
 
void itemRenamed (TQListViewItem *item, const TQString &str, int col)
 
void itemRenamed (TQListViewItem *item)
 
void menuShortCutPressed (KListView *list, TQListViewItem *item)
 
void contextMenu (KListView *l, TQListViewItem *i, const TQPoint &p)
 
void itemAdded (TQListViewItem *item)
 
void itemRemoved (TQListViewItem *item)
 

Public Member Functions

 KListView (TQWidget *parent=0, const char *name=0)
 
virtual ~KListView ()
 
virtual void setAcceptDrops (bool)
 
virtual bool isExecuteArea (const TQPoint &point)
 
bool isExecuteArea (int x)
 
TQPtrList< TQListViewItem > selectedItems () const
 
TQPtrList< TQListViewItem > selectedItems (bool includeHiddenItems) const
 
void moveItem (TQListViewItem *item, TQListViewItem *parent, TQListViewItem *after)
 
TQListViewItem * lastItem () const
 
TQListViewItem * lastChild () const
 
KLineEdit * renameLineEdit () 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 TQListViewItem *item) const
 
TQListViewItem * itemAtIndex (int index)
 
void setFullWidth () KDE_DEPRECATED
 
void setFullWidth (bool fullWidth)
 
bool fullWidth () const
 
virtual int addColumn (const TQString &label, int width=-1)
 
virtual int addColumn (const TQIconSet &iconset, const TQString &label, int width=-1)
 
virtual void removeColumn (int index)
 
void setAlternateBackground (const TQColor &c)
 
const TQColor & alternateBackground () const
 
void saveLayout (KConfig *config, const TQString &group) const
 
void restoreLayout (KConfig *config, const TQString &group)
 
virtual void setSorting (int column, bool ascending=true)
 
int columnSorted (void) const
 
bool ascendingSort (void) const
 
virtual void takeItem (TQListViewItem *i)
 
void setShadeSortColumn (bool shadeSortColumn)
 
bool shadeSortColumn (void) const
 

Protected Slots

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

Protected Member Functions

bool below (const TQRect &rect, const TQPoint &p)
 
bool below (TQListViewItem *i, const TQPoint &p)
 
virtual bool event (TQEvent *)
 
void emitExecute (TQListViewItem *item, const TQPoint &pos, int c)
 
virtual void focusInEvent (TQFocusEvent *fe)
 
virtual void focusOutEvent (TQFocusEvent *fe)
 
virtual void leaveEvent (TQEvent *e)
 
virtual TQString tooltip (TQListViewItem *item, int column) const
 
virtual bool showTooltip (TQListViewItem *item, const TQPoint &pos, int column) const
 
virtual void contentsDragMoveEvent (TQDragMoveEvent *event)
 
virtual void contentsMousePressEvent (TQMouseEvent *e)
 
virtual void contentsMouseMoveEvent (TQMouseEvent *e)
 
virtual void contentsMouseDoubleClickEvent (TQMouseEvent *e)
 
virtual void contentsDragLeaveEvent (TQDragLeaveEvent *event)
 
virtual void contentsMouseReleaseEvent (TQMouseEvent *)
 
virtual void contentsDropEvent (TQDropEvent *)
 
virtual void contentsDragEnterEvent (TQDragEnterEvent *)
 
virtual TQDragObject * dragObject ()
 
virtual bool acceptDrag (TQDropEvent *event) const
 
virtual TQRect drawDropVisualizer (TQPainter *p, TQListViewItem *parent, TQListViewItem *after)
 
virtual TQRect drawItemHighlighter (TQPainter *painter, TQListViewItem *item)
 
virtual void startDrag ()
 
virtual void keyPressEvent (TQKeyEvent *)
 
virtual void viewportPaintEvent (TQPaintEvent *)
 
void activateAutomaticSelection ()
 
void deactivateAutomaticSelection ()
 
bool automaticSelection () const
 
virtual void viewportResizeEvent (TQResizeEvent *e)
 
void disableAutoSelection ()
 
void resetAutoSelection ()
 
void resetKeyboardSelectionOperation ()
 
void setActiveMultiSelectItem (TQListViewItem *item)
 
void doubleClicked (TQListViewItem *item, const TQPoint &pos, int c)
 
virtual void movableDropEvent (TQListViewItem *parent, TQListViewItem *afterme)
 
virtual void findDrop (const TQPoint &pos, TQListViewItem *&parent, TQListViewItem *&after)
 
void fileManagerKeyPressEvent (TQKeyEvent *)
 
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
 
TQColor alternateBackground
 
bool shadeSortColumn
 

Friends

class KListViewItem
 

Detailed Description

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

KListView 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 53 of file klistview.h.

Member Enumeration Documentation

enum KListView::SelectionModeExt

Possible selection modes.

The first four correspond directly to TQListView::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 105 of file klistview.h.

Constructor & Destructor Documentation

KListView::KListView ( TQWidget *  parent = 0,
const char *  name = 0 
)

Constructor.

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

Definition at line 431 of file klistview.cpp.

KListView::~KListView ( )
virtual

Destructor.

Definition at line 476 of file klistview.cpp.

Member Function Documentation

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()
bool KListView::acceptDrag ( TQDropEvent *  event) const
protectedvirtual
Returns
true if the event provides some acceptable format. A common mistake is to forget the "const" in your reimplementation

Definition at line 1425 of file klistview.cpp.

void KListView::activateAutomaticSelection ( )
protected

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

Definition at line 1496 of file klistview.cpp.

int KListView::addColumn ( const TQString &  label,
int  width = -1 
)
virtual

Reimplemented for full width support.

See also
removeColumn()

Definition at line 2143 of file klistview.cpp.

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

Reimplemented for full width support.

Definition at line 2153 of file klistview.cpp.

const TQColor& KListView::alternateBackground ( ) const
Returns
the alternate background color
See also
setAlternateBackground()
bool KListView::ascendingSort ( void  ) const
Returns
whether the current sort is ascending (or descending)

Definition at line 2287 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 1513 of file klistview.cpp.

bool KListView::autoOpen ( ) const
Returns
true if AutoOpen is enabled (not implemented currently).
See also
setAutoOpen()
bool KListView::below ( const TQRect &  rect,
const TQPoint &  p 
)
inlineprotected

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

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

Definition at line 680 of file klistview.h.

bool KListView::below ( TQListViewItem *  i,
const TQPoint &  p 
)
inlineprotected

An overloaded version of below(const TQRect&, const TQPoint&).

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

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

Definition at line 694 of file klistview.h.

void KListView::cleanDropVisualizer ( )
protectedslot

Repaint the rect where I was drawing the drop line.

Definition at line 1060 of file klistview.cpp.

void KListView::cleanItemHighlighter ( )
protectedslot

Repaint the rect where I was drawing the drop rectangle.

Definition at line 1386 of file klistview.cpp.

int KListView::columnSorted ( void  ) const
Returns
the currently sorted column, or -1 if none is sorted

Definition at line 2282 of file klistview.cpp.

void KListView::contentsDragEnterEvent ( TQDragEnterEvent *  event)
protectedvirtual

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 1312 of file klistview.cpp.

void KListView::contentsDragLeaveEvent ( TQDragLeaveEvent *  event)
protectedvirtual

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 1053 of file klistview.cpp.

void KListView::contentsDragMoveEvent ( TQDragMoveEvent *  event)
protectedvirtual

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 1003 of file klistview.cpp.

void KListView::contentsDropEvent ( TQDropEvent *  e)
protectedvirtual

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 927 of file klistview.cpp.

void KListView::contentsMouseDoubleClickEvent ( TQMouseEvent *  e)
protectedvirtual

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 896 of file klistview.cpp.

void KListView::contentsMouseMoveEvent ( TQMouseEvent *  e)
protectedvirtual

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 823 of file klistview.cpp.

void KListView::contentsMousePressEvent ( TQMouseEvent *  e)
protectedvirtual

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 776 of file klistview.cpp.

void KListView::contentsMouseReleaseEvent ( TQMouseEvent *  e)
protectedvirtual

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 863 of file klistview.cpp.

void KListView::contextMenu ( KListView *  l,
TQListViewItem *  i,
const TQPoint &  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
lis this listview.
iis the item for which the menu should be shown. May be 0L.
pis the point at which the menu should be shown.
bool KListView::createChildren ( ) const

For future expansions.

Do not use.

Deprecated:

Definition at line 1435 of file klistview.cpp.

void KListView::deactivateAutomaticSelection ( )
protected

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

Definition at line 1508 of file klistview.cpp.

int KListView::depthToPixels ( int  depth)
protected

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

Definition at line 1070 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 2300 of file klistview.cpp.

void KListView::doubleClicked ( TQListViewItem *  item,
const TQPoint &  pos,
int  c 
)
protected
Deprecated:
This is just here for binary compatibility.

Use the signal in TQListView instead.

Definition at line 2319 of file klistview.cpp.

bool KListView::dragEnabled ( ) const
Returns
whether dragging is enabled. False by default.
See also
setDragEnabled()
TQDragObject * KListView::dragObject ( )
protectedvirtual
Returns
a dragobject encoding the current selection.
See also
setDragEnabled()

Definition at line 1180 of file klistview.cpp.

TQRect KListView::drawDropVisualizer ( TQPainter *  p,
TQListViewItem *  parent,
TQListViewItem *  after 
)
protectedvirtual

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 1323 of file klistview.cpp.

TQRect KListView::drawItemHighlighter ( TQPainter *  painter,
TQListViewItem *  item 
)
protectedvirtual

Paint the drag rectangle.

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

Returns
the rectangle that you painted to.

Definition at line 1370 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 1456 of file klistview.cpp.

void KListView::dropped ( TQDropEvent *  e,
TQListViewItem *  after 
)
signal

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

Parameters
eis the drop event itself (it has already been accepted)
afteris the item after which the drop occurred (or 0L, if the drop was above all items)
See also
acceptDrop()
void KListView::dropped ( KListView *  list,
TQDropEvent *  e,
TQListViewItem *  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
listis the listview
eis the drop event itself (it has already been accepted)
afteris the item after which the drop occurred (or 0L, if the drop was above all items
void KListView::dropped ( KListView *  list,
TQDropEvent *  e,
TQListViewItem *  parent,
TQListViewItem *  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
listis the listview
eis the drop event itself (it has already been accepted)
parentthe item that is to be the parent of the new item
afteris the item after which the drop occurred (or 0L, if the drop was above all items
void KListView::dropped ( TQDropEvent *  e,
TQListViewItem *  parent,
TQListViewItem *  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
eis the drop event itself (it has already been accepted)
parentthe item that is to be the parent of the new item
afteris the item after which the drop occurred (or 0L, if the drop was above all items
bool KListView::dropVisualizer ( ) const
Returns
true if drawing of the drop-visualizer has been enabled. True by default.
See also
setDropVisualizer()
int KListView::dropVisualizerWidth ( ) const

The dropVisualizerWidth defaults to 4.

See also
setDropVisualizerWidth()
Returns
the current width of the drop-visualizer.
void KListView::emitContextMenu ( TQListViewItem *  i,
const TQPoint &  p,
int   
)
protectedslot

Emit the contextMenu signal.

This slot is for mouse actions.

Definition at line 2083 of file klistview.cpp.

void KListView::emitContextMenu ( KListView *  ,
TQListViewItem *  i 
)
protectedslot

Emit the contextMenu signal.

This slot is for key presses.

Definition at line 2071 of file klistview.cpp.

void KListView::emitExecute ( TQListViewItem *  item,
const TQPoint &  pos,
int  c 
)
protected

Emit signal executed.

Definition at line 695 of file klistview.cpp.

bool KListView::event ( TQEvent *  e)
protectedvirtual

Reimplemented to reload the alternate background in palette changes.

Definition at line 768 of file klistview.cpp.

void KListView::executed ( TQListViewItem *  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
itemis the pointer to the executed listview item.

Note that you may not delete any TQListViewItem objects in slots connected to this signal.

void KListView::executed ( TQListViewItem *  item,
const TQPoint &  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
itemis the pointer to the executed listview item.
posis the position where the user has clicked
cis the column into which the user clicked.

Note that you may not delete any TQListViewItem objects in slots connected to this signal.

void KListView::fileManagerKeyPressEvent ( TQKeyEvent *  e)
protected

A special keyPressEvent (for FileManager selection mode).

Definition at line 1532 of file klistview.cpp.

void KListView::findDrop ( const TQPoint &  pos,
TQListViewItem *&  parent,
TQListViewItem *&  after 
)
protectedvirtual

Where is the nearest TQListViewItem 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 1075 of file klistview.cpp.

void KListView::focusInEvent ( TQFocusEvent *  fe)
protectedvirtual

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 723 of file klistview.cpp.

void KListView::focusOutEvent ( TQFocusEvent *  fe)
protectedvirtual

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 739 of file klistview.cpp.

bool KListView::fullWidth ( ) const

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

See also
setFullWidth()
bool KListView::isExecuteArea ( const TQPoint &  point)
virtual

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

The execute area is the part of a TQListViewItem where mouse clicks or double clicks respectively generate a executed() signal. Depending on TQListView::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 481 of file klistview.cpp.

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 491 of file klistview.cpp.

bool KListView::isRenameable ( int  column) const
Returns
true if column is renamable.
See also
setRenameable()

Definition at line 1405 of file klistview.cpp.

TQListViewItem * 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 2055 of file klistview.cpp.

int KListView::itemIndex ( const TQListViewItem *  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 2036 of file klistview.cpp.

void KListView::itemRenamed ( TQListViewItem *  item,
const TQString &  str,
int  col 
)
signal

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

Parameters
itemis the renamed item.
stris the new value of column col.
colis the renamed column.
void KListView::itemRenamed ( TQListViewItem *  item)
signal

Same as above, but without the extra information.

bool KListView::itemsMovable ( ) const
Returns
if it is legal to move items in the list view. True by default.
See also
setDragEnabled()
setItemsMovable()
bool KListView::itemsRenameable ( ) const
Returns
whether inplace-renaming has been enabled. False by default.
See also
setItemsRenameable()
void KListView::keyPressEvent ( TQKeyEvent *  e)
protectedvirtual

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 1481 of file klistview.cpp.

TQListViewItem * KListView::lastChild ( ) const
Returns
the last child of this listview.
See also
lastItem()

Definition at line 1144 of file klistview.cpp.

TQListViewItem * KListView::lastItem ( ) const
Returns
the last item (not child!) of this listview.
See also
lastChild()

Definition at line 1154 of file klistview.cpp.

void KListView::leaveEvent ( TQEvent *  e)
protectedvirtual

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 761 of file klistview.cpp.

void KListView::menuShortCutPressed ( KListView *  list,
TQListViewItem *  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*, TQListViewItem*, const TQPoint&) to correctly handle showing context menus regardless of settings.

Parameters
listis this listview.
itemis the currentItem() at the time the key was pressed. May be 0L.
void KListView::movableDropEvent ( TQListViewItem *  parent,
TQListViewItem *  afterme 
)
protectedvirtual

Handle dropEvent when itemsMovable() is set to true.

Definition at line 953 of file klistview.cpp.

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.

void KListView::moved ( TQListViewItem *  item,
TQListViewItem *  afterFirst,
TQListViewItem *  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
itemthe item that was moved
afterFirstthe item that parameter item was in before the move, in the list
afterNowthe item it's currently after.
void KListView::moved ( TQPtrList< TQListViewItem > &  items,
TQPtrList< TQListViewItem > &  afterFirst,
TQPtrList< TQListViewItem > &  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::moveItem ( TQListViewItem *  item,
TQListViewItem *  parent,
TQListViewItem *  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 1282 of file klistview.cpp.

void KListView::removeColumn ( int  index)
virtual

Reimplemented for full width support.

See also
addColumn()

Definition at line 2163 of file klistview.cpp.

void KListView::rename ( TQListViewItem *  item,
int  c 
)
virtualslot

Rename column c of item.

Definition at line 1396 of file klistview.cpp.

KLineEdit * KListView::renameLineEdit ( ) const
Returns
the lineedit used for inline renaming. Use that to setup a KCompletion or TQValidator for the lineedit
Since
3.2

Definition at line 1164 of file klistview.cpp.

void KListView::resetAutoSelection ( )
protected

Reset AutoSelection to the system wide setting.

See also
disableAutoSelection()
Since
3.2

Definition at line 2310 of file klistview.cpp.

void KListView::resetKeyboardSelectionOperation ( )
protected

In FileManager selection mode: reset the keyboard selection operation; e.g.

after completion of a mouse rubberband operation

Since
14.0

Definition at line 1518 of file klistview.cpp.

void KListView::restoreLayout ( KConfig *  config,
const TQString &  group 
)

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

Parameters
configthe KConfig object to read from
groupthe config group to use

Definition at line 2214 of file klistview.cpp.

void KListView::saveLayout ( KConfig *  config,
const TQString &  group 
) const

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

Parameters
configthe KConfig object to write to
groupthe config group to use

Definition at line 2196 of file klistview.cpp.

void KListView::selectAll ( bool  select)
virtualslot

Override TQListView selectAll() so that filtered items are not selected.

Since
14.0

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.

Definition at line 2544 of file klistview.cpp.

TQPtrList< TQListViewItem > KListView::selectedItems ( ) const
Returns
a list containing the currently selected items.
Deprecated:

Definition at line 1240 of file klistview.cpp.

TQPtrList< TQListViewItem > KListView::selectedItems ( bool  includeHiddenItems) const
Returns
a list containing the currently selected items.
Parameters
includeHiddenItemsSet 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 1245 of file klistview.cpp.

KListView::SelectionModeExt KListView::selectionModeExt ( ) const
Returns
the "extended" selection mode of this listview.
See also
SelectionModeExt
setSelectionModeExt

Definition at line 2031 of file klistview.cpp.

void KListView::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 2088 of file klistview.cpp.

void KListView::setActiveMultiSelectItem ( TQListViewItem *  item)
protected

In FileManager selection mode: set the current keyboard cursor selection item; e.g.

during a mouse rubberband operation

Parameters
directiondown is 1, up is -1
Since
14.0

Definition at line 1524 of file klistview.cpp.

void KListView::setAlternateBackground ( const TQColor &  c)

sets the alternate background background color.

This only has an effect if the items are KListViewItems

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

Definition at line 2179 of file klistview.cpp.

void KListView::setAutoOpen ( bool  b)
virtualslot

Enable/Disable AutoOpen (not implemented currently).

Definition at line 1220 of file klistview.cpp.

void KListView::setCreateChildren ( bool  b)
virtualslot

For future expansions.

Do not use.

Deprecated:

Definition at line 1430 of file klistview.cpp.

void KListView::setDragEnabled ( bool  b)
virtualslot

Enable/Disable the dragging of items.

It is disabled by default.

Definition at line 1210 of file klistview.cpp.

void KListView::setDropHighlighter ( bool  b)
virtualslot

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 1451 of file klistview.cpp.

void KListView::setDropVisualizer ( bool  b)
virtualslot

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 1235 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 1318 of file klistview.cpp.

void KListView::setFullWidth ( )
Deprecated:
See also
setFullWidth()

Definition at line 2127 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 2132 of file klistview.cpp.

void KListView::setItemsMovable ( bool  b)
virtualslot

Set whether items in the list view can be moved.

It is enabled by default.

See also
itemsMovable()

Definition at line 1189 of file klistview.cpp.

void KListView::setItemsRenameable ( bool  b)
virtualslot

Enables inplace-renaming of items.

It is disabled by default.

See also
itemsRenameable()
setRenameable()

Definition at line 1199 of file klistview.cpp.

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 1410 of file klistview.cpp.

void KListView::setSelectionModeExt ( SelectionModeExt  mode)
slot

Set the selection mode.

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

Definition at line 2008 of file klistview.cpp.

void KListView::setShadeSortColumn ( bool  shadeSortColumn)

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

Defaults to true

Parameters
shadeSortColumnTrue if sort column should be shaded.
Since
3.4

Definition at line 2185 of file klistview.cpp.

void KListView::setSorting ( int  column,
bool  ascending = true 
)
virtual

Reimplemented to remember the current sort column and order.

Parameters
columnis the column to be sorted, or -1 to sort in order of insertion
ascendingwhether to sort ascending (or descending)

Definition at line 2249 of file klistview.cpp.

void KListView::setTabOrderedRenaming ( bool  b)
slot

Enable/disable tabbing between editable cells.

Since
3.1

Definition at line 1471 of file klistview.cpp.

void KListView::setTooltipColumn ( int  column)
virtualslot

Set which column should be used for automatic tooltips.

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

Definition at line 1446 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
bool KListView::showTooltip ( TQListViewItem *  item,
const TQPoint &  pos,
int  column 
) const
protectedvirtual
Returns
whether the tooltip for column of item shall be shown at point pos.

Definition at line 1461 of file klistview.cpp.

void KListView::slotAutoSelect ( )
protectedslot

Process AutoSelection.

Definition at line 606 of file klistview.cpp.

void KListView::slotHeaderChanged ( )
protectedslot

Reacts to header changes in full width mode.

Definition at line 682 of file klistview.cpp.

void KListView::slotOnItem ( TQListViewItem *  item)
protectedslot

Accessory slot for AutoSelect.

Definition at line 539 of file klistview.cpp.

void KListView::slotOnViewport ( )
protectedslot

Accessory slot for AutoSelect/ChangeCursorOverItem.

Definition at line 548 of file klistview.cpp.

void KListView::slotSettingsChanged ( int  category)
protectedslot

Update internal settings whenever the global ones change.

Definition at line 557 of file klistview.cpp.

void KListView::startDrag ( )
protectedvirtual

This method calls dragObject() and starts the drag.

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

Definition at line 1169 of file klistview.cpp.

bool KListView::tabOrderedRenaming ( ) const
slot

Returns whether tab ordered renaming is enabled.

Since
3.1

Definition at line 1476 of file klistview.cpp.

void KListView::takeItem ( TQListViewItem *  i)
virtual

Reimplemented for internal reasons.

Definition at line 2292 of file klistview.cpp.

TQString KListView::tooltip ( TQListViewItem *  item,
int  column 
) const
protectedvirtual
Returns
the tooltip for column of item.

Definition at line 1466 of file klistview.cpp.

int KListView::tooltipColumn ( ) const
Returns
the column for which tooltips are displayed (or -1 if none set).
See also
setTooltipColumn()
void KListView::viewportPaintEvent ( TQPaintEvent *  e)
protectedvirtual

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 2100 of file klistview.cpp.

void KListView::viewportResizeEvent ( TQResizeEvent *  e)
protectedvirtual

Reimplemented for setFullWidth()

Definition at line 2169 of file klistview.cpp.


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

kdeui

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

kdeui

Skip menu "kdeui"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdeui by doxygen 1.8.11
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |