.TH "KFileDetailView" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileDetailView \- A list-view capable of showing KFileItem'.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kfiledetailview.h>\fP
.PP
Inherits \fBKListView\fP, and \fBKFileView\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBdropped\fP (\fBQDropEvent\fP *\fBevent\fP, \fBKFileItem\fP *fileItem)"
.br
.ti -1c
.RI "void \fBdropped\fP (\fBQDropEvent\fP *\fBevent\fP, const \fBKURL::List\fP &urls, const \fBKURL\fP &url)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKFileDetailView\fP (\fBQWidget\fP *parent, const char *name)"
.br
.ti -1c
.RI "virtual \fBQWidget\fP * \fBwidget\fP ()"
.br
.ti -1c
.RI "virtual void \fBclearView\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetAutoUpdate\fP (bool)"
.br
.ti -1c
.RI "virtual void \fBsetSelectionMode\fP (KFile::SelectionMode sm)"
.br
.ti -1c
.RI "virtual void \fBupdateView\fP (bool)"
.br
.ti -1c
.RI "virtual void \fBupdateView\fP (const \fBKFileItem\fP *)"
.br
.ti -1c
.RI "virtual void \fBremoveItem\fP (const \fBKFileItem\fP *)"
.br
.ti -1c
.RI "virtual void \fBlistingCompleted\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetSelected\fP (const \fBKFileItem\fP *, bool)"
.br
.ti -1c
.RI "virtual bool \fBisSelected\fP (const \fBKFileItem\fP *i) const "
.br
.ti -1c
.RI "virtual void \fBclearSelection\fP ()"
.br
.ti -1c
.RI "virtual void \fBselectAll\fP ()"
.br
.ti -1c
.RI "virtual void \fBinvertSelection\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetCurrentItem\fP (const \fBKFileItem\fP *)"
.br
.ti -1c
.RI "virtual \fBKFileItem\fP * \fBcurrentFileItem\fP () const "
.br
.ti -1c
.RI "virtual \fBKFileItem\fP * \fBfirstFileItem\fP () const "
.br
.ti -1c
.RI "virtual \fBKFileItem\fP * \fBnextItem\fP (const \fBKFileItem\fP *) const "
.br
.ti -1c
.RI "virtual \fBKFileItem\fP * \fBprevItem\fP (const \fBKFileItem\fP *) const "
.br
.ti -1c
.RI "virtual void \fBinsertItem\fP (\fBKFileItem\fP *i)"
.br
.ti -1c
.RI "virtual void \fBsetSorting\fP (QDir::SortSpec)"
.br
.ti -1c
.RI "void \fBensureItemVisible\fP (const \fBKFileItem\fP *)"
.br
.ti -1c
.RI "void \fBmimeTypeDeterminationFinished\fP ()"
.br
.ti -1c
.RI "void \fBdetermineIcon\fP (\fBKFileListViewItem\fP *item)"
.br
.ti -1c
.RI "\fBQScrollView\fP * \fBscrollWidget\fP () const "
.br
.ti -1c
.RI "virtual void \fBreadConfig\fP (\fBKConfig\fP *, const \fBQString\fP &group=QString::null)"
.br
.ti -1c
.RI "virtual void \fBwriteConfig\fP (\fBKConfig\fP *, const \fBQString\fP &group=QString::null)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotSelectionChanged\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBkeyPressEvent\fP (\fBQKeyEvent\fP *)"
.br
.ti -1c
.RI "virtual \fBQDragObject\fP * \fBdragObject\fP ()"
.br
.ti -1c
.RI "virtual void \fBcontentsDragEnterEvent\fP (\fBQDragEnterEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsDragMoveEvent\fP (\fBQDragMoveEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsDragLeaveEvent\fP (\fBQDragLeaveEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBcontentsDropEvent\fP (\fBQDropEvent\fP *ev)"
.br
.ti -1c
.RI "virtual bool \fBacceptDrag\fP (\fBQDropEvent\fP *e) const "
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "int \fBm_sortingCol\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A list-view capable of showing KFileItem'. 

Used in the filedialog for example. Most of the documentation is in \fBKFileView\fP class.
.PP
\fBSee also:\fP
.RS 4
\fBKDirOperator\fP 
.PP
\fBKCombiView\fP 
.PP
\fBKFileIconView\fP 
.RE
.PP

.PP
Definition at line 109 of file kfiledetailview.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQWidget\fP* KFileDetailView::widget ()\fC [inline, virtual]\fP"
.PP
a pure virtual function to get a \fBQWidget\fP, that can be added to other widgets. 
.PP
This function is needed to make it possible for derived classes to derive from other widgets. 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 117 of file kfiledetailview.h.
.SS "void KFileDetailView::clearView ()\fC [virtual]\fP"
.PP
pure virtual function, that should be implemented to clear the view. 
.PP
At this moment the list is already empty 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 202 of file kfiledetailview.cpp.
.PP
References QListView::clear(), QPtrList::clear(), and KMimeTypeResolver< IconItem, Parent >::m_lstPendingMimeIconItems.
.SS "void KFileDetailView::updateView (bool)\fC [virtual]\fP"
.PP
does a repaint of the view. 
.PP
The default implementation calls 
.PP
.nf
 widget()->repaint(f)

.fi
.PP
 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 296 of file kfiledetailview.cpp.
.PP
References QListViewItemIterator::current(), KFileListViewItem::fileInfo(), KFileItem::pixmap(), and QListViewItem::setPixmap().
.SS "void KFileDetailView::removeItem (const \fBKFileItem\fP *)\fC [virtual]\fP"
.PP
Removes an item from the list; has to be implemented by the view. 
.PP
Call KFileView::removeItem( item ) after removing it. 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 340 of file kfiledetailview.cpp.
.PP
References KMimeTypeResolver< IconItem, Parent >::m_lstPendingMimeIconItems, QPtrList::remove(), and KFileView::removeItem().
.SS "void KFileDetailView::listingCompleted ()\fC [virtual]\fP"
.PP
This hook is called when all items of the currently listed directory are listed and inserted into the view, i.e. 
.PP
there won't come any new items anymore. 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 531 of file kfiledetailview.cpp.
.PP
References KMimeTypeResolver< IconItem, Parent >::start().
.SS "void KFileDetailView::setSelected (const \fBKFileItem\fP *, bool)\fC [virtual]\fP"
.PP
Tells the view that it should highlight the item. 
.PP
This function must be implemented by the view. 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 143 of file kfiledetailview.cpp.
.PP
References QListView::setSelected().
.SS "bool KFileDetailView::isSelected (const \fBKFileItem\fP * i) const\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
whether the given item is currently selected. Must be implemented by the view. 
.RE
.PP

.PP
Implements \fBKFileView\fP.
.PP
Definition at line 286 of file kfiledetailview.cpp.
.PP
References QListViewItem::isSelected().
.SS "void KFileDetailView::clearSelection ()\fC [virtual]\fP"
.PP
Clears any selection, unhighlights everything. 
.PP
Must be implemented by the view. 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 173 of file kfiledetailview.cpp.
.PP
References QListView::clearSelection().
.SS "void KFileDetailView::selectAll ()\fC [virtual]\fP"
.PP
Selects all items. 
.PP
You may want to override this, if you can implement it more efficiently than calling \fBsetSelected()\fP with every item. This works only in Multiselection mode of course. 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 178 of file kfiledetailview.cpp.
.PP
References QListView::selectAll().
.SS "void KFileDetailView::invertSelection ()\fC [virtual]\fP"
.PP
Inverts the current selection, i.e. 
.PP
selects all items, that were up to now not selected and deselects the other. 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 187 of file kfiledetailview.cpp.
.PP
References QListView::invertSelection().
.SS "void KFileDetailView::setCurrentItem (const \fBKFileItem\fP *)\fC [virtual]\fP"
.PP
Reimplement this to set \fCitem\fP the current item in the view, e.g. 
.PP
the item having focus. 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 155 of file kfiledetailview.cpp.
.PP
References QListView::setCurrentItem().
.SS "\fBKFileItem\fP * KFileDetailView::currentFileItem () const\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the 'current' \fBKFileItem\fP, e.g. where the cursor is. Returns 0L when there is no current item (e.g. in an empty view). Subclasses have to implement this. 
.RE
.PP

.PP
Implements \fBKFileView\fP.
.PP
Definition at line 164 of file kfiledetailview.cpp.
.PP
References QListView::currentItem(), and KFileListViewItem::fileInfo().
.SS "void KFileDetailView::insertItem (\fBKFileItem\fP * i)\fC [virtual]\fP"
.PP
The derived view must implement this function to add the file in the widget. 
.PP
Make sure to call this implementation, i.e. KFileView::insertItem( i ); 
.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 208 of file kfiledetailview.cpp.
.PP
References QPtrList::append(), KFileView::insertItem(), and KMimeTypeResolver< IconItem, Parent >::m_lstPendingMimeIconItems.
.SS "void KFileDetailView::setSorting (QDir::SortSpec)\fC [virtual]\fP"
.PP
Sets the sorting order of the view. 
.PP
Default is QDir::Name | QDir::IgnoreCase | QDir::DirsFirst Override this in your subclass and sort accordingly (usually by setting the sorting-key for every item and telling \fBQIconView\fP or \fBQListView\fP to sort.
.PP
A view may choose to use a different sorting than QDir::Name, Time or Size. E.g. to sort by mimetype or any possible string. Set the sorting to QDir::Unsorted for that and do the rest internally.
.PP
\fBSee also:\fP
.RS 4
\fBsortingKey\fP 
.RE
.PP

.PP
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 426 of file kfiledetailview.cpp.
.PP
References KFileView::setSorting().
.SS "void KFileDetailView::ensureItemVisible (const \fBKFileItem\fP *)\fC [virtual]\fP"
.PP
pure virtual function, that should be implemented to make item i visible, i.e. 
.PP
by scrolling the view appropriately. 
.PP
Implements \fBKFileView\fP.
.PP
Definition at line 454 of file kfiledetailview.cpp.
.PP
References QListView::ensureItemVisible(), and KFileItem::extraData().
.SS "void KFileDetailView::dropped (\fBQDropEvent\fP * event, \fBKFileItem\fP * fileItem)\fC [signal]\fP"
.PP
The user dropped something. 
.PP
\fCfileItem\fP points to the item dropped on or can be 0 if the user dropped on empty space. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.SS "void KFileDetailView::dropped (\fBQDropEvent\fP * event, const \fBKURL::List\fP & urls, const \fBKURL\fP & url)\fC [signal]\fP"
.PP
The user dropped the URLs \fCurls\fP. 
.PP
\fCurl\fP points to the item dropped on or can be empty if the user dropped on empty space. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
