KListView Class Reference
#include <klistview.h>
Inheritance diagram for KListView:

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 have to derive from it. Reimplement dragObject() and (possibly) startDrag(), and setDragEnabled(true).
Definition at line 53 of file klistview.h.
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< QListViewItem > | selectedItems () const |
QPtrList< QListViewItem > | selectedItems (bool includeHiddenItems) const |
void | moveItem (QListViewItem *item, QListViewItem *parent, QListViewItem *after) |
QListViewItem * | lastItem () const |
QListViewItem * | 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 QListViewItem *item) const |
QListViewItem * | itemAtIndex (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 QColor & | alternateBackground () 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 QDragObject * | dragObject () |
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 |
Member Enumeration Documentation
|
Possible selection modes. The first four correspond directly to QListView::SelectionMode, while the FileManager selection mode is defined as follows:
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
|
Constructor.
The parameters Definition at line 411 of file klistview.cpp. |
|
Destructor.
Definition at line 456 of file klistview.cpp. |
Member Function Documentation
|
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
|
|
Definition at line 1393 of file klistview.cpp. |
|
In FileManager selection mode: explicitly activate the mode in which the current item is automatically selected.
Definition at line 1464 of file klistview.cpp. |
|
Reimplemented for full width support.
Reimplemented from QListView. Definition at line 1961 of file klistview.cpp. |
|
Reimplemented for full width support.
Reimplemented from QListView. Definition at line 1951 of file klistview.cpp. |
|
|
|
Definition at line 2095 of file klistview.cpp. |
|
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. |
|
|
|
An overloaded version of below(const QRect&, const QPoint&). It differs from the above only in what arguments it takes.
Definition at line 685 of file klistview.h. |
|
Determine whether a drop on position
Definition at line 671 of file klistview.h. |
|
Repaint the rect where I was drawing the drop line.
Definition at line 1028 of file klistview.cpp. |
|
Repaint the rect where I was drawing the drop rectangle.
Definition at line 1354 of file klistview.cpp. |
|
Definition at line 2090 of file klistview.cpp. |
|
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 1280 of file klistview.cpp. |
|
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 1021 of file klistview.cpp. |
|
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 971 of file klistview.cpp. |
|
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 895 of file klistview.cpp. |
|
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. |
|
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. |
|
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. |
|
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. |
|
This signal is emitted whenever a context-menu should be shown for item It automatically adjusts for all settings involved (Menu key, showMenuOnPress/Click).
|
|
For future expansions. Do not use. Definition at line 1403 of file klistview.cpp. |
|
In FileManager selection mode: explicitly deactivate the mode in which the current item is automatically selected.
Definition at line 1476 of file klistview.cpp. |
|
Convert the depth of an item into its indentation in pixels.
Definition at line 1038 of file klistview.cpp. |
|
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.
Definition at line 2108 of file klistview.cpp. |
|
Reimplemented from QListView. Definition at line 2127 of file klistview.cpp. |
|
|
|
Reimplemented from QListView. Definition at line 1148 of file klistview.cpp. |
|
Paint the drag line. If painter is null, don't try to :) If after == 0 then the marker should be drawn at the top.
Definition at line 1291 of file klistview.cpp. |
|
Paint the drag rectangle. If painter is null, don't try to :)
Definition at line 1338 of file klistview.cpp. |
|
Definition at line 1424 of file klistview.cpp. |
|
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
|
|
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
|
|
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).
|
|
This signal gets emitted whenever something acceptable is dropped onto the listview.
|
|
|
|
The dropVisualizerWidth defaults to 4.
|
|
Emit the contextMenu signal. This slot is for key presses. Definition at line 1879 of file klistview.cpp. |
|
Emit the contextMenu signal. This slot is for mouse actions. Definition at line 1891 of file klistview.cpp. |
|
Emit signal executed.
For internal use only.
Definition at line 666 of file klistview.cpp. |
|
Reimplemented to reload the alternate background in palette changes.
For internal use only.
Definition at line 739 of file klistview.cpp. |
|
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.
|
|
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.
|
|
A special keyPressEvent (for FileManager selection mode).
Definition at line 1486 of file klistview.cpp. |
|
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. |
|
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. |
|
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. |
|
Returns whether the last column is set to fit the available width.
|
|
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. |
|
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.
Definition at line 461 of file klistview.cpp. |
|
Definition at line 1373 of file klistview.cpp. |
|
Returns the item of This function takes all items into account not only the visible ones. Definition at line 1863 of file klistview.cpp. |
|
Returns the index of This function takes all items into account not only the visible ones. Definition at line 1844 of file klistview.cpp. |
|
Same as above, but without the extra information.
|
|
This signal gets emitted when an item is renamed via in-place renaming.
|
|
|
|
|
|
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 1449 of file klistview.cpp. |
|
Definition at line 1112 of file klistview.cpp. |
|
Definition at line 1122 of file klistview.cpp. |
|
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. |
|
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.
|
|
Handle dropEvent when itemsMovable() is set to true.
Definition at line 921 of file klistview.cpp. |
|
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 |
|
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 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. |
|
Arbitrarily move
If after is 0, (Un-deprecated in kde-3.4) Definition at line 1250 of file klistview.cpp. |
|
Reimplemented for full width support.
Reimplemented from QListView. Definition at line 1971 of file klistview.cpp. |
|
Rename column
Definition at line 1364 of file klistview.cpp. |
|
Definition at line 1132 of file klistview.cpp. |
|
Reset AutoSelection to the system wide setting.
Definition at line 2118 of file klistview.cpp. |
|
Reads the list view's layout from a KConfig group as stored with saveLayout.
Definition at line 2022 of file klistview.cpp. |
|
Saves the list view's layout (column widtsh, column order, sort column) to a KConfig group.
Definition at line 2004 of file klistview.cpp. |
|
Definition at line 1213 of file klistview.cpp. |
|
Definition at line 1208 of file klistview.cpp. |
|
Definition at line 1839 of file klistview.cpp. |
|
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. |
|
sets the alternate background background color. This only has an effect if the items are KListViewItems
Definition at line 1987 of file klistview.cpp. |
|
Enable/Disable AutoOpen (not implemented currently).
Definition at line 1188 of file klistview.cpp. |
|
For future expansions. Do not use. Definition at line 1398 of file klistview.cpp. |
|
Enable/Disable the dragging of items. It is disabled by default. Definition at line 1178 of file klistview.cpp. |
|
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. |
|
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. |
|
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. |
|
Let the last column fit exactly all the available width.
Definition at line 1940 of file klistview.cpp. |
|
Definition at line 1935 of file klistview.cpp. |
|
Set whether items in the list view can be moved. It is enabled by default.
Definition at line 1157 of file klistview.cpp. |
|
Enables inplace-renaming of items. It is disabled by default.
Definition at line 1167 of file klistview.cpp. |
|
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. |
|
Set the selection mode. A different name was chosen to avoid API-clashes with QListView::setSelectionMode(). Definition at line 1816 of file klistview.cpp. |
|
Set to true if the currently sorted column should be drawn shaded. Defaults to true
Definition at line 1993 of file klistview.cpp. |
|
Reimplemented to remember the current sort column and order.
Reimplemented from QListView. Definition at line 2057 of file klistview.cpp. |
|
Enable/disable tabbing between editable cells.
Definition at line 1439 of file klistview.cpp. |
|
Set which column should be used for automatic tooltips.
Definition at line 1414 of file klistview.cpp. |
|
See if the sort column should be drawn shaded.
|
|
Definition at line 1429 of file klistview.cpp. |
|
Process AutoSelection.
For internal use only.
Definition at line 577 of file klistview.cpp. |
|
Reacts to header changes in full width mode.
For internal use only.
Definition at line 653 of file klistview.cpp. |
|
Accessory slot for AutoSelect.
For internal use only.
Definition at line 510 of file klistview.cpp. |
|
Accessory slot for AutoSelect/ChangeCursorOverItem.
For internal use only.
Definition at line 519 of file klistview.cpp. |
|
Update internal settings whenever the global ones change.
For internal use only.
Definition at line 528 of file klistview.cpp. |
|
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. |
|
Returns whether tab ordered renaming is enabled.
Definition at line 1444 of file klistview.cpp. |
|
Reimplemented for internal reasons.
Reimplemented from QListView. Definition at line 2100 of file klistview.cpp. |
|
Definition at line 1434 of file klistview.cpp. |
|
|
|
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. |
|
Reimplemented for setFullWidth().
Definition at line 1977 of file klistview.cpp. |
The documentation for this class was generated from the following files: