.TH "KFileDetailView" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KFileDetailView \- A list-view capable of showing \fBKFileItem\fP'.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kfiledetailview.h>\fP
.PP
Inherits \fBKListView\fP, and \fBKFileView\fP.
.PP
.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
.RI "\fIa pure virtual function to get a \fBQWidget\fP, that can be added to other widgets. \fP"
.ti -1c
.RI "virtual void \fBclearView\fP ()"
.br
.RI "\fIpure virtual function, that should be implemented to clear the view. \fP"
.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
.RI "\fIdoes a repaint of the view. \fP"
.ti -1c
.RI "virtual void \fBupdateView\fP (const  \fBKFileItem\fP *)"
.br
.ti -1c
.RI "virtual void \fBremoveItem\fP (const  \fBKFileItem\fP *)"
.br
.RI "\fIRemoves an item from the list; has to be implemented by the view. \fP"
.ti -1c
.RI "virtual void \fBlistingCompleted\fP ()"
.br
.RI "\fIThis hook is called when all items of the currently listed directory are listed and inserted into the view, i.e. \fP"
.ti -1c
.RI "virtual void \fBsetSelected\fP (const  \fBKFileItem\fP *, bool)"
.br
.RI "\fITells the view that it should highlight the item. \fP"
.ti -1c
.RI "virtual bool \fBisSelected\fP (const  \fBKFileItem\fP *i) const "
.br
.ti -1c
.RI "virtual void \fBclearSelection\fP ()"
.br
.RI "\fIClears any selection, unhighlights everything. \fP"
.ti -1c
.RI "virtual void \fBselectAll\fP ()"
.br
.RI "\fISelects all items. \fP"
.ti -1c
.RI "virtual void \fBinvertSelection\fP ()"
.br
.RI "\fIInverts the current selection, i.e. \fP"
.ti -1c
.RI "virtual void \fBsetCurrentItem\fP (const  \fBKFileItem\fP *)"
.br
.RI "\fIReimplement this to set \fCitem\fP the current item in the view, e.g. \fP"
.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
.RI "\fIThe derived view must implement this function to add the file in the widget. \fP"
.ti -1c
.RI "virtual void \fBsetSorting\fP (QDir::SortSpec)"
.br
.RI "\fISets the sorting order of the view. \fP"
.ti -1c
.RI "void \fBensureItemVisible\fP (const  \fBKFileItem\fP *)"
.br
.RI "\fIpure virtual function, that should be implemented to make item i visible, i.e. \fP"
.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
.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 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 \fBKFileItem\fP'. 

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. This function is needed to make it possible for derived classes to derive from other widgets. 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. At this moment the list is already empty Implements \fBKFileView\fP.
.PP
Definition at line 174 of file kfiledetailview.cpp.
.PP
References QListView::clear(), QPtrList< KFileListViewItem >::clear(), and KMimeTypeResolver< KFileListViewItem, KFileDetailView >::m_lstPendingMimeIconItems.
.SS "void KFileDetailView::updateView (bool)\fC [virtual]\fP"
.PP
does a repaint of the view. The default implementation calls 
.PP
.nf
\fBwidget()\fP->repaint(f)
.PP
 Reimplemented from \fBKFileView\fP.
.PP
Definition at line 268 of file kfiledetailview.cpp.
.PP
References QListViewItemIterator::current(), KFileListViewItem::fileInfo(), KFileItem::pixmap(), QListViewItem::setPixmap(), and KIcon::SizeSmall.
.SS "void KFileDetailView::removeItem (const \fBKFileItem\fP *)\fC [virtual]\fP"
.PP
Removes an item from the list; has to be implemented by the view. Call KFileView::removeItem( item ) after removing it. Reimplemented from \fBKFileView\fP.
.PP
Definition at line 312 of file kfiledetailview.cpp.
.PP
References KFileItem::extraData(), KMimeTypeResolver< KFileListViewItem, KFileDetailView >::m_lstPendingMimeIconItems, QPtrList< KFileListViewItem >::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. there won't come any new items anymore. Reimplemented from \fBKFileView\fP.
.PP
Definition at line 501 of file kfiledetailview.cpp.
.PP
References KMimeTypeResolver< KFileListViewItem, KFileDetailView >::start().
.SS "void KFileDetailView::setSelected (const \fBKFileItem\fP *, bool)\fC [virtual]\fP"
.PP
Tells the view that it should highlight the item. This function must be implemented by the view. Implements \fBKFileView\fP.
.PP
Definition at line 115 of file kfiledetailview.cpp.
.PP
References KFileItem::extraData(), and 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
Implements \fBKFileView\fP.
.PP
Definition at line 258 of file kfiledetailview.cpp.
.PP
References KFileItem::extraData(), and QListViewItem::isSelected().
.SS "void KFileDetailView::clearSelection ()\fC [virtual]\fP"
.PP
Clears any selection, unhighlights everything. Must be implemented by the view. Implements \fBKFileView\fP.
.PP
Definition at line 145 of file kfiledetailview.cpp.
.PP
References QListView::clearSelection().
.SS "void KFileDetailView::selectAll ()\fC [virtual]\fP"
.PP
Selects all items. 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. Reimplemented from \fBKFileView\fP.
.PP
Definition at line 150 of file kfiledetailview.cpp.
.PP
References QListView::selectAll().
.SS "void KFileDetailView::invertSelection ()\fC [virtual]\fP"
.PP
Inverts the current selection, i.e. selects all items, that were up to now not selected and deselects the other. Reimplemented from \fBKFileView\fP.
.PP
Definition at line 159 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. the item having focus. Implements \fBKFileView\fP.
.PP
Definition at line 127 of file kfiledetailview.cpp.
.PP
References KFileItem::extraData(), and 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
Implements \fBKFileView\fP.
.PP
Definition at line 136 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. Make sure to call this implementation, i.e. KFileView::insertItem( i ); Reimplemented from \fBKFileView\fP.
.PP
Definition at line 180 of file kfiledetailview.cpp.
.PP
References QPtrList< KFileListViewItem >::append(), KFileView::insertItem(), KFileItem::isMimeTypeKnown(), KMimeTypeResolver< KFileListViewItem, KFileDetailView >::m_lstPendingMimeIconItems, and KFileItem::setExtraData().
.SS "void KFileDetailView::setSorting (QDir::SortSpec)\fC [virtual]\fP"
.PP
Sets the sorting order of the view. 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
Reimplemented from \fBKFileView\fP.
.PP
Definition at line 396 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. by scrolling the view appropriately. Implements \fBKFileView\fP.
.PP
Definition at line 424 of file kfiledetailview.cpp.
.PP
References QListView::ensureItemVisible(), and KFileItem::extraData().

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